net.shibboleth.metadata.dom

Class DOMFilesystemSourceStage

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.metadata.pipeline.BaseStage<Element>

net.shibboleth.metadata.dom.DOMFilesystemSourceStage

All Implemented Interfaces:

Stage<Element>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

@ThreadSafe
public class DOMFilesystemSourceStage
extends BaseStage<Element>

A stage which reads XML information from the filesystem and places it in the given DOMElementItem collection.

This stage requires the following properties be set prior to initialization:

• parserPool
• source

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	errorCausesSourceFailure Whether an error parsing one source file causes this entire Stage to fail, or just excludes the material from the offending source file.
private Logger	log Class logger.
private boolean	noSourceFilesAnError Whether the lack of source files is treated as an error.
private net.shibboleth.utilities.java.support.xml.ParserPool	parserPool Pool of DOM parsers used to parse the XML file in to a DOM.
private boolean	recurseDirectories Whether or not directories are recursed if the given input file is a directory.
private File	sourceFile The file path to the DOM material provided by this source.
private FileFilter	sourceFileFilter Filter used to determine if a file should be included.

Constructor Summary

Constructors

Constructor and Description
DOMFilesystemSourceStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doExecute(Collection<Item<Element>> itemCollection) Performs the stage processing on the given Item collection.
protected void	doInitialize()
boolean	getErrorCausesSourceFailure() Gets whether an error parsing a single file causes the source to fail.
net.shibboleth.utilities.java.support.xml.ParserPool	getParserPool() Gets the pool of DOM parsers used to parse the XML file in to a DOM.
boolean	getRecurseDirectories() Gets whether directories will be recursively searched for XML input files.
File	getSource() Gets the path to the DOM material provided by this source.
FileFilter	getSourceFileFilter() Gets the filter used to determine if a file, in a directory, should be treated as a source file.
protected void	getSourceFiles(File input, List<File> collector) Gets the source files from a given input.
boolean	isNoSourceFilesAnError() Get whether the lack of source files is considered an error.
protected DOMElementItem	processSourceFile(File source) Reads in an XML source file, parses it, and creates the appropriate DOMElementItem for the data.
void	setErrorCausesSourceFailure(boolean causesFailure) Sets whether an error parsing a single file causes the source to fail.
void	setNoSourceFilesAnError(boolean isError) Sets whether the lack of source files is considered an error.
void	setParserPool(net.shibboleth.utilities.java.support.xml.ParserPool pool) Sets the pool of DOM parsers used to parse the XML file in to a DOM.
void	setRecurseDirectories(boolean recurse) Sets whether directories will be recursively searched for XML input files.
void	setSource(File source) Sets the path to the DOM material provided by this source.
void	setSourceFileFilter(FileFilter filter) Sets the filter used to determine if a file, in a directory, should be treated as a source file.

Methods inherited from class net.shibboleth.metadata.pipeline.BaseStage

execute, getCollectionPredicate, setCollectionPredicate

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

private final Logger log

Class logger.

parserPool

private net.shibboleth.utilities.java.support.xml.ParserPool parserPool

Pool of DOM parsers used to parse the XML file in to a DOM.

sourceFile

private File sourceFile

The file path to the DOM material provided by this source. May be a file or a directory.

sourceFileFilter

private FileFilter sourceFileFilter

Filter used to determine if a file should be included. This is only used if the sourceFile is a directory.

recurseDirectories

private boolean recurseDirectories

Whether or not directories are recursed if the given input file is a directory. Default value: false

noSourceFilesAnError

private boolean noSourceFilesAnError

Whether the lack of source files is treated as an error. Default value: false

errorCausesSourceFailure

private boolean errorCausesSourceFailure

Whether an error parsing one source file causes this entire Stage to fail, or just excludes the material from the offending source file. Default value: true

Constructor Detail

DOMFilesystemSourceStage

public DOMFilesystemSourceStage()

Method Detail

getParserPool

@Nullable
public net.shibboleth.utilities.java.support.xml.ParserPool getParserPool()

