IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.wssecurity.callbackhandler
Class GenericIssuedTokenConsumeCallback

java.lang.Object
  extended by com.ibm.websphere.wssecurity.callbackhandler.GenericIssuedTokenConsumeCallback
All Implemented Interfaces:
javax.security.auth.callback.Callback

public class GenericIssuedTokenConsumeCallback
extends java.lang.Object
implements javax.security.auth.callback.Callback

This is a Callback class used to collect configuration data associated with the consumer of an incoming generic issued token. It is important to note that an incoming generic token (inbound request) is validated against a SecurityTokenService using WS-Trust Validate.


Field Summary
 java.lang.String[] validateTargets
           
 
Constructor Summary
GenericIssuedTokenConsumeCallback()
           
 
Method Summary
 java.lang.String getExchangedTokenType()
           
 java.lang.String getIssuer()
          Return the token issuer name.
 java.util.Map<java.lang.String,java.lang.String> getProperties()
          Return WS-Trust request parameters as defined in RSTT
 java.lang.String getStsBinding()
          Returns the name for the policySet binding used by the WS-Trust client's Issue or Validate operation.
 java.lang.String getStsBindingScope()
          Return the binding scope for WS-Trust client, and it is either "domain" or "application".
 java.lang.String getStsPolicy()
          Returns the policySet name for WS-Trust client's Issue or Validate operation.
 java.lang.String getStsSoapVersion()
          Returns the SOAP version for the WS-Trust client.
 java.lang.String getStsURI()
          Returns the URL of SecurityTokenService that issues SecurityToken.
 java.lang.String getStsValidateBinding()
          Returns the name for the policySet binding used by the WS-Trust client's Validate operation.
 java.lang.String getStsValidatePolicy()
          Returns the policySet name for WS-Trust client's Validate operation.
 java.lang.String getValidateTarget()
          Return the optional flag that indicate how to pass validation target to STS.
 java.lang.String getWstNamespace()
          Return the WS-Trust namespace used in the SOAP communication with the Security Token provider.
 void setExchangedTokenType(java.lang.String type)
           
 void setIssuer(java.lang.String issuer)
          Set token issuer name.
 void setProperties(java.util.Map<java.lang.String,java.lang.String> map)
          Set RSTT for WS-Trust request
 void setStsBinding(java.lang.String binding)
          Sets the name of WS-Trust client bindings for WS-Trust's Issue or Validate operation.
 void setStsBindingScope(java.lang.String scope)
          Sets the binding scope for WS-Trust client, and it could be set to "domain" or "application".
 void setStsPolicy(java.lang.String policy)
          Sets the name of WS-Trust client policy set for Issue or Validate operation.
 void setStsSoapVersion(java.lang.String ns)
          Sets the required SOAP version of WS-Trust client.
 void setStsURI(java.lang.String uri)
          Sets the URL name of SecurityTokenservice.
 void setStsValidateBinding(java.lang.String binding)
          Sets the name of WS-Trust client bindings for WS-Trust's Validate operation.
 void setStsValidatePolicy(java.lang.String policy)
          Sets the name of WS-Trust client policy set for Validate operation.
 void setValidateTarget(java.lang.String target)
          Set flag to indicate how Validate message for WS-Trust request should be formated, the valid options are "token" or "base".
 void setWstNamespace(java.lang.String ns)
          Set WS-Trust namespace used in the SOAP communication with the Security Token provider.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

validateTargets

public java.lang.String[] validateTargets
Constructor Detail

GenericIssuedTokenConsumeCallback

public GenericIssuedTokenConsumeCallback()
Method Detail

getStsURI

public java.lang.String getStsURI()
Returns the URL of SecurityTokenService that issues SecurityToken.

Returns:
the URL of SecurityTokenService.

setStsURI

public void setStsURI(java.lang.String uri)
Sets the URL name of SecurityTokenservice.

Parameters:
uri - the URL name of the Security Token Service (STS).

getStsPolicy

public java.lang.String getStsPolicy()
Returns the policySet name for WS-Trust client's Issue or Validate operation.

Returns:
the policySet name for WS-Trust client's Issue or Validate operation.

setStsPolicy

public void setStsPolicy(java.lang.String policy)
Sets the name of WS-Trust client policy set for Issue or Validate operation.

Parameters:
the - name of WS-Trust client policy set for Issue or Validate operation.

getStsBinding

public java.lang.String getStsBinding()
Returns the name for the policySet binding used by the WS-Trust client's Issue or Validate operation.

