Package com.ibm.wsspi.security.tai

Class TAIResult

java.lang.Object

com.ibm.wsspi.security.tai.TAIResult

public final class TAIResult
extends Object

This is the result returned from com.ibm.wsspi.security.tai.TrustAssociationInterceptor.negotiateValidateandEstablishTrust method. It contains the result of trust association interceptor negotiation, validation and establishing trust. If the trust is validated and established, then status code with value HttpServletResponse.SC_OK and the authenticated principal must be set in the TAIResult. The JAAS Subject is optionally, this is only used if trust association interceptor wants to pass additional security information to WebSphere Application Server security runtime (please security attribute propagation documentation for details).

Please see com.ibm.wsspi.security.tai.TrustAssociationInterceptor for details on the status code returned.

See Also:

• Subject
• TrustAssociationInterceptor

Constructor Summary

Constructors

Constructor	Description
TAIResult(int status, String principal, Subject subject)

Method Summary

Modifier and Type	Method	Description
static TAIResult	create(int status)	Create an instance of the result with status code other than HttpServletResponse.SC_OK.
static TAIResult	create(int status, String principal)	Create an instance of the result with status, if trust is validated and established (should return status HttpServletResponse.SC_OK, if any other status code is return, WebSphere Application Server will stop the normal processing and send status code back to caller.) and the authenticated principal.
static TAIResult	create(int status, String principal, Subject subject)	Create an instance of the result with status, if trust is validated and established (should return status HttpServletResponse.SC_OK, if any other status code is return, WebSphere Application Server will stop the normal processing and send status code back to caller.), the authenticated principal and JAAS Subject contains additional security information from third party security service.
final String	getAuthenticatedPrincipal()	If trust is validated and established and status is HttpServletResponse.SC_OK, then this method return the authenticated principal.
final int	getStatus()	If trust is validated and established, then HttpServletResponse.SC_OK should be returned.
final Subject	getSubject()	If trust is validated and established and status is HttpServletResponse.SC_OK, then this return the JAAS Subject that contains the other security information that can be used to create the WebSphere Application Server credential.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TAIResult

public TAIResult(int status,
 String principal,
 Subject subject)
          throws com.ibm.websphere.security.WebTrustAssociationFailedException

Throws:

com.ibm.websphere.security.WebTrustAssociationFailedException

Method Details

create

public static TAIResult create(int status,
 String principal,
 Subject subject)
                        throws com.ibm.websphere.security.WebTrustAssociationFailedException

Create an instance of the result with status, if trust is validated and established (should return status HttpServletResponse.SC_OK, if any other status code is return, WebSphere Application Server will stop the normal processing and send status code back to caller.), the authenticated principal and JAAS Subject contains additional security information from third party security service.

Parameters:

status - status code, please use HttpServletResponse.SC_OK if trust is validated and established

principal - authenticated principal

subject - JAAS Subject contains additional security information

Returns:

TAIResult

Throws:

com.ibm.websphere.security.WebTrustAssociationFailedException - Thrown if there is no authenticated principal when status is HttpServletResponse.SC_OK

See Also:

• Subject

create

public static TAIResult create(int status,
 String principal)
                        throws com.ibm.websphere.security.WebTrustAssociationFailedException

Create an instance of the result with status, if trust is validated and established (should return status HttpServletResponse.SC_OK, if any other status code is return, WebSphere Application Server will stop the normal processing and send status code back to caller.) and the authenticated principal.

Parameters:

status - status code, please use HttpServletResponse.SC_OK if trust is validated and established

principal - authenticated principal

Returns:

TAIResult

Throws:

com.ibm.websphere.security.WebTrustAssociationFailedException - Thrown if there is no authenticated principal when status is HttpServletResponse.SC_OK

create

public static TAIResult create(int status)
                        throws com.ibm.websphere.security.WebTrustAssociationFailedException

Create an instance of the result with status code other than HttpServletResponse.SC_OK. This is for failure case.

Parameters:

status - status code other than HttpServletResponse.SC_OK, for negotiation, or failure

Returns:

TAIResult

Throws:

com.ibm.websphere.security.WebTrustAssociationFailedException

getStatus

public final int getStatus()

If trust is validated and established, then HttpServletResponse.SC_OK should be returned. If any other status code is return, WebSphere Application Server will stop the normal processing and send status code back to caller.

Returns:

The status of the trust association interceptor processing.

getAuthenticatedPrincipal

public final String getAuthenticatedPrincipal()

If trust is validated and established and status is HttpServletResponse.SC_OK, then this method return the authenticated principal.

Returns:

The authenticated principal.

getSubject

public final Subject getSubject()

If trust is validated and established and status is HttpServletResponse.SC_OK, then this return the JAAS Subject that contains the other security information that can be used to create the WebSphere Application Server credential. Please refer to the security token propagation documentation for details.

This is optional and null could be return if there is no additional security information.

Returns:

The JAAS Subject contains additional security information. null could be returned.

See Also:

• Subject