diff options
author | Ade Lee <alee@redhat.com> | 2011-12-07 16:58:12 -0500 |
---|---|---|
committer | Ade Lee <alee@redhat.com> | 2011-12-07 16:58:12 -0500 |
commit | 32150d3ee32f8ac27118af7c792794b538c78a2f (patch) | |
tree | 52dd96f664a6fa51be25b28b6f10adc5f2c9f660 /pki/base/common/src/com/netscape/certsrv/profile/IProfileAuthenticator.java | |
parent | f05d58a46795553beb8881039cc922974b40db34 (diff) | |
download | pki-32150d3ee32f8ac27118af7c792794b538c78a2f.tar.gz pki-32150d3ee32f8ac27118af7c792794b538c78a2f.tar.xz pki-32150d3ee32f8ac27118af7c792794b538c78a2f.zip |
Formatting
Formatted project according to eclipse project settings
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 | 48 |
1 files changed, 22 insertions, 26 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 195078f7b..26ef3fcd0 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,12 @@ 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. - * + * 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,35 +40,35 @@ 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(); /** - * Populates authentication specific information into the - * request for auditing purposes. - * + * 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 +76,7 @@ public interface IProfileAuthenticator extends IAuthManager { /** * Retrieves the localizable description of this policy. - * + * * @param locale end user locale * @return localized authenticator description */ @@ -86,26 +84,24 @@ public interface IProfileAuthenticator extends IAuthManager { /** * Retrieves a list of names of the property. - * + * * @return a list of property names */ public Enumeration getValueNames(); /** - * Checks if the value of the given property should be - * serializable into the request. Passsword or other - * security-related value may not be desirable for - * storage. - * + * Checks if the value of the given property should be 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 - * property by name. - * + * 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 +110,7 @@ public interface IProfileAuthenticator extends IAuthManager { /** * Checks if this authenticator requires SSL client authentication. - * + * * @return client authentication required or not */ public boolean isSSLClientRequired(); |