org.apache.rampart
Class RampartMessageData

java.lang.Object
  extended by org.apache.rampart.RampartMessageData

public class RampartMessageData
extends java.lang.Object


Field Summary
static java.lang.String CANCEL_REQUEST
           
static java.lang.String KEY_CUSTOM_ISSUED_TOKEN
          Key to hold the custom issued token identifier
static java.lang.String KEY_RAMPART_POLICY
          Axis2 parameter name to be used in the client's axis2 xml
static java.lang.String KEY_SCT_ISSUER_POLICY
           
static java.lang.String KEY_WSSC_VERSION
          Key to hold the WS-SecConv version
static java.lang.String KEY_WST_VERSION
          Key to hold the WS-Trust version
static java.lang.String PARAM_CLIENT_SIDE
           
static java.lang.String RAMPART_POLICY_DATA
          Key to hold the populated RampartPolicyData object
static java.lang.String RAMPART_STS_POLICY
           
static java.lang.String SCT_ID
           
 
Constructor Summary
RampartMessageData(org.apache.axis2.context.MessageContext msgCtx, boolean sender)
           
 
Method Summary
 org.apache.ws.security.WSSConfig getConfig()
           
 java.lang.ClassLoader getCustomClassLoader()
          Returns the custom class loader if we are using one
 org.w3c.dom.Document getDocument()
           
 java.lang.String getIssuedEncryptionTokenId()
           
 java.lang.String getIssuedSignatureTokenId()
           
 org.apache.axis2.context.MessageContext getMsgContext()
           
 RampartPolicyData getPolicyData()
           
 java.lang.String getSecConvTokenId()
           
 int getSecConvVersion()
           
 org.apache.ws.security.message.WSSecHeader getSecHeader()
           
 org.apache.neethi.Policy getServicePolicy()
           
 org.apache.ws.security.SOAPConstants getSoapConstants()
          Returns an org.apache.ws.security.SOAPConstants instance with soap version information of this request.
 java.lang.String getTimestampId()
           
 int getTimestampMaxSkew()
           
 int getTimeToLive()
           
 TokenStorage getTokenStorage()
           
 int getWstVersion()
           
 boolean isInitiator()
           
 void setConfig(org.apache.ws.security.WSSConfig config)
           
 void setDocument(org.w3c.dom.Document document)
          Deprecated. document is derived from MessageContext passed in constructor
 void setIssuedEncryptionTokenId(java.lang.String issuedEncryptionTokenId)
           
 void setIssuedSignatureTokenId(java.lang.String issuedSignatureTokenId)
           
 void setMsgContext(org.apache.axis2.context.MessageContext msgContext)
          Deprecated. MessageContext is set in constructor
 void setPolicyData(RampartPolicyData policyData)
          Deprecated. Policy data determined within constructor
 void setSecConvTokenId(java.lang.String secConvTokenId)
           
 void setSecHeader(org.apache.ws.security.message.WSSecHeader secHeader)
           
 void setServicePolicy(org.apache.neethi.Policy servicePolicy)
          Deprecated. servicePolicy determined in constructor
 void setTimestampId(java.lang.String timestampId)
           
 void setTimestampMaxSkew(int timestampMaxSkew)
           
 void setTimeToLive(int timeToLive)
           
 void setTokenStorage(TokenStorage tokenStorage)
           
 void setWstVersion(int wstVersion)
          Deprecated. This is defined by the class.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY_RAMPART_POLICY

public static final java.lang.String KEY_RAMPART_POLICY
Axis2 parameter name to be used in the client's axis2 xml

See Also:
Constant Field Values

RAMPART_POLICY_DATA

public static final java.lang.String RAMPART_POLICY_DATA
Key to hold the populated RampartPolicyData object

See Also:
Constant Field Values

RAMPART_STS_POLICY

public static final java.lang.String RAMPART_STS_POLICY
See Also:
Constant Field Values

KEY_CUSTOM_ISSUED_TOKEN

public static final java.lang.String KEY_CUSTOM_ISSUED_TOKEN
Key to hold the custom issued token identifier

See Also:
Constant Field Values

KEY_WST_VERSION

public static final java.lang.String KEY_WST_VERSION
Key to hold the WS-Trust version

See Also:
Constant Field Values

PARAM_CLIENT_SIDE

public static final java.lang.String PARAM_CLIENT_SIDE
See Also:
Constant Field Values

KEY_WSSC_VERSION

public static final java.lang.String KEY_WSSC_VERSION
Key to hold the WS-SecConv version

See Also:
Constant Field Values

KEY_SCT_ISSUER_POLICY

public static final java.lang.String KEY_SCT_ISSUER_POLICY
See Also:
Constant Field Values

CANCEL_REQUEST

public static final java.lang.String CANCEL_REQUEST
See Also:
Constant Field Values

