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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensaml.xmlsec.AlgorithmPolicyConfiguration

AlgorithmPolicyConfiguration.Precedence

Nested classes/interfaces inherited from interface org.opensaml.xmlsec.WhitelistBlacklistConfiguration

WhitelistBlacklistConfiguration.Precedence

Field Summary

Fields inherited from class org.opensaml.xmlsec.impl.BasicAlgorithmPolicyConfiguration

DEFAULT_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Collection<String>	getBlacklistedAlgorithms()	Deprecated, for removal: This API element is subject to removal in a future version. Get the list of blacklisted algorithm URIs.
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.
Collection<String>	getWhitelistedAlgorithms()	Deprecated, for removal: This API element is subject to removal in a future version. Get the list of whitelisted algorithm URIs.
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.
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.
void	setBlacklistedAlgorithms(Collection<String> uris)	Deprecated, for removal: This API element is subject to removal in a future version. Set the list of blacklisted algorithm URIs.
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.
void	setWhitelistBlacklistPrecedence(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.
void	setWhitelistedAlgorithms(Collection<String> uris)	Deprecated, for removal: This API element is subject to removal in a future version. Set the list of whitelisted algorithm URIs.
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.

Methods inherited from class org.opensaml.xmlsec.impl.BasicAlgorithmPolicyConfiguration

getExcludedAlgorithms, getIncludedAlgorithms, getIncludeExcludePrecedence, isExcludeMerge, isIncludeMerge, setExcludedAlgorithms, setExcludeMerge, setIncludedAlgorithms, setIncludeExcludePrecedence, setIncludeMerge

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.xmlsec.AlgorithmPolicyConfiguration

getExcludedAlgorithms, getIncludedAlgorithms, getIncludeExcludePrecedence, isExcludeMerge, isIncludeMerge

Constructor Detail

BasicWhitelistBlacklistConfiguration

public BasicWhitelistBlacklistConfiguration()

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

Method Detail

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