|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.wsspi.wssecurity.auth.token.WSSToken
A default implementation of the Token
interface for processing security
tokens.
Token
Nested Class Summary | |
---|---|
protected class |
WSSToken.AttributesEnumerator
|
Field Summary | |
---|---|
protected java.util.HashMap |
_attributes
|
protected boolean |
_callerChecked
|
protected SoapSecurityException |
_error
|
protected java.lang.String |
_keyInfoType
|
protected boolean |
_processed
|
protected boolean |
_referenced
|
protected org.w3c.dom.Element |
_tokenelem
|
protected java.lang.String |
_tokenId
|
protected boolean |
_trusted
|
protected TokenConsumerConfig |
_usedTokenConsumer
|
protected TokenGeneratorConfig |
_usedTokenGenerator
|
protected boolean |
_usedToLogin
|
protected static short |
_version
|
protected javax.xml.namespace.QName |
_vtype
|
Constructor Summary | |
---|---|
WSSToken()
|
Method Summary | |
---|---|
java.lang.String[] |
addAttribute(java.lang.String key,
java.lang.String value)
Adds an attribute in the form of a key-value pair. |
java.lang.Object |
clone()
Returns a copy of this class instance |
java.util.Enumeration |
getAttributeNames()
Returns the enumeration of attribute names. |
java.lang.String[] |
getAttributes(java.lang.String key)
Returns the attributes of the specified key. |
byte[] |
getBytes()
Returns the byte array representation of this token if possible. |
boolean |
getCallerChecked()
Returns if the caller check has been done or not. |
org.w3c.dom.Element |
getElement()
Returns DOM expression of the token. |
SoapSecurityException |
getError()
Returns the error that occurs during token processing. |
java.lang.String |
getId()
Returns id string of this token. |
java.lang.String |
getKeyInfoType()
Gets the KeyInfo's type. |
java.lang.String |
getName()
Returns the implementation class name |
javax.xml.namespace.QName |
getType()
Returns the value type of the token in the form of a QName object. |
TokenConsumerConfig |
getUsedTokenConsumer()
Returns the configuration of token consumer. |
TokenGeneratorConfig |
getUsedTokenGenerator()
Returns the configuration of token generator. |
boolean |
getUsedToLogin()
Checks whether the token is used to login or not. |
short |
getVersion()
Returns the implementation version |
boolean |
isForwardable()
Checks if the token is forwardable or not |
boolean |
isProcessed()
Returns if the token is processed or not. |
boolean |
isReferenced()
Returns if the token is referenced in the message or not. |
boolean |
isTrusted()
Returns auth required flag |
void |
setCallerChecked(boolean isCallerChecked)
Sets the whether the caller check has been done or not. |
void |
setElement(org.w3c.dom.Element elem)
Sets DOM expression of the token. |
void |
setError(SoapSecurityException error)
Sets the error that occurs during token processing. |
void |
setId(java.lang.String tid)
Sets id string of this token. |
void |
setKeyInfoType(java.lang.String keyInfoType)
Sets the KeyInfo's type. |
void |
setProcessed(boolean isProcessed)
Sets if the token is processed or not. |
void |
setReferenced(boolean isReferenced)
Sets whether the token is referenced in the message or not. |
void |
setTrusted(boolean trusted)
Sets auth required flag. |
void |
setType(javax.xml.namespace.QName type)
Sets the value type of the token in the form of a QName object. |
void |
setType(java.lang.String uri,
java.lang.String localName)
Sets the value type of the token by a URI -- local name pair (i.e., qname). |
void |
setUsedTokenConsumer(TokenConsumerConfig usedConfig)
Sets the configuration of token consumer. |
void |
setUsedTokenGenerator(TokenGeneratorConfig usedConfig)
Sets the configuration of token generator. |
void |
setUsedToLogin(boolean usedToLogin)
Sets the flag that indicates whether the token is used to login. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.wsspi.security.token.Token |
---|
getExpiration, getPrincipal, getUniqueID, isValid, setReadOnly |
Field Detail |
protected static final short _version
protected java.util.HashMap _attributes
protected java.lang.String _tokenId
protected org.w3c.dom.Element _tokenelem
protected javax.xml.namespace.QName _vtype
protected java.lang.String _keyInfoType
protected boolean _trusted
protected boolean _usedToLogin
protected boolean _callerChecked
protected boolean _referenced
protected TokenGeneratorConfig _usedTokenGenerator
protected TokenConsumerConfig _usedTokenConsumer
protected boolean _processed
protected SoapSecurityException _error
Constructor Detail |
public WSSToken()
Method Detail |
public java.lang.String getId()
getId
in interface Token
public void setId(java.lang.String tid)
setId
in interface Token
tid
- public org.w3c.dom.Element getElement()
getElement
in interface Token
Element
objectpublic void setElement(org.w3c.dom.Element elem)
setElement
in interface Token
elem
- An Element
of the token itselfpublic javax.xml.namespace.QName getType()
QName
object.
getType
in interface Token
public void setType(javax.xml.namespace.QName type)
QName
object.
setType
in interface Token
type
- a qname of the tokenpublic void setType(java.lang.String uri, java.lang.String localName)
setType
in interface Token
uri
- localName
- public java.lang.String getKeyInfoType()
getKeyInfoType
in interface Token
public void setKeyInfoType(java.lang.String keyInfoType)
setKeyInfoType
in interface Token
keyInfoType
- The KeyInfo's type
public byte[] getBytes()
getBytes
in interface com.ibm.wsspi.security.token.Token
public java.lang.String getName()
getName
in interface com.ibm.wsspi.security.token.Token
public short getVersion()
getVersion
in interface com.ibm.wsspi.security.token.Token
public boolean isForwardable()
isForwardable
in interface com.ibm.wsspi.security.token.Token
public java.lang.Object clone()
clone
in interface com.ibm.wsspi.security.token.Token
public void setTrusted(boolean trusted)
setTrusted
in interface Token
trusted
- True if auth is required, false otherwisepublic boolean isTrusted()
isTrusted
in interface Token
public void setUsedToLogin(boolean usedToLogin)
setUsedToLogin
in interface Token
usedToLogin
- True if the token is used to login, false otherwisepublic boolean getUsedToLogin()
getUsedToLogin
in interface Token
public java.util.Enumeration getAttributeNames()
getAttributeNames
in interface com.ibm.wsspi.security.token.Token
public java.lang.String[] getAttributes(java.lang.String key)
getAttributes
in interface com.ibm.wsspi.security.token.Token
key
- The key of the attributes to retrieve
String[]
of attributes of the specified keypublic java.lang.String[] addAttribute(java.lang.String key, java.lang.String value)
addAttribute
in interface com.ibm.wsspi.security.token.Token
key
- The key of the attribute to addvalue
- The value of the attribute to add
String[]
representation of the set of attributespublic void setCallerChecked(boolean isCallerChecked)
setCallerChecked
in interface Token
isCallerChecked
- True if caller check has been done, false otherwisepublic boolean getCallerChecked()
getCallerChecked
in interface Token
public boolean isReferenced()
isReferenced
in interface Token
public void setReferenced(boolean isReferenced)
setReferenced
in interface Token
isReferenced
- True if the token is referenced, false otherwisepublic TokenGeneratorConfig getUsedTokenGenerator()
getUsedTokenGenerator
in interface Token
public void setUsedTokenGenerator(TokenGeneratorConfig usedConfig)
setUsedTokenGenerator
in interface Token
usedConfig
- The token generator configurationpublic TokenConsumerConfig getUsedTokenConsumer()
getUsedTokenConsumer
in interface Token
public void setUsedTokenConsumer(TokenConsumerConfig usedConfig)
setUsedTokenConsumer
in interface Token
usedConfig
- The token consumer configurationpublic boolean isProcessed()
isProcessed
in interface Token
public void setProcessed(boolean isProcessed)
setProcessed
in interface Token
isProcessed
- True if the token is processed, false otherwisepublic SoapSecurityException getError()
getError
in interface Token
public void setError(SoapSecurityException error)
setError
in interface Token
error
- The SoapSecurityException that occured during token processing
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |