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

Class ComputedIDDataConnector

java.lang.Object

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

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.BaseDataConnector

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.ComputedIDDataConnector

All Implemented Interfaces:

DataConnector, ResolutionPlugIn<Map<String,BaseAttribute>>

public class ComputedIDDataConnector
extends BaseDataConnector

A data connector that generates a unique ID by computing the SHA-1 hash of a given attribute value, the entity ID of the inbound message issuer, and a provided salt.

Field Summary

Fields

Modifier and Type	Field and Description
private String	generatedAttribute ID of the attribute generated by this data connector.
private org.slf4j.Logger	log Class logger.
private byte[]	salt Salt used when computing the ID.
private String	sourceAttribute ID of the attribute whose first value is used when generating the computed ID.

Constructor Summary

Constructors

Constructor and Description
ComputedIDDataConnector(String generatedAttributeId, String sourceAttributeId, byte[] idSalt) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getGeneratedAttributeId() Gets the ID of the attribute generated by this connector.
byte[]	getSalt() Gets the salt used when computing the ID.
String	getSourceAttributeId() Gets the ID of the attribute whose first value is used when generating the computed ID.
Map<String,BaseAttribute>	resolve(ShibbolethResolutionContext resolutionContext) Performs the attribute resolution for this plugin.
void	validate() Validate the internal state of this plug-in.

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

getFailoverDependencyId, setFailoverDependencyIds

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.

generatedAttribute

private String generatedAttribute

ID of the attribute generated by this data connector.

sourceAttribute

private String sourceAttribute

ID of the attribute whose first value is used when generating the computed ID.

salt

private byte[] salt

Salt used when computing the ID.

Constructor Detail

ComputedIDDataConnector

public ComputedIDDataConnector(String generatedAttributeId,
                       String sourceAttributeId,
                       byte[] idSalt)

Constructor.

Parameters:

generatedAttributeId - ID of the attribute generated by this data connector

sourceAttributeId - ID of the attribute whose first value is used when generating the computed ID

idSalt - salt used when computing the ID

Method Detail

getSalt

public byte[] getSalt()

Gets the salt used when computing the ID.

Returns:

salt used when computing the ID

getSourceAttributeId

public String getSourceAttributeId()

Gets the ID of the attribute whose first value is used when generating the computed ID.

Returns:

ID of the attribute whose first value is used when generating the computed ID

getGeneratedAttributeId

public String getGeneratedAttributeId()

Gets the ID of the attribute generated by this connector.

Returns:

ID of the attribute generated by this connector

resolve

public Map<String,BaseAttribute> 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

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