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

Class SAML2ScopedStringAttributeEncoder

java.lang.Object

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

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

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

All Implemented Interfaces:

AttributeEncoder<Attribute>, SAML2AttributeEncoder, XMLObjectAttributeEncoder<Attribute>

public class SAML2ScopedStringAttributeEncoder
extends AbstractScopedAttributeEncoder<Attribute>
implements SAML2AttributeEncoder

Implementation of SAML 2.0 scoped attribute encoder.

Field Summary

Fields

Modifier and Type	Field and Description
private SAMLObjectBuilder<Attribute>	attributeBuilder Builder for SAML 2 attribute XMLObjects.
private String	format Format of attribute.
private String	friendlyName Friendly name of attribute.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
SAML2ScopedStringAttributeEncoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Attribute	encode(BaseAttribute attribute) Enocdes the attribute into a protocol specific representations.
String	getFriendlyName() Gets the human friendly name of the attribute.
String	getNameFormat() Gets the attribute's name format.
void	setFriendlyName(String name) Sets the human friendly name of the attribute.
void	setNameFormat(String newFormat) Sets the attribute's name format.

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

encodeAttributeValues, getScopeAttribute, getScopeDelimiter, getScopeType, setScopeAttribute, setScopeDelimiter, setScopeType

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

getAttributeName, setAttributeName

Field Detail

log

private final org.slf4j.Logger log

Class logger.

attributeBuilder

private final SAMLObjectBuilder<Attribute> attributeBuilder

Builder for SAML 2 attribute XMLObjects.

format

private String format

Format of attribute.

friendlyName

private String friendlyName

Friendly name of attribute.

Constructor Detail

SAML2ScopedStringAttributeEncoder

public SAML2ScopedStringAttributeEncoder()

Constructor.

Method Detail

getNameFormat

public String getNameFormat()

Gets the attribute's name format.

Specified by:

getNameFormat in interface SAML2AttributeEncoder

Returns:

attribute's name format

getFriendlyName

public String getFriendlyName()

Gets the human friendly name of the attribute.

Specified by:

getFriendlyName in interface SAML2AttributeEncoder

Returns:

human friendly name of the attribute

setNameFormat

public void setNameFormat(String newFormat)

Sets the attribute's name format.

Specified by:

setNameFormat in interface SAML2AttributeEncoder

Parameters:

newFormat - attribute's name format

setFriendlyName

public void setFriendlyName(String name)

Sets the human friendly name of the attribute.

Specified by:

setFriendlyName in interface SAML2AttributeEncoder

Parameters:

name - human friendly name of the attribute

encode

public Attribute encode(BaseAttribute attribute)
                 throws AttributeEncodingException

Enocdes the attribute into a protocol specific representations.

Specified by:

encode in interface AttributeEncoder<Attribute>

Parameters:

attribute - the attribute to encode

Returns:

the Object the attribute was encoded into

Throws:

AttributeEncodingException - if unable to successfully encode attribute