Gets the pool of DOM parsers used to parse the XML file in to a DOM.

Returns:

pool of DOM parsers used to parse the XML file in to a DOM

setParserPool

public void setParserPool(@Nonnull
                 net.shibboleth.utilities.java.support.xml.ParserPool pool)

Sets the pool of DOM parsers used to parse the XML file in to a DOM.

Parameters:

pool - pool of DOM parsers used to parse the XML file in to a DOM

getSource

@Nullable
public File getSource()

Gets the path to the DOM material provided by this source. May be a file or a directory.

Returns:

path to the DOM material provided by this source

setSource

public void setSource(@Nonnull
             File source)

Sets the path to the DOM material provided by this source. May be a file or a directory.

Parameters:

source - path to the DOM material provided by this source

getSourceFileFilter

@Nullable
public FileFilter getSourceFileFilter()

Gets the filter used to determine if a file, in a directory, should be treated as a source file. If no filter is set then all files are used as source files. If the source file is not a directory this filter is meaningless.

Returns:

filter used to determine if a file, in a directory, should be treated as a source file, may be null

setSourceFileFilter

public void setSourceFileFilter(@Nonnull
                       FileFilter filter)

Sets the filter used to determine if a file, in a directory, should be treated as a source file.

Parameters:

filter - filter used to determine if a file, in a directory, should be treated as a source file, may be null

getRecurseDirectories

public boolean getRecurseDirectories()

Gets whether directories will be recursively searched for XML input files.

Returns:

whether directories will be recursively searched for XML input files

setRecurseDirectories

public void setRecurseDirectories(boolean recurse)

Sets whether directories will be recursively searched for XML input files.

Parameters:

recurse - whether directories will be recursively searched for XML input files

isNoSourceFilesAnError

public boolean isNoSourceFilesAnError()

Get whether the lack of source files is considered an error.

Returns:

whether the lack of source files is considered an error

setNoSourceFilesAnError

public void setNoSourceFilesAnError(boolean isError)

Sets whether the lack of source files is considered an error.

Parameters:

isError - whether the lack of source files is considered an error

getErrorCausesSourceFailure

public boolean getErrorCausesSourceFailure()

Gets whether an error parsing a single file causes the source to fail. If not, the parsed file is simply ignored.

Returns:

whether an error parsing a single file causes the source to fail

setErrorCausesSourceFailure

public void setErrorCausesSourceFailure(boolean causesFailure)

Sets whether an error parsing a single file causes the source to fail. If not, the parsed file is simply ignored.

Parameters:

causesFailure - whether an error parsing a single file causes the source to fail

doExecute

protected void doExecute(@Nonnull@NonnullElements
             Collection<Item<Element>> itemCollection)
                  throws StageProcessingException

Performs the stage processing on the given Item collection.

The stage is guaranteed to be have been initialized and not destroyed when this is invoked.

Specified by:

doExecute in class BaseStage<Element>

Parameters:

itemCollection - collection to be processed

Throws:

StageProcessingException - thrown if there is an unrecoverable problem when processing the stage

getSourceFiles

protected void getSourceFiles(@Nonnull
                  File input,
                  @Nonnull@NonnullElements@Live
                  List<File> collector)

Gets the source files from a given input. If the input is an XML file, it's added to the collector. If the input file is a directory, all of its XML files are added to the collector. If the directory contains other directories and recurseDirectories is true, then this process is repeated for each child direcrory.

Parameters:

input - the source input file, never null

collector - the collector of XML input files

processSourceFile

@Nonnull
protected DOMElementItem processSourceFile(@Nonnull
                                       File source)
                                    throws StageProcessingException

Reads in an XML source file, parses it, and creates the appropriate DOMElementItem for the data.

Parameters:

source - XML file to read in

Returns:

the resultant DOMElementItem, may be null if there was an error parsing the data and errorCausesSourceFailure is false

Throws:

StageProcessingException - thrown if there is a problem reading in the Element and errorCausesSourceFailure is true

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException