IdentityTokenHandlerImpl

java.lang.Object
- com.ibm.commerce.foundation.server.webservices.IdentityTokenHandlerImpl

All Implemented Interfaces:

javax.xml.rpc.handler.Handler
```
public class IdentityTokenHandlerImpl
extends java.lang.Object
implements javax.xml.rpc.handler.Handler
```
A generic JAX-RPC handler implementation used to map mustUnderstood elements within the SOAP header to a JAX-RPC handler. This handler only provides internal processing of the SOAP request.

Constructor Summary

Constructors
Constructor and Description

IdentityTokenHandlerImpl()
Creates an instance of the Open Web Service JAX-RPC handler.

Constructors
Constructor and Description
`IdentityTokenHandlerImpl()` Creates an instance of the Open Web Service JAX-RPC handler.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`destroy()` Cleanup of the JAX-RPC handler.
`javax.xml.namespace.QName[]`	`getHeaders()` Returns the headers that were specified in the configuration.
`boolean`	`handleFault(javax.xml.rpc.handler.MessageContext messageContext)` Handles the fault and returns true to call the next handler to process the fault.
`boolean`	`handleRequest(javax.xml.rpc.handler.MessageContext messageContext)` Handles the request and returns true to allow the next handler to process the request.
`boolean`	`handleResponse(javax.xml.rpc.handler.MessageContext messageContext)` Handles the response and returns true to all the next handler to process the response.
`void`	`init(javax.xml.rpc.handler.HandlerInfo handlerInfo)` Initializes the handler by setting the header `QName`.
`protected java.lang.String`	`resolveLTPATokenFromHeader(javax.xml.rpc.handler.soap.SOAPMessageContext messageContext)` This method finds the LTPA token from the `SOAP` messageContext of this request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IdentityTokenHandlerImpl
```
public IdentityTokenHandlerImpl()
```
    Creates an instance of the Open Web Service JAX-RPC handler.
- Method Detail
  - handleRequest
```
public boolean handleRequest(javax.xml.rpc.handler.MessageContext messageContext)
```
    Handles the request and returns true to allow the next handler to process the request.
    
    Specified by:
    
    handleRequest in interface javax.xml.rpc.handler.Handler
    
    Parameters:
    
    messageContext - The message context associated with the SOAP request.
    
    Returns:
    
    Always true.
    
    See Also:
    
    Handler.handleRequest(javax.xml.rpc.handler.MessageContext)
  - handleResponse
```
public boolean handleResponse(javax.xml.rpc.handler.MessageContext messageContext)
```
    Handles the response and returns true to all the next handler to process the response.
    
    Specified by:
    
    handleResponse in interface javax.xml.rpc.handler.Handler
    
    Parameters:
    
    messageContext - The message context associated with the SOAP request.
    
    Returns:
    
    Always true.
    
    See Also:
    
    Handler.handleResponse(javax.xml.rpc.handler.MessageContext)
  - handleFault
```
public boolean handleFault(javax.xml.rpc.handler.MessageContext messageContext)
```
    Handles the fault and returns true to call the next handler to process the fault.
    
    Specified by:
    
    handleFault in interface javax.xml.rpc.handler.Handler
    
    Parameters:
    
    messageContext - The message context associated with the SOAP request.
    
    Returns:
    
    Always true.
    
    See Also:
    
    Handler.handleFault(javax.xml.rpc.handler.MessageContext)
  - init
```
public void init(javax.xml.rpc.handler.HandlerInfo handlerInfo)
```
    Initializes the handler by setting the header QName.
    
    Specified by:
    
    init in interface javax.xml.rpc.handler.Handler
    
    Parameters:
    
    handlerInfo - The handler configuration.
    
    See Also:
    
    Handler.init(javax.xml.rpc.handler.HandlerInfo)
  - destroy
```
public void destroy()
```
    Cleanup of the JAX-RPC handler. No operation is required.
    
    Specified by:
    
    destroy in interface javax.xml.rpc.handler.Handler
    
    See Also:
    
    Handler.destroy()
  - getHeaders
```
public javax.xml.namespace.QName[] getHeaders()
```
    Returns the headers that were specified in the configuration.
    
    Specified by:
    
    getHeaders in interface javax.xml.rpc.handler.Handler
    
    Returns:
    
    The headers configured with the handler.
    
    See Also:
    
    Handler.getHeaders()
  - resolveLTPATokenFromHeader
```
protected java.lang.String resolveLTPATokenFromHeader(javax.xml.rpc.handler.soap.SOAPMessageContext messageContext)
                                               throws ServiceException
```
    This method finds the LTPA token from the SOAP messageContext of this request. This implementation parses the SOAP messageContext and looks for a node that represents the LTPA token. If the node is found and the LTPA token is valid, then the LTPA token is resolved. If the LTPA token is not valid, a service exception is thrown. If an LTPA token is not found then null is returned.
    
    XKEk+O46iPB1E2/4YB9HbMVQhu9cMpx3XSAwy1M9OEmJ9iVFZ9VnnQ8kMHCIdtfdqpAJWErz8oRISTYLvk
    where BinarySecurityToken element is the LTPA token
    
    Parameters:
    
    messageContext - The SOAP messageContext associated with the request.
    
    Returns:
    
    The valid LTPA token associated with the request. If no LTPA token can be found then null is returned.
    
    Throws:
    
    ServiceException - Thrown if the LTPA token specified is invalid, that is, it either does not exist or the signature does not match the expected signature.

Class IdentityTokenHandlerImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdentityTokenHandlerImpl

Method Detail

handleRequest

handleResponse

handleFault

init

destroy

getHeaders

resolveLTPATokenFromHeader