com.ibm.wsspi.wssecurity.auth.token
Class X509BSToken

java.lang.Object
  extended bycom.ibm.wsspi.wssecurity.auth.token.WSSToken
      extended bycom.ibm.wsspi.wssecurity.auth.token.X509BSToken
All Implemented Interfaces:
java.lang.Cloneable, com.ibm.wsspi.security.token.PropagationToken, Token, com.ibm.wsspi.security.token.Token

public class X509BSToken
extends WSSToken

This class is a token object implementation for X.509 binary security tokens. It extends the WSSToken class, which implements the Token class. It will typically be created by the X509TokenGenerator and process by the X509TokenConsumer.

See Also:
WSSToken, Token

Nested Class Summary
 
Nested classes inherited from class com.ibm.wsspi.wssecurity.auth.token.WSSToken
WSSToken.AttributesEnumerator
 
Field Summary
static java.lang.String CERT_INFO
           This is the key used when the X509 certificate is passed to from a KeyLocator object to a TokenConsumer object or from a TokenConsumer object to a LoginModule object.
static java.lang.String CERT_STORES
           This is the key used when the CertStore object is passed from a TokenGenerator object to a CallbackHandler object or from a TokenConsumer object to a LoginModule object.
static java.lang.String KEY_LOCATOR
           This is the key used when the object is passed to from a KeyInfoContentConsumer object to a TokenConsumer object.
static java.lang.String PKIX_BUILDERPARAM
           This is the key used when the PkiXBuilderParameter object is passed from a TokenConsumer object to a LoginModule object.
static java.lang.String PROVIDER
           This is the key used when the Provider object is passed from a TokenGenerator object to a CallbackHandler object or from a TokenConsumer object to a LoginModule object.
static java.lang.String TRUST_ANY
           This is the key used when the flag to indicate that any certificates are trusted is passed to from a TokenConsumer object to a LoginModule object.
 
Fields inherited from class com.ibm.wsspi.wssecurity.auth.token.WSSToken
_attributes, _callerChecked, _error, _keyInfoType, _processed, _referenced, _tokenelem, _tokenId, _trusted, _usedTokenConsumer, _usedTokenGenerator, _usedToLogin, _version, _vtype
 
Constructor Summary
X509BSToken(java.lang.String tokenId, java.security.cert.X509Certificate cert, javax.xml.namespace.QName vtype)
          Constructor
 
Method Summary
 boolean equals(java.lang.Object o)
           
 byte[] getBytes()
          Returns the byte array representation of this token if possible.
 java.security.cert.X509Certificate getCert()
          Gets the Certificate from X509 Binary Security Token
 long getExpiration()
           
 java.lang.String getPrincipal()
           
 java.lang.String getUniqueID()
           
 short getVersion()
          Returns the implementation version
 int hashCode()
           
 boolean isReadOnly()
           
 boolean isValid()
           
 void setBytes(byte[] binary)
           
 void setCert(java.security.cert.X509Certificate cert)
          Sets a reference to the X509Certificate object.
 void setExpiration(long expiration)
           
 void setReadOnly()
           
 java.lang.String toString()
           
 
Methods inherited from class com.ibm.wsspi.wssecurity.auth.token.WSSToken
addAttribute, clone, getAttributeNames, getAttributes, getCallerChecked, getElement, getError, getId, getKeyInfoType, getName, getType, getUsedTokenConsumer, getUsedTokenGenerator, getUsedToLogin, isForwardable, isProcessed, isReferenced, isTrusted, setCallerChecked, setElement, setError, setId, setKeyInfoType, setProcessed, setReferenced, setTrusted, setType, setType, setUsedTokenConsumer, setUsedTokenGenerator, setUsedToLogin
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

KEY_LOCATOR

public static final java.lang.String KEY_LOCATOR

This is the key used when the object is passed to from a KeyInfoContentConsumer object to a TokenConsumer object.

See Also:
Constant Field Values

CERT_INFO

public static final java.lang.String CERT_INFO

This is the key used when the X509 certificate is passed to from a KeyLocator object to a TokenConsumer object or from a TokenConsumer object to a LoginModule object.

See Also:
Constant Field Values

TRUST_ANY

public static final java.lang.String TRUST_ANY

This is the key used when the flag to indicate that any certificates are trusted is passed to from a TokenConsumer object to a LoginModule object.

See Also:
Constant Field Values

PROVIDER

public static final java.lang.String PROVIDER

This is the key used when the Provider object is passed from a TokenGenerator object to a CallbackHandler object or from a TokenConsumer object to a LoginModule object.

See Also:
Constant Field Values

PKIX_BUILDERPARAM

public static final java.lang.String PKIX_BUILDERPARAM

This is the key used when the PkiXBuilderParameter object is passed from a TokenConsumer object to a LoginModule object.

See Also:
Constant Field Values

CERT_STORES

public static final java.lang.String CERT_STORES

This is the key used when the CertStore object is passed from a TokenGenerator object to a CallbackHandler object or from a TokenConsumer object to a LoginModule object.

See Also:
Constant Field Values
Constructor Detail

X509BSToken

public X509BSToken(java.lang.String tokenId,
                   java.security.cert.X509Certificate cert,
                   javax.xml.namespace.QName vtype)
Constructor

Parameters:
tokenId -
cert -
vtype -
Method Detail

getCert

public java.security.cert.X509Certificate getCert()
                                           throws SoapSecurityException
Gets the Certificate from X509 Binary Security Token

Returns:
X509Certificate
Throws:
SoapSecurityException

setCert

public void setCert(java.security.cert.X509Certificate cert)
Sets a reference to the X509Certificate object.

Parameters:
cert - X509Certificate object

getBytes

public byte[] getBytes()
Description copied from class: WSSToken
Returns the byte array representation of this token if possible.

Specified by:
getBytes in interface com.ibm.wsspi.security.token.Token
Overrides:
getBytes in class WSSToken
Returns:
The byte array representation of this token

setBytes

public void setBytes(byte[] binary)

getExpiration

public long getExpiration()

setExpiration

public void setExpiration(long expiration)

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly()

getPrincipal

public java.lang.String getPrincipal()

getUniqueID

public java.lang.String getUniqueID()

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object o)

isValid

public boolean isValid()

getVersion

public short getVersion()
Description copied from class: WSSToken
Returns the implementation version

Specified by:
getVersion in interface com.ibm.wsspi.security.token.Token
Overrides:
getVersion in class WSSToken
Returns:
The implementation version

toString

public java.lang.String toString()