com.sun.xml.wss.impl.policy.mls
Class AuthenticationTokenPolicy.SAMLAssertionBinding

java.lang.Object
  com.sun.xml.wss.impl.policy.MLSPolicy
      com.sun.xml.wss.impl.policy.mls.WSSPolicy
          com.sun.xml.wss.impl.policy.mls.KeyBindingBase
              com.sun.xml.wss.impl.policy.mls.AuthenticationTokenPolicy.SAMLAssertionBinding

All Implemented Interfaces:

LazyKeyBinding, SecurityPolicy, java.lang.Cloneable

Enclosing class:

AuthenticationTokenPolicy

public static class AuthenticationTokenPolicy.SAMLAssertionBinding
extends KeyBindingBase
implements LazyKeyBinding

A policy representing a SAML Assertion. An instance of this class can be used as concrete feature binding for an AuthenticationTokenPolicy.

Field Summary

static java.lang.String	HOK_ASSERTION Holder-Of-Key Subject ConfirmationMethod
static java.lang.String	SV_ASSERTION Sender-Vouches Subject ConfirmationMethod
static java.lang.String	V10_ASSERTION
static java.lang.String	V11_ASSERTION
static java.lang.String	V20_ASSERTION

Fields inherited from class com.sun.xml.wss.impl.policy.mls.KeyBindingBase

claims, claimsDialect, INCLUDE_ALWAYS, INCLUDE_ALWAYS_TO_RECIPIENT, INCLUDE_ALWAYS_TO_RECIPIENT_VER2, INCLUDE_ALWAYS_VER2, INCLUDE_NEVER, INCLUDE_NEVER_VER2, INCLUDE_ONCE, INCLUDE_ONCE_VER2, includeToken, issuer, policyToken

Fields inherited from class com.sun.xml.wss.impl.policy.mls.WSSPolicy

_featureBinding, _isOptional, _keyBinding, _policyIdentifier, bsp, UUID

Fields inherited from class com.sun.xml.wss.impl.policy.MLSPolicy

readonly

Constructor Summary

AuthenticationTokenPolicy.SAMLAssertionBinding()
Default constructor

AuthenticationTokenPolicy.SAMLAssertionBinding(java.lang.String type, java.lang.String keyIdentifier, java.lang.String authorityIdentifier, java.lang.String referenceType)
Constructor

Method Summary

java.lang.Object	clone() clone operatror
boolean	equals(WSSPolicy policy) equals operator
boolean	equalsIgnoreTargets(WSSPolicy binding)
org.w3c.dom.Element	get_assertion()
org.w3c.dom.Element	getAssertion()
java.lang.String	getAssertionId() A CallbackHandler can choose to just set the AuthorityBinding and the AssertionId, and not set the actual assertion
javax.xml.stream.XMLStreamReader	getAssertionReader()
java.lang.String	getAssertionType()
org.w3c.dom.Element	getAuthorityBinding()
java.lang.String	getAuthorityIdentifier()
java.lang.String	getKeyAlgorithm()
java.lang.String	getKeyIdentifier()
java.lang.String	getRealId()
java.lang.String	getReferenceType()
java.lang.String	getSAMLVersion()
java.lang.String	getSTRID()
java.lang.String	getType() Get the type of the policy.
MLSPolicy	newPrivateKeyBinding() Create and set the KeyBinding for this WSSPolicy to a PrivateKeyBinding
void	setAssertion(org.w3c.dom.Element assertion) set the SAML Assertion
void	setAssertion(javax.xml.stream.XMLStreamReader reader)
void	setAssertionId(java.lang.String id) set the AssertionId for the possibly remote assertion A CallbackHandler can choose to just set the AuthorityBinding and the AssertionId, and not set the actual assertion
void	setAssertionType(java.lang.String type) set the SubjectConfirmation type of the SAML assertion
void	setAuthorityBinding(org.w3c.dom.Element authorityBinding) set the SAML AuthorityBinding element, identifying a remote assertion
void	setAuthorityIdentifier(java.lang.String uri) set the abstract identifier for the issuing authority
void	setKeyAlgorithm(java.lang.String algorithm) set the keyAlgorithm to be used
void	setKeyIdentifier(java.lang.String ki) set the abstract identifier for the Confirmation Key
void	setRealId(java.lang.String realId)
void	setReferenceType(java.lang.String rtype) set the ReferenceType to be used for references to the SAML Assertion
void	setSAMLVersion(java.lang.String ver)
void	setSTRID(java.lang.String id)
java.lang.String	toString()

Methods inherited from class com.sun.xml.wss.impl.policy.mls.KeyBindingBase

getClaims, getIncludeToken, getIssuer, policyTokenWasSet, setClaims, setIncludeToken, setIssuer, setPolicyTokenFlag

Methods inherited from class com.sun.xml.wss.impl.policy.mls.WSSPolicy

getFeatureBinding, getKeyBinding, getPolicyIdentifier, getUUID, isBSP, isBSP, isOptional, isOptional, setFeatureBinding, setKeyBinding, setPolicyIdentifier, setUUID

Methods inherited from class com.sun.xml.wss.impl.policy.MLSPolicy

isReadOnly, isReadOnly

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

V10_ASSERTION

public static final java.lang.String V10_ASSERTION

See Also:

Constant Field Values

V11_ASSERTION

public static final java.lang.String V11_ASSERTION

See Also:

Constant Field Values

V20_ASSERTION

public static final java.lang.String V20_ASSERTION

See Also:

Constant Field Values

SV_ASSERTION

public static final java.lang.String SV_ASSERTION

Sender-Vouches Subject ConfirmationMethod

See Also:

Constant Field Values

HOK_ASSERTION

