Update javadocs

Resolves: https://jira.duraspace.org/browse/FCREPO-1354
fcrepo-exts · Feb 17, 2015 · 54876f2 · 54876f2
1 parent a12ae02
commit 54876f2
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 10 deletions.
diff --git a/...common/src/main/java/org/fcrepo/auth/roles/common/AbstractRolesAuthorizationDelegate.java b/...common/src/main/java/org/fcrepo/auth/roles/common/AbstractRolesAuthorizationDelegate.java
@@ -58,6 +58,7 @@ public abstract class AbstractRolesAuthorizationDelegate implements FedoraAuthor
     /**
      * Gather effectives roles
      *
+     * @param acl access control list
      * @param principals effective principals
      * @return set of effective content roles
      */

diff --git a/fcrepo-auth-roles-common/src/main/java/org/fcrepo/auth/roles/common/AccessRoles.java b/fcrepo-auth-roles-common/src/main/java/org/fcrepo/auth/roles/common/AccessRoles.java
@@ -97,7 +97,7 @@ public AccessRoles() {
 
     /**
      * Create a new FedoraNodes instance for a given path
-     * @param externalPath
+     * @param externalPath external path
      */
     @VisibleForTesting
     public AccessRoles(final String externalPath) {
@@ -115,8 +115,8 @@ private AccessRolesProvider getAccessRolesProvider() {
     /**
      * Retrieve the roles assigned to each principal on this specific path.
      *
+     * @param effective the effective roles
      * @return JSON representation of assignment map
-     * @throws RepositoryException
      */
     @GET
     @Produces(APPLICATION_JSON)
@@ -152,9 +152,9 @@ public Response get(@QueryParam("effective") final String effective) {
     /**
      * Apply new role assignments at the specified node.
      *
-     * @param data
+     * @param data access roles
      * @return response
-     * @throws RepositoryException
+     * @throws RepositoryException if IllegalArgumentException can not handle
      */
     @POST
     @Consumes(APPLICATION_JSON)
@@ -217,6 +217,8 @@ private void validatePOST(final Map<String, Set<String>> data) {
 
     /**
      * Delete the access roles and node type.
+     * @return response
+     * @throws RepositoryException if delete failed
      */
     @DELETE
     @Timed

diff --git a/fcrepo-auth-roles-common/src/main/java/org/fcrepo/auth/roles/common/AccessRolesProvider.java b/fcrepo-auth-roles-common/src/main/java/org/fcrepo/auth/roles/common/AccessRolesProvider.java
@@ -161,6 +161,7 @@ private void getAssignments(final Node node, final Map<String, List<String>> dat
      *
      * @param node the Node to edit
      * @param data the roles to assign
+     * @throws RepositoryException if repository exception occurred
      */
     public void postRoles(final Node node, final Map<String, Set<String>> data)
         throws RepositoryException {
@@ -192,7 +193,8 @@ public void postRoles(final Node node, final Map<String, Set<String>> data)
     /**
      * Deletes all roles assigned on this node and removes the mixin type.
      *
-     * @param node
+     * @param node the node to delete
+     * @throws RepositoryException if delete failed
      */
     public void deleteRoles(final Node node) throws RepositoryException {
         final Session session = node.getSession();
@@ -214,8 +216,9 @@ public void deleteRoles(final Node node) throws RepositoryException {
      * Finds effective roles assigned to a path, using first real ancestor node.
      *
      * @param absPath the real or potential node path
+     * @param session session
      * @return the roles assigned to each principal
-     * @throws RepositoryException
+     * @throws RepositoryException if PathNotFoundException can not handle
      */
     public Map<String, List<String>> findRolesForPath(final Path absPath,
             final Session session) throws RepositoryException {

diff --git a/fcrepo-auth-roles-common/src/main/java/org/fcrepo/auth/roles/common/AccessRolesTypes.java b/fcrepo-auth-roles-common/src/main/java/org/fcrepo/auth/roles/common/AccessRolesTypes.java
@@ -48,8 +48,7 @@ public class AccessRolesTypes {
     /**
      * Initialize, register role assignment node types.
      *
-     * @throws RepositoryException
-     * @throws IOException
+     * @throws IOException if io exception occurred
      */
     @PostConstruct
     public void setUpRepositoryConfiguration() throws IOException {

diff --git a/fcrepo-auth-roles-common/src/main/java/org/fcrepo/auth/roles/common/Constants.java b/fcrepo-auth-roles-common/src/main/java/org/fcrepo/auth/roles/common/Constants.java
@@ -101,8 +101,8 @@ public String toString() {
 
     /**
      * Adds access roles prefix "authz" to the given session.
-     * @param session
-     * @throws RepositoryException
+     * @param session session
+     * @throws RepositoryException if repository exception occurred
      */
     public static void registerPrefixes(final Session session)
         throws RepositoryException {