Package com.sun.xml.wss.impl.policy.mls

Class PrivateKeyBinding

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.PrivateKeyBinding

All Implemented Interfaces:

SecurityPolicy, Cloneable

public class PrivateKeyBinding
extends WSSPolicy

Objects of this class act as KeyBindings for AuthenticationTokens such as AuthenticationTokenPolicy.X509CertificateBinding and AuthenticationTokenPolicy.SAMLAssertionBinding. When associated with an AuthenticationToken they represent the PrivateKey associated with the AuthenticationToken.

Field Summary

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

Constructors

Constructor	Description
PrivateKeyBinding()	Default constructor
PrivateKeyBinding(String keyIdentifier, String keyAlgorithm)	Constructor

Method Summary

Modifier and Type	Method	Description
Object	clone()	clone operator
boolean	equals(WSSPolicy binding)	equality operator
boolean	equalsIgnoreTargets(WSSPolicy binding)
String	getKeyAlgorithm()
String	getKeyIdentifier()
PrivateKey	getPrivateKey()
String	getType()	Get the type of the policy.
void	setKeyAlgorithm(String keyAlgorithm)	set the KeyAlgorithm of this Private Key.
void	setKeyIdentifier(String keyIdentifier)	set the keyIdentifier for the Private Key
void	setPrivateKey(PrivateKey privateKey)	set the private key instance
String	toString()

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

Constructor Detail

PrivateKeyBinding

public PrivateKeyBinding()

Default constructor

PrivateKeyBinding

public PrivateKeyBinding(String keyIdentifier,
                         String keyAlgorithm)

Constructor

Parameters:

keyIdentifier - identifier for the Private Key

keyAlgorithm - identified for the Key Algorithm

Method Detail

setKeyIdentifier

public void setKeyIdentifier(String keyIdentifier)

set the keyIdentifier for the Private Key

Parameters:

keyIdentifier - Key Identifier for the Private Key

getKeyIdentifier

public String getKeyIdentifier()

Returns:

key identifier for the Private Key

setKeyAlgorithm

public void setKeyAlgorithm(String keyAlgorithm)

set the KeyAlgorithm of this Private Key. Implementation Note: This KeyAlgorithm is not used by XWS-Runtime, refer setKeyAlgorithm on X509CertificateBinding, SAMLAssertionBinding, and SymmetricKeyBinding instead.

Parameters:

keyAlgorithm - KeyAlgorithm of this Private Key

getKeyAlgorithm

public String getKeyAlgorithm()

Returns:

KeyAlgorithm of this Private Key

setPrivateKey

public void setPrivateKey(PrivateKey privateKey)

set the private key instance

Parameters:

privateKey - PrivateKey for this PrivateKeyBinding

getPrivateKey

public PrivateKey getPrivateKey()

Returns:

PrivateKey associated with this PrivateKeyBinding

equals

public boolean equals(WSSPolicy binding)

equality operator

Specified by:

equals in class WSSPolicy

Parameters:

binding - the Policy to be checked for equality

Returns:

true if the argument binding is equal to this PrivateKeyBinding.

See Also:

SignaturePolicy, EncryptionPolicy, AuthenticationTokenPolicy, PrivateKeyBinding, SymmetricKeyBinding

equalsIgnoreTargets

public boolean equalsIgnoreTargets(WSSPolicy binding)

Specified by:

equalsIgnoreTargets in class WSSPolicy

clone

public Object clone()

clone operator

Specified by:

clone in class WSSPolicy

Returns:

a clone of this PrivateKeyBinding

See Also:

SignaturePolicy, EncryptionPolicy, AuthenticationTokenPolicy

getType

public String getType()

Description copied from interface: SecurityPolicy

Get the type of the policy.

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

Returns:

the type of the policy

toString

public String toString()

Overrides:

toString in class Object