com.dtolabs.rundeck.core.common

Class ProjectNodeSupport

java.lang.Object

com.dtolabs.rundeck.core.common.ProjectNodeSupport

All Implemented Interfaces:

IProjectNodes

public class ProjectNodeSupport
extends java.lang.Object
implements IProjectNodes

Manage node source loading for a project

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FRAMEWORK_RESOURCES_ALLOWED_URL_PREFIX
static java.lang.String	NODES_XML
static java.lang.String	PROJECT_RESOURCES_ALLOWED_URL_PREFIX
static java.lang.String	PROJECT_RESOURCES_FILE_PROPERTY
static java.lang.String	PROJECT_RESOURCES_FILEFORMAT_PROPERTY
static java.lang.String	PROJECT_RESOURCES_MERGE_NODE_ATTRIBUTES
static java.lang.String	PROJECT_RESOURCES_URL_PROPERTY
static java.lang.String	RESOURCES_SOURCE_PROP_PREFIX

Constructor Summary

Constructors

Constructor and Description
ProjectNodeSupport(IRundeckProjectConfig projectConfig, ResourceFormatGeneratorService resourceFormatGeneratorService, ResourceModelSourceService resourceModelSourceService)

Method Summary

Methods

Modifier and Type	Method and Description
static ResourceModelSource	asModelSource(IProjectNodes nodes)
ResourceModelSource	createCachingSource(ResourceModelSource origin, java.lang.String ident, java.lang.String descr, SourceFactory.CacheType type, boolean logging)
INodeSet	getNodeSet() Returns the set of nodes for the project
static java.lang.String	getNodesResourceFilePath(IRundeckProject project, Framework framework)
IRundeckProjectConfig	getProjectConfig()
java.util.ArrayList<java.lang.Exception>	getResourceModelSourceExceptions()
java.util.Map<java.lang.String,java.lang.Exception>	getResourceModelSourceExceptionsMap()
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listResourceModelConfigurations() list the configurations of resource model providers.
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listResourceModelConfigurations(java.util.Properties props) Return a list of resource model configuration
void	updateNodesResourceFile(java.io.File source, java.lang.String nodesResourceFilePath) Update the resources file from a source file
void	updateNodesResourceFile(INodeSet nodeset, java.lang.String nodesResourceFilePath) 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.

Methods inherited from class java.lang.Object

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

Field Detail

NODES_XML

public static final java.lang.String NODES_XML

See Also:

Constant Field Values

PROJECT_RESOURCES_URL_PROPERTY

public static final java.lang.String PROJECT_RESOURCES_URL_PROPERTY

See Also:

Constant Field Values

PROJECT_RESOURCES_FILE_PROPERTY

public static final java.lang.String PROJECT_RESOURCES_FILE_PROPERTY

See Also:

Constant Field Values

PROJECT_RESOURCES_FILEFORMAT_PROPERTY

public static final java.lang.String PROJECT_RESOURCES_FILEFORMAT_PROPERTY

See Also:

Constant Field Values

RESOURCES_SOURCE_PROP_PREFIX

public static final java.lang.String RESOURCES_SOURCE_PROP_PREFIX

See Also:

Constant Field Values

PROJECT_RESOURCES_MERGE_NODE_ATTRIBUTES

public static final java.lang.String PROJECT_RESOURCES_MERGE_NODE_ATTRIBUTES

See Also:

Constant Field Values

PROJECT_RESOURCES_ALLOWED_URL_PREFIX

public static final java.lang.String PROJECT_RESOURCES_ALLOWED_URL_PREFIX

See Also:

Constant Field Values

FRAMEWORK_RESOURCES_ALLOWED_URL_PREFIX

public static final java.lang.String FRAMEWORK_RESOURCES_ALLOWED_URL_PREFIX

See Also:

Constant Field Values

Constructor Detail

ProjectNodeSupport

public ProjectNodeSupport(IRundeckProjectConfig projectConfig,
                  ResourceFormatGeneratorService resourceFormatGeneratorService,
                  ResourceModelSourceService resourceModelSourceService)

Method Detail

getNodeSet

public INodeSet getNodeSet()

Returns the set of nodes for the project

Specified by:

getNodeSet in interface IProjectNodes

Returns:

an instance of INodeSet

getResourceModelSourceExceptions

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

Specified by:

getResourceModelSourceExceptions in interface IProjectNodes

Returns:

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

getResourceModelSourceExceptionsMap

public java.util.Map<java.lang.String,java.lang.Exception> getResourceModelSourceExceptionsMap()

Specified by:

getResourceModelSourceExceptionsMap in interface IProjectNodes

Returns:

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

asModelSource

public static ResourceModelSource asModelSource(IProjectNodes nodes)

Parameters:

nodes - IProjectNodes

Returns:

model source view of the nodes

createCachingSource

public ResourceModelSource createCachingSource(ResourceModelSource origin,
                                      java.lang.String ident,
                                      java.lang.String descr,
                                      SourceFactory.CacheType type,
                                      boolean logging)

Parameters:

logging -

origin - origin source

ident - unique identity for this cached source, used in filename

descr - description of the source, used in logging

logging - if true, log cache access

Returns:

new source

listResourceModelConfigurations

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

list the configurations of resource model providers.

Specified by:

listResourceModelConfigurations in interface IProjectNodes

Returns:

a list of maps containing:

• type - provider type name
• props - configuration properties

listResourceModelConfigurations

public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listResourceModelConfigurations(java.util.Properties props)

Return a list of resource model configuration

Parameters:

props - properties

Returns:

List of Maps, each map containing "type": String, "props":Properties

getNodesResourceFilePath

public static java.lang.String getNodesResourceFilePath(IRundeckProject project,
                                        Framework framework)

Returns:

specific nodes resources file path for the project, based on the framework.nodes.file.name property

updateNodesResourceFile

public 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

Specified by:

updateNodesResourceFile in interface IProjectNodes

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

public 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.

Specified by:

updateNodesResourceFileFromUrl in interface IProjectNodes

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

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

Update the resources file given an input Nodes set

Specified by:

updateNodesResourceFile in interface IProjectNodes

Parameters:

nodeset - nodes

nodesResourceFilePath - destination file path

Throws:

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

updateNodesResourceFile

public void updateNodesResourceFile(java.io.File source,
                           java.lang.String nodesResourceFilePath)
                             throws UpdateUtils.UpdateException

Update the resources file from a source file

Parameters:

source - the source file

Throws:

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

getProjectConfig

public IRundeckProjectConfig getProjectConfig()