IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.wssecurity.trust.config
Interface RequesterConfig

All Superinterfaces:
Configuration, RequesterConfiguration

public interface RequesterConfig
extends RequesterConfiguration

The RequesterConfig object encapsulates the state information needed for a WS-Trust security token request dispatched by WSSTrustClient

State information includes:

See Also:
RequesterConfiguration.RSTT

Nested Class Summary
static interface RequesterConfig.Namespace
          Common namespace prefixes associated with the WSSTrustClient.
 
Nested classes/interfaces inherited from interface com.ibm.wsspi.wssecurity.core.token.config.RequesterConfiguration
RequesterConfiguration.RSTT, RequesterConfiguration.RSTT13
 
Method Summary
 void addXML(com.ibm.websphere.wssecurity.wssapi.XMLStructure xmlStructure)
          Adds a user constructed XML Structure to the trust request.
 boolean containsKey(java.lang.String key)
          Method to determine if a specific configuration setting exists in the RequesterConfig.
 boolean containsSecondaryParameterKey(java.lang.String key)
          Method to determine if a specific secondary parameter configuration setting exists in the RequesterConfig.
 java.lang.String get(java.lang.String key)
          Method to query a specific configuration setting in the RequesterConfig.
 java.lang.String getMessageID()
          Gets the existing message id configuration setting.
 java.lang.String getSecondaryParameter(java.lang.String key)
          Method to query a specific secondary parameter configuration setting in the RequesterConfig.
 java.util.Map<java.lang.String,java.lang.String> getSecondaryParameters()
          Gets the secondary parameters.
 java.lang.String getSOAPNamespace()
          Gets the SOAP namespace.
 java.lang.String getWSAddressingNamespace()
          Gets the WS-Addressing namespace.
 java.util.List<com.ibm.websphere.wssecurity.wssapi.XMLStructure> getXMLList()
          Gets the current list of user created XML Structures that will be included with the trust request.
 void put(java.lang.String key, java.lang.String text)
          Method to set a specific configuration setting in the RequesterConfig.
 void putSecondaryParameter(java.lang.String key, java.lang.String text)
          Method to set a specific secondary parameter configuration setting in the RequesterConfig.
 void setMessageID(java.lang.String messageID)
          Sets the message id.
 void setSOAPNamespace(java.lang.String namespace)
          Sets the SOAP namespace.
 
Methods inherited from interface com.ibm.wsspi.wssecurity.core.token.config.RequesterConfiguration
getRSTTProperties, setRSTTProperties
 
Methods inherited from interface com.ibm.wsspi.wssecurity.core.config.Configuration
validate
 

Method Detail

addXML

void addXML(com.ibm.websphere.wssecurity.wssapi.XMLStructure xmlStructure)
Adds a user constructed XML Structure to the trust request. The XML Structure will be included as a child of the RequestSecurityToken element. This method may be called an arbitrary number of times. The WSSTrustClient keeps a list of XML Structures and will include all of them in the trust request. The XMLStructure parameter provided on this method call must implement com.ibm.wsspi.wssecurity.wssapi.OMStructure where the getNode method returns the OMElement that is the element that should be added to the trust request.

Parameters:
xmlStructure - The user constructed XML structure

containsKey

boolean containsKey(java.lang.String key)
Method to determine if a specific configuration setting exists in the RequesterConfig.

Parameters:
key - Valid keys are listed in RequesterConfiguration.RSTT.
Returns:
true, if key setting exists.

containsSecondaryParameterKey

boolean containsSecondaryParameterKey(java.lang.String key)
Method to determine if a specific secondary parameter configuration setting exists in the RequesterConfig.

Parameters:
key - Valid keys are listed in RequesterConfiguration.RSTT.
Returns:
true, if key setting exists.

get

java.lang.String get(java.lang.String key)
Method to query a specific configuration setting in the RequesterConfig.

Parameters:
key - Valid keys are listed in RequesterConfiguration.RSTT.
Returns:
the existing configuration setting.

getMessageID

java.lang.String getMessageID()
Gets the existing message id configuration setting.

Returns:
the message id

getXMLList

java.util.List<com.ibm.websphere.wssecurity.wssapi.XMLStructure> getXMLList()
Gets the current list of user created XML Structures that will be included with the trust request.

Returns:
the list of XML Structures

getSecondaryParameter

java.lang.String getSecondaryParameter(java.lang.String key)
Method to query a specific secondary parameter configuration setting in the RequesterConfig.

Parameters:
key - Valid keys are listed in RequesterConfiguration.RSTT.
Returns:
the existing configuration setting.

getSecondaryParameters

java.util.Map<java.lang.String,java.lang.String> getSecondaryParameters()
Gets the secondary parameters.

Returns:
a Map of the secondary parameters

getSOAPNamespace

java.lang.String getSOAPNamespace()
Gets the SOAP namespace.

Returns:
the SOAP namespace

getWSAddressingNamespace

java.lang.String getWSAddressingNamespace()
Gets the WS-Addressing namespace.

Returns:
the WS-Addressing namespace

put

void put(java.lang.String key,
         java.lang.String text)
         throws com.ibm.websphere.wssecurity.wssapi.WSSException
Method to set a specific configuration setting in the RequesterConfig.

Parameters:
key - Valid keys are listed in RequesterConfiguration.RSTT.
text - Corresponding configuration setting value. See WSSConstants for common values.
Throws:
com.ibm.websphere.wssecurity.wssapi.WSSException - Exception thrown for invalid key

putSecondaryParameter

void putSecondaryParameter(java.lang.String key,
                           java.lang.String text)
                           throws com.ibm.websphere.wssecurity.wssapi.WSSException
Method to set a specific secondary parameter configuration setting in the RequesterConfig.

Parameters:
key - Valid keys are listed in RequesterConfiguration.RSTT.
text - Corresponding configuration setting value. See WSSConstants for common values.
Throws:
com.ibm.websphere.wssecurity.wssapi.WSSException - Exception thrown for invalid key.

setMessageID

void setMessageID(java.lang.String messageID)
Sets the message id.
The message id will be automatically generated if not explicitly set.

Parameters:
messageID - The message id for the request's WS-Adddressing message id header.

setSOAPNamespace

void setSOAPNamespace(java.lang.String namespace)
                      throws com.ibm.websphere.wssecurity.wssapi.WSSException
Sets the SOAP namespace. Defaults to SOAP Version 1.1
Valid settings are WSSConstants.Namespace.SOAP11 or WSSConstants.Namespace.SOAP12

Parameters:
namespace - The request's SOAP namespace
Throws:
com.ibm.websphere.wssecurity.wssapi.WSSException - Exception thrown for invalid namespace.

IBM WebSphere Application ServerTM
Release 8