SCT_ID

public static final java.lang.String SCT_ID
See Also:
Constant Field Values
Constructor Detail

RampartMessageData

public RampartMessageData(org.apache.axis2.context.MessageContext msgCtx,
                          boolean sender)
                   throws RampartException
Throws:
RampartException
Method Detail

getDocument

public org.w3c.dom.Document getDocument()
Returns:
Returns the document.

setDocument

public void setDocument(org.w3c.dom.Document document)
Deprecated. document is derived from MessageContext passed in constructor

Parameters:
document - The document to set.

getTimeToLive

public int getTimeToLive()
Returns:
Returns the timeToLive.

setTimeToLive

public void setTimeToLive(int timeToLive)
Parameters:
timeToLive - The timeToLive to set.

getTimestampMaxSkew

public int getTimestampMaxSkew()
Returns:
Returns the timestampMaxSkew.

setTimestampMaxSkew

public void setTimestampMaxSkew(int timestampMaxSkew)
Parameters:
timestampMaxSkew - The timestampMaxSkew to set.

getConfig

public org.apache.ws.security.WSSConfig getConfig()
Returns:
Returns the config.

setConfig

public void setConfig(org.apache.ws.security.WSSConfig config)
Parameters:
config - The config to set.

getMsgContext

public org.apache.axis2.context.MessageContext getMsgContext()
Returns:
Returns the msgContext.

setMsgContext

public void setMsgContext(org.apache.axis2.context.MessageContext msgContext)
Deprecated. MessageContext is set in constructor

Parameters:
msgContext - The msgContext to set.

getPolicyData

public RampartPolicyData getPolicyData()
Returns:
Returns the policyData.

setPolicyData

public void setPolicyData(RampartPolicyData policyData)
                   throws RampartException
Deprecated. Policy data determined within constructor

Parameters:
policyData - The policyData to set.
Throws:
RampartException

getSecHeader

public org.apache.ws.security.message.WSSecHeader getSecHeader()
Returns:
Returns the secHeader.

setSecHeader

public void setSecHeader(org.apache.ws.security.message.WSSecHeader secHeader)
Parameters:
secHeader - The secHeader to set.

getIssuedEncryptionTokenId

public java.lang.String getIssuedEncryptionTokenId()
Returns:
Returns the issuedEncryptionTokenId.

setIssuedEncryptionTokenId

public void setIssuedEncryptionTokenId(java.lang.String issuedEncryptionTokenId)
Parameters:
issuedEncryptionTokenId - The issuedEncryptionTokenId to set.

getIssuedSignatureTokenId

public java.lang.String getIssuedSignatureTokenId()
Returns:
Returns the issuedSignatureTokenId.

setIssuedSignatureTokenId

public void setIssuedSignatureTokenId(java.lang.String issuedSignatureTokenId)
Parameters:
issuedSignatureTokenId - The issuedSignatureTokenId to set.

getSecConvTokenId

public java.lang.String getSecConvTokenId()
Returns:
Returns the secConvTokenId.

setSecConvTokenId

public void setSecConvTokenId(java.lang.String secConvTokenId)
Parameters:
secConvTokenId - The secConvTokenId to set.

getTokenStorage

public TokenStorage getTokenStorage()
                             throws RampartException
Returns:
Returns the tokenStorage.
Throws:
RampartException

setTokenStorage

public void setTokenStorage(TokenStorage tokenStorage)
Parameters:
tokenStorage - The tokenStorage to set.

getWstVersion

public int getWstVersion()
Returns:
Returns the wstVersion.

setWstVersion

public void setWstVersion(int wstVersion)
Deprecated. This is defined by the class.

Parameters:
wstVersion - The wstVersion to set.

getSecConvVersion

public int getSecConvVersion()
Returns:
Returns the secConvVersion.

getServicePolicy

public org.apache.neethi.Policy getServicePolicy()
Returns:
Returns the servicePolicy.

setServicePolicy

public void setServicePolicy(org.apache.neethi.Policy servicePolicy)
Deprecated. servicePolicy determined in constructor

Parameters:
servicePolicy - The servicePolicy to set.

getTimestampId

public java.lang.String getTimestampId()
Returns:
Returns the timestampId.

setTimestampId

public void setTimestampId(java.lang.String timestampId)
Parameters:
timestampId - The timestampId to set.

isInitiator

public boolean isInitiator()
Returns:
Returns the Initiator value

getCustomClassLoader

public java.lang.ClassLoader getCustomClassLoader()
Returns the custom class loader if we are using one

Returns:
Returns the custom class loader if we are using one

getSoapConstants

public org.apache.ws.security.SOAPConstants getSoapConstants()
Returns an org.apache.ws.security.SOAPConstants instance with soap version information of this request.

Returns:
Returns soap version information of this request