com.dtolabs.rundeck.core.common

Class ProjectNodeSupport

java.lang.Object

com.dtolabs.rundeck.core.common.ProjectNodeSupport

All Implemented Interfaces:

IProjectNodes, java.io.Closeable, java.lang.AutoCloseable

public class ProjectNodeSupport
extends java.lang.Object
implements IProjectNodes, java.io.Closeable

Manage node source loading for a project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectNodeSupport.ProjectWriteableNodes
static interface	ProjectNodeSupport.SourceDefinition A source definition

Nested classes/interfaces inherited from interface com.dtolabs.rundeck.core.common.IProjectNodes

IProjectNodes.ReadableProjectNodes, IProjectNodes.WriteableProjectNodes

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NODE_ENHANCER_PROP_PREFIX
static java.lang.String	PROJECT_RESOURCES_FILE_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) Deprecated. use ProjectNodeSupport(IRundeckProjectConfig, ResourceFormatGeneratorService, ResourceModelSourceService, Function)
ProjectNodeSupport(IRundeckProjectConfig projectConfig, ResourceFormatGeneratorService resourceFormatGeneratorService, ResourceModelSourceService resourceModelSourceService, java.util.function.Function<ProjectNodeSupport.SourceDefinition,CloseableProvider<ResourceModelSource>> factoryFunction)

Method Summary

Modifier and Type	Method and Description
static ResourceModelSource	asModelSource(IProjectNodes nodes)
void	close()
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
IRundeckProjectConfig	getProjectConfig()
java.util.ArrayList<java.lang.Throwable>	getResourceModelSourceExceptions()
java.util.Map<java.lang.String,java.lang.Throwable>	getResourceModelSourceExceptionsMap()
java.util.List<IProjectNodes.ReadableProjectNodes>	getResourceModelSources()
java.util.Collection<IProjectNodes.WriteableProjectNodes>	getWriteableResourceModelSources()
java.util.List<ExtPluginConfiguration>	listNodeEnhancerConfigurations() list the configurations of node enhancer providers.
static java.util.List<ExtPluginConfiguration>	listPluginConfigurations(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String keyprefix, java.lang.String serviceName) Return a list of resource model configuration
static java.util.List<ExtPluginConfiguration>	listPluginConfigurations(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String keyprefix, java.lang.String serviceName, boolean extra) Return a list of resource model configuration
java.util.List<ExtPluginConfiguration>	listPluginConfigurations(java.lang.String keyprefix, java.lang.String serviceName) Return a list of resource model configuration
java.util.List<ExtPluginConfiguration>	listPluginConfigurations(java.lang.String keyprefix, java.lang.String serviceName, boolean extra) Return a list of resource model configuration
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
java.util.List<ExtPluginConfiguration>	listResourceModelPluginConfigurations() list the configurations of resource model providers.
static java.util.Properties	serializePluginConfigurations(java.lang.String prefix, java.util.List<ExtPluginConfiguration> configs, boolean extra)
static java.util.Properties	serializePluginConfigurations(java.lang.String prefix, java.util.List<PluginConfiguration> configs)
static void	serializeProp(java.lang.String prefix, java.util.Properties projProps, int count, PluginConfiguration config)
static java.util.Properties	serializeResourceModelConfigurations(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> configs)

Methods inherited from class java.lang.Object

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

Field Detail

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

RESOURCES_SOURCE_PROP_PREFIX

public static final java.lang.String RESOURCES_SOURCE_PROP_PREFIX

See Also:

Constant Field Values

NODE_ENHANCER_PROP_PREFIX

public static final java.lang.String NODE_ENHANCER_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

Constructor Detail

ProjectNodeSupport

public ProjectNodeSupport(IRundeckProjectConfig projectConfig,
                          ResourceFormatGeneratorService resourceFormatGeneratorService,
                          ResourceModelSourceService resourceModelSourceService,
                          java.util.function.Function<ProjectNodeSupport.SourceDefinition,CloseableProvider<ResourceModelSource>> factoryFunction)

