com.dtolabs.rundeck.core.common

Interface IProjectNodes

All Known Implementing Classes:

ProjectNodeSupport

public interface IProjectNodes

A project node source

Method Summary

Methods

Modifier and Type	Method and Description
INodeSet	getNodeSet() Returns the set of nodes for the project
java.util.ArrayList<java.lang.Exception>	getResourceModelSourceExceptions()
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listResourceModelConfigurations() list the configurations of resource model providers.
void	updateNodesResourceFile(INodeSet nodeset, java.lang.String nodesResourcesFilePath) Update the resources file given an input Nodes set
boolean	updateNodesResourceFile(java.lang.String nodesResourcesFilePath) 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	updateNodesResourceFileFromUrl(java.lang.String providerURL, java.lang.String username, java.lang.String password, java.lang.String nodesResourceFilePath) 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

getNodeSet

INodeSet getNodeSet()

Returns the set of nodes for the project

Returns:

an instance of INodeSet

getResourceModelSourceExceptions

java.util.ArrayList<java.lang.Exception> getResourceModelSourceExceptions()

Returns:

the set of exceptions produced by the last attempt to invoke all node providers

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

updateNodesResourceFile

boolean updateNodesResourceFile(java.lang.String nodesResourcesFilePath)
                                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

Parameters:

nodesResourcesFilePath - destination file path

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,
                                  java.lang.String nodesResourceFilePath)
                                    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

nodesResourceFilePath - path of the destination file

Throws:

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

updateNodesResourceFile

void updateNodesResourceFile(INodeSet nodeset,
                           java.lang.String nodesResourcesFilePath)
                             throws UpdateUtils.UpdateException

Update the resources file given an input Nodes set

Parameters:

nodeset - nodes

nodesResourcesFilePath - destination file path

Throws:

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