ValidRelayStateExtractor.SAMLEntityInfo (OpenAM Project 16.2.0-SNAPSHOT API)

java.lang.Object
- org.forgerock.openam.saml2.plugins.ValidRelayStateExtractor.SAMLEntityInfo

Enclosing class:

ValidRelayStateExtractor
```
public static final class ValidRelayStateExtractor.SAMLEntityInfo
extends Object
```
A domain object that helps to uniquely identify a given SAML entity in the configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ValidRelayStateExtractor.SAMLEntityInfo`	`from(String realm, String entityID, String role)`	Creates a new SAMLEntityInfo object based on the provided details.
`String`	`getEntityID()`	The entity ID of the hosted entity.
`String`	`getRealm()`	The realm the hosted entity belongs to.
`String`	`getRole()`	The role the hosted entity is acting in, which decides whose `relayStateUrlList` applies.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - from
```
public static ValidRelayStateExtractor.SAMLEntityInfo from(String realm,
                                                           String entityID,
                                                           String role)
```
    Creates a new SAMLEntityInfo object based on the provided details.
    
    Parameters:
    
    realm - The realm where the hosted entity belongs to.
    
    entityID - The entity ID of the hosted entity.
    
    role - The role of the hosted entity (e.g. SPRole or IDPRole).
    
    Returns:
    
    The SAMLEntityInfo object corresponding to the provided details.
  - getRealm
```
public String getRealm()
```
    The realm the hosted entity belongs to.
    
    Returns:
    
    The realm.
  - getEntityID
```
public String getEntityID()
```
    The entity ID of the hosted entity.
    
    Returns:
    
    The entity ID.
  - getRole
```
public String getRole()
```
    The role the hosted entity is acting in, which decides whose relayStateUrlList applies.
    
    Returns:
    
    The role, SAML2Constants.SP_ROLE or SAML2Constants.IDP_ROLE.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object