Package swiss.trustbroker.saml.dto

Class ResponseStatus

java.lang.Object
swiss.trustbroker.saml.dto.ResponseStatus
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CpResponse, RpRequest
public abstract class ResponseStatus extends Object implements Serializable
Base class for CP and RP side status codes.
See Also:

  • Field Details

    • statusCode

      protected String statusCode
      Usually urn:oasis:names:tc:SAML:2.0:status:Responder

    • statusNestedCode

      protected String statusNestedCode
      E.g. urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile

    • statusMessage

      protected String statusMessage
      E.g. SAML Federation not completed due to ....

    • flowPolicy

      protected Flow flowPolicy
      Optional flow policy to control the abort flow.

  • Constructor Details

  • Method Details

    • abort

      public void abort(String statusCode, String statusMessage, String statusNestedCode)
      Abort a SAML exchange (script hook).

    • abort

      public void abort(String statusCode, Flow flowPolicy)
      Abort a SAML exchange with a message to RP.

    • abort

      public void abort(String statusCode, String statusMessage, String statusNestedCode, Flow flowPolicy)
      Abort a SAML exchange with a message to RP.

    • resetErrorPageStatus

      public void resetErrorPageStatus()
      Reset error page passed as flow policy to abort.

    • copyAbortConditions

      public void copyAbortConditions(ResponseStatus responseStatus)

    • isAborted

      public boolean isAborted()

    • showErrorPage

      public boolean showErrorPage()

    • doAppRedirect

      public boolean doAppRedirect()

    • statusMessage

      public String statusMessage()

    • statusMessage

      public String statusMessage(SamlProperties samlProperties)

    • nestedStatusCode

      public String nestedStatusCode()

    • nestedStatusCode

      public String nestedStatusCode(SamlProperties samlProperties)

    • uiErrorCode

      public String uiErrorCode()

    • uiFlags

      public List<String> uiFlags()

    • featureConditions

      public void featureConditions(Set<String> featureConditions)
      Script hook: Toggle features via conditions.
      Since:
      1.9.0

    • featureConditions

      public void featureConditions(Map<String,String> featureConditions)
      Script hook: Toggle features via conditions.
      Since:
      1.11.0

    • addFeatureCondition

      public boolean addFeatureCondition(String featureCondition)
      Script hook: Add single feature condition.
      Returns:
      true if it was not present before
      Since:
      1.9.0

    • addFeatureCondition

      public boolean addFeatureCondition(String featureCondition, String parameter)
      Script hook: Add single feature condition with a nullable parameter.
      Returns:
      true if it was not present before
      Since:
      1.11.0

    • removeFeatureCondition

      public boolean removeFeatureCondition(String featureCondition)
      Script hook: Remove single feature condition.
      Returns:
      true if it was present
      Since:
      1.9.0

    • hasFeatureCondition

      public boolean hasFeatureCondition(String featureCondition)
      Script hook: Test single feature condition.
      Since:
      1.9.0

    • featureCondition

      public String featureCondition(String featureCondition)
      Script hook: Get single feature condition parameter.
      Since:
      1.11.0

    • featureConditions

      public Map<String,String> featureConditions()
      Get all feature conditions.
      Since:
      1.11.0

    • featureConditionSet

      public Set<String> featureConditionSet()
      Get all feature conditions without parameters.
      Since:
      1.11.0

    • getStatusCode

      public String getStatusCode()
      Usually urn:oasis:names:tc:SAML:2.0:status:Responder

    • getStatusNestedCode

      public String getStatusNestedCode()
      E.g. urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile

    • getStatusMessage

      public String getStatusMessage()
      E.g. SAML Federation not completed due to ....

    • getFlowPolicy

      public Flow getFlowPolicy()
      Optional flow policy to control the abort flow.

    • getFeatureConditions

      public Map<String,String> getFeatureConditions()
      Set by scripts to toggle features, to be consumed by the respective implementations.
      Potentially breaking changes:
      • With 1.11.0 This changed from Set to Map. Scripts that access the getter/setter directly have to be adapted (use featureConditionSet, featureConditions).
      Since:
      1.9.0

    • setStatusCode

      public void setStatusCode(String statusCode)
      Usually urn:oasis:names:tc:SAML:2.0:status:Responder

    • setStatusNestedCode

      public void setStatusNestedCode(String statusNestedCode)
      E.g. urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile

    • setStatusMessage

      public void setStatusMessage(String statusMessage)
      E.g. SAML Federation not completed due to ....

    • setFlowPolicy

      public void setFlowPolicy(Flow flowPolicy)
      Optional flow policy to control the abort flow.

    • setFeatureConditions

      public void setFeatureConditions(Map<String,String> featureConditions)
      Set by scripts to toggle features, to be consumed by the respective implementations.
      Potentially breaking changes:
      • With 1.11.0 This changed from Set to Map. Scripts that access the getter/setter directly have to be adapted (use featureConditionSet, featureConditions).
      Since:
      1.9.0

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object