org.opensaml.saml.saml2.core

Interface NameIDType

All Known Subinterfaces:

Issuer, NameID, RespondTo

All Known Implementing Classes:

AbstractNameIDType, IssuerImpl, NameIDImpl, RespondToImpl

public interface NameIDType

SAML 2.0 Assertion NameID schema type.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMAIL URI for email name format.
static java.lang.String	ENCRYPTED Special URI used by NameIDPolicy to indicate a NameID should be encrypted.
static java.lang.String	ENTITY URI for SAML entity name format.
static java.lang.String	FORMAT_ATTRIB_NAME Format attribute name.
static java.lang.String	KERBEROS URI for kerberos name format.
static java.lang.String	NAME_QUALIFIER_ATTRIB_NAME NameQualifier attribute name.
static java.lang.String	PERSISTENT URI for persistent name format.
static java.lang.String	SP_NAME_QUALIFIER_ATTRIB_NAME SPNameQualifier attribute name.
static java.lang.String	SPPROVIDED_ID_ATTRIB_NAME SPProviderID attribute name.
static java.lang.String	TRANSIENT URI for transient name format.
static java.lang.String	UNSPECIFIED URI for unspecified name format.
static java.lang.String	WIN_DOMAIN_QUALIFIED URI for windows domain qualified name name format.
static java.lang.String	X509_SUBJECT URI for X509 subject name format.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormat() Gets the format of the NameID.
java.lang.String	getNameQualifier() Gets the NameQualifier value.
java.lang.String	getSPNameQualifier() Gets the SPNameQualifier value.
java.lang.String	getSPProvidedID() Gets the SPProvidedID of this NameID.
java.lang.String	getValue() Gets the value of this type.
void	setFormat(java.lang.String newFormat) Sets the format of the NameID.
void	setNameQualifier(java.lang.String newNameQualifier) Sets the NameQualifier value.
void	setSPNameQualifier(java.lang.String newSPNameQualifier) Sets the SPNameQualifier value.
void	setSPProvidedID(java.lang.String newSPProvidedID) Sets the SPProvddedID of this NameID.
void	setValue(java.lang.String newValue) Sets the value of this type.

Field Detail

NAME_QUALIFIER_ATTRIB_NAME

static final java.lang.String NAME_QUALIFIER_ATTRIB_NAME

NameQualifier attribute name.

See Also:

Constant Field Values

SP_NAME_QUALIFIER_ATTRIB_NAME

static final java.lang.String SP_NAME_QUALIFIER_ATTRIB_NAME

SPNameQualifier attribute name.

See Also:

Constant Field Values

FORMAT_ATTRIB_NAME

static final java.lang.String FORMAT_ATTRIB_NAME

Format attribute name.

See Also:

Constant Field Values

SPPROVIDED_ID_ATTRIB_NAME

static final java.lang.String SPPROVIDED_ID_ATTRIB_NAME

SPProviderID attribute name.

See Also:

Constant Field Values

UNSPECIFIED

static final java.lang.String UNSPECIFIED

URI for unspecified name format.

See Also:

Constant Field Values

EMAIL

static final java.lang.String EMAIL

URI for email name format.

See Also:

Constant Field Values

X509_SUBJECT

static final java.lang.String X509_SUBJECT

URI for X509 subject name format.

See Also:

Constant Field Values

WIN_DOMAIN_QUALIFIED

static final java.lang.String WIN_DOMAIN_QUALIFIED

URI for windows domain qualified name name format.

See Also:

Constant Field Values

KERBEROS

static final java.lang.String KERBEROS

URI for kerberos name format.

See Also:

Constant Field Values

ENTITY

static final java.lang.String ENTITY

URI for SAML entity name format.

See Also:

Constant Field Values

PERSISTENT

static final java.lang.String PERSISTENT

URI for persistent name format.

See Also:

Constant Field Values

TRANSIENT

static final java.lang.String TRANSIENT

URI for transient name format.

See Also:

Constant Field Values

ENCRYPTED

static final java.lang.String ENCRYPTED

Special URI used by NameIDPolicy to indicate a NameID should be encrypted.

See Also:

Constant Field Values

Method Detail

getValue

java.lang.String getValue()

Gets the value of this type.

Returns:

the value of this type

setValue

void setValue(java.lang.String newValue)

Sets the value of this type.

Parameters:

newValue - the value of this type

getNameQualifier

java.lang.String getNameQualifier()

Gets the NameQualifier value.

Returns:

the NameQualifier value

setNameQualifier

void setNameQualifier(java.lang.String newNameQualifier)

Sets the NameQualifier value.

Parameters:

newNameQualifier - the NameQualifier value

getSPNameQualifier

java.lang.String getSPNameQualifier()

Gets the SPNameQualifier value.

Returns:

the SPNameQualifier value

setSPNameQualifier

void setSPNameQualifier(java.lang.String newSPNameQualifier)

Sets the SPNameQualifier value.

Parameters:

newSPNameQualifier - the SPNameQualifier value

getFormat

java.lang.String getFormat()

Gets the format of the NameID.

Returns:

the format of the NameID

setFormat

void setFormat(java.lang.String newFormat)

Sets the format of the NameID.

Parameters:

newFormat - the format of the NameID

getSPProvidedID

java.lang.String getSPProvidedID()

Gets the SPProvidedID of this NameID.

Returns:

the SPProvidedID of this NameID

setSPProvidedID

void setSPProvidedID(java.lang.String newSPProvidedID)

Sets the SPProvddedID of this NameID.

Parameters:

newSPProvidedID - the SPProvidedID of this NameID