uk.ac.soton.itinnovation.grid.types
Class SubjectDescription

java.lang.Object
  uk.ac.soton.itinnovation.grid.types.SubjectDescription

Direct Known Subclasses:

ParsedSubjectDescription

public class SubjectDescription
extends Object

The identity details of a user (eg, as checked by WSS4J).

Field Summary

protected AdditionalSecurityToken[]	additionalSecurityTokens
protected X509Certificate	cert
protected TrustedAttribute[]	trustedAttributes

Constructor Summary

SubjectDescription()

SubjectDescription(SubjectDescription source)

SubjectDescription(X509Certificate cert)

Method Summary

void	addAdditionalTokens(MessageElement[] tokens)
AdditionalSecurityToken[]	getAdditionalSecurityTokens()
AdditionalSecurityToken	getAdditionalSecurityTokens(int i)
TrustedAttribute[]	getTrustedAttributes()
TrustedAttribute	getTrustedAttributes(int i)
static TypeDesc	getTypeDesc() Return type metadata object
X509Certificate	getX509Certificate()
protected void	securityTokensChanged() Overridden by sub-classes which maintain a parsed version of the tokens.
void	setAdditionalSecurityTokens(AdditionalSecurityToken[] additionalSecurityTokens) Set any additional tokens.
void	setAdditionalSecurityTokens(int i, AdditionalSecurityToken value)
void	setTrustedAttributes(int i, TrustedAttribute value)
void	setTrustedAttributes(TrustedAttribute[] attributes) Record attributes of the subject which have already been verified.
void	setX509Certificate(X509Certificate cert)
IDType	toID() Convert a SubjectDescription to an IDType.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cert

protected X509Certificate cert

additionalSecurityTokens

protected AdditionalSecurityToken[] additionalSecurityTokens

trustedAttributes

protected TrustedAttribute[] trustedAttributes

Constructor Detail

SubjectDescription

public SubjectDescription()

SubjectDescription

public SubjectDescription(SubjectDescription source)

SubjectDescription

public SubjectDescription(X509Certificate cert)

Method Detail

setX509Certificate

public void setX509Certificate(X509Certificate cert)

getX509Certificate

public X509Certificate getX509Certificate()

setTrustedAttributes

public void setTrustedAttributes(TrustedAttribute[] attributes)

Record attributes of the subject which have already been verified. This can be used to pass information from other authentication systems. For example, the subject's tomcat role (as determined by tomcat) could be passed as a trusted attribute.

getTrustedAttributes

public TrustedAttribute[] getTrustedAttributes()

getTrustedAttributes

public TrustedAttribute getTrustedAttributes(int i)

setTrustedAttributes

public void setTrustedAttributes(int i,
                                 TrustedAttribute value)

setAdditionalSecurityTokens

public void setAdditionalSecurityTokens(AdditionalSecurityToken[] additionalSecurityTokens)
                                 throws InvalidSubjectDescriptorException

Set any additional tokens. This typically contains extra security tokens, such as SAML assertions.

Throws:

InvalidSubjectDescriptorException

securityTokensChanged

protected void securityTokensChanged()

Overridden by sub-classes which maintain a parsed version of the tokens. The default implementation does nothing.

getAdditionalSecurityTokens

public AdditionalSecurityToken[] getAdditionalSecurityTokens()

getAdditionalSecurityTokens

public AdditionalSecurityToken getAdditionalSecurityTokens(int i)

setAdditionalSecurityTokens

public void setAdditionalSecurityTokens(int i,
                                        AdditionalSecurityToken value)

addAdditionalTokens

public void addAdditionalTokens(MessageElement[] tokens)

toString

public String toString()

Overrides:

toString in class Object

toID

public IDType toID()

Convert a SubjectDescription to an IDType.

getTypeDesc

public static TypeDesc getTypeDesc()

Return type metadata object