edu.internet2.middleware.shibboleth.common.attribute.encoding.provider

Class AbstractScopedAttributeEncoder<EncodedType>

java.lang.Object

edu.internet2.middleware.shibboleth.common.attribute.encoding.provider.AbstractAttributeEncoder<EncodedType>

edu.internet2.middleware.shibboleth.common.attribute.encoding.provider.AbstractScopedAttributeEncoder<EncodedType>

Type Parameters:

EncodedType - the type of object created by encoding the attribute

All Implemented Interfaces:

AttributeEncoder<EncodedType>

Direct Known Subclasses:

SAML1ScopedStringAttributeEncoder, SAML2ScopedStringAttributeEncoder

public abstract class AbstractScopedAttributeEncoder<EncodedType>
extends AbstractAttributeEncoder<EncodedType>

Base class for scoped attribute encoders.

Field Summary

Fields

Modifier and Type	Field and Description
private String	scopeAttribute Attribute name used for "attribute" scopeType.
private String	scopeDelimiter Delimeter used for "inline" scopeType.
private String	scopeType Type of scoping to use.
private XMLObjectBuilder<ShibbolethScopedValue>	shibScopeValueBuilder Builder of Shibboleth scoped value XMLObjects.
private XMLObjectBuilder<XSString>	stringValueBuilder Builder of string XMLObjects.

Constructor Summary

Constructors

Constructor and Description
AbstractScopedAttributeEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<XMLObject>	encodeAttributeValues(QName objectName, BaseAttribute<ScopedAttributeValue> attribute) Encodes attributes whose values are scoped.
String	getScopeAttribute() Get the scope attribute.
String	getScopeDelimiter() Get the scope delimiter.
String	getScopeType() Get the scope type.
void	setScopeAttribute(String newScopeAttribute) Set the scope attribute.
void	setScopeDelimiter(String newScopeDelimiter) Set the scope delimiter.
void	setScopeType(String newScopeType) Set the scope type.

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.encoding.provider.AbstractAttributeEncoder

getAttributeName, setAttributeName

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.encoding.AttributeEncoder

encode

Field Detail

shibScopeValueBuilder

private final XMLObjectBuilder<ShibbolethScopedValue> shibScopeValueBuilder

Builder of Shibboleth scoped value XMLObjects.

stringValueBuilder

private final XMLObjectBuilder<XSString> stringValueBuilder

Builder of string XMLObjects.

scopeType

private String scopeType

Type of scoping to use.

scopeDelimiter

private String scopeDelimiter

Delimeter used for "inline" scopeType.

scopeAttribute

private String scopeAttribute

Attribute name used for "attribute" scopeType.

Constructor Detail

AbstractScopedAttributeEncoder

public AbstractScopedAttributeEncoder()

Method Detail

getScopeAttribute

public String getScopeAttribute()

Get the scope attribute.

Returns:

Returns the scopeAttribute.

getScopeDelimiter

public String getScopeDelimiter()

Get the scope delimiter.

Returns:

Returns the scopeDelimiter.

getScopeType

public String getScopeType()

Get the scope type.

Returns:

Returns the scopeType.

setScopeAttribute

public void setScopeAttribute(String newScopeAttribute)

Set the scope attribute.

Parameters:

newScopeAttribute - The scopeAttribute to set.

setScopeDelimiter

public void setScopeDelimiter(String newScopeDelimiter)

Set the scope delimiter.

Parameters:

newScopeDelimiter - The scopeDelimiter to set.

setScopeType

public void setScopeType(String newScopeType)

Set the scope type.

Parameters:

newScopeType - The scopeType to set.

encodeAttributeValues

protected List<XMLObject> encodeAttributeValues(QName objectName,
                                    BaseAttribute<ScopedAttributeValue> attribute)

Encodes attributes whose values are scoped.

Parameters:

objectName - name of the attribute value element to create for each value

attribute - the attribute whose values will be encoded

Returns:

the list of encoded attribute values