Class AuthProvider

java.lang.Object
java.util.Dictionary<Object,Object>
java.util.Hashtable<Object,Object>
All Implemented Interfaces:
Serializable,Cloneable,Map<Object,Object>
public abstract classAuthProviderextendsProvider
This class defines login and logout methods for a provider.

While callers may invokelogin directly, the provider may also invokelogin on behalf of callers if it determines that a login must be performed prior to certain operations.

Since:
1.5
See Also:

  • Constructor Details

    • AuthProvider

      @Deprecated(since="9")protected AuthProvider(String name, double version,String info)
      Constructs a provider with the specified name, version number, and information.
      Parameters:
      name - the provider name.
      version - the provider version number.
      info - a description of the provider and its services.

    • AuthProvider

      protected AuthProvider(String name,String versionStr,String info)
      Constructs a provider with the specified name, version string, and information.
      Parameters:
      name - the provider name.
      versionStr - the provider version string.
      info - a description of the provider and its services.
      Since:
      9

  • Method Details

    • login

      public abstract void login(Subject subject,CallbackHandler handler) throwsLoginException
      Log in to this provider.

      The provider relies on aCallbackHandler to obtain authentication information from the caller (a PIN, for example). If the caller passes anull handler to this method, the provider uses the handler set in thesetCallbackHandler method. If no handler was set in that method, the provider queries theauth.login.defaultCallbackHandler security property for the fully qualified class name of a default handler implementation. If the security property is not set, the provider is assumed to have alternative means for obtaining authentication information.

      Parameters:
      subject - theSubject which may contain principals/credentials used for authentication, or may be populated with additional principals/credentials after successful authentication has completed. This parameter may benull.
      handler - theCallbackHandler used by this provider to obtain authentication information from the caller, which may benull
      Throws:
      IllegalStateException - if the provider requires configuration andProvider.configure(java.lang.String) has not been called
      LoginException - if the login operation fails

    • logout

      public abstract void logout() throwsLoginException
      Log out from this provider.
      Throws:
      IllegalStateException - if the provider requires configuration andProvider.configure(java.lang.String) has not been called
      LoginException - if the logout operation fails

    • setCallbackHandler

      public abstract void setCallbackHandler(CallbackHandler handler)
      Set aCallbackHandler.

      The provider uses this handler if one is not passed to thelogin method. The provider also uses this handler if it invokeslogin on behalf of callers. In either case if a handler is not set via this method, the provider queries theauth.login.defaultCallbackHandler security property for the fully qualified class name of a default handler implementation. If the security property is not set, the provider is assumed to have alternative means for obtaining authentication information.

      Parameters:
      handler - aCallbackHandler for obtaining authentication information, which may benull
      Throws:
      IllegalStateException - if the provider requires configuration andProvider.configure(java.lang.String) has not been called