Returns:
the name of the policySet binding for the WS-Trust client's Issue or Validate operation.

setStsBinding

public void setStsBinding(java.lang.String binding)
Sets the name of WS-Trust client bindings for WS-Trust's Issue or Validate operation.

Parameters:
binding - the name of WS-Trust client bindings for WS-Trust's Issue or Validate operation.

getWstNamespace

public java.lang.String getWstNamespace()
Return the WS-Trust namespace used in the SOAP communication with the Security Token provider. wstNamespace is a String value that can be set to "http://schemas.xmlsoap.org/ws/2005/02/trust" for ws-trust 1.2, or "http://docs.oasis-open.org/ws-sx/ws-trust/200512" for ws-trust 1.3.

Returns:
the WS-Trust namespace.

setWstNamespace

public void setWstNamespace(java.lang.String ns)
Set WS-Trust namespace used in the SOAP communication with the Security Token provider. wstNamespace is a String value that can be set to "http://schemas.xmlsoap.org/ws/2005/02/trust" for ws-trust 1.2, or "http://docs.oasis-open.org/ws-sx/ws-trust/200512" for ws-trust 1.3

Parameters:
wstNamespace - the WS-Trust NameSpace, it is "http://schemas.xmlsoap.org/ws/2005/02/trust" for ws-trust 1.2, or "http://docs.oasis-open.org/ws-sx/ws-trust/200512" for ws-trust 1.3

getStsSoapVersion

public java.lang.String getStsSoapVersion()
Returns the SOAP version for the WS-Trust client.

Returns:
the the SOAP version for the WS-Trust client, the valid values are 1.1 or 1.2

setStsSoapVersion

public void setStsSoapVersion(java.lang.String ns)
Sets the required SOAP version of WS-Trust client.

Parameters:
version - the required SOAP version for WS-Trust client, the valid values are 1.1 or 1.2.

getStsBindingScope

public java.lang.String getStsBindingScope()
Return the binding scope for WS-Trust client, and it is either "domain" or "application". A value of domain indicates that the specifiied binding is a general binding, and a value of application indicates that the specified binding is an application specific binding.

Returns:
the binding scope for WS-Trust client, and it is either "domain" or "application".

setStsBindingScope

public void setStsBindingScope(java.lang.String scope)
Sets the binding scope for WS-Trust client, and it could be set to "domain" or "application". A value of domain indicates that the specified binding is a general binding, and a value of application indicates that the specified binding is an application specific binding.

Parameters:
scope - the binding scope for WS-Trust client, and it is either "domain" or "application".

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()
Return WS-Trust request parameters as defined in RSTT

Returns:
WS-Trust RSTT parameters

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> map)
Set RSTT for WS-Trust request

Parameters:
WS-Trust - RSTT parameters

getExchangedTokenType

public java.lang.String getExchangedTokenType()

setExchangedTokenType

public void setExchangedTokenType(java.lang.String type)

getValidateTarget

public java.lang.String getValidateTarget()
Return the optional flag that indicate how to pass validation target to STS. The valid options are "token", "base".

Returns:
flag to indicate how to pass validation target to STS.

setValidateTarget

public void setValidateTarget(java.lang.String target)
Set flag to indicate how Validate message for WS-Trust request should be formated, the valid options are "token" or "base".

Parameters:
WS-Trust - Validate target format.

getIssuer

public java.lang.String getIssuer()
Return the token issuer name.

Returns:
the optional token issuer name.

setIssuer

public void setIssuer(java.lang.String issuer)
Set token issuer name.

Parameters:
token - issuer name.

getStsValidatePolicy

public java.lang.String getStsValidatePolicy()
Returns the policySet name for WS-Trust client's Validate operation.

Returns:
the policySet name for WS-Trust client's Validate operation.

setStsValidatePolicy

public void setStsValidatePolicy(java.lang.String policy)
Sets the name of WS-Trust client policy set for Validate operation.

Parameters:
the - name of WS-Trust client policy set for Validate operation.

getStsValidateBinding

public java.lang.String getStsValidateBinding()
Returns the name for the policySet binding used by the WS-Trust client's Validate operation.

Returns:
the name of the policySet binding for the WS-Trust client's Validate operation.

setStsValidateBinding

public void setStsValidateBinding(java.lang.String binding)
Sets the name of WS-Trust client bindings for WS-Trust's Validate operation.

Parameters:
binding - the name of WS-Trust client bindings for WS-Trust's Validate operation.

IBM WebSphere Application ServerTM
Release 7