Package com.dtolabs.rundeck.core.common

Interface IFrameworkNodes

All Known Subinterfaces:

IFramework

All Known Implementing Classes:

Framework, FrameworkBase, NodeSupport

public interface IFrameworkNodes

Created by greg on 2/20/15.

Method Summary

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" property
java.lang.String	getFrameworkNodeName()	Gets the value of "framework.server.name" property
INodeDesc	getNodeDesc()	Gets the INodeDesc value describing the framework node
boolean	isLocalNode(INodeDesc node)	Return true if the node is the local framework node.

Method Detail

getFrameworkNodeHostname

java.lang.String getFrameworkNodeHostname()

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

Returns:

Returns value of framework.server.hostname property

getFrameworkNodeName

java.lang.String getFrameworkNodeName()

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

Returns:

Returns value of framework.server.name property

createFrameworkNode

NodeEntryImpl createFrameworkNode()

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)

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

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.

Parameters:

node - the node

Returns:

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