Package org.opensaml.saml.saml2.core

Interface Subject

All Superinterfaces:

SAMLObject, XMLObject

All Known Implementing Classes:

SubjectImpl

public interface Subject
extends SAMLObject

SAML 2.0 Core Subject.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ELEMENT_LOCAL_NAME	Element local name.
static final QName	DEFAULT_ELEMENT_NAME	Default element name.
static final String	TYPE_LOCAL_NAME	Local name of the XSI type.
static final QName	TYPE_NAME	QName of the XSI type.

Method Summary

Modifier and Type	Method	Description
BaseID	getBaseID()	Gets the base identifier of the principal for this request.
EncryptedID	getEncryptedID()	Gets the encrypted name identifier of the principal for this request.
NameID	getNameID()	Gets the name identifier of the principal for this request.
List<SubjectConfirmation>	getSubjectConfirmations()	Gets the confirmations made about this subject.
void	setBaseID(BaseID newBaseID)	Sets the base identifier of the principal for this request.
void	setEncryptedID(EncryptedID newEncryptedID)	Sets the encrypted name identifier of the principal for this request.
void	setNameID(NameID newNameID)	Sets the name identifier of the principal for this request.

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Details

DEFAULT_ELEMENT_LOCAL_NAME

@Nonnull
@NotEmpty
static final String DEFAULT_ELEMENT_LOCAL_NAME

Element local name.

See Also:

• Constant Field Values

DEFAULT_ELEMENT_NAME

@Nonnull
static final QName DEFAULT_ELEMENT_NAME

Default element name.

TYPE_LOCAL_NAME

@Nonnull
@NotEmpty
static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

• Constant Field Values

TYPE_NAME

@Nonnull
static final QName TYPE_NAME

QName of the XSI type.

Method Details

getBaseID

@Nullable
BaseID getBaseID()

Gets the base identifier of the principal for this request.

Returns:

the base identifier of the principal for this request

setBaseID

void setBaseID(@Nullable
 BaseID newBaseID)

Sets the base identifier of the principal for this request.

Parameters:

newBaseID - the base identifier of the principal for this request

getNameID

@Nullable
NameID getNameID()

Gets the name identifier of the principal for this request.

Returns:

the name identifier of the principal for this request

setNameID

void setNameID(@Nullable
 NameID newNameID)

Sets the name identifier of the principal for this request.

Parameters:

newNameID - the name identifier of the principal for this request

getEncryptedID

@Nullable
EncryptedID getEncryptedID()

Gets the encrypted name identifier of the principal for this request.

Returns:

the encrypted name identifier of the principal for this request

setEncryptedID

void setEncryptedID(@Nullable
 EncryptedID newEncryptedID)

Sets the encrypted name identifier of the principal for this request.

Parameters:

newEncryptedID - the new encrypted name identifier of the principal for this request

getSubjectConfirmations

@Nonnull
@Live
List<SubjectConfirmation> getSubjectConfirmations()

Gets the confirmations made about this subject.

Returns:

the confirmations made about this subject