public interface HTTPTrustAssociationInterceptor
HTTPTrustAssociationInterceptor is an interface for developing a HTTP custom trust association interceptor (TAI).
A custom TAI that implements this interface should also extend com.ibm.wsspi.security.tai.extension.BaseTrustAssociationInterceptor class.
The custom TAI must implement the following methods:
initialize to allocate any resources needed for the TAI
negotiateValidateandEstablishProtocolTrust that returns TAIResult to indicate the status of the HTTP message being processed
isTargetProtocolInterceptor that returns false/true to indicate whether a HTTP message will be handled by the TAI.
| Modifier and Type | Method and Description |
|---|---|
void |
cleanup()
Invoked when the TAI should free any resources it holds.
|
java.lang.String |
getType()
Returns a type value of the TAI.
|
java.lang.String |
getVersion()
Returns the version number of the current TAI implementation.
|
int |
initialize(java.util.Properties properties)
Initializes the trust association interceptor.
|
boolean |
isTargetProtocolInterceptor(javax.servlet.http.HttpServletRequest req)
The custom TAI should use this method to handle the http request.
|
com.ibm.wsspi.security.tai.TAIResult |
negotiateValidateandEstablishProtocolTrust(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp)
Returns
TAIResult that indicates the status of the message being processed. |
boolean isTargetProtocolInterceptor(javax.servlet.http.HttpServletRequest req)
throws com.ibm.websphere.security.WebTrustAssociationFailedException
req - HttpServletRequest to be handled by the TAIcom.ibm.websphere.security.WebTrustAssociationFailedException - exceptioncom.ibm.wsspi.security.tai.TAIResult negotiateValidateandEstablishProtocolTrust(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp)
throws com.ibm.websphere.security.WebTrustAssociationFailedException
TAIResult that indicates the status of the message being processed.
If authentication succeeds, the TAIResult should contain the status HttpServletResponse.SC_OK and a principal.
If authentication fails, the TAIResult should contain a return code of HttpServletResponse.SC_UNAUTHORIZED (401), SC_FORBIDDEN (403), or SC_PROXY_AUTHENTICATION_REQUIRED (407).
req - incoming SipServletRequest to be handled by the TAIresp - incoming SipServletResponse to be handled by the TAIcom.ibm.websphere.security.WebTrustAssociationFailedException - exceptionint initialize(java.util.Properties properties)
throws com.ibm.websphere.security.WebTrustAssociationFailedException
properties - Properties defined in the TAI propertiescom.ibm.websphere.security.WebTrustAssociationFailedException - exceptionjava.lang.String getVersion()
java.lang.String getType()
void cleanup()