net.shibboleth.idp.saml.attribute.principalconnector.impl

Class PrincipalConnector

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.saml.attribute.principalconnector.impl.PrincipalConnector

All Implemented Interfaces:

NameIDDecoder, NameIdentifierDecoder, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class PrincipalConnector
extends AbstractIdentifiableInitializableComponent
implements NameIdentifierDecoder, NameIDDecoder

The concrete representation of a <PrincipalConnector>, delegates actual work to decoders.

Field Summary

Fields

Modifier and Type	Field and Description
private String	format The format we match against.
private NameIDDecoder	nameIDDecoder The NameID decoder.
private NameIdentifierDecoder	nameIdentifierDecoder The NameIdentifier decoder.
private Collection<String>	relyingParties The relying parties we support.

Constructor Summary

Constructors

Constructor and Description
PrincipalConnector()

Method Summary

Methods

Modifier and Type	Method and Description
String	decode(SubjectCanonicalizationContext c14nContext, org.opensaml.saml.saml2.core.NameID nameID)
String	decode(SubjectCanonicalizationContext c14nContext, org.opensaml.saml.saml1.core.NameIdentifier nameIdentifier)
protected void	doInitialize()
String	getFormat() Get the format we support.
NameIDDecoder	getNameIDDecoder() Get the NameIDDecoder.
NameIdentifierDecoder	getNameIdentifierDecoder() Set the NameIdentifierDecoder.
Collection<String>	getRelyingParties() Get the supported relying parties.
boolean	requesterMatches(String requester) Does the supplier requester (relying party) match our configuration?
void	setFormat(String theFormat) Set the format we support.
void	setNameIDDecoder(NameIDDecoder saml2Decoder) Set the NameIDDecoder.
void	setNameIdentifierDecoder(NameIdentifierDecoder saml1Decoder) Get the NameIdentifierDecoder.
void	setRelyingParties(Collection<String> rps) Set the supported relying parties.

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, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

nameIDDecoder

@NonnullAfterInit
private NameIDDecoder nameIDDecoder

The NameID decoder.

nameIdentifierDecoder

@NonnullAfterInit
private NameIdentifierDecoder nameIdentifierDecoder

The NameIdentifier decoder.

format

@NonnullAfterInit
@NotEmpty
private String format

The format we match against.

relyingParties

@Nonnull
private Collection<String> relyingParties

The relying parties we support.

Constructor Detail

PrincipalConnector

public PrincipalConnector()

Method Detail

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

setNameIDDecoder

@Nonnull
public void setNameIDDecoder(NameIDDecoder saml2Decoder)

Set the NameIDDecoder.

Parameters:

saml2Decoder - the decoder

getNameIDDecoder

@Nonnull
public NameIDDecoder getNameIDDecoder()

Get the NameIDDecoder.

Returns:

the decoder

setNameIdentifierDecoder

@Nonnull
public void setNameIdentifierDecoder(@Nonnull
                                    NameIdentifierDecoder saml1Decoder)

Get the NameIdentifierDecoder.

Parameters:

saml1Decoder - the decoder for a NameIdentifier

getNameIdentifierDecoder

@Nonnull
public NameIdentifierDecoder getNameIdentifierDecoder()

Set the NameIdentifierDecoder.

Returns:

the decoder

setFormat

@Nonnull
public void setFormat(@Nonnull@NotEmpty
                     String theFormat)

Set the format we support.

Parameters:

theFormat - the format to match on

getFormat

@Nonnull
public String getFormat()

Get the format we support.

Returns:

the format we support

getRelyingParties

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Collection<String> getRelyingParties()

Get the supported relying parties.

Returns:

the supporred relying parties

setRelyingParties

public void setRelyingParties(@Nullable@NullableElements
                     Collection<String> rps)

Set the supported relying parties.

Parameters:

rps - the supported relying parties

requesterMatches

public boolean requesterMatches(@Nullable
                       String requester)

Does the supplier requester (relying party) match our configuration?

Parameters:

requester - the requester

Returns:

true iff no relyingParties were configured or the requester matches

decode

@Nullable
public String decode(@Nonnull
                     SubjectCanonicalizationContext c14nContext,
                     @Nonnull
                     org.opensaml.saml.saml2.core.NameID nameID)
              throws NameDecoderException

Specified by:

decode in interface NameIDDecoder

Throws:

NameDecoderException

decode

@Nullable
public String decode(@Nonnull
                     SubjectCanonicalizationContext c14nContext,
                     @Nonnull
                     org.opensaml.saml.saml1.core.NameIdentifier nameIdentifier)
              throws NameDecoderException

Specified by:

decode in interface NameIdentifierDecoder

Throws:

NameDecoderException