Package com.dtolabs.rundeck.core.common
Interface IFramework
-
- All Superinterfaces:
IExecutionProviders
,IExecutionServices
,IFrameworkNodes
,IFrameworkServices
,IServicesRegistration
- All Known Implementing Classes:
Framework
,FrameworkBase
public interface IFramework extends IFrameworkServices, IFrameworkNodes
Interface for framework instance
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method 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" propertyjava.lang.String
getFrameworkNodeName()
Gets the value of "framework.server.name" propertyProjectManager
getFrameworkProjectMgr()
Gets DepotMgr for this framework instanceINodeDesc
getNodeDesc()
Gets theINodeDesc
value describing the framework nodeIPropertyLookup
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.IExecutionProviders
getFileCopierForNodeAndProject, getNodeDispatcherForContext, getNodeExecutorForNodeAndProject, getNodeStepExecutorForItem, getStepExecutorForItem
-
Methods inherited from interface com.dtolabs.rundeck.core.common.IExecutionServices
getFileCopierService, getNodeDispatcherService, getNodeExecutorService, getNodeStepExecutorService, getOrchestratorService, getResourceFormatGeneratorService, getResourceFormatParserService, getResourceModelSourceService, getStepExecutionService, getWorkflowExecutionService, getWorkflowStrategyService
-
Methods inherited from interface com.dtolabs.rundeck.core.common.IFrameworkServices
getExecutionService, getPluginManager, initialize
-
Methods inherited from interface com.dtolabs.rundeck.core.common.IServicesRegistration
getService, overrideService, 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 interfaceIFrameworkNodes
- 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 interfaceIFrameworkNodes
- Returns:
- Returns value of framework.server.name property
-
createFrameworkNode
NodeEntryImpl createFrameworkNode()
- Specified by:
createFrameworkNode
in interfaceIFrameworkNodes
- 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 interfaceIFrameworkNodes
- Parameters:
project
- project nameactions
- action setunfiltered
- nodesauthContext
- authoriziation- Returns:
- the nodeset consisting only of the input nodes where the specified actions are all authorized
-
getNodeDesc
INodeDesc getNodeDesc()
Gets theINodeDesc
value describing the framework node- Specified by:
getNodeDesc
in interfaceIFrameworkNodes
- 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 interfaceIFrameworkNodes
- Parameters:
node
- the node- Returns:
- true if the node's name is the same as the framework's node name
-
-