|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn<BaseAttribute>
edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition.BaseAttributeDefinition
public abstract class BaseAttributeDefinition
Base class for AttributeDefinition
plug-ins.
Field Summary | |
---|---|
private boolean |
dependencyOnly
Whether this attribute definition is only a dependency and thus its values should never be released. |
private Map<Locale,String> |
displayDescriptions
Localized human readable description of attribute. |
private Map<Locale,String> |
displayNames
Localized human intelligible attribute name. |
private ArrayList<AttributeEncoder> |
encoders
Attribute encoders associated with this definition. |
private org.slf4j.Logger |
log
Class logger. |
private String |
sourceAttributeID
Name of the attribute from data connectors to use to populate this definition. |
Constructor Summary | |
---|---|
BaseAttributeDefinition()
Constructor. |
Method Summary | |
---|---|
protected abstract BaseAttribute |
doResolve(ShibbolethResolutionContext resolutionContext)
Creates and populates the values for the resolved attribute. |
List<AttributeEncoder> |
getAttributeEncoders()
Gets the map of encoders to be added to attributes produced by this definition, keyed on encoder category. |
Map<Locale,String> |
getDisplayDescriptions()
Gets the localized human readable description of attribute. |
Map<Locale,String> |
getDisplayNames()
Gets the localized human readable name of the attribute. |
String |
getSourceAttributeID()
Return the source attribute. |
protected Collection<Object> |
getValuesFromAllDependencies(ShibbolethResolutionContext context)
Get values from dependencies. |
boolean |
isDependencyOnly()
Gets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver. |
BaseAttribute |
resolve(ShibbolethResolutionContext resolutionContext)
Performs the attribute resolution for this plugin. |
void |
setDependencyOnly(boolean isDependencyOnly)
Sets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver. |
void |
setSourceAttributeID(String newSourceAttributeID)
Set the source attribute. |
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, validate |
Field Detail |
---|
private final org.slf4j.Logger log
private boolean dependencyOnly
private ArrayList<AttributeEncoder> encoders
private String sourceAttributeID
private Map<Locale,String> displayNames
private Map<Locale,String> displayDescriptions
Constructor Detail |
---|
public BaseAttributeDefinition()
Method Detail |
---|
public Map<Locale,String> getDisplayDescriptions()
getDisplayDescriptions
in interface AttributeDefinition
public Map<Locale,String> getDisplayNames()
getDisplayNames
in interface AttributeDefinition
public boolean isDependencyOnly()
isDependencyOnly
in interface AttributeDefinition
public void setDependencyOnly(boolean isDependencyOnly)
isDependencyOnly
- whether this attribute definition is only a dependencypublic List<AttributeEncoder> getAttributeEncoders()
getAttributeEncoders
in interface AttributeDefinition
public BaseAttribute resolve(ShibbolethResolutionContext resolutionContext) throws AttributeResolutionException
resolve
in interface ResolutionPlugIn<BaseAttribute>
resolutionContext
- the context for the resolution
AttributeResolutionException
- the problem that occurred during the resolutionprotected abstract BaseAttribute doResolve(ShibbolethResolutionContext resolutionContext) throws AttributeResolutionException
resolutionContext
- current attribute resolution context
AttributeResolutionException
- thrown if there is a problem resolving and creating the attributeprotected Collection<Object> getValuesFromAllDependencies(ShibbolethResolutionContext context)
context
- resolution context
public String getSourceAttributeID()
public void setSourceAttributeID(String newSourceAttributeID)
newSourceAttributeID
- The sourceAttribute to set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |