Author: vtence
Date: Sat Mar 19 19:05:58 2005
New Revision: 158278
URL: http://svn.apache.org/viewcvs?view=rev&rev=158278
Log:
Javadoc
Modified:
directory/authx/trunk/core/src/java/org/apache/authx/authentication/realm/AuthenticationMethod.java
Modified:
directory/authx/trunk/core/src/java/org/apache/authx/authentication/realm/AuthenticationMethod.java
URL:
http://svn.apache.org/viewcvs/directory/authx/trunk/core/src/java/org/apache/authx/authentication/realm/AuthenticationMethod.java?view=diff&r1=158277&r2=158278
==============================================================================
---
directory/authx/trunk/core/src/java/org/apache/authx/authentication/realm/AuthenticationMethod.java
(original)
+++
directory/authx/trunk/core/src/java/org/apache/authx/authentication/realm/AuthenticationMethod.java
Sat Mar 19 19:05:58 2005
@@ -21,6 +21,17 @@
import java.security.Principal;
/**
+ * Authentication methods are pluggable mechanisms by means of which a
<code>Realm</code>
+ * indentifies and authenticates credentials against its contained identities.
+ * <p>
+ * <code>AuthenticationMethod</code>s provide two mechanisms for
identification and
+ * authentication operations. The matcher mechanism filters credentials by
sequential
+ * traversal of the realm. This mechanism is used in the
<code>MemoryRealm</code>.
+ * The selector mechanism filters credentials by direct selection
+ * in the realm. This mechanism is used by the <code>JDBCRealm</code> for
instance.
+ * <p>
+ * A typical example of authentication method is the [EMAIL PROTECTED]
UsernamePasswordAuthentication} method.
+ *
* @author <a href="mailto:[email protected]";>Apache Directory
Project</a>
*/
public interface AuthenticationMethod
@@ -33,5 +44,5 @@
CredentialsMatcher getIdentificationMatcher( CredentialSet credentials );
- SelectorBuilder getAuthenticationSelector( CredentialSet credentials );
+ SelectorBuilder getAuthenticationBuilder( CredentialSet credentials );
}
