Package swiss.trustbroker.federation.xmlconfig

Class Flow

java.lang.Object
swiss.trustbroker.federation.xmlconfig.Flow
All Implemented Interfaces:
Serializable
public class Flow extends Object implements Serializable
Configuration for an individual error code.
See Also:

  • Field Details

  • Constructor Details

    • Flow

      public Flow()

    • Flow

      public Flow(String id, String namespacePrefix, Boolean supportInfo, Boolean reLogin, Boolean appContinue, Boolean link, String appRedirectUrl, String appUrl, String supportEmail, String supportPhone)
      Creates a new Flow instance.
      Parameters:
      id - SAML error code with or without namespace, adding 
      trustbroker.config.saml.flowNamespaces
      if needed.
      E.g. UserCancel, PwResetSuccessful, PwResetFailed, PwResetTmpBlocked, urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal
      namespacePrefix - Prefix if there are multiple 
      trustbroker.config.saml.flowNamespaces
      .
      supportInfo - Show error page including a support info section.
      reLogin - Show error page including re-login button (triggers another login).
      appContinue - Show error page including continue to application button (send SAML error on to application).
      link - Show error page including a link to appUrl.
      appRedirectUrl - Redirect to (application-specific) URL instead of showing an error page.
      appUrl - Show a link to further information on the error page (general error information on the application or specific to this error code).
      supportEmail - Show (application specific) support e-mail address on the error page.
      supportPhone - Show (application specific) support phone number on the error page.
      Since:
      1.10.0, 1.8.0

  • Method Details

    • showErrorPage

      public boolean showErrorPage()

    • doAppRedirect

      public boolean doAppRedirect()

    • uiFlags

      public List<String> uiFlags()

    • doAppContinue

      public boolean doAppContinue()

    • builder

      public static Flow.FlowBuilder builder()

    • getId

      public String getId()
      SAML error code with or without namespace, adding 
      trustbroker.config.saml.flowNamespaces
      if needed.
      E.g. UserCancel, PwResetSuccessful, PwResetFailed, PwResetTmpBlocked, urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal

    • getNamespacePrefix

      public String getNamespacePrefix()
      Prefix if there are multiple 
      trustbroker.config.saml.flowNamespaces
      .

    • getSupportInfo

      public Boolean getSupportInfo()
      Show error page including a support info section.

    • getReLogin

      public Boolean getReLogin()
      Show error page including re-login button (triggers another login).

    • getAppContinue

      public Boolean getAppContinue()
      Show error page including continue to application button (send SAML error on to application).

    • getLink

      public Boolean getLink()
      Show error page including a link to appUrl.
      Since:
      1.10.0

    • getAppRedirectUrl

      public String getAppRedirectUrl()
      Redirect to (application-specific) URL instead of showing an error page.
      Since:
      1.8.0

    • getAppUrl

      public String getAppUrl()
      Show a link to further information on the error page (general error information on the application or specific to this error code).

    • getSupportEmail

      public String getSupportEmail()
      Show (application specific) support e-mail address on the error page.

    • getSupportPhone

      public String getSupportPhone()
      Show (application specific) support phone number on the error page.

    • setId

      public void setId(String id)
      SAML error code with or without namespace, adding 
      trustbroker.config.saml.flowNamespaces
      if needed.
      E.g. UserCancel, PwResetSuccessful, PwResetFailed, PwResetTmpBlocked, urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal

    • setNamespacePrefix

      public void setNamespacePrefix(String namespacePrefix)
      Prefix if there are multiple 
      trustbroker.config.saml.flowNamespaces
      .

    • setSupportInfo

      public void setSupportInfo(Boolean supportInfo)
      Show error page including a support info section.

    • setReLogin

      public void setReLogin(Boolean reLogin)
      Show error page including re-login button (triggers another login).

    • setAppContinue

      public void setAppContinue(Boolean appContinue)
      Show error page including continue to application button (send SAML error on to application).

    • setLink

      public void setLink(Boolean link)
      Show error page including a link to appUrl.
      Since:
      1.10.0

    • setAppRedirectUrl

      public void setAppRedirectUrl(String appRedirectUrl)
      Redirect to (application-specific) URL instead of showing an error page.
      Since:
      1.8.0

    • setAppUrl

      public void setAppUrl(String appUrl)
      Show a link to further information on the error page (general error information on the application or specific to this error code).

    • setSupportEmail

      public void setSupportEmail(String supportEmail)
      Show (application specific) support e-mail address on the error page.

    • setSupportPhone

      public void setSupportPhone(String supportPhone)
      Show (application specific) support phone number on the error page.

    • 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