org.opensaml.xmlsec.impl

Class BasicWhitelistBlacklistConfiguration

java.lang.Object

org.opensaml.xmlsec.impl.BasicWhitelistBlacklistConfiguration

All Implemented Interfaces:

WhitelistBlacklistConfiguration

Direct Known Subclasses:

BasicDecryptionConfiguration, BasicEncryptionConfiguration, BasicSignatureSigningConfiguration, BasicSignatureValidationConfiguration

public class BasicWhitelistBlacklistConfiguration
extends java.lang.Object
implements WhitelistBlacklistConfiguration

Basic implementation of WhitelistBlacklistConfiguration.

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

Nested Class Summary

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

WhitelistBlacklistConfiguration.Precedence

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Collection<java.lang.String>	blacklist Blacklisted algorithm URIs.
private boolean	blacklistMerge Blacklist merge flag.
static WhitelistBlacklistConfiguration.Precedence	DEFAULT_PRECEDENCE Default precedence.
private WhitelistBlacklistConfiguration.Precedence	precedence Precedence flag.
private java.util.Collection<java.lang.String>	whitelist Whitelisted algorithm URIs.
private boolean	whitelistMerge Whitelist merge flag.

Constructor Summary

Constructors

Constructor and Description
BasicWhitelistBlacklistConfiguration() Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getBlacklistedAlgorithms() Get the list of blacklisted algorithm URI's.
WhitelistBlacklistConfiguration.Precedence	getWhitelistBlacklistPrecedence() Get preference value indicating which should take precedence when both whitelist and blacklist are non-empty.
java.util.Collection<java.lang.String>	getWhitelistedAlgorithms() Get the list of whitelisted algorithm URI's.
boolean	isBlacklistMerge() 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() 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(java.util.Collection<java.lang.String> uris) Set the list of blacklisted algorithm URI's.
void	setBlacklistMerge(boolean flag) 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) Set preference value indicating which should take precedence when both whitelist and blacklist are non-empty.
void	setWhitelistedAlgorithms(java.util.Collection<java.lang.String> uris) Set the list of whitelisted algorithm URI's.
void	setWhitelistMerge(boolean flag) 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 java.lang.Object

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

Field Detail

DEFAULT_PRECEDENCE

public static final WhitelistBlacklistConfiguration.Precedence DEFAULT_PRECEDENCE

Default precedence.

whitelist

private java.util.Collection<java.lang.String> whitelist

Whitelisted algorithm URIs.

whitelistMerge

private boolean whitelistMerge

Whitelist merge flag.

blacklist

private java.util.Collection<java.lang.String> blacklist

Blacklisted algorithm URIs.

blacklistMerge

private boolean blacklistMerge

Blacklist merge flag.

precedence

private WhitelistBlacklistConfiguration.Precedence precedence

Precedence flag.

Constructor Detail

BasicWhitelistBlacklistConfiguration

public BasicWhitelistBlacklistConfiguration()

Constructor.

Method Detail

getWhitelistedAlgorithms

@Nonnull
 @NonnullElements
 @NotLive
 @Unmodifiable
public java.util.Collection<java.lang.String> getWhitelistedAlgorithms()

Get the list of whitelisted algorithm URI's.

Specified by:

getWhitelistedAlgorithms in interface WhitelistBlacklistConfiguration

Returns:

the list of algorithms

setWhitelistedAlgorithms

public void setWhitelistedAlgorithms(@Nullable
                                     java.util.Collection<java.lang.String> uris)

Set the list of whitelisted algorithm URI's.

Parameters:

uris - the list of algorithms

isWhitelistMerge

public boolean isWhitelistMerge()

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.

Specified by:

isWhitelistMerge in interface WhitelistBlacklistConfiguration

Returns:

true if should merge, false otherwise

setWhitelistMerge

public void setWhitelistMerge(boolean flag)

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

getBlacklistedAlgorithms

@Nonnull
 @NonnullElements
 @NotLive
 @Unmodifiable
public java.util.Collection<java.lang.String> getBlacklistedAlgorithms()

Get the list of blacklisted algorithm URI's.

Specified by:

getBlacklistedAlgorithms in interface WhitelistBlacklistConfiguration

Returns:

the list of algorithms

setBlacklistedAlgorithms

public void setBlacklistedAlgorithms(@Nullable
                                     java.util.Collection<java.lang.String> uris)

Set the list of blacklisted algorithm URI's.

Parameters:

uris - the list of algorithms

isBlacklistMerge

public boolean isBlacklistMerge()

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.

Specified by:

isBlacklistMerge in interface WhitelistBlacklistConfiguration

Returns:

true if should merge, false otherwise

setBlacklistMerge

public void setBlacklistMerge(boolean flag)

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

getWhitelistBlacklistPrecedence

@Nonnull
public WhitelistBlacklistConfiguration.Precedence getWhitelistBlacklistPrecedence()

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)

Set preference value indicating which should take precedence when both whitelist and blacklist are non-empty.

Parameters:

value - the precedence value