Package com.sun.identity.saml2.common

Class NameIDInfoKey

java.lang.Object

com.sun.identity.saml2.common.NameIDInfoKey

public class NameIDInfoKey
extends Object

This class NameIDInfoKey represents the user account federation information key: sun-fm-saml2-nameid-info-key. This multiple-valued attribute is used for searching purpose, in case of ldap datastore, an equality index need to be created for this attribute for better search performance. Value format for this attribute: || where: : entity id for this hosted entity : entity id for the remote entity : name identifier for the IDP for example: http://www.sp1.com|http://www.idp1.com|vPQyHXLnSWLAVh2BoI3gdUrhanC1

Constructor Summary

Constructors

Constructor	Description
NameIDInfoKey(String nameIDValue, String hostEntityID, String remoteEntityID)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getHostEntityID()	Returns the EntityID of the hosted provider.
String	getNameIDValue()	Returns the NameID value.
String	getRemoteEntityID()	Returns the EntityID of the remote provider.
static NameIDInfoKey	parse(String infoKey)	Returns the NameIDInfoKey by parsing the string value.
String	toValueString()	Returns the account federation information key value string that is stored in the repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameIDInfoKey

public NameIDInfoKey(String nameIDValue,
                     String hostEntityID,
                     String remoteEntityID)
              throws SAML2Exception

Constructor

Parameters:

nameIDValue - randomly generated name identifier value.

hostEntityID - EntityID of the hosted provider.

remoteEntityID - EntityID of the remote provider.

Throws:

SAML2Exception - if any of the parameter values are null.

Method Detail

getNameIDValue

public String getNameIDValue()

Returns the NameID value.

Returns:

the value of the NameID.

getHostEntityID

public String getHostEntityID()

Returns the EntityID of the hosted provider.

Returns:

the EntityID of the hosted provider.

getRemoteEntityID

public String getRemoteEntityID()

Returns the EntityID of the remote provider.

Returns:

the EntityID of the remote provider.

toValueString

public String toValueString()

Returns the account federation information key value string that is stored in the repository.

Returns:

the value of the NameIDInfoKey that is stored in the repository.

parse

public static NameIDInfoKey parse(String infoKey)
                           throws SAML2Exception

Returns the NameIDInfoKey by parsing the string value.

Returns:

the NameIDInfoKey

Throws:

SAML2Exception - if the parsing fails.