Indicated which classes require JavaDoc
git-svn-id: https://svn.apache.org/repos/asf/incubator/jsecurity/trunk@711110 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/org/jsecurity/mgt/CachingSecurityManager.java b/src/org/jsecurity/mgt/CachingSecurityManager.java
index eade873..999b34d 100644
--- a/src/org/jsecurity/mgt/CachingSecurityManager.java
+++ b/src/org/jsecurity/mgt/CachingSecurityManager.java
@@ -41,6 +41,8 @@
*/
public abstract class CachingSecurityManager implements SecurityManager, Destroyable, CacheManagerAware {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(CachingSecurityManager.class);
protected CacheManager cacheManager;
diff --git a/src/org/jsecurity/mgt/DefaultSecurityManager.java b/src/org/jsecurity/mgt/DefaultSecurityManager.java
index b4c32b3..c9adf89 100644
--- a/src/org/jsecurity/mgt/DefaultSecurityManager.java
+++ b/src/org/jsecurity/mgt/DefaultSecurityManager.java
@@ -69,6 +69,8 @@
*/
public class DefaultSecurityManager extends SessionsSecurityManager {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(DefaultSecurityManager.class);
protected RememberMeManager rememberMeManager;
diff --git a/src/org/jsecurity/mgt/RealmSecurityManager.java b/src/org/jsecurity/mgt/RealmSecurityManager.java
index ec2c5fe..04f4aeb 100644
--- a/src/org/jsecurity/mgt/RealmSecurityManager.java
+++ b/src/org/jsecurity/mgt/RealmSecurityManager.java
@@ -39,6 +39,8 @@
*/
public abstract class RealmSecurityManager extends CachingSecurityManager {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(RealmSecurityManager.class);
protected Collection<Realm> realms;
diff --git a/src/org/jsecurity/mgt/SecurityManagerFactory.java b/src/org/jsecurity/mgt/SecurityManagerFactory.java
index 18445b3..a74f663 100644
--- a/src/org/jsecurity/mgt/SecurityManagerFactory.java
+++ b/src/org/jsecurity/mgt/SecurityManagerFactory.java
@@ -25,5 +25,7 @@
*/
public interface SecurityManagerFactory {
+ //TODO - complete JavaDoc
+
SecurityManager getSecurityManager();
}
diff --git a/src/org/jsecurity/mgt/SessionsSecurityManager.java b/src/org/jsecurity/mgt/SessionsSecurityManager.java
index 67e5bf9..c3c77e2 100644
--- a/src/org/jsecurity/mgt/SessionsSecurityManager.java
+++ b/src/org/jsecurity/mgt/SessionsSecurityManager.java
@@ -53,6 +53,8 @@
*/
public abstract class SessionsSecurityManager extends AuthorizingSecurityManager implements SessionListenerRegistrar {
+ //TODO - complete JavaDoc
+
protected SessionManager sessionManager;
/**
diff --git a/src/org/jsecurity/realm/AuthenticatingRealm.java b/src/org/jsecurity/realm/AuthenticatingRealm.java
index e5ec194..708b5da 100644
--- a/src/org/jsecurity/realm/AuthenticatingRealm.java
+++ b/src/org/jsecurity/realm/AuthenticatingRealm.java
@@ -50,6 +50,8 @@
*/
public abstract class AuthenticatingRealm extends CachingRealm implements LogoutAware {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(AuthenticatingRealm.class);
/**
diff --git a/src/org/jsecurity/realm/AuthorizingRealm.java b/src/org/jsecurity/realm/AuthorizingRealm.java
index 3b33038..6a841fd 100644
--- a/src/org/jsecurity/realm/AuthorizingRealm.java
+++ b/src/org/jsecurity/realm/AuthorizingRealm.java
@@ -55,6 +55,8 @@
*/
public abstract class AuthorizingRealm extends AuthenticatingRealm implements Initializable, PermissionResolverAware {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/src/org/jsecurity/realm/CachingRealm.java b/src/org/jsecurity/realm/CachingRealm.java
index 06c43f8..b75feae 100644
--- a/src/org/jsecurity/realm/CachingRealm.java
+++ b/src/org/jsecurity/realm/CachingRealm.java
@@ -31,6 +31,8 @@
*/
public abstract class CachingRealm implements Realm, CacheManagerAware {
+ //TODO - complete JavaDoc
+
private static int INSTANCE_COUNT = 0;
/*--------------------------------------------
diff --git a/src/org/jsecurity/realm/SimpleAccountRealm.java b/src/org/jsecurity/realm/SimpleAccountRealm.java
index d2a5a58..fdc262a 100644
--- a/src/org/jsecurity/realm/SimpleAccountRealm.java
+++ b/src/org/jsecurity/realm/SimpleAccountRealm.java
@@ -47,6 +47,8 @@
*/
public class SimpleAccountRealm extends AuthorizingRealm {
+ //TODO - complete JavaDoc
+
protected Map<String, SimpleRole> roles = null;
public SimpleAccountRealm() {
diff --git a/src/org/jsecurity/realm/activedirectory/ActiveDirectoryRealm.java b/src/org/jsecurity/realm/activedirectory/ActiveDirectoryRealm.java
index 3075aef..89d3c7d 100644
--- a/src/org/jsecurity/realm/activedirectory/ActiveDirectoryRealm.java
+++ b/src/org/jsecurity/realm/activedirectory/ActiveDirectoryRealm.java
@@ -53,6 +53,8 @@
*/
public class ActiveDirectoryRealm extends AbstractLdapRealm {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/src/org/jsecurity/realm/jdbc/JdbcRealm.java b/src/org/jsecurity/realm/jdbc/JdbcRealm.java
index 5cc5da5..4daaf55 100644
--- a/src/org/jsecurity/realm/jdbc/JdbcRealm.java
+++ b/src/org/jsecurity/realm/jdbc/JdbcRealm.java
@@ -60,6 +60,8 @@
*/
public class JdbcRealm extends AuthorizingRealm {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/src/org/jsecurity/realm/ldap/AbstractLdapRealm.java b/src/org/jsecurity/realm/ldap/AbstractLdapRealm.java
index e98610c..d615294 100644
--- a/src/org/jsecurity/realm/ldap/AbstractLdapRealm.java
+++ b/src/org/jsecurity/realm/ldap/AbstractLdapRealm.java
@@ -54,6 +54,8 @@
*/
public abstract class AbstractLdapRealm extends AuthorizingRealm {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/src/org/jsecurity/realm/ldap/DefaultLdapContextFactory.java b/src/org/jsecurity/realm/ldap/DefaultLdapContextFactory.java
index 9e9fe55..e871df3 100644
--- a/src/org/jsecurity/realm/ldap/DefaultLdapContextFactory.java
+++ b/src/org/jsecurity/realm/ldap/DefaultLdapContextFactory.java
@@ -43,6 +43,8 @@
*/
public class DefaultLdapContextFactory implements LdapContextFactory {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/src/org/jsecurity/realm/ldap/LdapUtils.java b/src/org/jsecurity/realm/ldap/LdapUtils.java
index d20a02a..76fd8f4 100644
--- a/src/org/jsecurity/realm/ldap/LdapUtils.java
+++ b/src/org/jsecurity/realm/ldap/LdapUtils.java
@@ -38,6 +38,7 @@
*/
public class LdapUtils {
+ /** Private internal log instance. */
private static final Log log = LogFactory.getLog(LdapUtils.class);
/**
diff --git a/src/org/jsecurity/realm/text/PropertiesRealm.java b/src/org/jsecurity/realm/text/PropertiesRealm.java
index d89b72a..64e231a 100644
--- a/src/org/jsecurity/realm/text/PropertiesRealm.java
+++ b/src/org/jsecurity/realm/text/PropertiesRealm.java
@@ -94,6 +94,8 @@
*/
public class PropertiesRealm extends TextConfigurationRealm implements Destroyable, Runnable {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/src/org/jsecurity/realm/text/TextConfigurationRealm.java b/src/org/jsecurity/realm/text/TextConfigurationRealm.java
index 4098001..5762897 100644
--- a/src/org/jsecurity/realm/text/TextConfigurationRealm.java
+++ b/src/org/jsecurity/realm/text/TextConfigurationRealm.java
@@ -45,6 +45,8 @@
*/
public class TextConfigurationRealm extends SimpleAccountRealm {
+ //TODO - complete JavaDoc
+
private String userDefinitions;
private String roleDefinitions;
diff --git a/src/org/jsecurity/session/SessionListener.java b/src/org/jsecurity/session/SessionListener.java
index c95887a..58821f7 100644
--- a/src/org/jsecurity/session/SessionListener.java
+++ b/src/org/jsecurity/session/SessionListener.java
@@ -19,6 +19,9 @@
package org.jsecurity.session;
/**
+ * Interface to be implemented by components that wish to be notified of events that occur during a
+ * {@link Session Session}'s lifecycle.
+ *
* @author Les Hazlewood
* @since 0.9
*/
diff --git a/src/org/jsecurity/session/SessionListenerRegistrar.java b/src/org/jsecurity/session/SessionListenerRegistrar.java
index a74dbdf..40ed22f 100644
--- a/src/org/jsecurity/session/SessionListenerRegistrar.java
+++ b/src/org/jsecurity/session/SessionListenerRegistrar.java
@@ -21,14 +21,38 @@
import java.util.Collection;
/**
+ * A <code>SessionListenerRegistrar</code> is a component that is capable of registering interested
+ * {@link SessionListener AuthenticationListener}s that wish to be notified during
+ * {@link Session Session} lifecycle events.
+ * <p/>
+ * This interface only guarantees that registered listeners will be notified during a <code>Session</code>'s
+ * lifecycle. How that notification occurs is implementation specific (e.g. iteration over a collection of
+ * listeners, JMS, etc.).
+ *
* @author Les Hazlewood
* @since 0.9
*/
public interface SessionListenerRegistrar {
+ /**
+ * Sets the <code>SessionListener</code>(s) that wish to be notified during <code>Session</code> lifecycles.
+ *
+ * @param listeners one or more <code>SessionListener</code>s that should be notified during
+ * <code>Session</code> lifecycles.
+ */
void setSessionListeners(Collection<SessionListener> listeners);
+ /**
+ * Registeres a single <code>listener</code> that wishes to be notified during <code>Session</code> lifecycles.
+ * @param listener the single <code>listener</code> that wishes to be notified during <code>Session</code> lifecycles.
+ */
void add(SessionListener listener);
+ /**
+ * Removes a single <code>listener</code> that no longer wishes to be notified during <code>Session</code> lifecycles.
+ * @param listener the single <code>listener</code> that no longer wishes to be notified during <code>Session</code> lifecycles.
+ * @return <code>true</code> if the listener was removed (i.e. it was previously registered), or <code>false</code>
+ * if the listener was not removed (i.e. it wasn't registered yet, effectively a no-op).
+ */
boolean remove(SessionListener listener);
}
diff --git a/src/org/jsecurity/session/mgt/AbstractSessionManager.java b/src/org/jsecurity/session/mgt/AbstractSessionManager.java
index 47d78e6..e58dac8 100644
--- a/src/org/jsecurity/session/mgt/AbstractSessionManager.java
+++ b/src/org/jsecurity/session/mgt/AbstractSessionManager.java
@@ -30,6 +30,7 @@
import java.util.Date;
/**
+ * TODO - complete JavaDoc
* @author Les Hazlewood
* @since 0.1
*/
diff --git a/src/org/jsecurity/session/mgt/AbstractValidatingSessionManager.java b/src/org/jsecurity/session/mgt/AbstractValidatingSessionManager.java
index 646b739..18b2176 100644
--- a/src/org/jsecurity/session/mgt/AbstractValidatingSessionManager.java
+++ b/src/org/jsecurity/session/mgt/AbstractValidatingSessionManager.java
@@ -41,6 +41,8 @@
public abstract class AbstractValidatingSessionManager extends AbstractSessionManager
implements ValidatingSessionManager, Destroyable {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(AbstractValidatingSessionManager.class);
protected static final long MILLIS_PER_SECOND = 1000;
diff --git a/src/org/jsecurity/session/mgt/DefaultSessionManager.java b/src/org/jsecurity/session/mgt/DefaultSessionManager.java
index 9a8b9ed..42ac514 100644
--- a/src/org/jsecurity/session/mgt/DefaultSessionManager.java
+++ b/src/org/jsecurity/session/mgt/DefaultSessionManager.java
@@ -41,6 +41,8 @@
*/
public class DefaultSessionManager extends AbstractValidatingSessionManager implements CacheManagerAware {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(DefaultSessionManager.class);
protected SessionDAO sessionDAO = new MemorySessionDAO();
diff --git a/src/org/jsecurity/session/mgt/DelegatingSession.java b/src/org/jsecurity/session/mgt/DelegatingSession.java
index 0758109..feb491e 100644
--- a/src/org/jsecurity/session/mgt/DelegatingSession.java
+++ b/src/org/jsecurity/session/mgt/DelegatingSession.java
@@ -45,6 +45,8 @@
*/
public class DelegatingSession implements Session {
+ //TODO - complete JavaDoc
+
private Serializable id = null;
//cached fields to avoid a server-side method call if out-of-process:
diff --git a/src/org/jsecurity/session/mgt/ExecutorServiceSessionValidationScheduler.java b/src/org/jsecurity/session/mgt/ExecutorServiceSessionValidationScheduler.java
index dd357b7..7b65890 100644
--- a/src/org/jsecurity/session/mgt/ExecutorServiceSessionValidationScheduler.java
+++ b/src/org/jsecurity/session/mgt/ExecutorServiceSessionValidationScheduler.java
@@ -35,6 +35,9 @@
*/
public class ExecutorServiceSessionValidationScheduler implements SessionValidationScheduler, Runnable {
+ //TODO - complete JavaDoc
+
+ /** Private internal log instance. */
private static final Log log = LogFactory.getLog(ExecutorServiceSessionValidationScheduler.class);
ValidatingSessionManager sessionManager;
diff --git a/src/org/jsecurity/session/mgt/SimpleSession.java b/src/org/jsecurity/session/mgt/SimpleSession.java
index 86f590d..dcfa11d 100644
--- a/src/org/jsecurity/session/mgt/SimpleSession.java
+++ b/src/org/jsecurity/session/mgt/SimpleSession.java
@@ -38,6 +38,8 @@
*/
public class SimpleSession implements ValidatingSession, Serializable {
+ //TODO - complete JavaDoc
+
protected static final long MILLIS_PER_SECOND = 1000;
protected static final long MILLIS_PER_MINUTE = 60 * MILLIS_PER_SECOND;
protected static final long MILLIS_PER_HOUR = 60 * MILLIS_PER_MINUTE;
diff --git a/src/org/jsecurity/session/mgt/ValidatingSession.java b/src/org/jsecurity/session/mgt/ValidatingSession.java
index c947501..bd17246 100644
--- a/src/org/jsecurity/session/mgt/ValidatingSession.java
+++ b/src/org/jsecurity/session/mgt/ValidatingSession.java
@@ -22,6 +22,12 @@
import org.jsecurity.session.Session;
/**
+ * A <code>ValidatingSession</code> is a <code>Session</code> that is capable of determining it is valid or not and
+ * is able to validate itself if necessary.
+ * <p/>
+ * Validation is usually an exercise of determining when the session was last accessed or modified and determining if
+ * that time is longer than a specified allowed duration.
+ *
* @author Les Hazlewood
* @since 0.9
*/
diff --git a/src/org/jsecurity/session/mgt/eis/CachingSessionDAO.java b/src/org/jsecurity/session/mgt/eis/CachingSessionDAO.java
index a1c2693..cdeb3c6 100644
--- a/src/org/jsecurity/session/mgt/eis/CachingSessionDAO.java
+++ b/src/org/jsecurity/session/mgt/eis/CachingSessionDAO.java
@@ -43,6 +43,8 @@
*/
public abstract class CachingSessionDAO implements SessionDAO, CacheManagerAware {
+ //TODO - complete JavaDoc
+
public static final String ACTIVE_SESSION_CACHE_NAME = "jsecurity-activeSessionCache";
private CacheManager cacheManager;
diff --git a/src/org/jsecurity/session/mgt/eis/MemorySessionDAO.java b/src/org/jsecurity/session/mgt/eis/MemorySessionDAO.java
index cd10739..4867fba 100644
--- a/src/org/jsecurity/session/mgt/eis/MemorySessionDAO.java
+++ b/src/org/jsecurity/session/mgt/eis/MemorySessionDAO.java
@@ -54,6 +54,8 @@
*/
public class MemorySessionDAO extends CachingSessionDAO {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(MemorySessionDAO.class);
private static final String RANDOM_NUM_GENERATOR_ALGORITHM_NAME = "SHA1PRNG";
diff --git a/src/org/jsecurity/subject/AbstractRememberMeManager.java b/src/org/jsecurity/subject/AbstractRememberMeManager.java
index 16325ac..d417266 100644
--- a/src/org/jsecurity/subject/AbstractRememberMeManager.java
+++ b/src/org/jsecurity/subject/AbstractRememberMeManager.java
@@ -36,8 +36,8 @@
* Abstract implementation of the <code>RememberMeManager</code> interface that handles
* {@link #setSerializer(org.jsecurity.io.Serializer) serialization} and
* {@link #setCipher(org.jsecurity.crypto.Cipher) encryption} of the remembered user identity.
- *
- * <p>The remembered identity storage location is implementation-specific.
+ * <p/>
+ * The remembered identity storage location is implementation-specific.
*
* @author Les Hazlewood
* @author Jeremy Haile
@@ -45,6 +45,9 @@
*/
public abstract class AbstractRememberMeManager implements RememberMeManager {
+ //TODO - complete JavaDoc
+
+ /** private inner log instance. */
private static final Log log = LogFactory.getLog(AbstractRememberMeManager.class);
private Serializer serializer = new DefaultSerializer();
diff --git a/src/org/jsecurity/subject/DelegatingSubject.java b/src/org/jsecurity/subject/DelegatingSubject.java
index 7503487..3288c0c 100644
--- a/src/org/jsecurity/subject/DelegatingSubject.java
+++ b/src/org/jsecurity/subject/DelegatingSubject.java
@@ -65,6 +65,8 @@
*/
public class DelegatingSubject implements Subject {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(DelegatingSubject.class);
protected PrincipalCollection principals = new SimplePrincipalCollection();
diff --git a/src/org/jsecurity/subject/InvalidSubjectException.java b/src/org/jsecurity/subject/InvalidSubjectException.java
index 69bc3ea..d2ea9b6 100644
--- a/src/org/jsecurity/subject/InvalidSubjectException.java
+++ b/src/org/jsecurity/subject/InvalidSubjectException.java
@@ -28,18 +28,37 @@
*/
public class InvalidSubjectException extends SubjectException {
+ /**
+ * Creates a new InvalidSubjectException.
+ */
public InvalidSubjectException() {
super();
}
+ /**
+ * Constructs a new InvalidSubjectException.
+ *
+ * @param message the reason for the exception
+ */
public InvalidSubjectException(String message) {
super(message);
}
+ /**
+ * Constructs a new InvalidSubjectException.
+ *
+ * @param cause the underlying Throwable that caused this exception to be thrown.
+ */
public InvalidSubjectException(Throwable cause) {
super(cause);
}
+ /**
+ * Constructs a new InvalidSubjectException.
+ *
+ * @param message the reason for the exception
+ * @param cause the underlying Throwable that caused this exception to be thrown.
+ */
public InvalidSubjectException(String message, Throwable cause) {
super(message, cause);
}
diff --git a/src/org/jsecurity/subject/RememberMeManager.java b/src/org/jsecurity/subject/RememberMeManager.java
index b496196..fbc2768 100644
--- a/src/org/jsecurity/subject/RememberMeManager.java
+++ b/src/org/jsecurity/subject/RememberMeManager.java
@@ -31,6 +31,8 @@
*/
public interface RememberMeManager {
+ //TODO - complete JavaDoc
+
PrincipalCollection getRememberedPrincipals();
void onSuccessfulLogin(AuthenticationToken token, AuthenticationInfo info);
diff --git a/src/org/jsecurity/subject/SimplePrincipalCollection.java b/src/org/jsecurity/subject/SimplePrincipalCollection.java
index c648308..47dada4 100644
--- a/src/org/jsecurity/subject/SimplePrincipalCollection.java
+++ b/src/org/jsecurity/subject/SimplePrincipalCollection.java
@@ -30,6 +30,8 @@
@SuppressWarnings({"unchecked"})
public class SimplePrincipalCollection implements MutablePrincipalCollection {
+ //TODO - complete JavaDoc
+
private Map<String, Set> realmPrincipals;
public SimplePrincipalCollection() {
diff --git a/src/org/jsecurity/subject/Subject.java b/src/org/jsecurity/subject/Subject.java
index 795ef27..834a804 100644
--- a/src/org/jsecurity/subject/Subject.java
+++ b/src/org/jsecurity/subject/Subject.java
@@ -74,6 +74,27 @@
Object getPrincipal();
+ /**
+ * Returns all of this Subject's principals (identifying attributes) in the form of a <code>PrincipalCollection</code>.
+ * <p/>
+ * The word "principals" is nothing more than a fancy security term for identifying attributes associated
+ * with a Subject, aka, application user. For example, user id, a surname (family/last name), given (first) name,
+ * social security number, nickname, username, etc, are all examples of a principal.
+ * <p/>
+ * This method returns all of the principals associated with the Subject, and it is expected that at least one of
+ * the principals contained within this collection represent an absolute unique identifier for the application.
+ * User IDs, such a <code>Long</code> database primary key or UUID, or maybe a globally unique username or email
+ * address are all good candidates for such a unique identifier. Non-unique things, such as surnames and
+ * given names, are often poor candidates.
+ * <p/>
+ * For convenience's sake, it is convention that the first principal in this collection be the application's
+ * "primary" principal. That is, <code>getPrincipals().iterator().next();</code> would return this
+ * primary uniquely-identifying principal.
+ * In fact, this logic is often the implementation of the {@link #getPrincipal() getPrincipal()} method.
+ *
+ * @return all of this Subject's principals (identifying attributes).
+ * @see #getPrincipal()
+ */
PrincipalCollection getPrincipals();
diff --git a/src/org/jsecurity/subject/SubjectException.java b/src/org/jsecurity/subject/SubjectException.java
index 10ffd53..8ab36cc 100644
--- a/src/org/jsecurity/subject/SubjectException.java
+++ b/src/org/jsecurity/subject/SubjectException.java
@@ -21,7 +21,7 @@
import org.jsecurity.JSecurityException;
/**
- * <p>Throw when there is an error accessing or interacting with a {@link Subject}.
+ * Throws when there is an error accessing or interacting with a {@link Subject}.
*
* @author Jeremy Haile
* @since 0.1
diff --git a/src/org/jsecurity/util/AntPathMatcher.java b/src/org/jsecurity/util/AntPathMatcher.java
index 723c6c6..b928b98 100644
--- a/src/org/jsecurity/util/AntPathMatcher.java
+++ b/src/org/jsecurity/util/AntPathMatcher.java
@@ -62,6 +62,8 @@
*/
public class AntPathMatcher implements PatternMatcher {
+ //TODO - complete JavaDoc
+
/**
* Default path separator: "/"
*/
diff --git a/src/org/jsecurity/util/ClassUtils.java b/src/org/jsecurity/util/ClassUtils.java
index 75372a7..b3be021 100644
--- a/src/org/jsecurity/util/ClassUtils.java
+++ b/src/org/jsecurity/util/ClassUtils.java
@@ -25,11 +25,17 @@
import java.lang.reflect.Constructor;
/**
+ * Utility method library used to conveniently interact with <code>Class</code>es, such as acquiring them from the
+ * application <code>ClassLoader</code>s and instantiating Objects from them.
+ *
* @author Les Hazlewood
* @since 0.1
*/
public class ClassUtils {
+ //TODO - complete JavaDoc
+
+ /** Private internal log instance. */
private static final Log log = LogFactory.getLog(ClassUtils.class);
/**
diff --git a/src/org/jsecurity/util/CollectionUtils.java b/src/org/jsecurity/util/CollectionUtils.java
index 19f288f..939a1b8 100644
--- a/src/org/jsecurity/util/CollectionUtils.java
+++ b/src/org/jsecurity/util/CollectionUtils.java
@@ -29,6 +29,8 @@
*/
public class CollectionUtils {
+ //TODO - complete JavaDoc
+
/**
* Simple method that just returns <code>Collections.EMPTY_SET</code>.
* This exists to enable type-safe empty collections so other locations in JSecurity code
diff --git a/src/org/jsecurity/util/InstantiationException.java b/src/org/jsecurity/util/InstantiationException.java
index 04b9d3b..a25226f 100644
--- a/src/org/jsecurity/util/InstantiationException.java
+++ b/src/org/jsecurity/util/InstantiationException.java
@@ -28,18 +28,37 @@
*/
public class InstantiationException extends JSecurityException {
+ /**
+ * Creates a new InstantiationException.
+ */
public InstantiationException() {
super();
}
+ /**
+ * Constructs a new InstantiationException.
+ *
+ * @param message the reason for the exception
+ */
public InstantiationException(String message) {
super(message);
}
+ /**
+ * Constructs a new InstantiationException.
+ *
+ * @param cause the underlying Throwable that caused this exception to be thrown.
+ */
public InstantiationException(Throwable cause) {
super(cause);
}
+ /**
+ * Constructs a new InstantiationException.
+ *
+ * @param message the reason for the exception
+ * @param cause the underlying Throwable that caused this exception to be thrown.
+ */
public InstantiationException(String message, Throwable cause) {
super(message, cause);
}
diff --git a/src/org/jsecurity/util/JavaEnvironment.java b/src/org/jsecurity/util/JavaEnvironment.java
index 5361c3d..c3eb5a3 100644
--- a/src/org/jsecurity/util/JavaEnvironment.java
+++ b/src/org/jsecurity/util/JavaEnvironment.java
@@ -63,11 +63,20 @@
*/
public static final int JAVA_17 = 4;
-
+ /** The virtual machine version, i.e. <code>System.getProperty("java.version");</code>. */
private static final String version;
+ /**
+ * The virtual machine <em>major</em> version. For example, with a <code>version</code> of
+ * <code>1.5.6_10</code>, this would be <code>1.5</code>
+ */
private static final int majorVersion;
+ /**
+ * Static code initialization block that sets the
+ * <code>version</code> and <code>majorVersion</code> Class constants
+ * upon initialization.
+ */
static {
version = System.getProperty("java.version");
// version String should look like "1.4.2_10"
diff --git a/src/org/jsecurity/util/JdbcUtils.java b/src/org/jsecurity/util/JdbcUtils.java
index 34df3a4..0f34a23 100644
--- a/src/org/jsecurity/util/JdbcUtils.java
+++ b/src/org/jsecurity/util/JdbcUtils.java
@@ -27,20 +27,18 @@
import java.sql.Statement;
/**
- * <p>
* A set of static helper methods for managing JDBC API objects.
- * </p>
- *
- * <p>
- * Some parts of this class were copied from the Spring Framework and then modified.
- * They were copied here to prevent Spring dependencies in the JSecurity core API.
- * </p>
+ * <p/>
+ * <em>Note:</em> Some parts of this class were copied from the Spring Framework and then modified.
+ * They were copied here to prevent Spring dependencies in the JSecurity core API. The original license conditions
+ * (Apache 2.0) have been maintained.
*
* @author Jeremy Haile
* @since 0.2
*/
public class JdbcUtils {
+ /** Private internal log instance. */
private static final Log log = LogFactory.getLog(JdbcUtils.class);
/**
diff --git a/src/org/jsecurity/util/LifecycleUtils.java b/src/org/jsecurity/util/LifecycleUtils.java
index 91888f6..d603514 100644
--- a/src/org/jsecurity/util/LifecycleUtils.java
+++ b/src/org/jsecurity/util/LifecycleUtils.java
@@ -25,6 +25,7 @@
import java.util.Collection;
/**
+ * TODO - complete JavaDoc
* @author Les Hazlewood
* @since 0.2
*/
diff --git a/src/org/jsecurity/util/Nameable.java b/src/org/jsecurity/util/Nameable.java
index 5772b95..0cd324e 100644
--- a/src/org/jsecurity/util/Nameable.java
+++ b/src/org/jsecurity/util/Nameable.java
@@ -19,10 +19,17 @@
package org.jsecurity.util;
/**
+ * Interface implemented by components that can be named, such as via configuration, and wish to have that name
+ * set once it has been configured.
+ *
* @author Les Hazlewood
- * @since Jun 23, 2008 11:29:55 PM
+ * @since 0.9
*/
public interface Nameable {
+ /**
+ * Sets the (preferably application unique) name for this component.
+ * @param name the preferably application unique name for this component.
+ */
void setName(String name);
}
diff --git a/src/org/jsecurity/util/PermissionUtils.java b/src/org/jsecurity/util/PermissionUtils.java
index 49c1d47..340b70b 100644
--- a/src/org/jsecurity/util/PermissionUtils.java
+++ b/src/org/jsecurity/util/PermissionUtils.java
@@ -27,6 +27,7 @@
import java.util.Set;
/**
+ * TODO - comlete JavaDoc
* @author Les Hazlewood
* @author Jeremy Haile
* @since 0.1
diff --git a/src/org/jsecurity/util/StringUtils.java b/src/org/jsecurity/util/StringUtils.java
index c2a457a..59abc1b 100644
--- a/src/org/jsecurity/util/StringUtils.java
+++ b/src/org/jsecurity/util/StringUtils.java
@@ -39,6 +39,8 @@
*/
public class StringUtils {
+ //TODO - complete JavaDoc
+
/** Constant representing the empty string, equal to "" */
public static final String EMPTY_STRING = "";
diff --git a/src/org/jsecurity/util/ThreadContext.java b/src/org/jsecurity/util/ThreadContext.java
index 86fcd3f..12b8aa6 100644
--- a/src/org/jsecurity/util/ThreadContext.java
+++ b/src/org/jsecurity/util/ThreadContext.java
@@ -46,6 +46,7 @@
@SuppressWarnings(value = {"unchecked", "unsafe"})
public abstract class ThreadContext {
+ /** Private internal log instance. */
private static final Log log = LogFactory.getLog(ThreadContext.class);
public static final String SECURITY_MANAGER_KEY = ThreadContext.class.getName() + "_SECURITY_MANAGER_KEY";
@@ -74,6 +75,9 @@
}
};
+ /**
+ * Default no-argument constructor.
+ */
protected ThreadContext() {
}
diff --git a/src/org/jsecurity/util/UnavailableConstructorException.java b/src/org/jsecurity/util/UnavailableConstructorException.java
index 0d9d49d..d099af8 100644
--- a/src/org/jsecurity/util/UnavailableConstructorException.java
+++ b/src/org/jsecurity/util/UnavailableConstructorException.java
@@ -29,18 +29,37 @@
*/
public class UnavailableConstructorException extends JSecurityException {
+ /**
+ * Creates a new UnavailableConstructorException.
+ */
public UnavailableConstructorException() {
super();
}
+ /**
+ * Constructs a new UnavailableConstructorException.
+ *
+ * @param message the reason for the exception
+ */
public UnavailableConstructorException(String message) {
super(message);
}
+ /**
+ * Constructs a new UnavailableConstructorException.
+ *
+ * @param cause the underlying Throwable that caused this exception to be thrown.
+ */
public UnavailableConstructorException(Throwable cause) {
super(cause);
}
+ /**
+ * Constructs a new UnavailableConstructorException.
+ *
+ * @param message the reason for the exception
+ * @param cause the underlying Throwable that caused this exception to be thrown.
+ */
public UnavailableConstructorException(String message, Throwable cause) {
super(message, cause);
}
diff --git a/src/org/jsecurity/util/UnknownClassException.java b/src/org/jsecurity/util/UnknownClassException.java
index 7ba18fc..51ad14e 100644
--- a/src/org/jsecurity/util/UnknownClassException.java
+++ b/src/org/jsecurity/util/UnknownClassException.java
@@ -29,18 +29,37 @@
*/
public class UnknownClassException extends JSecurityException {
+ /**
+ * Creates a new UnknownClassException.
+ */
public UnknownClassException() {
super();
}
+ /**
+ * Constructs a new UnknownClassException.
+ *
+ * @param message the reason for the exception
+ */
public UnknownClassException(String message) {
super(message);
}
+ /**
+ * Constructs a new UnknownClassException.
+ *
+ * @param cause the underlying Throwable that caused this exception to be thrown.
+ */
public UnknownClassException(Throwable cause) {
super(cause);
}
+ /**
+ * Constructs a new UnknownClassException.
+ *
+ * @param message the reason for the exception
+ * @param cause the underlying Throwable that caused this exception to be thrown.
+ */
public UnknownClassException(String message, Throwable cause) {
super(message, cause);
}
diff --git a/src/org/jsecurity/web/DefaultWebSecurityManager.java b/src/org/jsecurity/web/DefaultWebSecurityManager.java
index 443f19d..1831619 100644
--- a/src/org/jsecurity/web/DefaultWebSecurityManager.java
+++ b/src/org/jsecurity/web/DefaultWebSecurityManager.java
@@ -45,6 +45,8 @@
*/
public class DefaultWebSecurityManager extends DefaultSecurityManager {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(DefaultWebSecurityManager.class);
public static final String HTTP_SESSION_MODE = "http";
diff --git a/src/org/jsecurity/web/RedirectView.java b/src/org/jsecurity/web/RedirectView.java
index 95a3b33..b554c52 100644
--- a/src/org/jsecurity/web/RedirectView.java
+++ b/src/org/jsecurity/web/RedirectView.java
@@ -70,6 +70,8 @@
@SuppressWarnings({"deprecation"})
public class RedirectView {
+ //TODO - complete JavaDoc
+
/**
* The default encoding scheme: UTF-8
*/
diff --git a/src/org/jsecurity/web/SavedRequest.java b/src/org/jsecurity/web/SavedRequest.java
index 0a573d8..b45d796 100644
--- a/src/org/jsecurity/web/SavedRequest.java
+++ b/src/org/jsecurity/web/SavedRequest.java
@@ -29,6 +29,8 @@
*/
public class SavedRequest {
+ //TODO - complete JavaDoc
+
private String method;
private String queryString;
private String requestURI;
diff --git a/src/org/jsecurity/web/WebRememberMeManager.java b/src/org/jsecurity/web/WebRememberMeManager.java
index 79bf92a..3c16a86 100644
--- a/src/org/jsecurity/web/WebRememberMeManager.java
+++ b/src/org/jsecurity/web/WebRememberMeManager.java
@@ -55,6 +55,8 @@
*/
public class WebRememberMeManager extends AbstractRememberMeManager {
+ //TODO - complete JavaDoc
+
/**
* The default name of the underlying rememberMe cookie which is <code>rememberMe</code>.
*/
diff --git a/src/org/jsecurity/web/WebUtils.java b/src/org/jsecurity/web/WebUtils.java
index b374d16..141dd7f 100644
--- a/src/org/jsecurity/web/WebUtils.java
+++ b/src/org/jsecurity/web/WebUtils.java
@@ -51,6 +51,8 @@
*/
public class WebUtils {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(WebUtils.class);
diff --git a/src/org/jsecurity/web/attr/AbstractWebAttribute.java b/src/org/jsecurity/web/attr/AbstractWebAttribute.java
index 82fedfc..2d147e0 100644
--- a/src/org/jsecurity/web/attr/AbstractWebAttribute.java
+++ b/src/org/jsecurity/web/attr/AbstractWebAttribute.java
@@ -41,6 +41,8 @@
*/
public abstract class AbstractWebAttribute<T> implements WebAttribute<T> {
+ //TODO - complete JavaDoc
+
public static final String DEFAULT_NAME = "name";
private static final Log log = LogFactory.getLog(AbstractWebAttribute.class);
diff --git a/src/org/jsecurity/web/attr/CookieAttribute.java b/src/org/jsecurity/web/attr/CookieAttribute.java
index e854198..13c0ed3 100644
--- a/src/org/jsecurity/web/attr/CookieAttribute.java
+++ b/src/org/jsecurity/web/attr/CookieAttribute.java
@@ -38,6 +38,9 @@
*/
public class CookieAttribute<T> extends AbstractWebAttribute<T> {
+ //TODO - complete JavaDoc
+
+ /** Private internal log instance. */
private static final Log log = LogFactory.getLog(CookieAttribute.class);
/**
diff --git a/src/org/jsecurity/web/attr/RequestParamAttribute.java b/src/org/jsecurity/web/attr/RequestParamAttribute.java
index eab5034..96c6cda 100644
--- a/src/org/jsecurity/web/attr/RequestParamAttribute.java
+++ b/src/org/jsecurity/web/attr/RequestParamAttribute.java
@@ -30,6 +30,8 @@
*/
public class RequestParamAttribute<T> extends AbstractWebAttribute<T> {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(RequestParamAttribute.class);
public RequestParamAttribute() {
diff --git a/src/org/jsecurity/web/attr/WebAttribute.java b/src/org/jsecurity/web/attr/WebAttribute.java
index 453cb37..47ef5b1 100644
--- a/src/org/jsecurity/web/attr/WebAttribute.java
+++ b/src/org/jsecurity/web/attr/WebAttribute.java
@@ -32,6 +32,8 @@
*/
public interface WebAttribute<T> {
+ //TODO - complete JavaDoc
+
T retrieveValue(ServletRequest request, ServletResponse response);
void storeValue(T value, ServletRequest request, ServletResponse response);
diff --git a/src/org/jsecurity/web/config/IniWebConfiguration.java b/src/org/jsecurity/web/config/IniWebConfiguration.java
index c93af59..62040b6 100644
--- a/src/org/jsecurity/web/config/IniWebConfiguration.java
+++ b/src/org/jsecurity/web/config/IniWebConfiguration.java
@@ -51,6 +51,8 @@
*/
public class IniWebConfiguration extends IniConfiguration implements WebConfiguration {
+ //TODO - complete JavaDoc
+
private static final transient Log log = LogFactory.getLog(IniWebConfiguration.class);
public static final String FILTERS = "filters";
diff --git a/src/org/jsecurity/web/filter/PathConfigProcessor.java b/src/org/jsecurity/web/filter/PathConfigProcessor.java
index 55a1eee..1eb6cf0 100644
--- a/src/org/jsecurity/web/filter/PathConfigProcessor.java
+++ b/src/org/jsecurity/web/filter/PathConfigProcessor.java
@@ -26,5 +26,7 @@
*/
public interface PathConfigProcessor {
+ //TODO - complete JavaDoc
+
void processPathConfig(String path, String config);
}
diff --git a/src/org/jsecurity/web/filter/authc/AuthenticatingFilter.java b/src/org/jsecurity/web/filter/authc/AuthenticatingFilter.java
index 9c5f9cd..c247c2c 100644
--- a/src/org/jsecurity/web/filter/authc/AuthenticatingFilter.java
+++ b/src/org/jsecurity/web/filter/authc/AuthenticatingFilter.java
@@ -37,6 +37,8 @@
*/
public abstract class AuthenticatingFilter extends AuthenticationFilter {
+ //TODO - complete JavaDoc
+
protected boolean executeLogin(ServletRequest request, ServletResponse response) throws Exception {
AuthenticationToken token = createToken(request, response);
if (token == null) {
diff --git a/src/org/jsecurity/web/filter/authc/AuthenticationFilter.java b/src/org/jsecurity/web/filter/authc/AuthenticationFilter.java
index a053ac6..f61b08d 100644
--- a/src/org/jsecurity/web/filter/authc/AuthenticationFilter.java
+++ b/src/org/jsecurity/web/filter/authc/AuthenticationFilter.java
@@ -38,6 +38,8 @@
*/
public abstract class AuthenticationFilter extends AccessControlFilter {
+ //TODO - complete JavaDoc
+
public static final String DEFAULT_SUCCESS_URL = "/index.jsp";
private String successUrl = DEFAULT_SUCCESS_URL;
diff --git a/src/org/jsecurity/web/filter/authc/FormAuthenticationFilter.java b/src/org/jsecurity/web/filter/authc/FormAuthenticationFilter.java
index 8b4bc2b..33c5554 100644
--- a/src/org/jsecurity/web/filter/authc/FormAuthenticationFilter.java
+++ b/src/org/jsecurity/web/filter/authc/FormAuthenticationFilter.java
@@ -59,6 +59,8 @@
*/
public class FormAuthenticationFilter extends AuthenticatingFilter {
+ //TODO - complete JavaDoc
+
public static final String DEFAULT_ERROR_KEY_ATTRIBUTE_NAME = "jsecLoginFailure";
public static final String DEFAULT_USERNAME_PARAM = "username";
diff --git a/src/org/jsecurity/web/filter/authc/PassThruAuthenticationFilter.java b/src/org/jsecurity/web/filter/authc/PassThruAuthenticationFilter.java
index 106188e..f9ff960 100644
--- a/src/org/jsecurity/web/filter/authc/PassThruAuthenticationFilter.java
+++ b/src/org/jsecurity/web/filter/authc/PassThruAuthenticationFilter.java
@@ -45,6 +45,8 @@
*/
public class PassThruAuthenticationFilter extends AuthenticationFilter {
+ //TODO - complete JavaDoc
+
protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception {
if (isLoginRequest(request, response)) {
return true;
diff --git a/src/org/jsecurity/web/filter/authz/AuthorizationFilter.java b/src/org/jsecurity/web/filter/authz/AuthorizationFilter.java
index c8d25c0..8b8f20c 100644
--- a/src/org/jsecurity/web/filter/authz/AuthorizationFilter.java
+++ b/src/org/jsecurity/web/filter/authz/AuthorizationFilter.java
@@ -40,6 +40,8 @@
*/
public abstract class AuthorizationFilter extends AccessControlFilter {
+ //TODO - complete JavaDoc
+
private String unauthorizedUrl;
protected String getUnauthorizedUrl() {
diff --git a/src/org/jsecurity/web/filter/authz/PermissionsAuthorizationFilter.java b/src/org/jsecurity/web/filter/authz/PermissionsAuthorizationFilter.java
index 15a1bc1..cb79f7a 100644
--- a/src/org/jsecurity/web/filter/authz/PermissionsAuthorizationFilter.java
+++ b/src/org/jsecurity/web/filter/authz/PermissionsAuthorizationFilter.java
@@ -34,6 +34,8 @@
*/
public class PermissionsAuthorizationFilter extends AuthorizationFilter {
+ //TODO - complete JavaDoc
+
public boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws IOException {
Subject subject = getSubject(request, response);
diff --git a/src/org/jsecurity/web/filter/authz/RolesAuthorizationFilter.java b/src/org/jsecurity/web/filter/authz/RolesAuthorizationFilter.java
index 4388017..2a584c1 100644
--- a/src/org/jsecurity/web/filter/authz/RolesAuthorizationFilter.java
+++ b/src/org/jsecurity/web/filter/authz/RolesAuthorizationFilter.java
@@ -36,6 +36,8 @@
*/
public class RolesAuthorizationFilter extends AuthorizationFilter {
+ //TODO - complete JavaDoc
+
@SuppressWarnings({"unchecked"})
public boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws IOException {
diff --git a/src/org/jsecurity/web/servlet/FilterChainWrapper.java b/src/org/jsecurity/web/servlet/FilterChainWrapper.java
index 7f20fc7..d64f602 100644
--- a/src/org/jsecurity/web/servlet/FilterChainWrapper.java
+++ b/src/org/jsecurity/web/servlet/FilterChainWrapper.java
@@ -31,6 +31,8 @@
*/
public class FilterChainWrapper implements FilterChain {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(FilterChainWrapper.class);
private FilterChain orig;
diff --git a/src/org/jsecurity/web/servlet/JSecurityFilter.java b/src/org/jsecurity/web/servlet/JSecurityFilter.java
index 409dbc8..b7dc596 100644
--- a/src/org/jsecurity/web/servlet/JSecurityFilter.java
+++ b/src/org/jsecurity/web/servlet/JSecurityFilter.java
@@ -177,6 +177,8 @@
*/
public class JSecurityFilter extends OncePerRequestFilter {
+ //TODO - complete JavaDoc
+
public static final String SECURITY_MANAGER_CONTEXT_KEY = SecurityManager.class.getName() + "_SERVLET_CONTEXT_KEY";
public static final String CONFIG_CLASS_NAME_INIT_PARAM_NAME = "configClassName";
diff --git a/src/org/jsecurity/web/servlet/JSecurityHttpServletRequest.java b/src/org/jsecurity/web/servlet/JSecurityHttpServletRequest.java
index a4263b1..0932999 100644
--- a/src/org/jsecurity/web/servlet/JSecurityHttpServletRequest.java
+++ b/src/org/jsecurity/web/servlet/JSecurityHttpServletRequest.java
@@ -37,6 +37,8 @@
@SuppressWarnings({"deprecated", "deprecation"})
public class JSecurityHttpServletRequest extends HttpServletRequestWrapper {
+ //TODO - complete JavaDoc
+
//The following 7 constants support the JSecurity's implementation of the Servlet Specification
public static final String COOKIE_SESSION_ID_SOURCE = "cookie";
public static final String URL_SESSION_ID_SOURCE = "url";
diff --git a/src/org/jsecurity/web/servlet/JSecurityHttpServletResponse.java b/src/org/jsecurity/web/servlet/JSecurityHttpServletResponse.java
index d6df630..0995e19 100644
--- a/src/org/jsecurity/web/servlet/JSecurityHttpServletResponse.java
+++ b/src/org/jsecurity/web/servlet/JSecurityHttpServletResponse.java
@@ -46,6 +46,8 @@
@SuppressWarnings({"deprecated", "deprecation"})
public class JSecurityHttpServletResponse extends HttpServletResponseWrapper {
+ //TODO - complete JavaDoc
+
private static final String DEFAULT_SESSION_ID_PARAMETER_NAME = JSecurityHttpSession.DEFAULT_SESSION_ID_NAME;
private ServletContext context = null;
diff --git a/src/org/jsecurity/web/servlet/JSecurityHttpSession.java b/src/org/jsecurity/web/servlet/JSecurityHttpSession.java
index b3592aa..61e3ba5 100644
--- a/src/org/jsecurity/web/servlet/JSecurityHttpSession.java
+++ b/src/org/jsecurity/web/servlet/JSecurityHttpSession.java
@@ -37,6 +37,8 @@
@SuppressWarnings({"deprecation"})
public class JSecurityHttpSession implements HttpSession {
+ //TODO - complete JavaDoc
+
public static final String DEFAULT_SESSION_ID_NAME = "JSESSIONID";
private static final Enumeration EMPTY_ENUMERATION = new Enumeration() {
diff --git a/src/org/jsecurity/web/servlet/ServletContextSupport.java b/src/org/jsecurity/web/servlet/ServletContextSupport.java
index 66274dc..d3b6d0b 100644
--- a/src/org/jsecurity/web/servlet/ServletContextSupport.java
+++ b/src/org/jsecurity/web/servlet/ServletContextSupport.java
@@ -18,8 +18,6 @@
*/
package org.jsecurity.web.servlet;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
import org.jsecurity.web.DefaultWebSecurityManager;
import javax.servlet.ServletContext;
@@ -32,12 +30,12 @@
*/
public class ServletContextSupport {
+ //TODO - complete JavaDoc
+
public static final String SESSION_MODE_CONTEXT_PARAM_NAME = "sessionMode";
public static final String HTTP_SESSION_MODE = DefaultWebSecurityManager.HTTP_SESSION_MODE;
public static final String JSECURITY_SESSION_MODE = DefaultWebSecurityManager.JSECURITY_SESSION_MODE;
- private static final Log log = LogFactory.getLog(ServletContextSupport.class);
-
private ServletContext servletContext = null;
public ServletContext getServletContext() {
diff --git a/src/org/jsecurity/web/session/DefaultWebSessionManager.java b/src/org/jsecurity/web/session/DefaultWebSessionManager.java
index 966b177..8cb9cf2 100644
--- a/src/org/jsecurity/web/session/DefaultWebSessionManager.java
+++ b/src/org/jsecurity/web/session/DefaultWebSessionManager.java
@@ -45,6 +45,8 @@
*/
public class DefaultWebSessionManager extends DefaultSessionManager implements WebSessionManager {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(DefaultWebSessionManager.class);
/**
diff --git a/src/org/jsecurity/web/session/ServletContainerSessionManager.java b/src/org/jsecurity/web/session/ServletContainerSessionManager.java
index 267ed71..7d18ac8 100644
--- a/src/org/jsecurity/web/session/ServletContainerSessionManager.java
+++ b/src/org/jsecurity/web/session/ServletContainerSessionManager.java
@@ -53,6 +53,8 @@
*/
public class ServletContainerSessionManager extends AbstractSessionManager implements WebSessionManager {
+ //TODO - complete JavaDoc
+
public ServletContainerSessionManager() {
}
diff --git a/src/org/jsecurity/web/session/WebSession.java b/src/org/jsecurity/web/session/WebSession.java
index de9da9b..4b4df61 100644
--- a/src/org/jsecurity/web/session/WebSession.java
+++ b/src/org/jsecurity/web/session/WebSession.java
@@ -38,6 +38,8 @@
*/
public class WebSession implements Session {
+ //TODO - complete JavaDoc
+
private static final String INET_ADDRESS_SESSION_KEY = WebSession.class.getName() + "_INET_ADDRESS_SESSION_KEY";
private static final String TOUCH_OBJECT_SESSION_KEY = WebSession.class.getName() + "_TOUCH_OBJECT_SESSION_KEY";
diff --git a/src/org/jsecurity/web/session/WebSessionManager.java b/src/org/jsecurity/web/session/WebSessionManager.java
index 5f53c41..47daa2c 100644
--- a/src/org/jsecurity/web/session/WebSessionManager.java
+++ b/src/org/jsecurity/web/session/WebSessionManager.java
@@ -32,6 +32,8 @@
*/
public interface WebSessionManager extends SessionManager {
+ //TODO - complete JavaDoc
+
Session getSession(ServletRequest request, ServletResponse response);
}
diff --git a/src/org/jsecurity/web/tags/AuthenticatedTag.java b/src/org/jsecurity/web/tags/AuthenticatedTag.java
index d889e60..9e146b7 100644
--- a/src/org/jsecurity/web/tags/AuthenticatedTag.java
+++ b/src/org/jsecurity/web/tags/AuthenticatedTag.java
@@ -41,6 +41,8 @@
*/
public class AuthenticatedTag extends SecureTag {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(AuthenticatedTag.class);
public int onDoStartTag() throws JspException {
diff --git a/src/org/jsecurity/web/tags/GuestTag.java b/src/org/jsecurity/web/tags/GuestTag.java
index bf79c7b..a272a1b 100644
--- a/src/org/jsecurity/web/tags/GuestTag.java
+++ b/src/org/jsecurity/web/tags/GuestTag.java
@@ -36,6 +36,8 @@
*/
public class GuestTag extends SecureTag {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(GuestTag.class);
public int onDoStartTag() throws JspException {
diff --git a/src/org/jsecurity/web/tags/HasAnyRolesTag.java b/src/org/jsecurity/web/tags/HasAnyRolesTag.java
index 6f39610..1b54ab2 100644
--- a/src/org/jsecurity/web/tags/HasAnyRolesTag.java
+++ b/src/org/jsecurity/web/tags/HasAnyRolesTag.java
@@ -28,6 +28,8 @@
*/
public class HasAnyRolesTag extends RoleTag {
+ //TODO - complete JavaDoc
+
// Delimeter that separates role names in tag attribute
private static final String ROLE_NAMES_DELIMETER = ",";
diff --git a/src/org/jsecurity/web/tags/HasPermissionTag.java b/src/org/jsecurity/web/tags/HasPermissionTag.java
index eb3af89..4929d33 100644
--- a/src/org/jsecurity/web/tags/HasPermissionTag.java
+++ b/src/org/jsecurity/web/tags/HasPermissionTag.java
@@ -25,6 +25,8 @@
*/
public class HasPermissionTag extends PermissionTag {
+ //TODO - complete JavaDoc
+
public HasPermissionTag() {
}
diff --git a/src/org/jsecurity/web/tags/HasRoleTag.java b/src/org/jsecurity/web/tags/HasRoleTag.java
index e01d7bf..84a33cb 100644
--- a/src/org/jsecurity/web/tags/HasRoleTag.java
+++ b/src/org/jsecurity/web/tags/HasRoleTag.java
@@ -24,6 +24,8 @@
*/
public class HasRoleTag extends RoleTag {
+ //TODO - complete JavaDoc
+
public HasRoleTag() {
}
diff --git a/src/org/jsecurity/web/tags/LacksPermissionTag.java b/src/org/jsecurity/web/tags/LacksPermissionTag.java
index ffa67d3..6456827 100644
--- a/src/org/jsecurity/web/tags/LacksPermissionTag.java
+++ b/src/org/jsecurity/web/tags/LacksPermissionTag.java
@@ -25,6 +25,8 @@
*/
public class LacksPermissionTag extends PermissionTag {
+ //TODO - complete JavaDoc
+
public LacksPermissionTag() {
}
diff --git a/src/org/jsecurity/web/tags/LacksRoleTag.java b/src/org/jsecurity/web/tags/LacksRoleTag.java
index 22b7870..b267777 100644
--- a/src/org/jsecurity/web/tags/LacksRoleTag.java
+++ b/src/org/jsecurity/web/tags/LacksRoleTag.java
@@ -24,6 +24,8 @@
*/
public class LacksRoleTag extends RoleTag {
+ //TODO - complete JavaDoc
+
public LacksRoleTag() {
}
diff --git a/src/org/jsecurity/web/tags/NotAuthenticatedTag.java b/src/org/jsecurity/web/tags/NotAuthenticatedTag.java
index f6f4fda..fa26519 100644
--- a/src/org/jsecurity/web/tags/NotAuthenticatedTag.java
+++ b/src/org/jsecurity/web/tags/NotAuthenticatedTag.java
@@ -35,6 +35,8 @@
*/
public class NotAuthenticatedTag extends SecureTag {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(NotAuthenticatedTag.class);
public int onDoStartTag() throws JspException {
diff --git a/src/org/jsecurity/web/tags/PermissionTag.java b/src/org/jsecurity/web/tags/PermissionTag.java
index dbf24ff..b7a8aee 100644
--- a/src/org/jsecurity/web/tags/PermissionTag.java
+++ b/src/org/jsecurity/web/tags/PermissionTag.java
@@ -28,6 +28,8 @@
*/
public abstract class PermissionTag extends SecureTag {
+ //TODO - complete JavaDoc
+
private String name = null;
public PermissionTag() {
diff --git a/src/org/jsecurity/web/tags/PrincipalTag.java b/src/org/jsecurity/web/tags/PrincipalTag.java
index ee32db3..416b97a 100644
--- a/src/org/jsecurity/web/tags/PrincipalTag.java
+++ b/src/org/jsecurity/web/tags/PrincipalTag.java
@@ -45,6 +45,8 @@
*/
public class PrincipalTag extends SecureTag {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/src/org/jsecurity/web/tags/RoleTag.java b/src/org/jsecurity/web/tags/RoleTag.java
index 60deed5..1b4bbda 100644
--- a/src/org/jsecurity/web/tags/RoleTag.java
+++ b/src/org/jsecurity/web/tags/RoleTag.java
@@ -27,6 +27,8 @@
*/
public abstract class RoleTag extends SecureTag {
+ //TODO - complete JavaDoc
+
private String name = null;
public RoleTag() {
diff --git a/src/org/jsecurity/web/tags/SecureTag.java b/src/org/jsecurity/web/tags/SecureTag.java
index 68b7157..2d8d8ba 100644
--- a/src/org/jsecurity/web/tags/SecureTag.java
+++ b/src/org/jsecurity/web/tags/SecureTag.java
@@ -32,6 +32,8 @@
*/
public abstract class SecureTag extends TagSupport {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(SecureTag.class);
public SecureTag() {
diff --git a/src/org/jsecurity/web/tags/UserTag.java b/src/org/jsecurity/web/tags/UserTag.java
index f2281e8..428a46e 100644
--- a/src/org/jsecurity/web/tags/UserTag.java
+++ b/src/org/jsecurity/web/tags/UserTag.java
@@ -41,6 +41,8 @@
*/
public class UserTag extends SecureTag {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(UserTag.class);
public int onDoStartTag() throws JspException {
diff --git a/support/ehcache/src/org/jsecurity/cache/ehcache/EhCache.java b/support/ehcache/src/org/jsecurity/cache/ehcache/EhCache.java
index a40f379..60c9003 100644
--- a/support/ehcache/src/org/jsecurity/cache/ehcache/EhCache.java
+++ b/support/ehcache/src/org/jsecurity/cache/ehcache/EhCache.java
@@ -39,6 +39,7 @@
@SuppressWarnings("unchecked")
public class EhCache implements Cache {
+ /** Private internal log instance. */
private static final Log log = LogFactory.getLog(EhCache.class);
/**
diff --git a/support/ehcache/src/org/jsecurity/cache/ehcache/EhCacheManager.java b/support/ehcache/src/org/jsecurity/cache/ehcache/EhCacheManager.java
index c2a7429..9efc0e1 100644
--- a/support/ehcache/src/org/jsecurity/cache/ehcache/EhCacheManager.java
+++ b/support/ehcache/src/org/jsecurity/cache/ehcache/EhCacheManager.java
@@ -46,6 +46,8 @@
*/
public class EhCacheManager implements CacheManager, Initializable, Destroyable {
+ //TODO - complete JavaDoc
+
public static final String DEFAULT_ACTIVE_SESSIONS_CACHE_NAME = CachingSessionDAO.ACTIVE_SESSION_CACHE_NAME;
public static final int DEFAULT_ACTIVE_SESSIONS_CACHE_MAX_ELEM_IN_MEM = 20000;
public static final int DEFAULT_ACTIVE_SESSIONS_DISK_EXPIRY_THREAD_INTERVAL_SECONDS = 600;
diff --git a/support/quartz/src/org/jsecurity/session/mgt/quartz/QuartzSessionValidationScheduler.java b/support/quartz/src/org/jsecurity/session/mgt/quartz/QuartzSessionValidationScheduler.java
index 5f39b3a..1d5434c 100644
--- a/support/quartz/src/org/jsecurity/session/mgt/quartz/QuartzSessionValidationScheduler.java
+++ b/support/quartz/src/org/jsecurity/session/mgt/quartz/QuartzSessionValidationScheduler.java
@@ -40,6 +40,8 @@
*/
public class QuartzSessionValidationScheduler implements SessionValidationScheduler {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/support/spring/src/org/jsecurity/spring/LifecycleBeanPostProcessor.java b/support/spring/src/org/jsecurity/spring/LifecycleBeanPostProcessor.java
index 633a75a..5b628ef 100644
--- a/support/spring/src/org/jsecurity/spring/LifecycleBeanPostProcessor.java
+++ b/support/spring/src/org/jsecurity/spring/LifecycleBeanPostProcessor.java
@@ -42,6 +42,8 @@
*/
public class LifecycleBeanPostProcessor implements DestructionAwareBeanPostProcessor {
+ //TODO - complete JavaDoc
+
private static final Log log = LogFactory.getLog(LifecycleBeanPostProcessor.class);
/**
diff --git a/support/spring/src/org/jsecurity/spring/SpringIniWebConfiguration.java b/support/spring/src/org/jsecurity/spring/SpringIniWebConfiguration.java
index 1bb0233..ef982c4 100644
--- a/support/spring/src/org/jsecurity/spring/SpringIniWebConfiguration.java
+++ b/support/spring/src/org/jsecurity/spring/SpringIniWebConfiguration.java
@@ -65,6 +65,8 @@
*/
public class SpringIniWebConfiguration extends IniWebConfiguration {
+ //TODO - complete JavaDoc
+
public static final String SECURITY_MANAGER_BEAN_NAME_PARAM_NAME = "securityManagerBeanName";
public static final String DEFAULT_SECURITY_MANAGER_BEAN_ID = "securityManager";
diff --git a/support/spring/src/org/jsecurity/spring/SpringJSecurityFilter.java b/support/spring/src/org/jsecurity/spring/SpringJSecurityFilter.java
index d222dbb..8cd2221 100644
--- a/support/spring/src/org/jsecurity/spring/SpringJSecurityFilter.java
+++ b/support/spring/src/org/jsecurity/spring/SpringJSecurityFilter.java
@@ -29,6 +29,8 @@
*/
public class SpringJSecurityFilter extends JSecurityFilter {
+ //TODO - complete JavaDoc
+
public SpringJSecurityFilter() {
this.configClassName = SpringIniWebConfiguration.class.getName();
}
diff --git a/support/spring/src/org/jsecurity/spring/remoting/SecureRemoteInvocationExecutor.java b/support/spring/src/org/jsecurity/spring/remoting/SecureRemoteInvocationExecutor.java
index 01832f4..a0314d0 100644
--- a/support/spring/src/org/jsecurity/spring/remoting/SecureRemoteInvocationExecutor.java
+++ b/support/spring/src/org/jsecurity/spring/remoting/SecureRemoteInvocationExecutor.java
@@ -46,6 +46,8 @@
*/
public class SecureRemoteInvocationExecutor extends DefaultRemoteInvocationExecutor {
+ //TODO - complete JavaDoc
+
/*--------------------------------------------
| C O N S T A N T S |
============================================*/
diff --git a/support/spring/src/org/jsecurity/spring/remoting/SecureRemoteInvocationFactory.java b/support/spring/src/org/jsecurity/spring/remoting/SecureRemoteInvocationFactory.java
index c0a4834..25956fd 100644
--- a/support/spring/src/org/jsecurity/spring/remoting/SecureRemoteInvocationFactory.java
+++ b/support/spring/src/org/jsecurity/spring/remoting/SecureRemoteInvocationFactory.java
@@ -38,6 +38,8 @@
*/
public class SecureRemoteInvocationFactory extends DefaultRemoteInvocationFactory {
+ //TODO - complete JavaDoc
+
public static final String SESSION_ID_KEY = Session.class.getName() + "_ID_KEY";
private static final String SESSION_ID_SYSTEM_PROPERTY_NAME = "jsecurity.session.id";
diff --git a/support/spring/src/org/jsecurity/spring/security/interceptor/AopAllianceAnnotationsAuthorizingMethodInterceptor.java b/support/spring/src/org/jsecurity/spring/security/interceptor/AopAllianceAnnotationsAuthorizingMethodInterceptor.java
index 761f6b2..647b4fe 100644
--- a/support/spring/src/org/jsecurity/spring/security/interceptor/AopAllianceAnnotationsAuthorizingMethodInterceptor.java
+++ b/support/spring/src/org/jsecurity/spring/security/interceptor/AopAllianceAnnotationsAuthorizingMethodInterceptor.java
@@ -25,12 +25,15 @@
import java.lang.reflect.Method;
/**
+ * TODO - complete JavaDoc
* @author Les Hazlewood
* @since 0.2
*/
public class AopAllianceAnnotationsAuthorizingMethodInterceptor
extends AnnotationsAuthorizingMethodInterceptor implements MethodInterceptor {
+ //TODO - complete JavaDoc
+
protected org.jsecurity.aop.MethodInvocation createMethodInvocation(Object implSpecificMethodInvocation) {
final MethodInvocation mi = (MethodInvocation) implSpecificMethodInvocation;
diff --git a/support/spring/src/org/jsecurity/spring/security/interceptor/AuthorizationAttributeSourceAdvisor.java b/support/spring/src/org/jsecurity/spring/security/interceptor/AuthorizationAttributeSourceAdvisor.java
index 00c42cc..e5333bd 100644
--- a/support/spring/src/org/jsecurity/spring/security/interceptor/AuthorizationAttributeSourceAdvisor.java
+++ b/support/spring/src/org/jsecurity/spring/security/interceptor/AuthorizationAttributeSourceAdvisor.java
@@ -29,6 +29,7 @@
import java.lang.reflect.Method;
/**
+ * TODO - complete JavaDoc
* @author Les Hazlewood
* @since 0.1
*/
