|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
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
public abstract class WSSToken
A default implementation of the Token
interface for processing security
tokens.
Protected by following Java 2 Security permissions:
com.ibm.websphere.security.WebSphereRuntimePermission("wssecurity.WSSToken.setTrusted")
com.ibm.websphere.security.WebSphereRuntimePermission("wssecurity.WSSToken.addAttribute")
com.ibm.websphere.security.WebSphereRuntimePermission("wssecurity.WSSToken.setUsedTokenConsumer")
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 |
isReadOnly()
|
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 |
setReadOnly()
When called, the token becomes irreversibly read-only. |
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 |
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()
public void setId(java.lang.String tid)
tid
- public org.w3c.dom.Element getElement()
Element
objectpublic void setElement(org.w3c.dom.Element elem)
elem
- An Element
of the token itselfpublic javax.xml.namespace.QName getType()
QName
object.
public void setType(javax.xml.namespace.QName type)
QName
object.
type
- a qname of the tokenpublic void setType(java.lang.String uri, java.lang.String localName)
uri
- localName
- public java.lang.String getKeyInfoType()
public void setKeyInfoType(java.lang.String keyInfoType)
keyInfoType
- The KeyInfo's typepublic byte[] getBytes()
getBytes
in interface Token
public java.lang.String getName()
getName
in interface Token
public short getVersion()
getVersion
in interface Token
public boolean isForwardable()
isForwardable
in interface Token
public java.lang.Object clone()
clone
in interface Token
clone
in class java.lang.Object
public void setTrusted(boolean trusted)
trusted
- True if auth is required, false otherwise
Protected by Java 2 Security permission com.ibm.websphere.security.WebSphereRuntimePermission("wssecurity.WSSToken.setTrusted")public boolean isTrusted()
public void setUsedToLogin(boolean usedToLogin)
usedToLogin
- True if the token is used to login, false otherwisepublic boolean getUsedToLogin()
public java.util.Enumeration getAttributeNames()
getAttributeNames
in interface Token
public java.lang.String[] getAttributes(java.lang.String key)
getAttributes
in interface 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 Token
key
- The key of the attribute to addvalue
- The value of the attribute to add
String[]
representation of the set of attributes
Protected by Java 2 Security Permission com.ibm.websphere.security.WebSphereRuntimePermission("wssecurity.WSSToken.addAttribute")public void setCallerChecked(boolean isCallerChecked)
isCallerChecked
- True if caller check has been done, false otherwisepublic boolean getCallerChecked()
public boolean isReferenced()
public void setReferenced(boolean isReferenced)
isReferenced
- True if the token is referenced, false otherwisepublic TokenGeneratorConfig getUsedTokenGenerator()
public void setUsedTokenGenerator(TokenGeneratorConfig usedConfig)
usedConfig
- The token generator configurationpublic TokenConsumerConfig getUsedTokenConsumer()
public void setUsedTokenConsumer(TokenConsumerConfig usedConfig)
usedConfig
- The token consumer configuration
Protected by Java 2 Security permission com.ibm.websphere.security.WebSphereRuntimePermission("wssecurity.WSSToken.setUsedTokenConsumer")public boolean isProcessed()
public void setProcessed(boolean isProcessed)
isProcessed
- True if the token is processed, false otherwisepublic SoapSecurityException getError()
public void setError(SoapSecurityException error)
error
- The SoapSecurityException that occured during token processingpublic boolean isReadOnly()
public void setReadOnly()
Token
When called, the token becomes irreversibly read-only. The implementation needs to ensure any setter methods check that this has been set.
setReadOnly
in interface Token
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |