diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/profile/IProfileAuthenticator.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/profile/IProfileAuthenticator.java | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/profile/IProfileAuthenticator.java b/pki/base/common/src/com/netscape/certsrv/profile/IProfileAuthenticator.java index 476002e2d..98546c601 100644 --- a/pki/base/common/src/com/netscape/certsrv/profile/IProfileAuthenticator.java +++ b/pki/base/common/src/com/netscape/certsrv/profile/IProfileAuthenticator.java @@ -26,14 +26,13 @@ import com.netscape.certsrv.base.IConfigStore; import com.netscape.certsrv.property.IDescriptor; import com.netscape.certsrv.request.IRequest; - /** * This interface represents an authenticator for profile. * An authenticator is responsibile for authenting * the end-user. If authentication is successful, request * can be processed immediately. Otherwise, the request will * be defered and manual approval is then required. - * + * * @version $Revision$, $Date$ */ public interface IProfileAuthenticator extends IAuthManager { @@ -42,17 +41,17 @@ public interface IProfileAuthenticator extends IAuthManager { /** * Initializes this default policy. - * + * * @param profile owner of this authenticator * @param config configuration store * @exception EProfileException failed to initialize */ public void init(IProfile profile, IConfigStore config) - throws EProfileException; + throws EProfileException; /** * Retrieves the configuration store. - * + * * @return configuration store */ public IConfigStore getConfigStore(); @@ -60,17 +59,17 @@ public interface IProfileAuthenticator extends IAuthManager { /** * Populates authentication specific information into the * request for auditing purposes. - * + * * @param token authentication token * @param request request * @exception EProfileException failed to populate */ public void populate(IAuthToken token, IRequest request) - throws EProfileException; + throws EProfileException; /** * Retrieves the localizable name of this policy. - * + * * @param locale end user locale * @return localized authenticator name */ @@ -78,7 +77,7 @@ public interface IProfileAuthenticator extends IAuthManager { /** * Retrieves the localizable description of this policy. - * + * * @param locale end user locale * @return localized authenticator description */ @@ -86,7 +85,7 @@ public interface IProfileAuthenticator extends IAuthManager { /** * Retrieves a list of names of the property. - * + * * @return a list of property names */ public Enumeration<String> getValueNames(); @@ -96,16 +95,16 @@ public interface IProfileAuthenticator extends IAuthManager { * serializable into the request. Passsword or other * security-related value may not be desirable for * storage. - * + * * @param name property name * @return true if the property is not security related */ public boolean isValueWriteable(String name); /** - * Retrieves the descriptor of the given value + * Retrieves the descriptor of the given value * property by name. - * + * * @param locale user locale * @param name property name * @return descriptor of the requested property @@ -114,7 +113,7 @@ public interface IProfileAuthenticator extends IAuthManager { /** * Checks if this authenticator requires SSL client authentication. - * + * * @return client authentication required or not */ public boolean isSSLClientRequired(); |