Package com.dtolabs.rundeck.core.resources

Class FileResourceModelSource

java.lang.Object

com.dtolabs.rundeck.core.resources.BaseFileResourceModelSource

com.dtolabs.rundeck.core.resources.FileResourceModelSource

All Implemented Interfaces:

Configurable, ResourceModelSource, WriteableModelSource

public class FileResourceModelSource
extends BaseFileResourceModelSource
implements Configurable

FileResourceModelSource extends BaseFileResourceModelSource to provide an optionally editable Model source using a local file system path.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileResourceModelSource.Configuration

Field Summary

Fields inherited from class com.dtolabs.rundeck.core.resources.BaseFileResourceModelSource

framework, nodeSet

Method Summary

Modifier and Type	Method	Description
void	configure(FileResourceModelSource.Configuration configuration)	Configure the Source
void	configure(java.util.Properties configs)	Configure the object with the configuration properties.
protected java.lang.String	getDocumentFileExtension()
protected long	getLastModified()
protected java.lang.String	getResourceFormat()
java.lang.String	getSourceDescription()
boolean	hasData()
boolean	isDataWritable()
protected boolean	isSupportsLastModified()
java.io.InputStream	openFileDataInputStream()
static INodeSet	parseFile(java.io.File file, Framework framework, java.lang.String project)	Utility method to directly parse the nodes from a file
static INodeSet	parseFile(java.io.File file, java.lang.String format, Framework framework, java.lang.String project)	Utility method to directly parse the nodes from a file
protected boolean	shouldGenerateServerNode()
java.lang.String	toString()
long	writeFileData(java.io.InputStream dataStream)	Write the file data from the inputstream to the backing store

Methods inherited from class com.dtolabs.rundeck.core.resources.BaseFileResourceModelSource

getNodes, getNodes, getResourceFormatParser, getSourceType, getSyntaxMimeType, getWriteable, readData, writeData, writeFileData

Methods inherited from class java.lang.Object

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

Method Detail

configure

public void configure(java.util.Properties configs)
               throws ConfigurationException

Description copied from interface: Configurable

Configure the object with the configuration properties.

Specified by:

configure in interface Configurable

Parameters:

configs - the properties to use

Throws:

ConfigurationException - if there is an invalid configuration

configure

public void configure(FileResourceModelSource.Configuration configuration)
               throws ConfigurationException

Configure the Source

Parameters:

configuration - configuration

Throws:

ConfigurationException - on config error

writeFileData

public long writeFileData(java.io.InputStream dataStream)
                   throws java.io.IOException

Description copied from class: BaseFileResourceModelSource

Write the file data from the inputstream to the backing store

Specified by:

writeFileData in class BaseFileResourceModelSource

Parameters:

dataStream - input stream

Returns:

bytes writen

Throws:

java.io.IOException

openFileDataInputStream

public java.io.InputStream openFileDataInputStream()
                                            throws java.io.IOException,
                                                   ResourceModelSourceException

Specified by:

openFileDataInputStream in class BaseFileResourceModelSource

Returns:

an input stream that reads the data from the backing store

Throws:

java.io.IOException

ResourceModelSourceException

hasData

public boolean hasData()

Specified by:

hasData in interface WriteableModelSource

Returns:

true if the call to WriteableModelSource.readData(OutputStream) is expected to succeed.

isSupportsLastModified

protected boolean isSupportsLastModified()

Overrides:

isSupportsLastModified in class BaseFileResourceModelSource

Returns:

true if the underlying data set supports a "last modified" timestamp which should be used to determine whether the nodes data should be reloaded or cached data can be used

getLastModified

protected long getLastModified()

Overrides:

getLastModified in class BaseFileResourceModelSource

Returns:

last modified unix timestamp, or -1 if not available

getResourceFormat

protected java.lang.String getResourceFormat()

Specified by:

getResourceFormat in class BaseFileResourceModelSource

Returns:

the name of the supported ResourceFormatParser provider, or null if the file extension is used

getDocumentFileExtension

protected java.lang.String getDocumentFileExtension()

Specified by:

getDocumentFileExtension in class BaseFileResourceModelSource

Returns:

the file extension of the document, or the BaseFileResourceModelSource.getResourceFormat() must be used.

getSourceDescription

public java.lang.String getSourceDescription()

Specified by:

getSourceDescription in interface WriteableModelSource

Returns:

optional description of the source

isDataWritable

public boolean isDataWritable()

Overrides:

isDataWritable in class BaseFileResourceModelSource

Returns:

true if the model source is writable, false if the data should not be modified with BaseFileResourceModelSource.writeData(InputStream)

shouldGenerateServerNode

protected boolean shouldGenerateServerNode()

Overrides:

shouldGenerateServerNode in class BaseFileResourceModelSource

Returns:

true if the node set should always include the local server node data

parseFile

public static INodeSet parseFile(java.io.File file,
                                 Framework framework,
                                 java.lang.String project)
                          throws ResourceModelSourceException,
                                 ConfigurationException

Utility method to directly parse the nodes from a file

Parameters:

file - file

framework - fwk

project - project name

Returns:

nodes

Throws:

ResourceModelSourceException - if an error occurs

ConfigurationException - if a configuration error occurs

parseFile

public static INodeSet parseFile(java.io.File file,
                                 java.lang.String format,
                                 Framework framework,
                                 java.lang.String project)
                          throws ResourceModelSourceException,
                                 ConfigurationException

Utility method to directly parse the nodes from a file

Parameters:

file - file

format - specified format

framework - fwk

project - project name

Returns:

nodes

Throws:

ResourceModelSourceException - if an error occurs

ConfigurationException - if a configuration error occurs

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object