Package net.shibboleth.idp.attribute.transcoding.impl

Class TranscodingRuleLoader

java.lang.Object

net.shibboleth.idp.attribute.transcoding.impl.TranscodingRuleLoader

public class TranscodingRuleLoader
extends Object

A mechanism for loading a set of TranscodingRule objects from sources such as maps or directories of property files.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	failOnErrors	Whether to rethrow exceptions during construction or populate empty.
private org.slf4j.Logger	log	Class logger.
private final Collection<TranscodingRule>	rules	Rules loaded.

Constructor Summary

Constructors

Constructor	Description
TranscodingRuleLoader(Path dir)	Equivalent to TranscodingRuleLoader(Path, Collection, boolean) with null extensions and true fail fast behavior.
TranscodingRuleLoader(Path dir, Collection<String> extensions)	Equivalent to TranscodingRuleLoader(Path, Collection, boolean) with null extensions and true fail fast behavior.
TranscodingRuleLoader(Path dir, Collection<String> extensions, boolean failFast)	Load rules from all files found below a directory root.
TranscodingRuleLoader(Collection<Map<String,Object>> maps)	Constructor.
TranscodingRuleLoader(Resource resource)	Equivalent to TranscodingRuleLoader(Resource, Collection, boolean) with null extensions and true fail fast behavior.
TranscodingRuleLoader(Resource resource, Collection<String> extensions)	Equivalent to TranscodingRuleLoader(Resource, Collection, boolean) with true fail fast behavior.
TranscodingRuleLoader(Resource resource, Collection<String> extensions, boolean failFast)	Load rules from all files found below a directory root expressed as a Spring resource.

Method Summary

Modifier and Type	Method	Description
Collection<TranscodingRule>	getRules()	Get the rules loaded by this object.
private Collection<TranscodingRule>	load(Path dir, Collection<String> extensions)	Performs the load step using the supplied parameters from the various constructors.

Methods inherited from class java.lang.Object

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

Field Details

log

@Nonnull
private org.slf4j.Logger log

Class logger.

rules

@Nonnull
private final Collection<TranscodingRule> rules

Rules loaded.

failOnErrors

private final boolean failOnErrors

Whether to rethrow exceptions during construction or populate empty.

Constructor Details

TranscodingRuleLoader

public TranscodingRuleLoader(@Nonnull @ParameterName(name="resource")
 Resource resource,
 @Nullable @ParameterName(name="extensions")
 Collection<String> extensions,
 @ParameterName(name="failFast")
 boolean failFast)
                      throws IOException

Load rules from all files found below a directory root expressed as a Spring resource.

Files are assumed to be Java property files in text format.

Individual rules that fail to load will be skipped.

The file extensions must include the period, and only apply to files, while all directories will be examined.

Parameters:

resource - root to search

extensions - file extensions to include

failFast - true iff I/O failures should be surfaced

Throws:

IOException - if an error occurs

Since:

5.3.0

TranscodingRuleLoader

public TranscodingRuleLoader(@Nonnull @ParameterName(name="resource")
 Resource resource,
 @Nullable @ParameterName(name="extensions")
 Collection<String> extensions)
                      throws IOException

Equivalent to TranscodingRuleLoader(Resource, Collection, boolean) with true fail fast behavior.

Parameters:

resource - root to search

extensions - file extensions to include

Throws:

IOException - if an error occurs

Since:

5.3.0

TranscodingRuleLoader

public TranscodingRuleLoader(@Nonnull @ParameterName(name="resource")
 Resource resource)
                      throws IOException

Equivalent to TranscodingRuleLoader(Resource, Collection, boolean) with null extensions and true fail fast behavior.

Parameters:

resource - root to search

Throws:

IOException - if an error occurs

Since:

5.3.0

TranscodingRuleLoader

public TranscodingRuleLoader(@Nonnull @ParameterName(name="dir")
 Path dir,
 @Nullable @ParameterName(name="extensions")
 Collection<String> extensions,
 @ParameterName(name="failFast")
 boolean failFast)
                      throws IOException

Load rules from all files found below a directory root.

Files are assumed to be Java property files in text format.

Individual rules that fail to load will be skipped.

The file extensions must include the period, and only apply to files, while all directories will be examined.

Parameters:

dir - root to search

extensions - file extensions to include

failFast - true iff I/O failures should be surfaced

Throws:

IOException - if an error occurs

Since:

5.3.0

TranscodingRuleLoader

public TranscodingRuleLoader(@Nonnull @ParameterName(name="dir")
 Path dir,
 @Nullable @ParameterName(name="extensions")
 Collection<String> extensions)
                      throws IOException

Equivalent to TranscodingRuleLoader(Path, Collection, boolean) with null extensions and true fail fast behavior.

Parameters:

dir - root to search

extensions - file extensions to include

Throws:

IOException - if an error occurs

TranscodingRuleLoader

public TranscodingRuleLoader(@Nonnull @ParameterName(name="dir")
 Path dir)
                      throws IOException

Equivalent to TranscodingRuleLoader(Path, Collection, boolean) with null extensions and true fail fast behavior.

Parameters:

dir - root to search

Throws:

IOException - if an error occurs

TranscodingRuleLoader

public TranscodingRuleLoader(@Nonnull @ParameterName(name="maps")
 Collection<Map<String,Object>> maps)

Constructor.

Parameters:

maps - a collection of maps to build rules around directly.

Method Details

load

@Nonnull
@Unmodifiable
@NotLive
private Collection<TranscodingRule> load(@Nonnull @ParameterName(name="dir")
 Path dir,
 @Nullable @ParameterName(name="extensions")
 Collection<String> extensions)
                                  throws IOException

Performs the load step using the supplied parameters from the various constructors.

Parameters:

dir - path to attempt load from

extensions - file extensions to include

Returns:

the loaded rules

Throws:

IOException - on failure

Since:

5.3.0

getRules

@Nonnull
@Unmodifiable
@NotLive
public Collection<TranscodingRule> getRules()

Get the rules loaded by this object.

Returns:

collection of rules