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

Class SAML2StringNameIDEncoder

java.lang.Object

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

net.shibboleth.idp.saml.attribute.encoding.AbstractSAML2NameIDEncoder

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

All Implemented Interfaces:

Predicate<String>, AttributeEncoder<org.opensaml.saml.saml2.core.NameID>, NameIdentifierAttributeEncoder<org.opensaml.saml.saml2.core.NameID>, SAML2NameIDAttributeEncoder, Component, DestructableComponent, InitializableComponent

public class SAML2StringNameIDEncoder
extends AbstractSAML2NameIDEncoder

NameIdentifierAttributeEncoder that encodes the first String value of an IdPAttribute to a SAML 2 NameID.

Field Summary

Fields

Modifier and Type	Field and Description
private String	format The format of the name identifier.
private org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.NameID>	identifierBuilder Identifier builder.
private org.slf4j.Logger	log Class logger.
private String	qualifier The security or administrative domain that qualifies the name identifier.

Constructor Summary

Constructors

Constructor and Description
SAML2StringNameIDEncoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(String input)
org.opensaml.saml.saml2.core.NameID	encode(IdPAttribute attribute)
boolean	equals(Object obj)
String	getNameFormat() Get the format of the name identifier.
String	getNameQualifier() Get the security or administrative domain that qualifies the name identifier.
int	hashCode()
void	setNameFormat(String nameFormat) Set the format of the name identifier.
void	setNameQualifier(String nameQualifier) Set the security or administrative domain that qualifies the name identifier.

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

getActivationCondition, getProtocol, setActivationCondition

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

destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

identifierBuilder

@Nonnull
private final org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.NameID> identifierBuilder

Identifier builder.

format

@Nullable
private String format

The format of the name identifier.

qualifier

@Nullable
private String qualifier

The security or administrative domain that qualifies the name identifier.

Constructor Detail

SAML2StringNameIDEncoder

public SAML2StringNameIDEncoder()

Constructor.

Method Detail

getNameFormat

@Nullable
public final String getNameFormat()

Get the format of the name identifier.

Returns:

format of the name identifier

setNameFormat

public final void setNameFormat(@Nullable
                 String nameFormat)

Set the format of the name identifier.

Parameters:

nameFormat - format of the name identifier

getNameQualifier

@Nullable
public final String getNameQualifier()

Get the security or administrative domain that qualifies the name identifier.

Returns:

security or administrative domain that qualifies the name identifier

setNameQualifier

@Nullable
public final void setNameQualifier(String nameQualifier)

Set the security or administrative domain that qualifies the name identifier.

Parameters:

nameQualifier - security or administrative domain that qualifies the name identifier

apply

public boolean apply(String input)

encode

@Nonnull
public org.opensaml.saml.saml2.core.NameID encode(@Nonnull
                                                 IdPAttribute attribute)
                                           throws AttributeEncodingException

Throws:

AttributeEncodingException

equals

public boolean equals(Object obj)

Specified by:

equals in interface Predicate<String>

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object