com.sun.identity.saml2.assertion
インタフェース Subject


public interface Subject

The Subject specifies the principal that is the subject of all of the statements in the assertion. It contains an identifier, a series of one or more subject confirmations, or both.


メソッドの概要
 BaseID getBaseID()
          Returns the identifier in BaseID format
 EncryptedID getEncryptedID()
          Returns the encrypted identifier
 NameID getNameID()
          Returns the identifier in NameID format
 List getSubjectConfirmation()
          Returns a list of subject confirmations
 boolean isMutable()
          Returns true if the object is mutable
 void makeImmutable()
          Makes the object immutable
 void setBaseID(BaseID value)
          Sets the identifier in BaseID format
 void setEncryptedID(EncryptedID value)
          Sets the encrypted identifier
 void setNameID(NameID value)
          Sets the identifier in NameID format
 void setSubjectConfirmation(List confirmations)
          Sets a list of subject confirmations
 String toXMLString()
          Returns a String representation
 String toXMLString(boolean includeNSPrefix, boolean declareNS)
          Returns a String representation
 

メソッドの詳細

getEncryptedID

EncryptedID getEncryptedID()
Returns the encrypted identifier

戻り値:
the encrypted identifier

setEncryptedID

void setEncryptedID(EncryptedID value)
                    throws SAML2Exception
Sets the encrypted identifier

パラメータ:
value - the encrypted identifier
例外:
SAML2Exception - if the object is immutable

getNameID

NameID getNameID()
Returns the identifier in NameID format

戻り値:
the identifier in NameID format

setNameID

void setNameID(NameID value)
               throws SAML2Exception
Sets the identifier in NameID format

パラメータ:
value - the identifier in NameID format
例外:
SAML2Exception - if the object is immutable

getSubjectConfirmation

List getSubjectConfirmation()
Returns a list of subject confirmations

戻り値:
a list of subject confirmations

setSubjectConfirmation

void setSubjectConfirmation(List confirmations)
                            throws SAML2Exception
Sets a list of subject confirmations

パラメータ:
confirmations - a list of subject confirmations
例外:
SAML2Exception - if the object is immutable

getBaseID

BaseID getBaseID()
Returns the identifier in BaseID format

戻り値:
the identifier in BaseID format

setBaseID

void setBaseID(BaseID value)
               throws SAML2Exception
Sets the identifier in BaseID format

パラメータ:
value - the identifier in BaseID format
例外:
SAML2Exception - if the object is immutable

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
                   throws SAML2Exception
Returns a String representation

パラメータ:
includeNSPrefix - Determines whether or not the namespace qualifier is prepended to the Element when converted
declareNS - Determines whether or not the namespace is declared within the Element.
戻り値:
A String representation
例外:
SAML2Exception - if something is wrong during conversion

toXMLString

String toXMLString()
                   throws SAML2Exception
Returns a String representation

戻り値:
A String representation
例外:
SAML2Exception - if something is wrong during conversion

makeImmutable

void makeImmutable()
Makes the object immutable


isMutable

boolean isMutable()
Returns true if the object is mutable

戻り値:
true if the object is mutable