com.filenet.ae.toolkit.server.util.credentials
Interface CredentialsBean


public interface CredentialsBean


Field Summary
static java.lang.String CONTAINER_JAAS_MODE_KEY
          A key that can be set in the extraParameters map of the setCredentials method call.
static java.lang.String PERIMETER_CHALLENGE_MODE_KEY
          A key that can be set in the extraParameters map of the setCredentials method call.
static java.lang.String SERVER_PLUGIN_MODE_KEY
          A key that can be set in the extraParameters map of the setCredentials method call.
 
Method Summary
 boolean credentialsRequired()
          Returns the credentialsRequired flag state.
 void setCredentials(java.lang.String userId, java.lang.String password, java.lang.String userPrincipalName, java.util.Map extraParameters, boolean encrypt)
          Set valid credentials so that they will be picked up by the AE toolkit.
 

Field Detail

PERIMETER_CHALLENGE_MODE_KEY

public static final java.lang.String PERIMETER_CHALLENGE_MODE_KEY
A key that can be set in the extraParameters map of the setCredentials method call. Indicates whether or not user challenge is being managed outside the web application/container or not. By default, the value is false, which indicates that either the web application or the webapp container, on the application?s behalf, initiates and handles the response from a user challenge. When true, it is assumed that the user challenge is happening outside of the webapp container boundary, and authentication is being done via some form of user certificate (i.e. CLIENT_CERT). This would be the common case for a true SSO deployment.

See Also:
Constant Field Values

CONTAINER_JAAS_MODE_KEY

public static final java.lang.String CONTAINER_JAAS_MODE_KEY
A key that can be set in the extraParameters map of the setCredentials method call. When authentication filtering is configured, this flag is used to indicate that the authentication filter being used is assuming that container-managed, Java™ Authentication and Authorization Service (JAAS) based authentication is configured and in use. Default value if not specified is false.

See Also:
Constant Field Values

SERVER_PLUGIN_MODE_KEY

public static final java.lang.String SERVER_PLUGIN_MODE_KEY
A key that can be set in the extraParameters map of the setCredentials method call. Indicates whether or not the configured authentication filter is dependent on a corresponding server-side (CE/PE) authentication filter as specified in 3.5.1 SSO Integration. Defalut, if unspecified, is true.

See Also:
Constant Field Values
Method Detail

setCredentials

public void setCredentials(java.lang.String userId,
                           java.lang.String password,
                           java.lang.String userPrincipalName,
                           java.util.Map extraParameters,
                           boolean encrypt)
                    throws java.io.IOException
Set valid credentials so that they will be picked up by the AE toolkit. This call implicitly unsets the credentialsRequired flag.

Parameters:
userId -
password -
extraParameters -
Throws:
java.io.IOException

credentialsRequired

public boolean credentialsRequired()
Returns the credentialsRequired flag state.

Returns:
boolean true or false


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.