Package net.shibboleth.idp.authn.principal.impl

Class ProxyAuthenticationPrincipalSerializer

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.idp.authn.principal.AbstractPrincipalSerializer<String>

net.shibboleth.idp.authn.principal.impl.ProxyAuthenticationPrincipalSerializer

All Implemented Interfaces:

PrincipalSerializer<String>, Component, DestructableComponent, InitializableComponent

@ThreadSafe
public class ProxyAuthenticationPrincipalSerializer
extends AbstractPrincipalSerializer<String>

Principal serializer for ProxyAuthenticationPrincipal.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	JSON_PATTERN	Pattern used to determine if input is supported.
private final JsonBuilderFactory	objectBuilderFactory	JSON object bulder factory.
private static final String	PROXY_AUD_FIELD	Field name of proxy audiences.
private static final String	PROXY_AUTH_FIELD	Field name of authority content.
private static final String	PROXY_COUNT_FIELD	Field name of proxy count.

Constructor Summary

Constructors

Constructor	Description
ProxyAuthenticationPrincipalSerializer()	Constructor.

Method Summary

Modifier and Type	Method	Description
ProxyAuthenticationPrincipal	deserialize(String value)	Deserialize the supplied value.
private JsonArrayBuilder	getJsonArrayBuilder()	Get a JsonArrayBuilder in a thread-safe manner.
String	serialize(Principal principal)	Serialize the supplied principal.
boolean	supports(String value)	Whether the supplied value can be deserialized.
boolean	supports(Principal principal)	Whether the supplied principal can be serialized.

Methods inherited from class net.shibboleth.idp.authn.principal.AbstractPrincipalSerializer

getJsonGenerator, getJsonReader

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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.shared.component.InitializableComponent

initialize, isInitialized

Field Details

PROXY_AUTH_FIELD

@Nonnull
@NotEmpty
private static final String PROXY_AUTH_FIELD

Field name of authority content.

See Also:

• Constant Field Values

PROXY_COUNT_FIELD

@Nonnull
@NotEmpty
private static final String PROXY_COUNT_FIELD

Field name of proxy count.

See Also:

• Constant Field Values

PROXY_AUD_FIELD

@Nonnull
@NotEmpty
private static final String PROXY_AUD_FIELD

Field name of proxy audiences.

See Also:

• Constant Field Values

JSON_PATTERN

private static final Pattern JSON_PATTERN

Pattern used to determine if input is supported.

objectBuilderFactory

@Nonnull
private final JsonBuilderFactory objectBuilderFactory

JSON object bulder factory.

Constructor Details

ProxyAuthenticationPrincipalSerializer

public ProxyAuthenticationPrincipalSerializer()

Constructor.

Method Details

supports

public boolean supports(@Nonnull
 Principal principal)

Whether the supplied principal can be serialized.

Parameters:

principal - to examine

Returns:

whether principal can be serialized

serialize

@Nonnull
@NotEmpty
public String serialize(@Nonnull
 Principal principal)
                 throws IOException

Serialize the supplied principal.

Parameters:

principal - to serialize

Returns:

serialized value

Throws:

IOException - if an error occurs during serialization

supports

public boolean supports(@Nonnull @NotEmpty
 String value)

Whether the supplied value can be deserialized.

Parameters:

value - to examine

Returns:

whether value can be deserialized

deserialize

@Nullable
public ProxyAuthenticationPrincipal deserialize(@Nonnull @NotEmpty
 String value)
                                         throws IOException

Deserialize the supplied value.

Parameters:

value - to deserialize

Returns:

principal

Throws:

IOException - if an error occurs during deserialization

getJsonArrayBuilder

@Nonnull
private JsonArrayBuilder getJsonArrayBuilder()

Get a JsonArrayBuilder in a thread-safe manner.

Returns:

an array builder