Package org.opensaml.xmlsec.impl

Class BasicWhitelistBlacklistConfiguration

java.lang.Object
org.opensaml.xmlsec.impl.BasicAlgorithmPolicyConfiguration
org.opensaml.xmlsec.impl.BasicWhitelistBlacklistConfiguration
All Implemented Interfaces:
AlgorithmPolicyConfiguration, WhitelistBlacklistConfiguration
Direct Known Subclasses:
BasicDecryptionConfiguration, BasicEncryptionConfiguration, BasicSignatureSigningConfiguration, BasicSignatureValidationConfiguration
@Deprecated(forRemoval=true, since="4.1.0") public class BasicWhitelistBlacklistConfiguration extends BasicAlgorithmPolicyConfiguration implements WhitelistBlacklistConfiguration
Deprecated, for removal: This API element is subject to removal in a future version.
Basic implementation of WhitelistBlacklistConfiguration.

The value returned by WhitelistBlacklistConfiguration.getWhitelistBlacklistPrecedence() defaults to WhitelistBlacklistConfiguration.Precedence.WHITELIST.

  • Constructor Details

    • BasicWhitelistBlacklistConfiguration

      public BasicWhitelistBlacklistConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • isWhitelistMerge

      public boolean isWhitelistMerge()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Flag indicating whether to merge this configuration's whitelist with one of a lower order of precedence, or to treat this whitelist as authoritative.
      Specified by:
      isWhitelistMerge in interface WhitelistBlacklistConfiguration
      Returns:
      true if should merge, false otherwise

    • setWhitelistMerge

      public void setWhitelistMerge(boolean flag)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the flag indicating whether to merge this configuration's whitelist with one of a lower order of precedence, or to treat this whitelist as authoritative.

      Defaults to: false

      Parameters:
      flag - true if should merge, false otherwise

    • getWhitelistedAlgorithms

      @Nonnull @NonnullElements @Unmodifiable @NotLive public Collection<String> getWhitelistedAlgorithms()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of whitelisted algorithm URIs.
      Specified by:
      getWhitelistedAlgorithms in interface WhitelistBlacklistConfiguration
      Returns:
      the list of algorithms

    • setWhitelistedAlgorithms

      public void setWhitelistedAlgorithms(@Nullable Collection<String> uris)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the list of whitelisted algorithm URIs.
      Parameters:
      uris - the list of algorithms

    • isBlacklistMerge

      public boolean isBlacklistMerge()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Flag indicating whether to merge this configuration's blacklist with one of a lower order of precedence, or to treat this blacklist as authoritative.
      Specified by:
      isBlacklistMerge in interface WhitelistBlacklistConfiguration
      Returns:
      true if should merge, false otherwise

    • setBlacklistMerge

      public void setBlacklistMerge(boolean flag)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the flag indicating whether to merge this configuration's blacklist with one of a lower order of precedence, or to treat this blacklist as authoritative.

      Defaults to: true

      Parameters:
      flag - true if should merge, false otherwise

    • getBlacklistedAlgorithms

      @Nonnull @NonnullElements @Unmodifiable @NotLive public Collection<String> getBlacklistedAlgorithms()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of blacklisted algorithm URIs.
      Specified by:
      getBlacklistedAlgorithms in interface WhitelistBlacklistConfiguration
      Returns:
      the list of algorithms

    • setBlacklistedAlgorithms

      public void setBlacklistedAlgorithms(@Nullable Collection<String> uris)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the list of blacklisted algorithm URIs.
      Parameters:
      uris - the list of algorithms

    • getWhitelistBlacklistPrecedence

      @Nonnull public WhitelistBlacklistConfiguration.Precedence getWhitelistBlacklistPrecedence()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get preference value indicating which should take precedence when both whitelist and blacklist are non-empty.
      Specified by:
      getWhitelistBlacklistPrecedence in interface WhitelistBlacklistConfiguration
      Returns:
      the configured precedence value.

    • setWhitelistBlacklistPrecedence

      public void setWhitelistBlacklistPrecedence(@Nonnull WhitelistBlacklistConfiguration.Precedence value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set preference value indicating which should take precedence when both whitelist and blacklist are non-empty.
      Parameters:
      value - the precedence value