Package com.sun.xml.ws.security.impl.policy

Class SecureConversationToken

java.lang.Object

com.sun.xml.ws.policy.PolicyAssertion

com.sun.xml.ws.security.impl.policy.SecureConversationToken

All Implemented Interfaces:

SecureConversationToken, SecurityAssertionValidator, Token

public class SecureConversationToken
extends PolicyAssertion
implements SecureConversationToken, SecurityAssertionValidator

Author:

K.Venugopal@sun.com

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.xml.ws.security.policy.SecurityAssertionValidator

SecurityAssertionValidator.AssertionFitness

Field Summary

Fields inherited from interface com.sun.xml.ws.security.policy.Token

REQUIRE_DERIVED_KEYS, REQUIRE_EMBEDDED_TOKEN_REFERENCE, REQUIRE_EXTERNAL_REFERENCE, REQUIRE_EXTERNAL_URI_REFERENCE, REQUIRE_INTERNAL_REFERENCE, REQUIRE_ISSUER_SERIAL_REFERENCE, REQUIRE_KEY_IDENTIFIER_REFERENCE, REQUIRE_THUMBPRINT_REFERENCE, RSA_KEYVALUE_TOKEN, SC10_SECURITYCONTEXT_TOKEN, WSS_REL_V10_TOKEN10, WSS_REL_V10_TOKEN11, WSS_REL_V20_TOKEN10, WSS_REL_V20_TOKEN11, WSS_SAML_V10_TOKEN10, WSS_SAML_V10_TOKEN11, WSS_SAML_V11_TOKEN10, WSS_SAML_V11_TOKEN11, WSS_SAML_V20_TOKEN11, WSS_USERNAME_TOKEN_10, WSS_USERNAME_TOKEN_11, WSS10, WSS11, WSSKERBEROS_GSS_V5_AP_REQ_TOKEN11, WSSKERBEROS_V5_AP_REQ_TOKEN11, WSSX509PKCS7TOKEN10, WSSX509PKCS7TOKEN11, WSSX509PKIPATHV1TOKEN10, WSSX509PKIPATHV1TOKEN11, WSSX509V1TOKEN10, WSSX509V1TOKEN11, WSSX509V3TOKEN10, WSSX509V3TOKEN11

Constructor Summary

Constructors

Constructor	Description
SecureConversationToken()	Creates a new instance of SecureConversationToken
SecureConversationToken(AssertionData name, Collection<PolicyAssertion> nestedAssertions, AssertionSet nestedAlternative)

Method Summary

Modifier and Type	Method	Description
NestedPolicy	getBootstrapPolicy()	returns Policy which represents Bootstrap Policy
Claims	getClaims()
String	getIncludeToken()	returns the token inclusion value
Issuer	getIssuer()	returns the issuer for the SecureConversation token.
IssuerName	getIssuerName()
SecurityPolicyVersion	getSecurityPolicyVersion()
String	getTokenId()	Unique Id assigned to the token.
Set	getTokenRefernceTypes()	returns a Iterator over the token reference types to be used.
String	getTokenType()	returns the type of the token.
boolean	isMustNotSendCancel()	returns true if isMustNotSendCancel element is present under SecureConversationToken
boolean	isMustNotSendRenew()	returns true if isMustNotSendRenew element is present under SecureConversationToken
boolean	isRequireDerivedKeys()	returns true if RequiredDerivedKey element is present under SecureConversationToken
void	setIncludeToken(String type)
SecurityAssertionValidator.AssertionFitness	validate(boolean isServer)	returns true if all the assertions embeeded under a SecurityPolicy assertion are valid and supported by the implementation.

Methods inherited from class com.sun.xml.ws.policy.PolicyAssertion

equals, getAttributes, getAttributesSet, getAttributeValue, getImplementation, getName, getNestedAssertionsIterator, getNestedPolicy, getParametersIterator, getValue, hashCode, hasNestedAssertions, hasNestedPolicy, hasParameters, isIgnorable, isOptional, isPrivate, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SecureConversationToken

public SecureConversationToken()

Creates a new instance of SecureConversationToken

SecureConversationToken

public SecureConversationToken(AssertionData name,
 Collection<PolicyAssertion> nestedAssertions,
 AssertionSet nestedAlternative)

Method Details

getTokenRefernceTypes

public Set getTokenRefernceTypes()

Description copied from interface: SecureConversationToken

returns a Iterator over the token reference types to be used.

Specified by:

getTokenRefernceTypes in interface SecureConversationToken

Returns:

either REQUIRE_EXTERNAL_URI_REFERENCE

isRequireDerivedKeys

public boolean isRequireDerivedKeys()

Description copied from interface: SecureConversationToken

returns true if RequiredDerivedKey element is present under SecureConversationToken

Specified by:

isRequireDerivedKeys in interface SecureConversationToken

Returns:

true if RequireDerviedKeys element is present under SecureConversationToken or false.

isMustNotSendCancel

public boolean isMustNotSendCancel()

Description copied from interface: SecureConversationToken

returns true if isMustNotSendCancel element is present under SecureConversationToken

Specified by:

isMustNotSendCancel in interface SecureConversationToken

Returns:

true if isMustNotSendCancel element is present under SecureConversationToken or false.

isMustNotSendRenew

public boolean isMustNotSendRenew()

Description copied from interface: SecureConversationToken

returns true if isMustNotSendRenew element is present under SecureConversationToken

Specified by:

isMustNotSendRenew in interface SecureConversationToken

Returns:

true if isMustNotSendRenew element is present under SecureConversationToken or false.

getTokenType

public String getTokenType()

Description copied from interface: SecureConversationToken

returns the type of the token.

Specified by:

getTokenType in interface SecureConversationToken

Returns:

one of SC10_SECURITYCONTEXT_TOKEN

getIssuer

public Issuer getIssuer()

Description copied from interface: SecureConversationToken

returns the issuer for the SecureConversation token.

Specified by:

getIssuer in interface SecureConversationToken

Returns:

returns the issuer

getIssuerName

public IssuerName getIssuerName()

Specified by:

getIssuerName in interface SecureConversationToken

Returns:

the issuer name for SecureConversation token

getClaims

public Claims getClaims()

Specified by:

getClaims in interface SecureConversationToken

Returns:

Claims

getIncludeToken

public String getIncludeToken()

Description copied from interface: Token

returns the token inclusion value

Specified by:

getIncludeToken in interface Token

Returns:

one of ONCE,NEVER,ALWAYS_TO_RECIPIENT,ALWAYS

setIncludeToken

public void setIncludeToken(String type)

getBootstrapPolicy

public NestedPolicy getBootstrapPolicy()

Description copied from interface: SecureConversationToken

returns Policy which represents Bootstrap Policy

Specified by:

getBootstrapPolicy in interface SecureConversationToken

Returns:

Policy

getTokenId

public String getTokenId()

Description copied from interface: Token

Unique Id assigned to the token.

Specified by:

getTokenId in interface Token

Returns:

String representation of the token id.

validate

public SecurityAssertionValidator.AssertionFitness validate(boolean isServer)

Description copied from interface: SecurityAssertionValidator

returns true if all the assertions embeeded under a SecurityPolicy assertion are valid and supported by the implementation.

Specified by:

validate in interface SecurityAssertionValidator

getSecurityPolicyVersion

public SecurityPolicyVersion getSecurityPolicyVersion()

Specified by:

getSecurityPolicyVersion in interface Token

Returns:

version of SecurityPolicy being used