com.vmware.vapi.saml

Interface SamlToken

All Superinterfaces:

XmlPresentable

All Known Subinterfaces:

ValidatableSamlToken, ValidatableSamlTokenEx

public interface SamlToken
extends XmlPresentable

Class representing an instance of SAML token. Various data and the xml token itself can be obtained using this class.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SamlToken.TokenDelegate Implementations of this class will act as containers for a single intermediary/delegate represented by the assertion.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other) For any non-null reference values x and y, this method returns true if and only if the argument value implements this interface and the corresponding token IDs match ( x.getId().equals(y.getId() == true )
List<Advice>	getAdvice() SAML assertions may have custom data that is embedded in them.
Set<String>	getAudience() If the assertion is addressed to one or more specific audiences they will be in this list. Although a SAML relying party that is outside the audiences specified is capable of drawing conclusions from an assertion, the SAML asserting party explicitly makes no representation as to accuracy or trustworthiness to such a party. Recommended use: The assertion evaluates to Valid if and only if the SAML relying party is a member of one or more of the audiences specified.
X509Certificate	getConfirmationCertificate() If the confirmation type of the token is holder-of-key then this method will return the user's certificate.
ConfirmationType	getConfirmationType()
List<SamlToken.TokenDelegate>	getDelegationChain() The delegation chain reflects the path of the assertion through one or more intermediaries that act on behalf of the subject of the assertion.
Date	getExpirationTime()
List<PrincipalId>	getGroupList() Returns the group IDs the token subject belongs to.
String	getId()
Date	getStartTime()
PrincipalId	getSubject() A subject of a token is the principal to which the token is issued.
SubjectNameId	getSubjectNameId() A subject of a token is the principal to which the token is issued.
int	hashCode()
boolean	isDelegable()
boolean	isRenewable()
boolean	isSolution()

Methods inherited from interface com.vmware.vapi.saml.XmlPresentable

importTo, toXml

Method Detail

getStartTime

Date getStartTime()

Returns:

the startTime

getExpirationTime

Date getExpirationTime()

Returns:

the expiration time

isRenewable

boolean isRenewable()

Returns:

the isRenewable

isDelegable

boolean isDelegable()

Returns:

the isDelegable

getConfirmationType

ConfirmationType getConfirmationType()

Returns:

the confirmationType

getSubject

PrincipalId getSubject()

A subject of a token is the principal to which the token is issued. Although the token can be delegated this field will not change - it will contain the PrincipalId of the initial requester. This method should be used only to get the subject if it is in UPN format. Otherwise the more general method getSubjectNameId() should be used.

Returns:

the subject of the token if it is in UPN format, null otherwise.

getSubjectNameId

SubjectNameId getSubjectNameId()

A subject of a token is the principal to which the token is issued. It will be returned together with its format.

Returns:

the subject of the token.

getId

String getId()

Returns:

the token ID; Cannot be null

getDelegationChain

List<SamlToken.TokenDelegate> getDelegationChain()

The delegation chain reflects the path of the assertion through one or more intermediaries that act on behalf of the subject of the assertion.
It will be ordered from least to most recent.
Recommended use: A relying party MUST evaluate the list of delegates, and SHOULD NOT accept the assertion unless it wishes to permit each delegate to act on behalf of the subject of the containing assertion.

Returns:

the delegation chain for this token or empty list if the token has never been delegated.

getAudience

Set<String> getAudience()

If the assertion is addressed to one or more specific audiences they will be in this list.
Although a SAML relying party that is outside the audiences specified is capable of drawing conclusions from an assertion, the SAML asserting party explicitly makes no representation as to accuracy or trustworthiness to such a party.
Recommended use: The assertion evaluates to Valid if and only if the SAML relying party is a member of one or more of the audiences specified. Empty set means no restrictions.

Returns:

the audience restriction set. Cannot be null

getConfirmationCertificate

X509Certificate getConfirmationCertificate()

If the confirmation type of the token is holder-of-key then this method will return the user's certificate.

Returns:

the user certificate if HoK token, null otherwise

getAdvice

List<Advice> getAdvice()

SAML assertions may have custom data that is embedded in them. The token service does not give any guarantees about it and just put it there on request. This data is called advice.

Returns:

the advice list. Cannot be null

getGroupList

List<PrincipalId> getGroupList()

Returns the group IDs the token subject belongs to. These groups could be both AD groups and local groups. If the subject does not belong to any group empty list will be returned.

Returns:

the list of groups the principal belongs to. Cannot be null

See Also:

SamlToken#getSubject()}

isSolution

boolean isSolution()

Returns:

true if this token represents a solution user. In other words - if principal of the subject to which the token is issued is a solution type of principal then this method will return true

equals

boolean equals(Object other)

For any non-null reference values x and y, this method returns true if and only if the argument value implements this interface and the corresponding token IDs match ( x.getId().equals(y.getId() == true )

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object