Package swiss.trustbroker.config.dto

Class AccessRequestConfig

java.lang.Object
swiss.trustbroker.config.dto.AccessRequestConfig
public class AccessRequestConfig extends Object
Access request configuration.
Potentially breaking changes:
  • With 1.10.0 value of attributes changed to Object to allow nested structures.
See Also:

  • Constructor Details

    • AccessRequestConfig

      public AccessRequestConfig()

    • AccessRequestConfig

      public AccessRequestConfig(boolean enabled, String interactiveServiceUrl, String interactiveServiceParameters, String interactiveMultiServiceParameters, String centralCICD, String interactiveResultParameter, String interactiveResultUserCancel, String silentServiceUrl, String endpointReferenceAddress, int wsTrustRequestValiditySeconds, String wsTrustSoapProtocolVersion, swiss.trustbroker.common.config.KeystoreProperties truststore, swiss.trustbroker.common.config.KeystoreProperties signerTruststore, boolean doSignSamlMessages, String signatureMethodAlgorithm, String canonicalizationAlgorithm, String digestMethod, swiss.trustbroker.common.config.KeystoreProperties signercert, String issuerId, String recipientId, List<swiss.trustbroker.common.config.RegexNameValue> mappings, Map<String,Object> attributes, List<String> originalAttributes)
      Creates a new AccessRequestConfig instance.
      Parameters:
      enabled - Globally enable the feature.
      Default: false
      interactiveServiceUrl - Global default for interactive Access Request service URL
      interactiveServiceParameters - Global default for interactive Access Request service parameters.
      interactiveMultiServiceParameters - Global default for interactive Access Request service parameters (multi tenant mode).
      centralCICD - Global default for optional request parameter added to URLs.
      interactiveResultParameter - Interactive Access Request result parameter name.
      interactiveResultUserCancel - Value of resultParameter indicating user has cancelled the process.
      silentServiceUrl - Global default for silent Access Request service URL
      endpointReferenceAddress - Global default for ID in requests sent by the AccessRequest.
      wsTrustRequestValiditySeconds - Validity in seconds for WS-Trust expires.
      wsTrustSoapProtocolVersion - WS-Trust SOAP protocl.
      Default: SOAP 1.1 Protocol (alternative: SOAP 1.2 Protocol)
      truststore - Keystore for outbound requests.
      signerTruststore - Truststore for validating inbound messages.
      doSignSamlMessages - Sign outgoing Access Request SAML messages (not re-using SecurityChecks.doSignSuccessResponse) Assertion signature is controlled by SecurityChecks.doSignAssertions for AccessRequest too.
      Default: true
      signatureMethodAlgorithm - Access Request signature algorithm.
      Default: http://www.w3.org/2001/04/xmldsig-more#rsa-sha256
      canonicalizationAlgorithm - Access Request canonicalization algorithm.
      Default: http://www.w3.org/2001/10/xml-exc-c14n#
      digestMethod - Access requiest digest method.
      Default: null (Use default)
      signercert - Signer for outbound messages.
      issuerId - Global default issuer ID.
      recipientId - Global default recipient ID.
      mappings - Mappings that might be needed by the implementation.
      attributes - Custom attributes that might be needed by the implementation.
      originalAttributes - Special attributes that might be marked as coming from the original issuer i.e. IDP
      Since:
      1.12.0, 1.7.0, 1.7.0

  • Method Details

    • builder

      public static AccessRequestConfig.AccessRequestConfigBuilder builder()

    • isEnabled

      public boolean isEnabled()
      Globally enable the feature.
      Default: false

    • getInteractiveServiceUrl

      public String getInteractiveServiceUrl()
      Global default for interactive Access Request service URL

    • getInteractiveServiceParameters

      public String getInteractiveServiceParameters()
      Global default for interactive Access Request service parameters.

    • getInteractiveMultiServiceParameters

      public String getInteractiveMultiServiceParameters()
      Global default for interactive Access Request service parameters (multi tenant mode).
      Since:
      1.12.0

    • getCentralCICD

      public String getCentralCICD()
      Global default for optional request parameter added to URLs.

    • getInteractiveResultParameter

      public String getInteractiveResultParameter()
      Interactive Access Request result parameter name.
      Since:
      1.7.0

    • getInteractiveResultUserCancel

      public String getInteractiveResultUserCancel()
      Value of resultParameter indicating user has cancelled the process.
      Since:
      1.7.0

    • getSilentServiceUrl

      public String getSilentServiceUrl()
      Global default for silent Access Request service URL

    • getEndpointReferenceAddress

      public String getEndpointReferenceAddress()
      Global default for ID in requests sent by the AccessRequest.

    • getWsTrustRequestValiditySeconds

      public int getWsTrustRequestValiditySeconds()
      Validity in seconds for WS-Trust expires.

    • getWsTrustSoapProtocolVersion

      public String getWsTrustSoapProtocolVersion()
      WS-Trust SOAP protocl.
      Default: SOAP 1.1 Protocol (alternative: SOAP 1.2 Protocol)

    • getTruststore

      public swiss.trustbroker.common.config.KeystoreProperties getTruststore()
      Keystore for outbound requests.

    • getSignerTruststore

      public swiss.trustbroker.common.config.KeystoreProperties getSignerTruststore()
      Truststore for validating inbound messages.

    • isDoSignSamlMessages

      public boolean isDoSignSamlMessages()
      Sign outgoing Access Request SAML messages (not re-using SecurityChecks.doSignSuccessResponse) Assertion signature is controlled by SecurityChecks.doSignAssertions for AccessRequest too.
      Default: true

    • getSignatureMethodAlgorithm

      public String getSignatureMethodAlgorithm()
      Access Request signature algorithm.
      Default: http://www.w3.org/2001/04/xmldsig-more#rsa-sha256

    • getCanonicalizationAlgorithm

      public String getCanonicalizationAlgorithm()
      Access Request canonicalization algorithm.
      Default: http://www.w3.org/2001/10/xml-exc-c14n#

    • getDigestMethod

      public String getDigestMethod()
      Access requiest digest method.
      Default: null (Use default)

    • getSignercert

      public swiss.trustbroker.common.config.KeystoreProperties getSignercert()
      Signer for outbound messages.

    • getIssuerId

      public String getIssuerId()
      Global default issuer ID.

    • getRecipientId

      public String getRecipientId()
      Global default recipient ID.

    • getMappings

      public List<swiss.trustbroker.common.config.RegexNameValue> getMappings()
      Mappings that might be needed by the implementation.

    • getAttributes

      public Map<String,Object> getAttributes()
      Custom attributes that might be needed by the implementation.

    • getOriginalAttributes

      public List<String> getOriginalAttributes()
      Special attributes that might be marked as coming from the original issuer i.e. IDP

    • setEnabled

      public void setEnabled(boolean enabled)
      Globally enable the feature.
      Default: false

    • setInteractiveServiceUrl

      public void setInteractiveServiceUrl(String interactiveServiceUrl)
      Global default for interactive Access Request service URL

    • setInteractiveServiceParameters

      public void setInteractiveServiceParameters(String interactiveServiceParameters)
      Global default for interactive Access Request service parameters.

    • setInteractiveMultiServiceParameters

      public void setInteractiveMultiServiceParameters(String interactiveMultiServiceParameters)
      Global default for interactive Access Request service parameters (multi tenant mode).
      Since:
      1.12.0

    • setCentralCICD

      public void setCentralCICD(String centralCICD)
      Global default for optional request parameter added to URLs.

    • setInteractiveResultParameter

      public void setInteractiveResultParameter(String interactiveResultParameter)
      Interactive Access Request result parameter name.
      Since:
      1.7.0

    • setInteractiveResultUserCancel

      public void setInteractiveResultUserCancel(String interactiveResultUserCancel)
      Value of resultParameter indicating user has cancelled the process.
      Since:
      1.7.0

    • setSilentServiceUrl

      public void setSilentServiceUrl(String silentServiceUrl)
      Global default for silent Access Request service URL

    • setEndpointReferenceAddress

      public void setEndpointReferenceAddress(String endpointReferenceAddress)
      Global default for ID in requests sent by the AccessRequest.

    • setWsTrustRequestValiditySeconds

      public void setWsTrustRequestValiditySeconds(int wsTrustRequestValiditySeconds)
      Validity in seconds for WS-Trust expires.

    • setWsTrustSoapProtocolVersion

      public void setWsTrustSoapProtocolVersion(String wsTrustSoapProtocolVersion)
      WS-Trust SOAP protocl.
      Default: SOAP 1.1 Protocol (alternative: SOAP 1.2 Protocol)

    • setTruststore

      public void setTruststore(swiss.trustbroker.common.config.KeystoreProperties truststore)
      Keystore for outbound requests.

    • setSignerTruststore

      public void setSignerTruststore(swiss.trustbroker.common.config.KeystoreProperties signerTruststore)
      Truststore for validating inbound messages.

    • setDoSignSamlMessages

      public void setDoSignSamlMessages(boolean doSignSamlMessages)
      Sign outgoing Access Request SAML messages (not re-using SecurityChecks.doSignSuccessResponse) Assertion signature is controlled by SecurityChecks.doSignAssertions for AccessRequest too.
      Default: true

    • setSignatureMethodAlgorithm

      public void setSignatureMethodAlgorithm(String signatureMethodAlgorithm)
      Access Request signature algorithm.
      Default: http://www.w3.org/2001/04/xmldsig-more#rsa-sha256

    • setCanonicalizationAlgorithm

      public void setCanonicalizationAlgorithm(String canonicalizationAlgorithm)
      Access Request canonicalization algorithm.
      Default: http://www.w3.org/2001/10/xml-exc-c14n#

    • setDigestMethod

      public void setDigestMethod(String digestMethod)
      Access requiest digest method.
      Default: null (Use default)

    • setSignercert

      public void setSignercert(swiss.trustbroker.common.config.KeystoreProperties signercert)
      Signer for outbound messages.

    • setIssuerId

      public void setIssuerId(String issuerId)
      Global default issuer ID.

    • setRecipientId

      public void setRecipientId(String recipientId)
      Global default recipient ID.

    • setMappings

      public void setMappings(List<swiss.trustbroker.common.config.RegexNameValue> mappings)
      Mappings that might be needed by the implementation.

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Custom attributes that might be needed by the implementation.

    • setOriginalAttributes

      public void setOriginalAttributes(List<String> originalAttributes)
      Special attributes that might be marked as coming from the original issuer i.e. IDP

    • 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