net.shibboleth.idp.saml.attribute.encoding.impl

Class SAML2ScopedStringAttributeEncoder

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.saml.attribute.encoding.AbstractSAMLAttributeEncoder<org.opensaml.saml.saml2.core.Attribute,EncodedType>

net.shibboleth.idp.saml.attribute.encoding.AbstractSAML2AttributeEncoder<ScopedStringAttributeValue>

net.shibboleth.idp.saml.attribute.encoding.impl.SAML2ScopedStringAttributeEncoder

All Implemented Interfaces:

AttributeEncoder<org.opensaml.saml.saml2.core.Attribute>, AttributeMapperProcessor<org.opensaml.saml.saml2.metadata.RequestedAttribute,IdPRequestedAttribute>, SAML2AttributeEncoder<ScopedStringAttributeValue>, Component, DestructableComponent, InitializableComponent, UnmodifiableComponent

public class SAML2ScopedStringAttributeEncoder
extends AbstractSAML2AttributeEncoder<ScopedStringAttributeValue>
implements AttributeMapperProcessor<org.opensaml.saml.saml2.metadata.RequestedAttribute,IdPRequestedAttribute>

AttributeEncoder that produces a SAML 2 Attribute from an IdPAttribute that contains scoped string values.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private String	scopeAttributeName Attribute name used for "attribute" scopeType.
private String	scopeDelimiter Delimiter used for "inline" scopeType.
private String	scopeType Type of scoping to use.

Constructor Summary

Constructors

Constructor and Description
SAML2ScopedStringAttributeEncoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canEncodeValue(IdPAttribute attribute, IdPAttributeValue value)
protected void	doInitialize() Ensures that the values we will need are all there.
protected org.opensaml.core.xml.XMLObject	encodeValue(IdPAttribute attribute, ScopedStringAttributeValue value)
String	getScopeAttributeName() Get the name of the non-inline scope-carrying attribute.
String	getScopeDelimiter() Get the scope delimiter.
String	getScopeType() Get the scope syntax type.
void	populateAttributeMapper(AbstractSAMLAttributeMapper<org.opensaml.saml.saml2.metadata.RequestedAttribute,IdPRequestedAttribute> mapper)
void	setScopeAttributeName(String newScopeAttribute) Set the name of the non-inline scope-carrying attribute.
void	setScopeDelimiter(String newScopeDelimiter) Set the scope delimiter.
void	setScopeType(String newScopeType) Set the scope syntax type.

Methods inherited from class net.shibboleth.idp.saml.attribute.encoding.AbstractSAML2AttributeEncoder

buildAttribute, equals, getEffectiveNameFormat, getFriendlyName, getMapperId, getNameFormat, getProtocol, hashCode, setFriendlyName, setNameFormat

Methods inherited from class net.shibboleth.idp.saml.attribute.encoding.AbstractSAMLAttributeEncoder

encode, encodeType, getActivationCondition, getName, setActivationCondition, setEncodeType, setName

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.idp.saml.attribute.encoding.SAML2AttributeEncoder

getName

Methods inherited from interface net.shibboleth.idp.attribute.AttributeEncoder

encode, getActivationCondition

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

scopeType

@Nullable
private String scopeType

Type of scoping to use.

scopeDelimiter

@Nullable
private String scopeDelimiter

Delimiter used for "inline" scopeType.

scopeAttributeName

@Nullable
private String scopeAttributeName

Attribute name used for "attribute" scopeType.

Constructor Detail

SAML2ScopedStringAttributeEncoder

public SAML2ScopedStringAttributeEncoder()

Constructor.

Method Detail

getScopeAttributeName

@Nullable
public String getScopeAttributeName()

Get the name of the non-inline scope-carrying attribute.

Returns:

the name of the scope-carrying attribute

getScopeDelimiter

@Nullable
public String getScopeDelimiter()

Get the scope delimiter.

Returns:

the scope delimiter

getScopeType

@Nullable
public String getScopeType()

Get the scope syntax type.

Returns:

the type of scope syntax to use

setScopeAttributeName

public void setScopeAttributeName(@Nullable
                         String newScopeAttribute)

Set the name of the non-inline scope-carrying attribute.

Parameters:

newScopeAttribute - the name to set

setScopeDelimiter

public void setScopeDelimiter(@Nullable
                     String newScopeDelimiter)

Set the scope delimiter.

Parameters:

newScopeDelimiter - delimiter to set

setScopeType

public void setScopeType(@Nullable
                String newScopeType)

Set the scope syntax type.

Parameters:

newScopeType - the scope syntax type

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Ensures that the values we will need are all there.

Overrides:

doInitialize in class AbstractSAMLAttributeEncoder<org.opensaml.saml.saml2.core.Attribute,ScopedStringAttributeValue>

Throws:

ComponentInitializationException

canEncodeValue

protected boolean canEncodeValue(@Nonnull
                     IdPAttribute attribute,
                     @Nonnull
                     IdPAttributeValue value)

Specified by:

canEncodeValue in class AbstractSAMLAttributeEncoder<org.opensaml.saml.saml2.core.Attribute,ScopedStringAttributeValue>

encodeValue

@Nullable
protected org.opensaml.core.xml.XMLObject encodeValue(@Nonnull
                                                   IdPAttribute attribute,
                                                   @Nonnull
                                                   ScopedStringAttributeValue value)
                                               throws AttributeEncodingException

Specified by:

encodeValue in class AbstractSAMLAttributeEncoder<org.opensaml.saml.saml2.core.Attribute,ScopedStringAttributeValue>

Throws:

AttributeEncodingException

populateAttributeMapper

@Nonnull
public void populateAttributeMapper(AbstractSAMLAttributeMapper<org.opensaml.saml.saml2.metadata.RequestedAttribute,IdPRequestedAttribute> mapper)

Specified by:

populateAttributeMapper in interface AttributeMapperProcessor<org.opensaml.saml.saml2.metadata.RequestedAttribute,IdPRequestedAttribute>