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

Class AuthenticationResultPrincipalSerializer

java.lang.Object
net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
net.shibboleth.idp.authn.principal.AbstractPrincipalSerializer<String>
net.shibboleth.idp.authn.principal.impl.AuthenticationResultPrincipalSerializer
All Implemented Interfaces:
PrincipalSerializer<String>, Component, DestructableComponent, InitializableComponent
@ThreadSafe public class AuthenticationResultPrincipalSerializer extends AbstractPrincipalSerializer<String>
Principal serializer for AuthenticationResultPrincipal.

  • Field Details

    • PRINCIPAL_NAME_FIELD

      @Nonnull @NotEmpty private static final String PRINCIPAL_NAME_FIELD
      Field name of principal name.
      See Also:

    • 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.

    • resultSerializer

      @Nonnull private final StorageSerializer<AuthenticationResult> resultSerializer
      Circular reference back to the parent serializer.

    • objectBuilderFactory

      @Nonnull private final javax.json.JsonBuilderFactory objectBuilderFactory
      JSON object bulder factory.

  • Constructor Details

  • 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 AuthenticationResultPrincipal 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

    • getJsonObjectBuilder

      @Nonnull private javax.json.JsonObjectBuilder getJsonObjectBuilder()
      Get a JsonObjectBuilder in a thread-safe manner.
      Returns:
      an object builder

    • getJsonArrayBuilder

      @Nonnull private javax.json.JsonArrayBuilder getJsonArrayBuilder()
      Get a JsonArrayBuilder in a thread-safe manner.
      Returns:
      an array builder