Parameters:

projectConfig -

resourceFormatGeneratorService -

factoryFunction - factory for closeable model source provider

ProjectNodeSupport

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

Deprecated. use ProjectNodeSupport(IRundeckProjectConfig, ResourceFormatGeneratorService, ResourceModelSourceService, Function)

Parameters:

projectConfig -

resourceFormatGeneratorService -

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.Throwable> 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.Throwable> getResourceModelSourceExceptionsMap()

Specified by:

getResourceModelSourceExceptionsMap in interface IProjectNodes

Returns:

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

getResourceModelSources

public java.util.List<IProjectNodes.ReadableProjectNodes> getResourceModelSources()

Specified by:

getResourceModelSources in interface IProjectNodes

Returns:

all sources

getWriteableResourceModelSources

public java.util.Collection<IProjectNodes.WriteableProjectNodes> getWriteableResourceModelSources()

Specified by:

getWriteableResourceModelSources in interface IProjectNodes

Returns:

writeable sources

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

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

listResourceModelPluginConfigurations

public java.util.List<ExtPluginConfiguration> listResourceModelPluginConfigurations()

list the configurations of resource model providers.

Specified by:

listResourceModelPluginConfigurations in interface IProjectNodes

Returns:

a list of PluginConfiguration

listNodeEnhancerConfigurations

public java.util.List<ExtPluginConfiguration> listNodeEnhancerConfigurations()

list the configurations of node enhancer providers.

Specified by:

listNodeEnhancerConfigurations in interface IProjectNodes

Returns:

a list of PluginConfiguration

serializeResourceModelConfigurations

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

Returns:

Properties form for the serialized list of model source configurations

serializePluginConfigurations

public static java.util.Properties serializePluginConfigurations(java.lang.String prefix,
                                                                 java.util.List<PluginConfiguration> configs)

Returns:

Properties form for the serialized list of indexed plugin configurations with a prefix

serializeProp

public static void serializeProp(java.lang.String prefix,
                                 java.util.Properties projProps,
                                 int count,
                                 PluginConfiguration config)

serializePluginConfigurations

public static java.util.Properties serializePluginConfigurations(java.lang.String prefix,
                                                                 java.util.List<ExtPluginConfiguration> configs,
                                                                 boolean extra)

Parameters:

extra - if true, include extra data

Returns:

Properties form for the serialized list of indexed plugin configurations with a prefix

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

listPluginConfigurations

public java.util.List<ExtPluginConfiguration> listPluginConfigurations(java.lang.String keyprefix,
                                                                       java.lang.String serviceName)

Return a list of resource model configuration

Specified by:

listPluginConfigurations in interface IProjectNodes

Parameters:

serviceName -

keyprefix - prefix for properties

Returns:

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

listPluginConfigurations

public java.util.List<ExtPluginConfiguration> listPluginConfigurations(java.lang.String keyprefix,
                                                                       java.lang.String serviceName,
                                                                       boolean extra)

Return a list of resource model configuration

Specified by:

listPluginConfigurations in interface IProjectNodes

Parameters:

serviceName -

keyprefix - prefix for properties

Returns:

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

listPluginConfigurations

public static java.util.List<ExtPluginConfiguration> listPluginConfigurations(java.util.Map<java.lang.String,java.lang.String> props,
                                                                              java.lang.String keyprefix,
                                                                              java.lang.String serviceName)

Return a list of resource model configuration

Parameters:

serviceName - service name

props - properties

keyprefix - prefix for properties

Returns:

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

listPluginConfigurations

public static java.util.List<ExtPluginConfiguration> listPluginConfigurations(java.util.Map<java.lang.String,java.lang.String> props,
                                                                              java.lang.String keyprefix,
                                                                              java.lang.String serviceName,
                                                                              boolean extra)

Return a list of resource model configuration

Parameters:

serviceName - service name

props - properties

keyprefix - prefix for properties

Returns:

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

getProjectConfig

public IRundeckProjectConfig getProjectConfig()