Package se.curity.identityserver.sdk.haapi

Interface RepresentationFactory

public interface RepresentationFactory
Interface providing a set of factory methods to create different type of success and error representations. Implementations of this interface are provided to the RepresentationFunction.apply(RepresentationModel, RepresentationFactory) method.
Since:
5.4.0

  • Method Details

    • newAuthenticationStep

      Representation newAuthenticationStep(Consumer<? super AuthenticationStepConfigurator> builder)
      Creates the representation of an authentication step.
      Parameters:
      builder - builder allowing the addition of the step content, such as messages, actions and links.
      Returns:
      The representation of an authentication step.

    • newRegistrationStep

      Representation newRegistrationStep(Consumer<? super RegistrationStepConfigurator> builder)
      Creates the representation of a registration step.
      Parameters:
      builder - builder allowing the addition of the step content, such as messages, actions and links.
      Returns:
      The representation of a registration step.

    • newConsentorStep

      Representation newConsentorStep(Consumer<? super ConsentorStepConfigurator> builder)
      Creates the representation of a consentor step.
      Parameters:
      builder - builder allowing the addition of the step content, such as messages, actions and links.
      Returns:
      The representation of a consentor step.
      Since:
      6.0.0

    • newPostRedirectStep

      Representation newPostRedirectStep(URI uri, Consumer<? super FormActionHiddenFields> builder)
      Creates the representation of a POST-based redirect step, i.e., a step that the client application should perform automatically without requiring user interaction.
      Parameters:
      uri - the target URI for the HTTP request with POST method.
      builder - a builder allowing the addition of hidden fields to the redirect step.
      Returns:
      the redirect step.

    • newGetRedirectStep

      Representation newGetRedirectStep(URI uri)
      Creates the representation of a GET-based redirect step, i.e., a step that the client application should perform automatically without requiring user interaction.
      Parameters:
      uri - the target URI for the HTTP request with GET method.
      Returns:
      the redirect step.

    • newPollingStep

      PollingRepresentationFactory newPollingStep()
      Returns a polling step factory.
      Returns:
      an interface with factory methods to create polling step representations.

    • newContinueOnSameStep

      Representation newContinueOnSameStep(Consumer<? super UserMessages> builder)
      Creates a representation that informs the client application that the authentication process didn't advance as a result of the performed action.

      If continuation actions for the performed action are available on the previous step representation, those should be attempted.

      Otherwise, other actions already available on the previous step representation should allow the user to decide on how to proceed.

      Parameters:
      builder - builder allowing the addition of the representation content.
      Returns:
      The representation to continue on the same step
      See Also: