public class FrameworkBase extends java.lang.Object implements IFramework
FrameworkProjectMgr
, Authorization
.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
FRAMEWORK_GLOBALS_PROP |
static org.slf4j.Logger |
logger |
static java.lang.String |
NODES_RESOURCES_FILE_PROP |
static java.lang.String |
PROJECT_GLOBALS_PROP |
Constructor and Description |
---|
FrameworkBase(ProjectManager projectManager,
IPropertyLookup lookup,
IFrameworkServices services,
IFrameworkNodes iFrameworkNodes)
Standard constructor
|
Modifier and Type | Method and Description |
---|---|
NodeEntryImpl |
createFrameworkNode() |
static PropertyRetriever |
createPropertyRetriever(java.io.File basedir) |
INodeSet |
filterAuthorizedNodes(java.lang.String project,
java.util.Set<java.lang.String> actions,
INodeSet unfiltered,
com.dtolabs.rundeck.core.authorization.AuthContext authContext) |
ExecutionService |
getExecutionService() |
FileCopier |
getFileCopierForNodeAndProject(INodeEntry node,
ExecutionContext context)
provide file copier for the node and project
|
FileCopierService |
getFileCopierService() |
java.lang.String |
getFrameworkNodeHostname()
Gets the value of "framework.server.hostname" property
|
java.lang.String |
getFrameworkNodeName()
Gets the value of "framework.server.name" property
|
IFrameworkNodes |
getFrameworkNodes() |
ProjectManager |
getFrameworkProjectMgr()
Gets DepotMgr for this framework instance
|
IFrameworkServices |
getFrameworkServices() |
static Framework |
getInstance(java.lang.String basedir,
java.lang.String projectsdir) |
INodeDesc |
getNodeDesc()
Gets the
INodeDesc value describing the framework node |
NodeDispatcher |
getNodeDispatcherForContext(ExecutionContext context)
provide node dispatcher for context
|
NodeDispatcherService |
getNodeDispatcherService() |
NodeExecutor |
getNodeExecutorForNodeAndProject(INodeEntry node,
ExecutionContext context)
provide node executor for the node and project
|
NodeExecutorService |
getNodeExecutorService() |
NodeStepExecutor |
getNodeStepExecutorForItem(NodeStepExecutionItem item,
java.lang.String project)
provide node step executor for item and project
|
NodeStepExecutionService |
getNodeStepExecutorService() |
OrchestratorService |
getOrchestratorService() |
ServiceProviderLoader |
getPluginManager() |
java.util.Map<java.lang.String,java.lang.String> |
getProjectGlobals(java.lang.String project)
Retrieves the global properties defined for the specified project.
|
ProjectManager |
getProjectManager() |
java.lang.String |
getProjectProperty(java.lang.String project,
java.lang.String key) |
java.lang.String |
getProperty(java.lang.String name)
Return the property value by name
|
IPropertyLookup |
getPropertyLookup() |
ResourceFormatGeneratorService |
getResourceFormatGeneratorService() |
ResourceFormatParserService |
getResourceFormatParserService() |
ResourceModelSourceService |
getResourceModelSourceService() |
FrameworkSupportService |
getService(java.lang.String name) |
StepExecutionService |
getStepExecutionService() |
StepExecutor |
getStepExecutorForItem(StepExecutionItem item,
java.lang.String project)
provide step executor for the item and the project
|
WorkflowExecutionService |
getWorkflowExecutionService() |
WorkflowStrategyService |
getWorkflowStrategyService() |
boolean |
hasProjectProperty(java.lang.String key,
java.lang.String project) |
boolean |
hasProperty(java.lang.String key) |
void |
initialize(Framework framework)
initialize
|
boolean |
isLocalNode(INodeDesc node)
Return true if the node is the local framework node.
|
void |
overrideService(java.lang.String name,
FrameworkSupportService service)
Override existing registration
|
void |
setFrameworkNodes(IFrameworkNodes frameworkNodes) |
void |
setFrameworkServices(IFrameworkServices frameworkServices) |
void |
setProjectManager(ProjectManager projectManager) |
void |
setService(java.lang.String name,
FrameworkSupportService service)
Set a service by name if not yet set, will not override existing registration
|
java.lang.String |
toString()
Returns a string with useful information for debugging.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getPropertyRetriever
public static final org.slf4j.Logger logger
public static final java.lang.String NODES_RESOURCES_FILE_PROP
public static final java.lang.String FRAMEWORK_GLOBALS_PROP
public static final java.lang.String PROJECT_GLOBALS_PROP
public FrameworkBase(ProjectManager projectManager, IPropertyLookup lookup, IFrameworkServices services, IFrameworkNodes iFrameworkNodes)
public void initialize(Framework framework)
IFrameworkServices
initialize
in interface IFrameworkServices
public ProjectManager getFrameworkProjectMgr()
getFrameworkProjectMgr
in interface IFramework
public FrameworkSupportService getService(java.lang.String name)
getService
in interface IServicesRegistration
name
- service namepublic void overrideService(java.lang.String name, FrameworkSupportService service)
IServicesRegistration
overrideService
in interface IServicesRegistration
name
- nameservice
- servicepublic void setService(java.lang.String name, FrameworkSupportService service)
IServicesRegistration
setService
in interface IServicesRegistration
name
- nameservice
- service, or null to remove the registrationpublic StepExecutor getStepExecutorForItem(StepExecutionItem item, java.lang.String project) throws ExecutionServiceException
IExecutionProviders
getStepExecutorForItem
in interface IExecutionProviders
ExecutionServiceException
public NodeDispatcherService getNodeDispatcherService()
getNodeDispatcherService
in interface IExecutionServices
public ExecutionService getExecutionService()
getExecutionService
in interface IFrameworkServices
public OrchestratorService getOrchestratorService()
getOrchestratorService
in interface IExecutionServices
public WorkflowExecutionService getWorkflowExecutionService()
getWorkflowExecutionService
in interface IExecutionServices
public WorkflowStrategyService getWorkflowStrategyService()
getWorkflowStrategyService
in interface IExecutionServices
public StepExecutionService getStepExecutionService()
getStepExecutionService
in interface IExecutionServices
public FileCopier getFileCopierForNodeAndProject(INodeEntry node, ExecutionContext context) throws ExecutionServiceException
IExecutionProviders
getFileCopierForNodeAndProject
in interface IExecutionProviders
ExecutionServiceException
public FileCopierService getFileCopierService()
getFileCopierService
in interface IExecutionServices
public NodeExecutor getNodeExecutorForNodeAndProject(INodeEntry node, ExecutionContext context) throws ExecutionServiceException
IExecutionProviders
getNodeExecutorForNodeAndProject
in interface IExecutionProviders
ExecutionServiceException
public NodeExecutorService getNodeExecutorService()
getNodeExecutorService
in interface IExecutionServices
public NodeStepExecutionService getNodeStepExecutorService()
getNodeStepExecutorService
in interface IExecutionServices
public NodeStepExecutor getNodeStepExecutorForItem(NodeStepExecutionItem item, java.lang.String project) throws ExecutionServiceException
IExecutionProviders
getNodeStepExecutorForItem
in interface IExecutionProviders
ExecutionServiceException
public NodeDispatcher getNodeDispatcherForContext(ExecutionContext context) throws ExecutionServiceException
IExecutionProviders
getNodeDispatcherForContext
in interface IExecutionProviders
ExecutionServiceException
public ResourceModelSourceService getResourceModelSourceService()
getResourceModelSourceService
in interface IExecutionServices
public ResourceFormatParserService getResourceFormatParserService()
getResourceFormatParserService
in interface IExecutionServices
public ResourceFormatGeneratorService getResourceFormatGeneratorService()
getResourceFormatGeneratorService
in interface IExecutionServices
public ServiceProviderLoader getPluginManager()
getPluginManager
in interface IFrameworkServices
public static PropertyRetriever createPropertyRetriever(java.io.File basedir)
public static Framework getInstance(java.lang.String basedir, java.lang.String projectsdir)
public java.lang.String getProperty(java.lang.String name)
name
- Property keypublic boolean hasProperty(java.lang.String key)
key
- property keypublic boolean hasProjectProperty(java.lang.String key, java.lang.String project)
project
- projectkey
- property namepublic java.lang.String getProjectProperty(java.lang.String project, java.lang.String key)
project
- projectkey
- property namepublic java.util.Map<java.lang.String,java.lang.String> getProjectGlobals(java.lang.String project)
project
- The project identifier.public IPropertyLookup getPropertyLookup()
getPropertyLookup
in interface IFramework
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getFrameworkNodeHostname()
IFramework
getFrameworkNodeHostname
in interface IFramework
getFrameworkNodeHostname
in interface IFrameworkNodes
public java.lang.String getFrameworkNodeName()
IFramework
getFrameworkNodeName
in interface IFramework
getFrameworkNodeName
in interface IFrameworkNodes
public NodeEntryImpl createFrameworkNode()
createFrameworkNode
in interface IFramework
createFrameworkNode
in interface IFrameworkNodes
public INodeSet filterAuthorizedNodes(java.lang.String project, java.util.Set<java.lang.String> actions, INodeSet unfiltered, com.dtolabs.rundeck.core.authorization.AuthContext authContext)
filterAuthorizedNodes
in interface IFramework
filterAuthorizedNodes
in interface IFrameworkNodes
project
- project nameactions
- action setunfiltered
- nodesauthContext
- authoriziationpublic INodeDesc getNodeDesc()
IFramework
INodeDesc
value describing the framework nodegetNodeDesc
in interface IFramework
getNodeDesc
in interface IFrameworkNodes
INodeDesc
object for this framework instancepublic boolean isLocalNode(INodeDesc node)
IFramework
isLocalNode
in interface IFramework
isLocalNode
in interface IFrameworkNodes
node
- the nodepublic IFrameworkServices getFrameworkServices()
public void setFrameworkServices(IFrameworkServices frameworkServices)
public IFrameworkNodes getFrameworkNodes()
public void setFrameworkNodes(IFrameworkNodes frameworkNodes)
public ProjectManager getProjectManager()
public void setProjectManager(ProjectManager projectManager)