Class SAML2NameIDAttributeDefinition
- java.lang.Object
-
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
-
- net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
-
- net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
-
- net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin<IdPAttribute>
-
- net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition
-
- net.shibboleth.idp.saml.attribute.resolver.impl.SAML2NameIDAttributeDefinition
-
- All Implemented Interfaces:
AttributeDefinition,ResolverPlugin<IdPAttribute>,Component,DestructableComponent,IdentifiableComponent,IdentifiedComponent,InitializableComponent,UnmodifiableComponent,DisposableBean
@Deprecated(forRemoval=true, since="4.1.0") public class SAML2NameIDAttributeDefinition extends AbstractAttributeDefinition
Deprecated, for removal: This API element is subject to removal in a future version.An attribute definition that creates attributes whose values areNameID.When building the NameID the textual content of the NameID is the value of the source attribute. If a
getNameIdQualifier()is non-null, then that value is used as the NameID's NameQualifier otherwise the attribute issuer's entityID is used. IfgetNameIdSPQualifier()is non-null, then that valid is used as the NameID's SPNameQualifier, otherwise the attribute recipient's entityID is used.
-
-
Field Summary
Fields Modifier and Type Field Description private org.slf4j.LoggerlogDeprecated, for removal: This API element is subject to removal in a future version.Class logger.private SAMLObjectBuilder<NameID>nameIDBuilderDeprecated, for removal: This API element is subject to removal in a future version.The builder for the object represented inside this attribute.private StringnameIdFormatDeprecated, for removal: This API element is subject to removal in a future version.Format of the NameID.private StringnameIdQualifierDeprecated, for removal: This API element is subject to removal in a future version.Name qualifier for the NameID.private StringnameIdSPQualifierDeprecated, for removal: This API element is subject to removal in a future version.SP name qualifier for the NameID.
-
Constructor Summary
Constructors Constructor Description SAML2NameIDAttributeDefinition()Deprecated, for removal: This API element is subject to removal in a future version.Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected NameIDbuildNameId(String nameIdValue, AttributeResolutionContext resolutionContext)Deprecated, for removal: This API element is subject to removal in a future version.Builds a name ID.protected IdPAttributedoAttributeDefinitionResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext)Deprecated, for removal: This API element is subject to removal in a future version.private XMLObjectAttributeValueencodeOneValue(IdPAttributeValue theValue, AttributeResolutionContext resolutionContext)Deprecated, for removal: This API element is subject to removal in a future version.Worker function for doAttributeDefintionResolve.StringgetNameIdFormat()Deprecated, for removal: This API element is subject to removal in a future version.Gets the format for the NameID used as an attribute value.StringgetNameIdQualifier()Deprecated, for removal: This API element is subject to removal in a future version.Gets the NameQualifier for the NameID used as an attribute value.StringgetNameIdSPQualifier()Deprecated, for removal: This API element is subject to removal in a future version.Gets the SPNameQualifier for the NameID used as an attribute value.voidsetNameIdFormat(String format)Deprecated, for removal: This API element is subject to removal in a future version.Sets the format for the NameID used as an attribute value.voidsetNameIdQualifier(String qualifier)Deprecated, for removal: This API element is subject to removal in a future version.Sets the NameQualifier for the NameID used as an attribute value.voidsetNameIdSPQualifier(String qualifier)Deprecated, for removal: This API element is subject to removal in a future version.Sets the SPNameQualifier for the NameID used as an attribute value.-
Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition
doInitialize, doResolve, getLogPrefix, isDependencyOnly, isPreRequested, setDependencyOnly, setPreRequested
-
Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin
addDisplayInformation, doDestroy, equals, getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, getProfileContextStrategy, hashCode, isPropagateResolutionExceptions, isSuppressDisplayInformation, resolve, setActivationCondition, setAttributeDependencies, setDataConnectorDependencies, setProfileContextStrategy, setPropagateResolutionExceptions, setSuppressDisplayInformation
-
Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
setId
-
Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
getId
-
Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
destroy, 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.utilities.java.support.component.DestructableComponent
destroy, isDestroyed
-
Methods inherited from interface org.springframework.beans.factory.DisposableBean
destroy
-
Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent
getId
-
Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent
initialize, isInitialized
-
Methods inherited from interface net.shibboleth.idp.attribute.resolver.ResolverPlugin
getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, isPropagateResolutionExceptions, resolve
-
-
-
-
Field Detail
-
log
@Nonnull private final org.slf4j.Logger log
Deprecated, for removal: This API element is subject to removal in a future version.Class logger.
-
nameIDBuilder
@Nonnull private final SAMLObjectBuilder<NameID> nameIDBuilder
Deprecated, for removal: This API element is subject to removal in a future version.The builder for the object represented inside this attribute.
-
nameIdFormat
private String nameIdFormat
Deprecated, for removal: This API element is subject to removal in a future version.Format of the NameID.
-
nameIdQualifier
private String nameIdQualifier
Deprecated, for removal: This API element is subject to removal in a future version.Name qualifier for the NameID.
-
nameIdSPQualifier
private String nameIdSPQualifier
Deprecated, for removal: This API element is subject to removal in a future version.SP name qualifier for the NameID.
-
-
Method Detail
-
getNameIdFormat
@Nullable public String getNameIdFormat()
Deprecated, for removal: This API element is subject to removal in a future version.Gets the format for the NameID used as an attribute value.- Returns:
- format for the NameID used as an attribute value
-
setNameIdFormat
public void setNameIdFormat(@Nullable String format)Deprecated, for removal: This API element is subject to removal in a future version.Sets the format for the NameID used as an attribute value.- Parameters:
format- format for the NameID used as an attribute value
-
getNameIdQualifier
@Nullable public String getNameIdQualifier()
Deprecated, for removal: This API element is subject to removal in a future version.Gets the NameQualifier for the NameID used as an attribute value.- Returns:
- NameQualifier for the NameID used as an attribute value
-
setNameIdQualifier
public void setNameIdQualifier(@Nullable String qualifier)Deprecated, for removal: This API element is subject to removal in a future version.Sets the NameQualifier for the NameID used as an attribute value.- Parameters:
qualifier- NameQualifier for the NameID used as an attribute value
-
getNameIdSPQualifier
@Nullable public String getNameIdSPQualifier()
Deprecated, for removal: This API element is subject to removal in a future version.Gets the SPNameQualifier for the NameID used as an attribute value.- Returns:
- SPNameQualifier for the NameID used as an attribute value
-
setNameIdSPQualifier
public void setNameIdSPQualifier(@Nullable String qualifier)Deprecated, for removal: This API element is subject to removal in a future version.Sets the SPNameQualifier for the NameID used as an attribute value.- Parameters:
qualifier- SPNameQualifier for the NameID used as an attribute value
-
buildNameId
protected NameID buildNameId(@Nonnull @NotEmpty String nameIdValue, @Nonnull AttributeResolutionContext resolutionContext) throws ResolutionException
Deprecated, for removal: This API element is subject to removal in a future version.Builds a name ID. The provided value is the textual content of the NameID. The NameQualifier and SPNameQualifier are set according to the configuration, or to the local and requesting entityIDs respectively.- Parameters:
nameIdValue- value of the NameIDresolutionContext- current resolution context- Returns:
- the constructed NameID
- Throws:
ResolutionException- if the IdP Name is empty.
-
encodeOneValue
@Nullable private XMLObjectAttributeValue encodeOneValue(@Nonnull IdPAttributeValue theValue, @Nonnull AttributeResolutionContext resolutionContext) throws ResolutionException
Deprecated, for removal: This API element is subject to removal in a future version.Worker function for doAttributeDefintionResolve. This returns an AttributeValue if the input value is appropriate for encoding as a NameID.- Parameters:
theValue- an arbitrary value.resolutionContext- the context to get the rest of the values from- Returns:
- null or an attributeValue.
- Throws:
ResolutionException- if the IdP Name is empty.
-
doAttributeDefinitionResolve
@Nullable protected IdPAttribute doAttributeDefinitionResolve(@Nonnull AttributeResolutionContext resolutionContext, @Nonnull AttributeResolverWorkContext workContext) throws ResolutionException
Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
doAttributeDefinitionResolvein classAbstractAttributeDefinition- Throws:
ResolutionException
-
-