javax.security.auth.message.module.ServerAuthModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-javaee-all-8.0
Combine jar files which includes all Java EE 8 Spec APIs
The newest version!
package javax.security.auth.message.module;

import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.message.AuthException;
import javax.security.auth.message.MessagePolicy;
import javax.security.auth.message.ServerAuth;
import java.util.Map;

//$Id$

/**
 *  A ServerAuthModule validates client requests and secures responses 
 *  back to the client.
 *
 *  A module implementation should assume it may be used to secure different 
 *  requests as different clients. A module should also assume it may be used 
 *  concurrently by multiple callers. It is the module implementation's responsibility 
 *  to properly save and restore any state as necessary. A module that does not need 
 *  to do so may remain completely stateless.
 *
 *  Every implementation of the interface must provide a public zero argument constructor.
 *  
 *  @author Anil Saldhana
 *  @author Charlie Lai, Ron Monzillo (Javadoc for JSR-196) 
 *  @since  May 12, 2006 
 *  @version $Revision$
 *  @see javax.security.auth.message.config.ServerAuthContext
 */
public interface ServerAuthModule extends ServerAuth 
{
   /**
    * Get the one or more Class objects representing the message
    * types supported by the module.
    * @return An array of Class objects, with at least one element defining a message type supported by the
    *         module.
    */
   public java.lang.Class[] getSupportedMessageTypes();
   
   /**
    * Initialize this module with request and response message policies to 
    *    enforce, a CallbackHandler, and any module-specific configuration 
    *    properties.
    *
    * The request policy and the response policy must not both be null.
    * 
    * @param requestPolicy The request policy this module must enforce, or null.
    * @param responsePolicy The response policy this module must enforce, or null.
    * @param handler CallbackHandler used to request information.
    * @param options A Map of module-specific configuration properties.
    * @throws AuthException - If module initialization fails, including for the case
    *                         where the options argument contains elements that are 
    *                         not supported by the module.
    */
   public void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy,
         CallbackHandler handler, Map options) throws AuthException;
}