Interface SecurityToken
- All Known Subinterfaces:
InboundSecurityToken,OutboundSecurityToken
- All Known Implementing Classes:
AbstractInboundSecurityToken,AbstractSecurityToken,DsaKeyValueSecurityToken,ECKeyValueSecurityToken,GenericOutboundSecurityToken,KeyNameSecurityToken,RsaKeyValueSecurityToken,X509IssuerSerialSecurityToken,X509SecurityToken,X509SKISecurityToken,X509SubjectNameSecurityToken
public interface SecurityToken
External view to a SecurityToken
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddTokenUsage(SecurityTokenConstants.TokenUsage tokenUsage) getId()Returns the token id aka wsu:IdReturns the KeyIdentifierReturns the key wrapping tokenReturns the public key if one exists and already initialized, null otherwiseReturns the secret key's if already initialized, null otherwiseReturns a SHA-1 Identifier that refers to this tokenList<? extends SecurityToken>Returns the certificate chain if one exists for this token typebooleanReturns the token type
-
Method Details
-
getId
String getId()Returns the token id aka wsu:Id- Returns:
- The id
-
isAsymmetric
Returns the token type- Returns:
- true if asymmetric token, false if symmetric token
- Throws:
XMLSecurityException
-
getSecretKey
Returns the secret key's if already initialized, null otherwise- Returns:
- Algorithm-URI key map
- Throws:
XMLSecurityException
-
getPublicKey
Returns the public key if one exists and already initialized, null otherwise- Returns:
- the public key
- Throws:
XMLSecurityException
-
getX509Certificates
Returns the certificate chain if one exists for this token type- Returns:
- The certificate chain
- Throws:
XMLSecurityException- if the certificates can't be retrieved
-
getKeyWrappingToken
Returns the key wrapping token- Returns:
- The wrapping SecurityToken
- Throws:
XMLSecurityException
-
getWrappedTokens
- Throws:
XMLSecurityException
-
getKeyIdentifier
SecurityTokenConstants.KeyIdentifier getKeyIdentifier()Returns the KeyIdentifier- Returns:
- the KeyIdentifier
-
getTokenType
SecurityTokenConstants.TokenType getTokenType() -
getTokenUsages
List<SecurityTokenConstants.TokenUsage> getTokenUsages() -
addTokenUsage
- Throws:
XMLSecurityException
-
getSha1Identifier
String getSha1Identifier()Returns a SHA-1 Identifier that refers to this token- Returns:
- a SHA-1 Identifier that refers to this token
-