public static final java.lang.String HOK_ASSERTION

Holder-Of-Key Subject ConfirmationMethod

See Also:

Constant Field Values

Constructor Detail

AuthenticationTokenPolicy.SAMLAssertionBinding

public AuthenticationTokenPolicy.SAMLAssertionBinding()

Default constructor

AuthenticationTokenPolicy.SAMLAssertionBinding

public AuthenticationTokenPolicy.SAMLAssertionBinding(java.lang.String type,
                                                      java.lang.String keyIdentifier,
                                                      java.lang.String authorityIdentifier,
                                                      java.lang.String referenceType)

Constructor

Parameters:

type - the SubjectConfirmation type of the SAML assertion, one of SV, HOK

keyIdentifier - an abstract identifier for the Confirmation Key

authorityIdentifier - an abstract identifier for the issuing authority

referenceType - the reference type for references to the SAML Assertion, should be one of KeyIdentifier, Embedded reference type as defined by WSS SAML Token profile 1.0.

Method Detail

setAssertionType

public void setAssertionType(java.lang.String type)

set the SubjectConfirmation type of the SAML assertion

Parameters:

type - the SubjectConfirmation type of the SAML assertion, one of SV, HOK

setSAMLVersion

public void setSAMLVersion(java.lang.String ver)

getSAMLVersion

public java.lang.String getSAMLVersion()

newPrivateKeyBinding

public MLSPolicy newPrivateKeyBinding()

Create and set the KeyBinding for this WSSPolicy to a PrivateKeyBinding

Returns:

a new PrivateKeyBinding as a KeyBinding for this WSSPolicy

setKeyIdentifier

public void setKeyIdentifier(java.lang.String ki)

set the abstract identifier for the Confirmation Key

Parameters:

ki - the abstract identifier for the Confirmation Key

setAuthorityIdentifier

public void setAuthorityIdentifier(java.lang.String uri)

set the abstract identifier for the issuing authority

Parameters:

uri - the URI of the Assertion Issuer

setReferenceType

public void setReferenceType(java.lang.String rtype)

set the ReferenceType to be used for references to the SAML Assertion

Parameters:

rtype - reference type (one of KeyIdentifier, Embedded)

setAuthorityBinding

public void setAuthorityBinding(org.w3c.dom.Element authorityBinding)

set the SAML AuthorityBinding element, identifying a remote assertion

Parameters:

authorityBinding -

setAssertion

public void setAssertion(org.w3c.dom.Element assertion)

set the SAML Assertion

Parameters:

assertion - the SAML Assertion

setAssertion

public void setAssertion(javax.xml.stream.XMLStreamReader reader)

setKeyAlgorithm

public void setKeyAlgorithm(java.lang.String algorithm)

set the keyAlgorithm to be used

Parameters:

algorithm - the keyAlgorithm to be used

getKeyAlgorithm

public java.lang.String getKeyAlgorithm()

Returns:

key algorithm

getReferenceType

public java.lang.String getReferenceType()

Returns:

reference type

getAssertionType

public java.lang.String getAssertionType()

Returns:

type of SAMLAssertion (SV/HOK)

getKeyIdentifier

public java.lang.String getKeyIdentifier()

Returns:

identifier to key bound to the Assertion

getAuthorityIdentifier

public java.lang.String getAuthorityIdentifier()

Returns:

identifier to Authority issueing the Assertion

getAuthorityBinding

public org.w3c.dom.Element getAuthorityBinding()

Returns:

authority binding component of the assertion

getAssertion

public org.w3c.dom.Element getAssertion()

Returns:

SAML assertion

getAssertionReader

public javax.xml.stream.XMLStreamReader getAssertionReader()

equals

public boolean equals(WSSPolicy policy)

equals operator

Specified by:

equals in class WSSPolicy

Parameters:

policy - the policy to be compared for equality

Returns:

true if the argument policy is equal to this

See Also:

SignaturePolicy, EncryptionPolicy, AuthenticationTokenPolicy, PrivateKeyBinding, SymmetricKeyBinding

equalsIgnoreTargets

public boolean equalsIgnoreTargets(WSSPolicy binding)

Specified by:

equalsIgnoreTargets in class WSSPolicy

clone

public java.lang.Object clone()

Description copied from class: WSSPolicy

clone operatror

Specified by:

clone in class WSSPolicy

Returns:

clone of this SAML Policy

See Also:

SignaturePolicy, EncryptionPolicy, AuthenticationTokenPolicy

getType

public java.lang.String getType()

Description copied from interface: SecurityPolicy

Get the type of the policy.

Implementation Note: Useful to avoid instanceof checks and String.equals checks

Specified by:

getType in interface SecurityPolicy

Returns:

the type of the policy

setSTRID

public void setSTRID(java.lang.String id)

getSTRID

public java.lang.String getSTRID()

Specified by:

getSTRID in interface LazyKeyBinding

setAssertionId

public void setAssertionId(java.lang.String id)

set the AssertionId for the possibly remote assertion A CallbackHandler can choose to just set the AuthorityBinding and the AssertionId, and not set the actual assertion

Parameters:

id - the Assertion Id of the possibly remote SAML Assertion

getAssertionId

public java.lang.String getAssertionId()

A CallbackHandler can choose to just set the AuthorityBinding and the AssertionId, and not set the actual assertion

Returns:

the Assertion ID of the SAML Assertion represented by this Policy

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

get_assertion

public org.w3c.dom.Element get_assertion()

getRealId

public java.lang.String getRealId()

Specified by:

getRealId in interface LazyKeyBinding

setRealId

public void setRealId(java.lang.String realId)

Specified by:

setRealId in interface LazyKeyBinding