com.dtolabs.rundeck.core.common

Interface IRundeckProject

All Superinterfaces:

IRundeckProjectConfig

All Known Implementing Classes:

FrameworkProject

public interface IRundeckProject
extends IRundeckProjectConfig

Interface for a project

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteFileResource(java.lang.String path)
boolean	existsDirResource(java.lang.String path)
boolean	existsFileResource(java.lang.String path)
java.util.Date	getConfigLastModifiedTime()
IProjectInfo	getInfo()
java.lang.String	getName()
INodeSet	getNodeSet() Returns the set of nodes for the project
Authorization	getProjectAuthorization()
IProjectNodes	getProjectNodes()
java.util.Map<java.lang.String,java.lang.String>	getProjectProperties()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getProperty(java.lang.String name)
boolean	hasProperty(java.lang.String key)
java.util.List<java.lang.String>	listDirPaths(java.lang.String path)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listResourceModelConfigurations() list the configurations of resource model providers.
long	loadFileResource(java.lang.String path, java.io.OutputStream output) Read a file at a path for the project
void	mergeProjectProperties(java.util.Properties properties, java.util.Set<java.lang.String> removePrefixes) Update the project properties file by setting updating the given properties, and removing any properties that have a prefix in the removePrefixes set
void	setProjectProperties(java.util.Properties properties) Set the project properties file contents exactly
long	storeFileResource(java.lang.String path, java.io.InputStream input) Store a file at a path for the project
boolean	updateNodesResourceFile() Conditionally update the nodes resources file if a URL source is defined for it and return true if the update process was invoked and succeeded
void	updateNodesResourceFile(INodeSet nodeset) Update the resources file given an input Nodes set
void	updateNodesResourceFileFromUrl(java.lang.String providerURL, java.lang.String username, java.lang.String password) Update the nodes resources file from a specific URL, with BASIC authentication as provided or as defined in the URL's userInfo section.

Method Detail

getName

java.lang.String getName()

Specified by:

getName in interface IRundeckProjectConfig

Returns:

project name

getInfo

IProjectInfo getInfo()

listResourceModelConfigurations

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listResourceModelConfigurations()

list the configurations of resource model providers.

Returns:

a list of maps containing:

• type - provider type name
• props - configuration properties

getNodeSet

INodeSet getNodeSet()
                    throws NodeFileParserException

Returns the set of nodes for the project

Returns:

an instance of INodeSet

Throws:

NodeFileParserException - on parse error

updateNodesResourceFile

boolean updateNodesResourceFile()
                                throws UpdateUtils.UpdateException

Conditionally update the nodes resources file if a URL source is defined for it and return true if the update process was invoked and succeeded

Returns:

true if the update succeeded, false if it was not performed

Throws:

UpdateUtils.UpdateException - if an error occurs while trying to update the resources file

updateNodesResourceFileFromUrl

void updateNodesResourceFileFromUrl(java.lang.String providerURL,
                                  java.lang.String username,
                                  java.lang.String password)
                                    throws UpdateUtils.UpdateException

Update the nodes resources file from a specific URL, with BASIC authentication as provided or as defined in the URL's userInfo section.

Parameters:

providerURL - URL to retrieve resources file definition

username - username or null

password - or null

Throws:

UpdateUtils.UpdateException - if an error occurs during the update process

updateNodesResourceFile

void updateNodesResourceFile(INodeSet nodeset)
                             throws UpdateUtils.UpdateException

Update the resources file given an input Nodes set

Parameters:

nodeset - nodes

Throws:

UpdateUtils.UpdateException - if an error occurs while trying to update the resources file or generate nodes

getProperty

java.lang.String getProperty(java.lang.String name)

Specified by:

getProperty in interface IRundeckProjectConfig

Parameters:

name - property name

Returns:

the property value by name

hasProperty

boolean hasProperty(java.lang.String key)

Specified by:

hasProperty in interface IRundeckProjectConfig

Parameters:

key - property name

Returns:

true if present, false otherwise

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Specified by:

getProperties in interface IRundeckProjectConfig

Returns:

the merged properties available for the project

getProjectProperties

java.util.Map<java.lang.String,java.lang.String> getProjectProperties()

Specified by:

getProjectProperties in interface IRundeckProjectConfig

Returns:

the direct properties set for the project

mergeProjectProperties

void mergeProjectProperties(java.util.Properties properties,
                          java.util.Set<java.lang.String> removePrefixes)

Update the project properties file by setting updating the given properties, and removing any properties that have a prefix in the removePrefixes set

Parameters:

properties - new properties to put in the file

removePrefixes - prefixes of properties to remove from the file

setProjectProperties

void setProjectProperties(java.util.Properties properties)

Set the project properties file contents exactly

Parameters:

properties - new properties to use in the file

getConfigLastModifiedTime

java.util.Date getConfigLastModifiedTime()

Specified by:

getConfigLastModifiedTime in interface IRundeckProjectConfig

Returns:

last modified time for configuration in epoch time

getProjectNodes

IProjectNodes getProjectNodes()

Returns:

the project nodes interface

getProjectAuthorization

Authorization getProjectAuthorization()

Returns:

authorization for this project

existsFileResource

boolean existsFileResource(java.lang.String path)

Parameters:

path - path relative to the project

Returns:

true if it exists

existsDirResource

boolean existsDirResource(java.lang.String path)

Parameters:

path - path relative to the project

Returns:

true if it is a directory

listDirPaths

java.util.List<java.lang.String> listDirPaths(java.lang.String path)

Parameters:

path - path relative to the project

Returns:

list of paths within the directory

deleteFileResource

boolean deleteFileResource(java.lang.String path)

Parameters:

path - path relative to the project

Returns:

true if it is deleted, false if it was not deleted

storeFileResource

long storeFileResource(java.lang.String path,
                     java.io.InputStream input)
                       throws java.io.IOException

Store a file at a path for the project

Parameters:

path - path relative to the project

input - input

Throws:

java.io.IOException - if an IO error occurs

loadFileResource

long loadFileResource(java.lang.String path,
                    java.io.OutputStream output)
                      throws java.io.IOException

Read a file at a path for the project

Parameters:

path - path relative to the project

output - output

Returns:

length of data loaded

Throws:

java.io.IOException - if an IO error occurs