RampartMessageData (Apache Rampart)

java.lang.Object
- org.apache.rampart.RampartMessageData

public class RampartMessageData
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CANCEL_REQUEST`
`static String`	`KEY_CUSTOM_ISSUED_TOKEN` Key to hold the custom issued token identifier
`static String`	`KEY_RAMPART_IN_POLICY`
`static String`	`KEY_RAMPART_OUT_POLICY`
`static String`	`KEY_RAMPART_POLICY` Axis2 parameter name to be used in the client's axis2 xml
`static String`	`KEY_SCT_ISSUER_POLICY`
`static String`	`KEY_WSSC_VERSION` Key to hold the WS-SecConv version
`static String`	`KEY_WST_VERSION` Key to hold the WS-Trust version
`static String`	`PARAM_CLIENT_SIDE`
`static String`	`RAMPART_POLICY_DATA` Key to hold the populated RampartPolicyData object
`static String`	`RAMPART_STS_POLICY`
`static String`	`SCT_ID`
`static String`	`SIGNATURE_CERT_ALIAS`
`static String`	`USERNAME` Key to hold username which was used to authenticate
`static String`	`X509_CERT`

Constructor Summary

Constructors
Constructor and Description

RampartMessageData(org.apache.axis2.context.MessageContext msgCtx, boolean sender)

Constructors
Constructor and Description
`RampartMessageData(org.apache.axis2.context.MessageContext msgCtx, boolean sender)`

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.ws.security.WSSConfig`	`getConfig()`
`ClassLoader`	`getCustomClassLoader()` Returns the custom class loader if we are using one
`Document`	`getDocument()`
`String`	`getIssuedEncryptionTokenId()`
`String`	`getIssuedSignatureTokenId()`
`org.apache.axis2.context.MessageContext`	`getMsgContext()`
`RampartPolicyData`	`getPolicyData()`
`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.
`String`	`getTimestampId()`
`int`	`getTimestampMaxSkew()`
`int`	`getTimeToLive()`
`TokenStorage`	`getTokenStorage()`
`int`	`getWstVersion()`
`boolean`	`isInitiator()`
`void`	`setConfig(org.apache.ws.security.WSSConfig config)`
`void`	`setIssuedEncryptionTokenId(String issuedEncryptionTokenId)`
`void`	`setIssuedSignatureTokenId(String issuedSignatureTokenId)`
`void`	`setSecConvTokenId(String secConvTokenId)`
`void`	`setSecHeader(org.apache.ws.security.message.WSSecHeader secHeader)`
`void`	`setTimestampId(String timestampId)`
`void`	`setTimestampMaxSkew(int timestampMaxSkew)`
`void`	`setTimeToLive(int timeToLive)`
`void`	`setTokenStorage(TokenStorage tokenStorage)`

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 String KEY_RAMPART_POLICY
```
    Axis2 parameter name to be used in the client's axis2 xml
    
    See Also:
    Constant Field Values
  - KEY_RAMPART_IN_POLICY
```
public static final String KEY_RAMPART_IN_POLICY
```
    See Also:
    Constant Field Values
  - KEY_RAMPART_OUT_POLICY
```
public static final String KEY_RAMPART_OUT_POLICY
```
    See Also:
    Constant Field Values
  - RAMPART_POLICY_DATA
```
public static final String RAMPART_POLICY_DATA
```
    Key to hold the populated RampartPolicyData object
    
    See Also:
    Constant Field Values
  - RAMPART_STS_POLICY
```
public static final String RAMPART_STS_POLICY
```
    See Also:
    Constant Field Values
  - KEY_CUSTOM_ISSUED_TOKEN
```
public static final String KEY_CUSTOM_ISSUED_TOKEN
```
    Key to hold the custom issued token identifier
    
    See Also:
    Constant Field Values
  - USERNAME
```
public static final String USERNAME
```
    Key to hold username which was used to authenticate
    
    See Also:
    Constant Field Values
  - SIGNATURE_CERT_ALIAS
```
public static final String SIGNATURE_CERT_ALIAS
```
    See Also:
    Constant Field Values
  - KEY_WST_VERSION
```
public static final String KEY_WST_VERSION
```
    Key to hold the WS-Trust version
    
    See Also:
    Constant Field Values
  - PARAM_CLIENT_SIDE
```
public static final String PARAM_CLIENT_SIDE
```
    See Also:
    Constant Field Values
  - KEY_WSSC_VERSION
```
public static final String KEY_WSSC_VERSION
```
    Key to hold the WS-SecConv version
    
    See Also:
    Constant Field Values
  - KEY_SCT_ISSUER_POLICY
```
public static final String KEY_SCT_ISSUER_POLICY
```
    See Also:
    Constant Field Values
  - CANCEL_REQUEST
```
public static final String CANCEL_REQUEST
```
    See Also:
    Constant Field Values
  - SCT_ID
```
public static final String SCT_ID
```
    See Also:
    Constant Field Values
  - X509_CERT
```
public static final String X509_CERT
```
    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 Document getDocument()
```
    Returns:
    Returns the document.
  - 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.
  - getPolicyData
```
public RampartPolicyData getPolicyData()
```
    Returns:
    Returns the policyData.
  - 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 String getIssuedEncryptionTokenId()
```
    Returns:
    Returns the issuedEncryptionTokenId.
  - setIssuedEncryptionTokenId
```
public void setIssuedEncryptionTokenId(String issuedEncryptionTokenId)
```
    Parameters:
    issuedEncryptionTokenId - The issuedEncryptionTokenId to set.
  - getIssuedSignatureTokenId
```
public String getIssuedSignatureTokenId()
```
    Returns:
    Returns the issuedSignatureTokenId.
  - setIssuedSignatureTokenId
```
public void setIssuedSignatureTokenId(String issuedSignatureTokenId)
```
    Parameters:
    issuedSignatureTokenId - The issuedSignatureTokenId to set.
  - getSecConvTokenId
```
public String getSecConvTokenId()
```
    Returns:
    Returns the secConvTokenId.
  - setSecConvTokenId
```
public void setSecConvTokenId(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.
  - getSecConvVersion
```
public int getSecConvVersion()
```
    Returns:
    Returns the secConvVersion.
  - getServicePolicy
```
public org.apache.neethi.Policy getServicePolicy()
```
    Returns:
    Returns the servicePolicy.
  - getTimestampId
```
public String getTimestampId()
```
    Returns:
    Returns the timestampId.
  - setTimestampId
```
public void setTimestampId(String timestampId)
```
    Parameters:
    timestampId - The timestampId to set.
  - isInitiator
```
public boolean isInitiator()
```
    Returns:
    Returns the Initiator value
  - getCustomClassLoader
```
public 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

Class RampartMessageData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_RAMPART_POLICY

KEY_RAMPART_IN_POLICY

KEY_RAMPART_OUT_POLICY

RAMPART_POLICY_DATA

RAMPART_STS_POLICY

KEY_CUSTOM_ISSUED_TOKEN

USERNAME

SIGNATURE_CERT_ALIAS

KEY_WST_VERSION

PARAM_CLIENT_SIDE

KEY_WSSC_VERSION

KEY_SCT_ISSUER_POLICY

CANCEL_REQUEST

SCT_ID

X509_CERT

Constructor Detail

RampartMessageData

Method Detail

getDocument

getTimeToLive

setTimeToLive

getTimestampMaxSkew

setTimestampMaxSkew

getConfig

setConfig

getMsgContext

getPolicyData

getSecHeader

setSecHeader

getIssuedEncryptionTokenId

setIssuedEncryptionTokenId

getIssuedSignatureTokenId

setIssuedSignatureTokenId

getSecConvTokenId

setSecConvTokenId

getTokenStorage

setTokenStorage

getWstVersion

getSecConvVersion

getServicePolicy

getTimestampId

setTimestampId

isInitiator

getCustomClassLoader

getSoapConstants