edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.principalConnector

Class StoredIDPrincipalConnector

java.lang.Object

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn<String>

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.principalConnector.BasePrincipalConnector

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.principalConnector.StoredIDPrincipalConnector

All Implemented Interfaces:

PrincipalConnector, ResolutionPlugIn<String>

public class StoredIDPrincipalConnector
extends BasePrincipalConnector

A principal connector that resolved ID created by StoredIDPrincipalConnectors into principals.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private boolean	noResultIsError Whether an empty result set is an error.
private StoredIDStore	pidStore ID store that manages the stored IDs.

Constructor Summary

Constructors

Constructor and Description
StoredIDPrincipalConnector(StoredIDDataConnector idProducer) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getPeerEntityId(ShibbolethResolutionContext resolutionContext) Gets the entity ID used for the peer.
boolean	isNoResultIsError() This returns whether this connector will throw an exception if no search results are found.
String	resolve(ShibbolethResolutionContext resolutionContext) Performs the attribute resolution for this plugin.
void	setNoResultIsError(boolean isError) This sets whether this connector will throw an exception if no search results are found.
void	validate() Validate the internal state of this plug-in.

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.principalConnector.BasePrincipalConnector

getFormat, getRelyingParties, setFormat

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn

getDependencyIds, getId, getValuesFromAllDependencies, getValuesFromAttributeDependency, getValuesFromConnectorDependency, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ResolutionPlugIn

getDependencyIds, getId

Field Detail

log

private final org.slf4j.Logger log

Class logger.

pidStore

private StoredIDStore pidStore

ID store that manages the stored IDs.

noResultIsError

private boolean noResultIsError

Whether an empty result set is an error.

Constructor Detail

StoredIDPrincipalConnector

public StoredIDPrincipalConnector(StoredIDDataConnector idProducer)

Constructor.

Parameters:

idProducer - data connector that produced the stored ID.

Method Detail

isNoResultIsError

public boolean isNoResultIsError()

This returns whether this connector will throw an exception if no search results are found. The default is false.

Returns:

boolean

setNoResultIsError

public void setNoResultIsError(boolean isError)

This sets whether this connector will throw an exception if no search results are found.

Parameters:

isError - boolean

resolve

public String resolve(ShibbolethResolutionContext resolutionContext)
               throws AttributeResolutionException

Performs the attribute resolution for this plugin.

Parameters:

resolutionContext - the context for the resolution

Returns:

the attributes made available by the resolution, never null

Throws:

AttributeResolutionException - the problem that occurred during the resolution

getPeerEntityId

protected String getPeerEntityId(ShibbolethResolutionContext resolutionContext)

Gets the entity ID used for the peer. If the inbound request is a SAML 2 authentication context and contains a NameIDPolicy than the SPNameQualifier is used if present, otherwise the inbound message issuer is used.

Parameters:

resolutionContext - current attribute resolution context

Returns:

the entity ID to use for the peer

validate

public void validate()
              throws AttributeResolutionException

Validate the internal state of this plug-in. This process may not rely on information from any dependency.

Throws:

AttributeResolutionException - if the plug-in has an invalid internal state