Package com.salesforce.multicloudj.sts.model

Class SignOptions.Builder

java.lang.Object
com.salesforce.multicloudj.sts.model.SignOptions.Builder
Enclosing class:
SignOptions
public static class SignOptions.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • withCustomHeader

      public SignOptions.Builder withCustomHeader(String name, String value)
      Adds a single custom header to set on the signed request.
      Parameters:
      name - header name
      value - header value
      Returns:
      this builder

    • withCustomHeaders

      public SignOptions.Builder withCustomHeaders(Map<String,String> customHeaders)
      Adds all supplied custom headers to set on the signed request.
      Parameters:
      customHeaders - headers to add
      Returns:
      this builder

    • withExcludeRequestHashHeader

      public SignOptions.Builder withExcludeRequestHashHeader(boolean excludeRequestHashHeader)
      Controls whether the request payload hash header is excluded from the signed request.
      Parameters:
      excludeRequestHashHeader - true to exclude the request hash header
      Returns:
      this builder

    • withExcludeContentTypeHeader

      public SignOptions.Builder withExcludeContentTypeHeader(boolean excludeContentTypeHeader)
      Controls whether the content type header is excluded from the signed request.
      Parameters:
      excludeContentTypeHeader - true to exclude the content type header
      Returns:
      this builder

    • withActionInQueryString

      public SignOptions.Builder withActionInQueryString(boolean actionInQueryString)
      Controls whether the STS action and version are signed as URL query parameters over an empty body instead of as a form-encoded request body.
      Parameters:
      actionInQueryString - true to sign the action and version as query parameters
      Returns:
      this builder

    • build

      public SignOptions build()