Package com.authlete.common.util

Class ClientMetadataControl

  • public class ClientMetadataControl
extends MapControl
    Flags to control contents of a map that represents client metadata.
    Since:
    3.45

    • Constructor Detail

      • ClientMetadataControl

        public ClientMetadataControl()

    • Method Detail

      • setNullIncluded

        public ClientMetadataControl setNullIncluded​(boolean included)
        Description copied from class: MapControl
        Set the flag indicating whether properties should be included even when their values are null.
        Overrides:
        setNullIncluded in class MapControl
        Parameters:
        included - true to include properties even when their values are null. false not to include properties when their values are null.
        Returns:
        this object.

      • setZeroIncluded

        public ClientMetadataControl setZeroIncluded​(boolean included)
        Description copied from class: MapControl
        Set the flag indicating whether properties should be included even when their values are zero.
        Overrides:
        setZeroIncluded in class MapControl
        Parameters:
        included - true to include properties even when their values are zero. false not to include properties when their values are zero.
        Returns:
        this object.

      • setFalseIncluded

        public ClientMetadataControl setFalseIncluded​(boolean included)
        Description copied from class: MapControl
        Set the flag indicating whether properties should be included even when their values are false.
        Overrides:
        setFalseIncluded in class MapControl
        Parameters:
        included - true to include properties even when their values are false. false not to include properties when their values are false.
        Returns:
        this object.

      • isSecretIncluded

        public boolean isSecretIncluded()
        Get the flag indicating whether to include the client_secret property.

        Note that the client_secret property is not included when the client type is not "confidential" (cf. Client.getClientType()).

        Returns:
        true if the client_secret property is included. false if the client_secret property is not included.

      • setSecretIncluded

        public ClientMetadataControl setSecretIncluded​(boolean included)
        Set the flag indicating whether to include the client_secret property.

        Note that the client_secret property is not included when the client type is not "confidential" (cf. Client.getClientType()).

        Parameters:
        included - true to include the client_secret property. false not to include the client_secret property.
        Returns:
        this object.

      • isCustomIncluded

        public boolean isCustomIncluded()
        Get the flag indicating whether to include custom metadata.
        Returns:
        true if custom metadata are included. false if custom metadata are not included.

      • setCustomIncluded

        public ClientMetadataControl setCustomIncluded​(boolean included)
        Set the flag indicating whether to include custom metadata.
        Parameters:
        included - true to include custom metadata. false not to include custom metadata.
        Returns:
        this object.

      • isAliasPreferred

        public boolean isAliasPreferred()
        Get the flag whether to use the client ID alias as the value of the client_id property when available.

        Note that the alias is not used if the alias feature is not enabled (cf. Client.isClientIdAliasEnabled()).

        Returns:
        true if the client ID alias is used as the value of the client_id property when available.

      • setAliasPreferred

        public ClientMetadataControl setAliasPreferred​(boolean preferred)
        Set the flag whether to use the client ID alias as the value of the client_id property when available.

        Note that the alias is not used if the alias feature is not enabled (cf. Client.isClientIdAliasEnabled()).

        Parameters:
        preferred - true to use the client ID alias as the value of the client_id property when available.
        Returns:
        this object.

      • isEntityIdPreferred

        public boolean isEntityIdPreferred()
        Get the flag whether to use the entity ID as the value of the client_id property when available.
        Returns:
        true if the entity ID is used as the value of the client_id property when available.
        See Also:
        OpenID Federation 1.0

      • setEntityIdPreferred

        public ClientMetadataControl setEntityIdPreferred​(boolean preferred)
        Set the flag whether to use the entity ID as the value of the client_id property when available.
        Parameters:
        preferred - true to use the entity ID as the value of the client_id property when available.
        Returns:
        this object.
        See Also:
        OpenID Federation 1.0

      • isMetadataDocumentLocationPreferred

        public boolean isMetadataDocumentLocationPreferred()
        Get the flag whether to use the location of the client's metadata document as the value of the client_id property when available.
        Returns:
        true if the location of the client's metadata document is used as the value of the client_id property when available.
        Since:
        4.29, Authlete 3.0.22
        See Also:
        OAuth Client ID Metadata Document

      • setMetadataDocumentLocationPreferred

        public ClientMetadataControl setMetadataDocumentLocationPreferred​(boolean preferred)
        Set the flag whether to use the location of the client's metadata document as the value of the client_id property when available.
        Parameters:
        preferred - true to use the location of the client's metadata document as the value of the client_id property when available.
        Returns:
        this object.
        Since:
        4.29, Authlete 3.0.22
        See Also:
        OAuth Client ID Metadata Document