Package swiss.trustbroker.saml.dto

Class RpRequest

java.lang.Object
swiss.trustbroker.saml.dto.ResponseStatus
swiss.trustbroker.saml.dto.RpRequest
All Implemented Interfaces:
Serializable
public class RpRequest extends ResponseStatus
Class is used to implement the contract towards ScriptService on RP request processing side. See CpResponse class for counterpart on CP side.
See Also:

  • Field Details

    • CONTEXT_OIDC_AUTHORIZATION_QUERY_PARAMETER

      public static final String CONTEXT_OIDC_AUTHORIZATION_QUERY_PARAMETER
      Context key set by script to add one or several query parameters to the authorization request towards an OIDC CP.
      Since:
      1.11.0
      See Also:

  • Constructor Details

    • RpRequest

      protected RpRequest(RpRequest.RpRequestBuilder<?,?> b)

    • RpRequest

      public RpRequest()

    • RpRequest

      public RpRequest(String referer, String rpIssuer, String requestId, String applicationName, List<String> contextClasses, Map<String,String> context, QoaComparison comparisonType, boolean useSkinnyHrdScreen, List<ClaimsProvider> claimsProviders, UiObjects uiObjects)
      Creates a new RpRequest instance.
      Parameters:
      referer - Referer header from the incoming HTTP request.
      rpIssuer - Issuer of the incoming SAML request
      requestId - ID of the incoming message (e.g. AuthnRequest).
      applicationName - Application name e.g. from AuthnRequest.ProviderName.
      contextClasses - AuthnRequest RequestedAuthnContext.ContextClassRefs.
      context - Map to store internal processing attributes required during federation.
      comparisonType - AuthnRequest RequestedAuthnContext.comparisonType.
      useSkinnyHrdScreen - Allow to use a non-angular version of the HRD screen
      Default: false
      claimsProviders - ClaimsProvider mappings for RelyingParty.
      uiObjects - UI objects for the HRD screen.
      Since:
      1.9.0

  • Method Details

    • getClaimsProvider

      public ClaimsProvider getClaimsProvider(String id)
      Parameters:
      id -
      Returns:
      ClaimsProvider with that ID or null

    • hasSingleClaimsProvider

      public boolean hasSingleClaimsProvider()
      Returns:
      HRD: Federation to single CP possible

    • getClaimsProvidersCount

      public int getClaimsProvidersCount()
      Returns:
      Number of ClaimsProviders in the mapping.

    • addUiElement

      public void addUiElement(UiObject uiObject)
      Parameters:
      uiObject - HRD: Manually construct a HRD tile - script hook

    • addBanner

      public void addBanner(UiBanner uiBanner)
      Parameters:
      uiBanner - HRD: Manually construct a HRD banner - script hook

    • dropClaimsProvider

      public ClaimsProvider dropClaimsProvider(String id)
      Parameters:
      id - HRD: Remove a specific ClaimsProvider
      Returns:
      removed ClaimsProvider

    • retainClaimsProvider

      public ClaimsProvider retainClaimsProvider(String id)
      Parameters:
      id - HRD: Retain a specific one if present, to automatically dispatch
      Returns:
      retained ClaimsProvider

    • hasContextClass

      public boolean hasContextClass(String contextClass)
      Parameters:
      contextClass -
      Returns:
      If context class was set in request.

    • addContextClass

      public boolean addContextClass(String contextClass)
      Parameters:
      contextClass - Add context class if not yet present.
      Returns:
      true if added

    • removeContextClass

      public boolean removeContextClass(String contextClass)
      Parameters:
      contextClass - Remove context class.
      Returns:
      true if removed

    • retainContextClass

      public boolean retainContextClass(String contextClass)
      Parameters:
      contextClass - Retain a single context class if present.
      Returns:
      true if modified
      Since:
      1.9.0

    • addContext

      public String addContext(String name, String value)
      Add internal federation context required during federation.
      Returns:
      replaced context value or null

    • getContext

      public String getContext(String name)
      Query internal federation context setup during federation.
      Returns:
      context value or null if not found.

    • removeContext

      public String removeContext(String name)
      Remove internal federation context required during federation.
      Returns:
      removed context value or null.

    • builder

      public static RpRequest.RpRequestBuilder<?,?> builder()

    • getReferer

      public String getReferer()
      Referer header from the incoming HTTP request.

    • getRpIssuer

      public String getRpIssuer()
      Issuer of the incoming SAML request

    • getRequestId

      public String getRequestId()
      ID of the incoming message (e.g. AuthnRequest).

    • getApplicationName

      public String getApplicationName()
      Application name e.g. from AuthnRequest.ProviderName.

    • getContextClasses

      public List<String> getContextClasses()
      AuthnRequest RequestedAuthnContext.ContextClassRefs.

    • getContext

      public Map<String,String> getContext()
      Map to store internal processing attributes required during federation.

    • getComparisonType

      public QoaComparison getComparisonType()
      AuthnRequest RequestedAuthnContext.comparisonType.
      Since:
      1.9.0

    • isUseSkinnyHrdScreen

      public boolean isUseSkinnyHrdScreen()
      Allow to use a non-angular version of the HRD screen
      Default: false

    • getClaimsProviders

      public List<ClaimsProvider> getClaimsProviders()
      ClaimsProvider mappings for RelyingParty.

    • getUiObjects

      public UiObjects getUiObjects()
      UI objects for the HRD screen.

    • setReferer

      public void setReferer(String referer)
      Referer header from the incoming HTTP request.

    • setRpIssuer

      public void setRpIssuer(String rpIssuer)
      Issuer of the incoming SAML request

    • setRequestId

      public void setRequestId(String requestId)
      ID of the incoming message (e.g. AuthnRequest).

    • setApplicationName

      public void setApplicationName(String applicationName)
      Application name e.g. from AuthnRequest.ProviderName.

    • setContextClasses

      public void setContextClasses(List<String> contextClasses)
      AuthnRequest RequestedAuthnContext.ContextClassRefs.

    • setContext

      public void setContext(Map<String,String> context)
      Map to store internal processing attributes required during federation.

    • setComparisonType

      public void setComparisonType(QoaComparison comparisonType)
      AuthnRequest RequestedAuthnContext.comparisonType.
      Since:
      1.9.0

    • setUseSkinnyHrdScreen

      public void setUseSkinnyHrdScreen(boolean useSkinnyHrdScreen)
      Allow to use a non-angular version of the HRD screen
      Default: false

    • setClaimsProviders

      public void setClaimsProviders(List<ClaimsProvider> claimsProviders)
      ClaimsProvider mappings for RelyingParty.

    • setUiObjects

      public void setUiObjects(UiObjects uiObjects)
      UI objects for the HRD screen.

    • toString

      public String toString()
      Overrides:
      toString in class ResponseStatus

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class ResponseStatus

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class ResponseStatus

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class ResponseStatus