Package org.apache.rampart

Class RampartMessageData

java.lang.Object

org.apache.rampart.RampartMessageData

public class RampartMessageData
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_NAMESPACE_QUALIFIED_PASSWORDTYPES
static final String	ALLOW_RSA15_KEY_TRANSPORT_ALGORITHM
static final String	ALLOW_USERNAME_TOKEN_NO_PASSWORD
static final String	CANCEL_REQUEST
static final String	CUSTOM_WS_TIME_SOURCE	Key to hold the WSTimeSource
static final String	DISABLE_BSP_ENFORCEMENT	Key to hold the BSP compliance
static final String	ENCODE_PASSWORDS
static final String	HANDLE_CUSTOM_PASSWORD_TYPES
static final String	KEY_CUSTOM_ISSUED_TOKEN	Key to hold the custom issued token identifier
static final String	KEY_RAMPART_IN_POLICY
static final String	KEY_RAMPART_OUT_POLICY
static final String	KEY_RAMPART_POLICY	Axis2 parameter name to be used in the client's axis2 xml
static final String	KEY_SCT_ISSUER_POLICY
static final String	KEY_WSSC_VERSION	Key to hold the WS-SecConv version
static final String	KEY_WST_VERSION	Key to hold the WS-Trust version
static final String	MUST_UNDERSTAND_SECURITY_HEADER
static final String	PARAM_CLIENT_SIDE
static final String	RAMPART_POLICY_DATA	Key to hold the populated RampartPolicyData object
static final String	RAMPART_STS_POLICY
static final String	SCT_ID
static final String	SIGNATURE_CERT_ALIAS
static final String	TIMESTAMP_FUTURE_TTL
static final String	TIMESTAMP_PRECISION_IN_MS
static final String	TIMESTAMP_STRICT
static final String	USERNAME	Key to hold username which was used to authenticate
static final String	UT_FUTURE_TTL
static final String	UT_TTL
static final String	VALIDATE_SAML_SUBJECT_CONFIRMATION
static final String	X509_CERT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
org.apache.wss4j.dom.engine.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.wss4j.dom.message.WSSecHeader	getSecHeader()
org.apache.neethi.Policy	getServicePolicy()
org.apache.wss4j.dom.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.wss4j.dom.engine.WSSConfig config)
void	setIssuedEncryptionTokenId(String issuedEncryptionTokenId)
void	setIssuedSignatureTokenId(String issuedSignatureTokenId)
void	setSecConvTokenId(String secConvTokenId)
void	setSecHeader(org.apache.wss4j.dom.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 Details

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

CUSTOM_WS_TIME_SOURCE

public static final String CUSTOM_WS_TIME_SOURCE

Key to hold the WSTimeSource

See Also:

• Constant Field Values

DISABLE_BSP_ENFORCEMENT

public static final String DISABLE_BSP_ENFORCEMENT

Key to hold the BSP compliance

See Also:

• Constant Field Values

TIMESTAMP_STRICT

public static final String TIMESTAMP_STRICT

See Also:

• Constant Field Values

TIMESTAMP_PRECISION_IN_MS

public static final String TIMESTAMP_PRECISION_IN_MS

See Also:

• Constant Field Values

ALLOW_USERNAME_TOKEN_NO_PASSWORD

public static final String ALLOW_USERNAME_TOKEN_NO_PASSWORD

See Also:

• Constant Field Values

TIMESTAMP_FUTURE_TTL

public static final String TIMESTAMP_FUTURE_TTL

See Also:

• Constant Field Values

UT_TTL

public static final String UT_TTL

See Also:

• Constant Field Values

UT_FUTURE_TTL

public static final String UT_FUTURE_TTL

See Also:

• Constant Field Values

HANDLE_CUSTOM_PASSWORD_TYPES

public static final String HANDLE_CUSTOM_PASSWORD_TYPES

See Also:

• Constant Field Values

ALLOW_NAMESPACE_QUALIFIED_PASSWORDTYPES

public static final String ALLOW_NAMESPACE_QUALIFIED_PASSWORDTYPES

See Also:

• Constant Field Values

ENCODE_PASSWORDS

public static final String ENCODE_PASSWORDS

See Also:

• Constant Field Values

VALIDATE_SAML_SUBJECT_CONFIRMATION

public static final String VALIDATE_SAML_SUBJECT_CONFIRMATION

See Also:

• Constant Field Values

ALLOW_RSA15_KEY_TRANSPORT_ALGORITHM

public static final String ALLOW_RSA15_KEY_TRANSPORT_ALGORITHM

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

MUST_UNDERSTAND_SECURITY_HEADER

public static final String MUST_UNDERSTAND_SECURITY_HEADER

See Also:

• Constant Field Values

Constructor Details

RampartMessageData

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

Throws:

RampartException

Method Details

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.wss4j.dom.engine.WSSConfig getConfig()

Returns:

Returns the config.

setConfig

public void setConfig(org.apache.wss4j.dom.engine.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.wss4j.dom.message.WSSecHeader getSecHeader()

Returns:

Returns the secHeader.

setSecHeader

public void setSecHeader(org.apache.wss4j.dom.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 - If an error occurs getting TokenStorage

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.wss4j.dom.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