diff options
5 files changed, 27 insertions, 62 deletions
diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/security/DataSourceLoginService.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/security/DataSourceLoginService.java index aa61b57a0e..e3ab07f898 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/security/DataSourceLoginService.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/security/DataSourceLoginService.java @@ -77,17 +77,11 @@ public class DataSourceLoginService extends MappedLoginService /** * DBUser - * - * */ public class DBUser extends KnownUser { private int _key; - /** - * @param name - * @param credential - */ public DBUser(String name, Credential credential, int key) { super(name, credential); @@ -364,7 +358,6 @@ public class DataSourceLoginService extends MappedLoginService /** * @see org.eclipse.jetty.security.MappedLoginService#loadUserInfo(java.lang.String) - * @Override */ public KnownUser loadUserInfo (String username) { @@ -399,7 +392,6 @@ public class DataSourceLoginService extends MappedLoginService /** * @see org.eclipse.jetty.security.MappedLoginService#loadRoleInfo(org.eclipse.jetty.security.MappedLoginService.KnownUser) - * @Override */ public String[] loadRoleInfo (KnownUser user) { @@ -436,10 +428,6 @@ public class DataSourceLoginService extends MappedLoginService return null; } - - - - /* ------------------------------------------------------------ */ @Override public UserIdentity login(String username, Object credentials, ServletRequest request) @@ -507,8 +495,6 @@ public class DataSourceLoginService extends MappedLoginService prepareTables(); } - - private void prepareTables() throws NamingException, SQLException { @@ -609,12 +595,10 @@ public class DataSourceLoginService extends MappedLoginService } } - private Connection getConnection () throws NamingException, SQLException { initDb(); return _datasource.getConnection(); } - } diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java b/jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java index 423fcad941..c509f3741f 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java @@ -43,7 +43,8 @@ public interface Authenticator /* ------------------------------------------------------------ */ /** * Configure the Authenticator - * @param configuration + * + * @param configuration the configuration */ void setConfiguration(AuthConfiguration configuration); @@ -64,13 +65,16 @@ public interface Authenticator * where the http method of the original request causing authentication * is not the same as the http method resulting from the redirect * after authentication. - * @param request + * + * @param request the request to manipulate */ void prepareRequest(ServletRequest request); /* ------------------------------------------------------------ */ - /** Validate a request + /** + * Validate a request + * * @param request The request * @param response The response * @param mandatory True if authentication is mandatory. @@ -79,18 +83,20 @@ public interface Authenticator * implement {@link org.eclipse.jetty.server.Authentication.ResponseSent}. If Authentication is not manditory, then a * {@link org.eclipse.jetty.server.Authentication.Deferred} may be returned. * - * @throws ServerAuthException + * @throws ServerAuthException if unable to validate request */ Authentication validateRequest(ServletRequest request, ServletResponse response, boolean mandatory) throws ServerAuthException; /* ------------------------------------------------------------ */ /** - * @param request - * @param response - * @param mandatory - * @param validatedUser + * is response secure + * + * @param request the request + * @param response the response + * @param mandatory if security is mandator + * @param validatedUser the user that was validated * @return true if response is secure - * @throws ServerAuthException + * @throws ServerAuthException if unable to test response */ boolean secureResponse(ServletRequest request, ServletResponse response, boolean mandatory, User validatedUser) throws ServerAuthException; @@ -106,7 +112,8 @@ public interface Authenticator String getAuthMethod(); String getRealmName(); - /** Get a SecurityHandler init parameter + /** + * Get a SecurityHandler init parameter * @see SecurityHandler#getInitParameter(String) * @param param parameter name * @return Parameter value or null diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java b/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java index 15f64dc430..d06898e845 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/ConstraintAware.java @@ -29,15 +29,15 @@ public interface ConstraintAware /* ------------------------------------------------------------ */ /** Set Constraint Mappings and roles. * Can only be called during initialization. - * @param constraintMappings - * @param roles + * @param constraintMappings the mappings + * @param roles the roles */ void setConstraintMappings(List<ConstraintMapping> constraintMappings, Set<String> roles); /* ------------------------------------------------------------ */ /** Add a Constraint Mapping. * May be called for running webapplication as an annotated servlet is instantiated. - * @param mapping + * @param mapping the mapping */ void addConstraintMapping(ConstraintMapping mapping); @@ -45,7 +45,7 @@ public interface ConstraintAware /* ------------------------------------------------------------ */ /** Add a Role definition. * May be called on running webapplication as an annotated servlet is instantiated. - * @param role + * @param role the role */ void addRole(String role); @@ -53,7 +53,7 @@ public interface ConstraintAware * See Servlet Spec 31, sec 13.8.4, pg 145 * When true, requests with http methods not explicitly covered either by inclusion or omissions * in constraints, will have access denied. - * @param deny + * @param deny true for denied method access */ void setDenyUncoveredHttpMethods(boolean deny); diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/HashLoginService.java b/jetty-security/src/main/java/org/eclipse/jetty/security/HashLoginService.java index 659083b7cf..e9f18b59c2 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/HashLoginService.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/HashLoginService.java @@ -65,17 +65,11 @@ public class HashLoginService extends MappedLoginService implements UserListener { String[] _roles; - /** - * @param name - * @param credential - */ public HashKnownUser(String name, Credential credential) { super(name, credential); } - - public void setRoles (String[] roles) { _roles = roles; @@ -86,8 +80,6 @@ public class HashLoginService extends MappedLoginService implements UserListener return _roles; } } - - /* ------------------------------------------------------------ */ public HashLoginService() diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/JDBCLoginService.java b/jetty-security/src/main/java/org/eclipse/jetty/security/JDBCLoginService.java index 9153064ae1..e2f3d8aa4e 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/JDBCLoginService.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/JDBCLoginService.java @@ -41,24 +41,17 @@ import org.eclipse.jetty.util.security.Credential; /* ------------------------------------------------------------ */ /** * HashMapped User Realm with JDBC as data source. - * The login() method checks the inherited Map for the user. If the user is not + * The {@link #login(String, Object, ServletRequest)} method checks the inherited Map for the user. If the user is not * found, it will fetch details from the database and populate the inherited - * Map. It then calls the superclass login() method to perform the actual + * Map. It then calls the superclass {@link #login(String, Object, ServletRequest)} method to perform the actual * authentication. Periodically (controlled by configuration parameter), * internal hashes are cleared. Caching can be disabled by setting cache refresh * interval to zero. Uses one database connection that is initialized at - * startup. Reconnect on failures. authenticate() is 'synchronized'. - * + * startup. Reconnect on failures. + * <p> * An example properties file for configuration is in - * $JETTY_HOME/etc/jdbcRealm.properties - * - * @version $Id: JDBCLoginService.java 4792 2009-03-18 21:55:52Z gregw $ - * - * - * - * + * <code>${jetty.home}/etc/jdbcRealm.properties</code> */ - public class JDBCLoginService extends MappedLoginService { private static final Logger LOG = Log.getLogger(JDBCLoginService.class); @@ -80,17 +73,11 @@ public class JDBCLoginService extends MappedLoginService /** * JDBCKnownUser - * - * */ public class JDBCKnownUser extends KnownUser { int _userKey; - /** - * @param name - * @param credential - */ public JDBCKnownUser(String name, Credential credential, int key) { super(name, credential); @@ -306,7 +293,6 @@ public class JDBCLoginService extends MappedLoginService /** * @see org.eclipse.jetty.security.MappedLoginService#loadUserInfo(java.lang.String) - * @Override */ public KnownUser loadUserInfo (String username) { @@ -346,7 +332,6 @@ public class JDBCLoginService extends MappedLoginService /** * @see org.eclipse.jetty.security.MappedLoginService#loadRoleInfo(org.eclipse.jetty.security.MappedLoginService.KnownUser) - * @Override */ public String[] loadRoleInfo (KnownUser user) { @@ -383,8 +368,6 @@ public class JDBCLoginService extends MappedLoginService return null; } - - /** * Close an existing connection @@ -398,5 +381,4 @@ public class JDBCLoginService extends MappedLoginService } _con = null; } - } |