Add package-info, mostly to top level packages.

Resolves https://www.pivotaltracker.com/story/show/54952244
fcrepo · Nov 14, 2013 · 1c94c0c · 1c94c0c
1 parent e1e7bd0
commit 1c94c0c
Show file tree

Hide file tree

Showing 33 changed files with 671 additions and 1 deletion.
diff --git a/fcrepo-audit/src/main/java/org/fcrepo/audit/package-info.java b/fcrepo-audit/src/main/java/org/fcrepo/audit/package-info.java
@@ -14,7 +14,10 @@
  * limitations under the License.
  */
 /**
-Audit module code.
+ This package provides functionality for auditing Fedora events. An <code> Auditor</code> records auditable Fedora events.
+ Currently the implementation registers itself to Google Guava
+ <a href="http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/EventBus.html">EventBus</a>
+ and uses Logback framework.
  */
 
 package org.fcrepo.audit;
diff --git a/fcrepo-auth-common/src/main/java/org/fcrepo/auth/package-info.java b/fcrepo-auth-common/src/main/java/org/fcrepo/auth/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package contains interfaces and classes for providing base authorization
+and authentication capabilities. Several ModeShape <code>AuthenticationProvider</code>
+s are given.
+*/
+
+package org.fcrepo.auth;
diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/api/package-info.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/api/package-info.java
@@ -0,0 +1,21 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+RESTful interface to OAuth functionality. An <code>AuthzEndPoint</code> manages authorization codes
+and a <code>TokenEndpoint handles OAuth access tokens.</code>
+ */
+
+package org.fcrepo.auth.oauth.api;
diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/package-info.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+General contract and functionality for OAuth machinery.
+ */
+
+package org.fcrepo.auth.oauth;
diff --git a/fcrepo-generator-dc/src/main/java/org/fcrepo/generator/dublincore/package-info.java b/fcrepo-generator-dc/src/main/java/org/fcrepo/generator/dublincore/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package provides implementation for Dublin Core reading/writing functionality.
+ */
+
+package org.fcrepo.generator.dublincore;
diff --git a/fcrepo-generator-dc/src/main/java/org/fcrepo/generator/package-info.java b/fcrepo-generator-dc/src/main/java/org/fcrepo/generator/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package provides RESTful interface for Dublin Core generation.
+ */
+
+package org.fcrepo.generator;
diff --git a/fcrepo-http-api/src/main/java/org/fcrepo/http/api/package-info.java b/fcrepo-http-api/src/main/java/org/fcrepo/http/api/package-info.java
@@ -0,0 +1,28 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package provides a RESTful API for several content management and
+core repository services.
+
+<ul>
+      <li>Fixity Service</li>
+      <li>Contract for repository management services (e.g. backup/restore)</li>
+      <li>Sitemap</li>
+      <li>Controllers for manipulating object and data streams</li>
+</ul>
+*/
+
+package org.fcrepo.http.api;
diff --git a/fcrepo-http-api/src/main/java/org/fcrepo/http/api/repository/package-info.java b/fcrepo-http-api/src/main/java/org/fcrepo/http/api/repository/package-info.java
@@ -0,0 +1,21 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package provides functionality for core repository management.
+
+*/
+
+package org.fcrepo.http.api.repository;
diff --git a/fcrepo-http-commons/src/main/java/org/fcrepo/http/commons/domain/package-info.java b/fcrepo-http-commons/src/main/java/org/fcrepo/http/commons/domain/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+Annotations for working with
+{@link org.fcrepo.http.api.FedoraNodes FedoraNodes}.*/
+
+package org.fcrepo.http.commons.domain;
diff --git a/...po-http-commons/src/main/java/org/fcrepo/http/commons/exceptionhandlers/package-info.java b/...po-http-commons/src/main/java/org/fcrepo/http/commons/exceptionhandlers/package-info.java
@@ -0,0 +1,19 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+A variety of JAX-RS <code>ExceptionMapper</code>s handlers.*/
+
+package org.fcrepo.http.commons.exceptionhandlers;
diff --git a/fcrepo-http-commons/src/main/java/org/fcrepo/http/commons/package-info.java b/fcrepo-http-commons/src/main/java/org/fcrepo/http/commons/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+Common abstractions for module's sub-packages.
+ */
+
+package org.fcrepo.http.commons;
diff --git a/fcrepo-http-commons/src/main/java/org/fcrepo/http/commons/responses/package-info.java b/fcrepo-http-commons/src/main/java/org/fcrepo/http/commons/responses/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+Helpers and providers for different response formats.
+ */
+
+package org.fcrepo.http.commons.responses;
diff --git a/fcrepo-http-commons/src/main/java/org/fcrepo/http/commons/session/package-info.java b/fcrepo-http-commons/src/main/java/org/fcrepo/http/commons/session/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+Types and implementation classes that define and provide sessions.
+ */
+
+package org.fcrepo.http.commons.session;
diff --git a/fcrepo-jcr/src/main/java/org/fcrepo/jcr/package-info.java b/fcrepo-jcr/src/main/java/org/fcrepo/jcr/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package hosts configuration files for the backend technologies that power Fedora.
+ */
+
+package org.fcrepo.jcr;
diff --git a/fcrepo-jms/src/main/java/org/fcrepo/jms/legacy/package-info.java b/fcrepo-jms/src/main/java/org/fcrepo/jms/legacy/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package provides capability to create and handle ATOM messages for JMS messages.
+ */
+
+package org.fcrepo.jms.legacy;
diff --git a/fcrepo-jms/src/main/java/org/fcrepo/jms/observer/package-info.java b/fcrepo-jms/src/main/java/org/fcrepo/jms/observer/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package provides capability to emit JMS messages for Fedora events.
+ */
+
+package org.fcrepo.jms.observer;
diff --git a/fcrepo-jms/src/main/java/org/fcrepo/jms/package-info.java b/fcrepo-jms/src/main/java/org/fcrepo/jms/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+This package provides common JMS capability.
+ */
+
+package org.fcrepo.jms;
diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/kernel/exception/package-info.java b/fcrepo-kernel/src/main/java/org/fcrepo/kernel/exception/package-info.java
@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013 DuraSpace, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+Kernel exception classes.
+ */
+
+package org.fcrepo.kernel.exception;