Interface ProfileAuthenticator

All Superinterfaces:
AuthManager
All Known Implementing Classes:
AgentCertAuthentication, CMCAuth, FlatFileAuth, SessionAuthentication, SSLclientCertAuthentication, TokenAuthentication, UidPwdDirAuthentication, UidPwdPinDirAuthentication, UserPwdDirAuthentication

public interface ProfileAuthenticator extends AuthManager
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$
  • Field Details

  • Method Details

    • init

      void init(Profile profile, ConfigStore config) throws EProfileException
      Initializes this default policy.
      Parameters:
      profile - owner of this authenticator
      config - configuration store
      Throws:
      EProfileException - failed to initialize
    • getConfigStore

      AuthManagerConfig getConfigStore()
      Retrieves the configuration store.
      Specified by:
      getConfigStore in interface AuthManager
      Returns:
      configuration store
    • populate

      void populate(IAuthToken token, Request request) throws EProfileException
      Populates authentication specific information into the request for auditing purposes.
      Parameters:
      token - authentication token
      request - request
      Throws:
      EProfileException - failed to populate
    • getName

      String getName(Locale locale)
      Retrieves the localizable name of this policy.
      Parameters:
      locale - end user locale
      Returns:
      localized authenticator name
    • getText

      String getText(Locale locale)
      Retrieves the localizable description of this policy.
      Parameters:
      locale - end user locale
      Returns:
      localized authenticator description
    • getValueNames

      Enumeration<String> getValueNames()
      Retrieves a list of names of the property.
      Returns:
      a list of property names
    • isValueWriteable

      boolean isValueWriteable(String name)
      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.
      Parameters:
      name - property name
      Returns:
      true if the property is not security related
    • getValueDescriptor

      IDescriptor getValueDescriptor(Locale locale, String name)
      Retrieves the descriptor of the given value property by name.
      Parameters:
      locale - user locale
      name - property name
      Returns:
      descriptor of the requested property
    • isSSLClientRequired

      boolean isSSLClientRequired()
      Checks if this authenticator requires SSL client authentication.
      Returns:
      client authentication required or not