ValidWReplyExtractor (OpenAM Project 16.2.0-SNAPSHOT API)

java.lang.Object
- com.sun.identity.wsfederation.plugins.whitelist.ValidWReplyExtractor

All Implemented Interfaces:

ValidDomainExtractor<ValidWReplyExtractor.WSFederationEntityInfo>
```
public class ValidWReplyExtractor
extends Object
implements ValidDomainExtractor<ValidWReplyExtractor.WSFederationEntityInfo>
```
Extracts the valid relaystate URL list from the hosted SAML entity's configuration.
Per ValidDomainExtractor.extractValidDomains(Object) an empty collection means the configuration was read and holds no wreplyList, while null means it could not be read at all - the configuration store is unreachable, or the role whose list applies is not one of the two an entity can host. Callers that fail safe refuse to leave this server in the latter case.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ValidWReplyExtractor.WSFederationEntityInfo`	A domain object that helps to uniquely identify a given WS federation entity in the configuration.

Constructor Summary

Constructors
Constructor Description

ValidWReplyExtractor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Collection<String>`	`extractValidDomains(ValidWReplyExtractor.WSFederationEntityInfo entityInfo)`	Extracts the Valid goto URL domains based on the provided configuration details.

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

- Constructor Detail
  - ValidWReplyExtractor
```
public ValidWReplyExtractor()
```
- Method Detail
  - extractValidDomains
```
public Collection<String> extractValidDomains(ValidWReplyExtractor.WSFederationEntityInfo entityInfo)
```
    Description copied from interface: ValidDomainExtractor
    Extracts the Valid goto URL domains based on the provided configuration details.
    An empty collection and null are two different answers, and FailSafeRedirectUrlValidator tells them apart:
    
    an empty collection means the configuration was read and holds no URL patterns, which is what a realm or entity that was never configured looks like;
    
    null means the configuration could not be read at all - the store is unreachable, or the caller did not say which configuration to read - so nothing is known about the patterns. Callers that fail safe refuse to redirect off this server in that case, whatever they make of an empty list.
    
    RedirectUrlValidator, which fails open, treats the two the same.
    Specified by:
    
    extractValidDomains in interface ValidDomainExtractor<ValidWReplyExtractor.WSFederationEntityInfo>
    
    Parameters:
    
    entityInfo - The necessary information to retrieve the correct configuration.
    
    Returns:
    
    The collection of valid goto URL domains based on the provided configuration information. Empty when none are configured, null when they could not be read.