add javadocs and remove the checkstyle suppression

fcrepo · Jul 4, 2013 · 98d583c · 98d583c
1 parent 00822be
commit 98d583c
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 172 deletions.
diff --git a/fcrepo-auth-oauth/checkstyle-suppressions.xml b/fcrepo-auth-oauth/checkstyle-suppressions.xml
diff --git a/fcrepo-auth-oauth/pom.xml b/fcrepo-auth-oauth/pom.xml
@@ -154,14 +154,6 @@
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>
       </plugin>
-      <plugin>
-        <artifactId>maven-checkstyle-plugin</artifactId>
-        <configuration>
-          <consoleOutput>true</consoleOutput>
-          <configLocation>fcrepo-checkstyle/checkstyle.xml</configLocation>
-          <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
-        </configuration>
-      </plugin>
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>build-helper-maven-plugin</artifactId>

diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/Decision.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/Decision.java
@@ -32,6 +32,11 @@ public class Decision implements OAuthDecision {
 
     private boolean isAuthorized;
 
+    /**
+     * Initialize the decision for a client and principal
+     * @param client
+     * @param principal
+     */
     public Decision(final String client, final String principal) {
         this.oAuthClient = new OAuthClient() {
 
@@ -66,6 +71,10 @@ public boolean isAuthorized() {
         return isAuthorized;
     }
 
+    /**
+     * Set whether the principal is authorized
+     * @param isAuthorized
+     */
     public void setAuthorized(final boolean isAuthorized) {
         this.isAuthorized = isAuthorized;
     }

diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/DefaultOAuthResourceProvider.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/DefaultOAuthResourceProvider.java
@@ -86,6 +86,10 @@ public OAuthDecision validateRequest(final String rsId, final String token,
         return null;
     }
 
+    /**
+     * Test wiring, so w e can set the sessionFactory field without spring
+     * @param sessionFactory
+     */
     public void setSessionFactory(final SessionFactory sessionFactory) {
         this.sessionFactory = sessionFactory;
     }

diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/api/AuthzEndpoint.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/api/AuthzEndpoint.java
@@ -76,9 +76,8 @@ public class AuthzEndpoint extends AbstractResource {
      * @throws RepositoryException
      */
     @GET
-    public Response getAuthorization(@Context
-    final HttpServletRequest request) throws URISyntaxException,
-        OAuthSystemException, RepositoryException {
+    public Response getAuthorization(@Context final HttpServletRequest request)
+        throws URISyntaxException, OAuthSystemException, RepositoryException {
 
         OAuthAuthzRequest oauthRequest = null;
 

diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/api/TokenEndpoint.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/api/TokenEndpoint.java
@@ -86,9 +86,8 @@ public class TokenEndpoint extends AbstractResource {
     @POST
     @Consumes(APPLICATION_FORM_URLENCODED)
     @Produces(APPLICATION_JSON)
-    public Response getToken(@Context
-    final HttpServletRequest request) throws OAuthSystemException,
-        RepositoryException {
+    public Response getToken(@Context final HttpServletRequest request) throws
+        OAuthSystemException, RepositoryException {
         LOGGER.debug("Received request for token carried on request: {}",
                 request);
         OAuthTokenRequest oauthRequest = null;
@@ -244,6 +243,10 @@ private boolean isNotValid() {
         return false;
     }
 
+    /**
+     * Create the OAuth workspace in JCR to store all our tokens
+     * @throws RepositoryException
+     */
     @PostConstruct
     public void init() throws RepositoryException {
         createOauthWorkspace(sessions);

diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/api/Util.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/api/Util.java
@@ -35,9 +35,8 @@ public class Util {
      * @param sessionFactory
      * @throws RepositoryException
      */
-    public static void
-            createOauthWorkspace(final SessionFactory sessionFactory)
-                throws RepositoryException {
+    public static void createOauthWorkspace(final SessionFactory sessionFactory)
+        throws RepositoryException {
         final Session session = sessionFactory.getSession();
         try {
             if (!copyOf(session.getWorkspace().getAccessibleWorkspaceNames())

diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/filter/Decision.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/filter/Decision.java
diff --git a/...o-auth-oauth/src/main/java/org/fcrepo/auth/oauth/filter/DefaultOAuthResourceProvider.java b/...o-auth-oauth/src/main/java/org/fcrepo/auth/oauth/filter/DefaultOAuthResourceProvider.java
diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/filter/OAuthFilter.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/filter/OAuthFilter.java
@@ -64,12 +64,20 @@ public class OAuthFilter implements Filter {
 
     private Set<ParameterStyle> parameterStyles;
 
+    /**
+     * no-op
+     */
     @PostConstruct
     public void init() {
         LOGGER.debug("Initializing {}", getClass().getName());
 
     }
 
+    /**
+     * no-op
+     * @param filterConfig
+     * @throws ServletException
+     */
     @Override
     public void init(final FilterConfig filterConfig) throws ServletException {
         init();
@@ -131,6 +139,9 @@ public Principal getUserPrincipal() {
 
     }
 
+    /**
+     * noop
+     */
     @Override
     public void destroy() {
 
@@ -196,8 +207,7 @@ public void setProvider(final OAuthRSProvider provider) {
     /**
      * @param parameterStylesSet
      */
-    public void
-            setParameterStyles(final Set<ParameterStyle> parameterStylesSet) {
+    public void setParameterStyles(final Set<ParameterStyle> parameterStylesSet) {
         this.parameterStyles = parameterStylesSet;
     }
 

diff --git a/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/filter/RestrictToAuthNFilter.java b/fcrepo-auth-oauth/src/main/java/org/fcrepo/auth/oauth/filter/RestrictToAuthNFilter.java
@@ -47,6 +47,9 @@ public void init(final FilterConfig filterConfig) throws ServletException {
         init();
     }
 
+    /**
+     * no-op
+     */
     @PostConstruct
     public void init() {
         LOGGER.debug("Initialized {}", this.getClass().getName());