com.dtolabs.rundeck.core.common

Interface IFramework

All Superinterfaces:

IFrameworkNodes, IFrameworkServices

All Known Implementing Classes:

Framework, FrameworkBase

public interface IFramework
extends IFrameworkServices, IFrameworkNodes

Interface for framework instance

Method Summary

Modifier and Type	Method and Description
NodeEntryImpl	createFrameworkNode()
INodeSet	filterAuthorizedNodes(java.lang.String project, java.util.Set<java.lang.String> actions, INodeSet unfiltered, com.dtolabs.rundeck.core.authorization.AuthContext authContext)
java.lang.String	getFrameworkNodeHostname() Gets the value of "framework.server.hostname" property
java.lang.String	getFrameworkNodeName() Gets the value of "framework.server.name" property
ProjectManager	getFrameworkProjectMgr() Gets DepotMgr for this framework instance
INodeDesc	getNodeDesc() Gets the INodeDesc value describing the framework node
IPropertyLookup	getPropertyLookup()
default PropertyRetriever	getPropertyRetriever()
boolean	isLocalNode(INodeDesc node) Return true if the node is the local framework node.

Methods inherited from interface com.dtolabs.rundeck.core.common.IFrameworkServices

getExecutionService, getFileCopierForNodeAndProject, getFileCopierService, getNodeDispatcherForContext, getNodeExecutorForNodeAndProject, getNodeExecutorService, getNodeStepExecutorForItem, getNodeStepExecutorService, getOrchestratorService, getPluginManager, getResourceFormatGeneratorService, getResourceFormatParserService, getResourceModelSourceService, getService, getStepExecutionService, getWorkflowExecutionService, getWorkflowStrategyService, setService

Method Detail

getFrameworkProjectMgr

ProjectManager getFrameworkProjectMgr()

Gets DepotMgr for this framework instance

Returns:

returns instance of IFrameworkProjectMgr

getPropertyLookup

IPropertyLookup getPropertyLookup()

Returns:

property lookup

getPropertyRetriever

default PropertyRetriever getPropertyRetriever()

Returns:

safe property retriever

getFrameworkNodeHostname

java.lang.String getFrameworkNodeHostname()

Gets the value of "framework.server.hostname" property

Specified by:

getFrameworkNodeHostname in interface IFrameworkNodes

Returns:

Returns value of framework.server.hostname property

getFrameworkNodeName

java.lang.String getFrameworkNodeName()

Gets the value of "framework.server.name" property

Specified by:

getFrameworkNodeName in interface IFrameworkNodes

Returns:

Returns value of framework.server.name property

createFrameworkNode

NodeEntryImpl createFrameworkNode()

Specified by:

createFrameworkNode in interface IFrameworkNodes

Returns:

Generate a node entry for the framework with default values

filterAuthorizedNodes

INodeSet filterAuthorizedNodes(java.lang.String project,
                               java.util.Set<java.lang.String> actions,
                               INodeSet unfiltered,
                               com.dtolabs.rundeck.core.authorization.AuthContext authContext)

Specified by:

filterAuthorizedNodes in interface IFrameworkNodes

Parameters:

project - project name

actions - action set

unfiltered - nodes

authContext - authoriziation

Returns:

the nodeset consisting only of the input nodes where the specified actions are all authorized

getNodeDesc

INodeDesc getNodeDesc()

Gets the INodeDesc value describing the framework node

Specified by:

getNodeDesc in interface IFrameworkNodes

Returns:

the singleton INodeDesc object for this framework instance

isLocalNode

boolean isLocalNode(INodeDesc node)

Return true if the node is the local framework node. Compares the (logical) node names of the nodes after eliding any embedded 'user@' parts.

Specified by:

isLocalNode in interface IFrameworkNodes

Parameters:

node - the node

Returns:

true if the node's name is the same as the framework's node name