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

Class IdPAttributePrincipalSerializer

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

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

net.shibboleth.idp.authn.principal.impl.IdPAttributePrincipalSerializer

All Implemented Interfaces:

PrincipalSerializer<String>, Component, DestructableComponent, InitializableComponent

@ThreadSafe
public class IdPAttributePrincipalSerializer
extends AbstractPrincipalSerializer<String>

Principal serializer for IdPAttributePrincipal.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	EMPTY_VALUE_FIELD	Field name of type code of an EmptyAttributeValue.
private static final Pattern	JSON_PATTERN	Pattern used to determine if input is supported.
private final org.slf4j.Logger	log	Class logger.
private final JsonBuilderFactory	objectBuilderFactory	JSON object bulder factory.
private static final String	PRINCIPAL_ENTRY_FIELD	Field name of principal entry.
private static final String	PRINCIPAL_NAME_FIELD	Field name of principal name.
private static final String	SCOPED_VALUE_FIELD	Field name of type code of an ScopedStringAttributeValue.
private static final String	STRING_VALUE_FIELD	Field name of type code of an StringAttributeValue.

Constructor Summary

Constructors

Constructor	Description
IdPAttributePrincipalSerializer()	Constructor.

Method Summary

Modifier and Type	Method	Description
IdPAttributePrincipal	deserialize(String value)	Deserialize the supplied value.
protected IdPAttributeValue	deserializeValue(JsonObject object)	Deserialize an attribute value from a JsonObject.
private JsonArrayBuilder	getJsonArrayBuilder()	Get a JsonArrayBuilder in a thread-safe manner.
private JsonObjectBuilder	getJsonObjectBuilder()	Get a JsonObjectBuilder in a thread-safe manner.
String	serialize(Principal principal)	Serialize the supplied principal.
protected JsonObject	serializeValue(IdPAttributeValue value)	Serialize an attribute value and produce a JsonObject.
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

PRINCIPAL_NAME_FIELD

@Nonnull
@NotEmpty
private static final String PRINCIPAL_NAME_FIELD

Field name of principal name.

See Also:

• Constant Field Values

PRINCIPAL_ENTRY_FIELD

@Nonnull
@NotEmpty
private static final String PRINCIPAL_ENTRY_FIELD

Field name of principal entry.

See Also:

• Constant Field Values

EMPTY_VALUE_FIELD

@Nonnull
@NotEmpty
private static final String EMPTY_VALUE_FIELD

Field name of type code of an EmptyAttributeValue.

See Also:

• Constant Field Values

STRING_VALUE_FIELD

@Nonnull
@NotEmpty
private static final String STRING_VALUE_FIELD

Field name of type code of an StringAttributeValue.

See Also:

• Constant Field Values

SCOPED_VALUE_FIELD

@Nonnull
@NotEmpty
private static final String SCOPED_VALUE_FIELD

Field name of type code of an ScopedStringAttributeValue.

See Also:

• Constant Field Values

JSON_PATTERN

private static final Pattern JSON_PATTERN

Pattern used to determine if input is supported.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

objectBuilderFactory

@Nonnull
private final JsonBuilderFactory objectBuilderFactory

JSON object bulder factory.

Constructor Details

IdPAttributePrincipalSerializer

public IdPAttributePrincipalSerializer()

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 IdPAttributePrincipal 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

serializeValue

@Nullable
protected JsonObject serializeValue(@Nonnull
 IdPAttributeValue value)

Serialize an attribute value and produce a JsonObject.

Override this method to support additional value types.

Parameters:

value - the attribute value to serialize

Returns:

the object

deserializeValue

@Nullable
protected IdPAttributeValue deserializeValue(@Nonnull
 JsonObject object)

Deserialize an attribute value from a JsonObject.

Override this method to support additional value types.

Parameters:

object - object to deserialize

Returns:

the attribute value, or null

getJsonObjectBuilder

@Nonnull
private JsonObjectBuilder getJsonObjectBuilder()

Get a JsonObjectBuilder in a thread-safe manner.

Returns:

an object builder

getJsonArrayBuilder

@Nonnull
private JsonArrayBuilder getJsonArrayBuilder()

Get a JsonArrayBuilder in a thread-safe manner.

Returns:

an array builder