Interface ContextProvider.Builder

  • Method Details

    • keyDefinitionList

      ContextProvider.Builder keyDefinitionList(Collection<ContextProviderKeyDefinition> keyDefinitionList)

      A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

      Parameters:
      keyDefinitionList - A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • keyDefinitionList

      ContextProvider.Builder keyDefinitionList(ContextProviderKeyDefinition... keyDefinitionList)

      A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

      Parameters:
      keyDefinitionList - A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • keyDefinitionList

      ContextProvider.Builder keyDefinitionList(Consumer<ContextProviderKeyDefinition.Builder>... keyDefinitionList)

      A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

      This is a convenience method that creates an instance of the ContextProviderKeyDefinition.Builder avoiding the need to create one manually via ContextProviderKeyDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to keyDefinitionList(List<ContextProviderKeyDefinition>).

      Parameters:
      keyDefinitionList - a consumer that will call methods on ContextProviderKeyDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • subjectSourceKey

      ContextProvider.Builder subjectSourceKey(String subjectSourceKey)

      The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.

      The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      Parameters:
      subjectSourceKey - The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.

      The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • subjectTypeValue

      ContextProvider.Builder subjectTypeValue(String subjectTypeValue)

      A static value for the subject type, such as user or workload.

      This parameter is optional and is mutually exclusive with SubjectTypeSourceKey. Specify either SubjectTypeValue or SubjectTypeSourceKey, but not both.

      Parameters:
      subjectTypeValue - A static value for the subject type, such as user or workload.

      This parameter is optional and is mutually exclusive with SubjectTypeSourceKey. Specify either SubjectTypeValue or SubjectTypeSourceKey, but not both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • subjectTypeSourceKey

      ContextProvider.Builder subjectTypeSourceKey(String subjectTypeSourceKey)

      The source key that supplies the subject type from the external identity provider's assertion or token.

      The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      This parameter is mutually exclusive with SubjectTypeValue. Specify either SubjectTypeSourceKey or SubjectTypeValue, but not both.

      Parameters:
      subjectTypeSourceKey - The source key that supplies the subject type from the external identity provider's assertion or token.

      The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      This parameter is mutually exclusive with SubjectTypeValue. Specify either SubjectTypeSourceKey or SubjectTypeValue, but not both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.