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

Class X500PrincipalSerializer

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

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

net.shibboleth.idp.authn.principal.impl.X500PrincipalSerializer

All Implemented Interfaces:

PrincipalSerializer<String>, Component, DestructableComponent, InitializableComponent

@ThreadSafe
public class X500PrincipalSerializer
extends AbstractPrincipalSerializer<String>

Principal serializer for X500Principal.

Since:

4.1.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	JSON_PATTERN	Pattern used to determine if input is supported.
private static final String	X500_NAME_FIELD	Field name of X.500 name.

Constructor Summary

Constructors

Constructor	Description
X500PrincipalSerializer()

Method Summary

Modifier and Type	Method	Description
X500Principal	deserialize(String value)	Deserialize the supplied value.
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

X500_NAME_FIELD

@Nonnull
@NotEmpty
private static final String X500_NAME_FIELD

Field name of X.500 name.

See Also:

• Constant Field Values

JSON_PATTERN

private static final Pattern JSON_PATTERN

Pattern used to determine if input is supported.

Constructor Details

X500PrincipalSerializer

public X500PrincipalSerializer()

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