Author: angela
Date: Tue Mar 10 10:53:44 2009
New Revision: 752059
URL: http://svn.apache.org/viewvc?rev=752059&view=rev
Log:
javadoc
Modified:
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalIterator.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalProvider.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/DefaultPrincipalProvider.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalManagerImpl.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalProviderRegistry.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/ProviderRegistryImpl.java
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalIterator.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalIterator.java?rev=752059&r1=752058&r2=752059&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalIterator.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalIterator.java
Tue Mar 10 10:53:44 2009
@@ -45,6 +45,10 @@
/**
* Subclasses must call {#link seekNext()} upon object construction and
* assign the value to the 'next' field.
+ *
+ * @return The principal to be return upon the subsequent {@link #next()}
+ * or {@link #nextPrincipal()} call or <code>null</code> if no next principal
+ * exists.
*/
abstract Principal seekNext();
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalProvider.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalProvider.java?rev=752059&r1=752058&r2=752059&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalProvider.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/AbstractPrincipalProvider.java
Tue Mar 10 10:53:44 2009
@@ -68,6 +68,8 @@
/**
* Add an entry to the principal cache.
+ *
+ * @param principal to be cached.
*/
protected synchronized void addToCache(Principal principal) {
cache.put(principal.getName(), principal);
@@ -78,7 +80,7 @@
* Implementations should return a {@link Principal} from their source,
* if it contains one for the given name or <code>null</code>.
*
- * @param principalName
+ * @param principalName Name of the principal to be returned.
* @return Principal or null, if non provided for the given name
* @see #getPrincipal(String)
*/
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/DefaultPrincipalProvider.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/DefaultPrincipalProvider.java?rev=752059&r1=752058&r2=752059&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/DefaultPrincipalProvider.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/DefaultPrincipalProvider.java
Tue Mar 10 10:53:44 2009
@@ -76,7 +76,8 @@
* Creates a new DefaultPrincipalProvider reading the principals from the
* storage below the given security root node.
*
- * @param securitySession for Repository Access
+ * @param securitySession for repository access.
+ * @param userManager Used to retrieve the principals.
* @throws RepositoryException if an error accessing the repository occurs.
*/
public DefaultPrincipalProvider(Session securitySession,
@@ -162,7 +163,13 @@
/**
* @see PrincipalProvider#getPrincipals(int)
- * @param searchType
+ * @param searchType Any of the following search types:
+ * <ul>
+ * <li>{@link PrincipalManager#SEARCH_TYPE_GROUP}</li>
+ * <li>{@link PrincipalManager#SEARCH_TYPE_NOT_GROUP}</li>
+ * <li>{@link PrincipalManager#SEARCH_TYPE_ALL}</li>
+ * </ul>
+ * @see PrincipalProvider#getPrincipals(int)
*/
public PrincipalIterator getPrincipals(int searchType) {
return findPrincipals(null, searchType);
@@ -264,7 +271,7 @@
* Recursively collect all Group-principals the specified principal is
* member of.
*
- * @param princ
+ * @param princ Principal for which the group membership will be collected.
* @return all Group principals the specified <code>princ</code> is member
of
* including inherited membership.
*/
@@ -291,7 +298,7 @@
}
/**
- * @param simpleFilter
+ * @param simpleFilter Principal name or fragment.
* @return An iterator over the main principals of the authorizables found
* by the user manager.
*/
@@ -308,7 +315,7 @@
}
/**
- * @param simpleFilter
+ * @param simpleFilter Principal name or fragment.
* @return An iterator over the main principals of the authorizables found
* by the user manager.
*/
@@ -346,6 +353,9 @@
next = seekNext();
}
+ /**
+ * @see org.apache.jackrabbit.core.security.principal.AbstractPrincipalIterator#seekNext()
+ */
protected Principal seekNext() {
while (authorizableItr.hasNext()) {
try {
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalManagerImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalManagerImpl.java?rev=752059&r1=752058&r2=752059&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalManagerImpl.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalManagerImpl.java
Tue Mar 10 10:53:44 2009
@@ -303,6 +303,9 @@
next = seekNext();
}
+ /**
+ * @see org.apache.jackrabbit.core.security.principal.AbstractPrincipalIterator#seekNext()
+ */
protected final Principal seekNext() {
while (!entries.isEmpty()) {
// first test if current-itr has more elements
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalProviderRegistry.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalProviderRegistry.java?rev=752059&r1=752058&r2=752059&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalProviderRegistry.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/PrincipalProviderRegistry.java
Tue Mar 10 10:53:44 2009
@@ -49,7 +49,7 @@
PrincipalProvider getDefault();
/**
- * @param className
+ * @param className Name of the principal provider class.
* @return PrincipalProvider or <code>null</code> if no provider with
* the given class name was registered.
*/
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/ProviderRegistryImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/ProviderRegistryImpl.java?rev=752059&r1=752058&r2=752059&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/ProviderRegistryImpl.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/principal/ProviderRegistryImpl.java
Tue Mar 10 10:53:44 2009
@@ -44,7 +44,7 @@
* default principal provider.
* NOTE that the provider must be initialized by the caller.
*
- * @param defaultPrincipalProvider
+ * @param defaultPrincipalProvider The default principal provider.
*/
public ProviderRegistryImpl(PrincipalProvider defaultPrincipalProvider) {
this.defaultPrincipalProvider = defaultPrincipalProvider;
@@ -102,9 +102,11 @@
* {@link LoginModuleConfig#PARAM_PRINCIPAL_PROVIDER_CLASS} key.<br>
* The class gets set the properties of the given map, via a Bean mechanism
*
- * @param config
+ * @param config Configuration properties.
* @return the new provider instance or <code>null</code> if the
* configuration does not contain the required entry.
+ * @throws RepositoryException If an error occurs while creating the
+ * principal provider.
*/
private PrincipalProvider createProvider(Properties config)
throws RepositoryException {
|