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

Class AbstractSAML2AttributeEncoder

java.lang.Object

edu.internet2.middleware.shibboleth.common.attribute.encoding.provider.AbstractAttributeEncoder<org.opensaml.saml2.core.Attribute>

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

All Implemented Interfaces:

AttributeEncoder<org.opensaml.saml2.core.Attribute>, SAML2AttributeEncoder, XMLObjectAttributeEncoder<org.opensaml.saml2.core.Attribute>

Direct Known Subclasses:

SAML2Base64AttributeEncoder, SAML2StringAttributeEncoder, SAML2XMLObjectAttributeEncoder

public abstract class AbstractSAML2AttributeEncoder
extends AbstractAttributeEncoder<org.opensaml.saml2.core.Attribute>
implements SAML2AttributeEncoder

Base for encoders that produce Attributes.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.opensaml.common.SAMLObjectBuilder<org.opensaml.saml2.core.Attribute>	attributeBuilder Builder for SAML 2 attribute XMLObjects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSAML2AttributeEncoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFriendlyName() Gets the human friendly name of the attribute.
String	getNameFormat() Gets the attribute's name format.
protected void	populateAttribute(org.opensaml.saml2.core.Attribute attribute) Populates the attribute with attribute name, name format, and friendly name information.
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.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, getAttributeName, setAttributeName

Field Detail

attributeBuilder

protected final org.opensaml.common.SAMLObjectBuilder<org.opensaml.saml2.core.Attribute> attributeBuilder

Builder for SAML 2 attribute XMLObjects.

Constructor Detail

AbstractSAML2AttributeEncoder

protected AbstractSAML2AttributeEncoder()

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

populateAttribute

protected void populateAttribute(org.opensaml.saml2.core.Attribute attribute)

Populates the attribute with attribute name, name format, and friendly name information.

Parameters:

attribute - to populate