edu.internet2.middleware.shibboleth.wayf
Class HandlerConfig

java.lang.Object
  edu.internet2.middleware.shibboleth.wayf.HandlerConfig

public class HandlerConfig
extends Object

Class used by the DiscoveryServiceHandler to handle run time behaviour.

Field Summary

private String	errorJspFile Where to find the error jsp file.
private HashSet<String>	ignoredForMatch A set of names which are ignored when doing a search.
private String	jspFile Where to find the GUI description jsp file.
private static Logger	LOG How to get debug output out.
private boolean	lookupSp Do we do a pre-filter by SP name in for each metadata provider.
private boolean	provideList Do we give the jsp file a flat list of IdPs?
private boolean	provideListOfLists Do we give the jsp file an array of arrays of IdPs?
private boolean	warnOnBadBinding Do we warn on the bad binding.
private boolean	warnOnNoSAML2 Do we warn on the SP not have SAML2 endpoints if we are approached as DS.

Constructor Summary

HandlerConfig()
Build the 'default default' configuation.

HandlerConfig(Element config, HandlerConfig defaultValue)
Parse the Supplied XML element into a new WayfConfig Object.

Method Summary

private void	addIgnoredForMatch(String s) Sets the tokens that should be ignored when a user searches for an origin site.
String	getErrorJspFile() Get the name of the error jsp File this instance uses.
String	getJspFile() Get the name of the jsp File this instance uses.
boolean	getLookupSp() Do we lookup the SP or just return all the IdPs?.
boolean	getProvideList() Do we provide a list of IdPs?.
boolean	getProvideListOfLists() Do we provide a list of lists of IdPs?.
boolean	getWarnOnBadBinding() Do ignore badly formed bindings or just warn.
boolean	getwarnOnNoSAML2() Do we check to see whether an SP has SAML2 end points when approached from is to speak DS.
boolean	isIgnoredForMatch(String str) Determines if a particular string token should be used for matching when a user searches for origins.
private boolean	lookupElement(Element element, String attributeName, boolean defaultValue) Lookup for the names attribute, falling back to a default.
private String	lookupElement(Element element, String attributeName, String defaultValue) Lookup for the names attribute, falling back to a default.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logger LOG

How to get debug output out.

ignoredForMatch

private final HashSet<String> ignoredForMatch

A set of names which are ignored when doing a search.

jspFile

private final String jspFile

Where to find the GUI description jsp file.

errorJspFile

private final String errorJspFile

Where to find the error jsp file.

provideListOfLists

private final boolean provideListOfLists

Do we give the jsp file an array of arrays of IdPs?

provideList

private final boolean provideList

Do we give the jsp file a flat list of IdPs?

lookupSp

private final boolean lookupSp

Do we do a pre-filter by SP name in for each metadata provider.

warnOnBadBinding

private final boolean warnOnBadBinding

Do we warn on the bad binding.

warnOnNoSAML2

private final boolean warnOnNoSAML2

Do we warn on the SP not have SAML2 endpoints if we are approached as DS.

Constructor Detail

HandlerConfig

public HandlerConfig()

Build the 'default default' configuation.

HandlerConfig

public HandlerConfig(Element config,
                     HandlerConfig defaultValue)
              throws ShibbolethConfigurationException

Parse the Supplied XML element into a new WayfConfig Object.

Parameters:

config - - The XML with the configuration info.

defaultValue - - The default if nothing is specified.

Throws:

ShibbolethConfigurationException - - if we see somethin wrong.

Method Detail

lookupElement

private boolean lookupElement(Element element,
                              String attributeName,
                              boolean defaultValue)

Lookup for the names attribute, falling back to a default.

Parameters:

element - The DOM elemtn we are looking at.

attributeName - The name to lookup.

defaultValue - The value to default to.

Returns:

the result if present, or the default.

lookupElement

private String lookupElement(Element element,
                             String attributeName,
                             String defaultValue)

Lookup for the names attribute, falling back to a default.

Parameters:

element - The DOM elemtn we are looking at.

attributeName - The name to lookup.

defaultValue - The value.

Returns:

the result if present, or the default.

isIgnoredForMatch

public boolean isIgnoredForMatch(String str)

Determines if a particular string token should be used for matching when a user searches for origins.

Parameters:

str - - The string to lookup.

Returns:

whether it is or not.

addIgnoredForMatch

private void addIgnoredForMatch(String s)

Sets the tokens that should be ignored when a user searches for an origin site.

Parameters:

s - The ignored tokens are passed as a single string, each separated by whitespace

getJspFile

public String getJspFile()

Get the name of the jsp File this instance uses.

Returns:

the name.

getErrorJspFile

public String getErrorJspFile()

Get the name of the error jsp File this instance uses.

Returns:

the name.

getProvideListOfLists

public boolean getProvideListOfLists()

Do we provide a list of lists of IdPs?.

Returns:

whether we do or not.

getProvideList

public boolean getProvideList()

Do we provide a list of IdPs?.

Returns:

whether we provide a list of IdPs?.

getLookupSp

public boolean getLookupSp()

Do we lookup the SP or just return all the IdPs?.

Returns:

whether or not we lookup the SP

getWarnOnBadBinding

public boolean getWarnOnBadBinding()

Do ignore badly formed bindings or just warn.

Returns:

whether we warn.

getwarnOnNoSAML2

public boolean getwarnOnNoSAML2()

Do we check to see whether an SP has SAML2 end points when approached from is to speak DS.

Returns:

whether to check or not.