oracle.ifs.core.runtime

Interface NodeInterface

All Known Implementing Classes:

Node

public interface NodeInterface

NodeInterface is the interface for Node, a managed CMSDK process.

Version:

1.0

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static int	NODESTATUS_DISPOSED A Node that has been disposed.
static int	NODESTATUS_RUNNING A Node that is running.
static int	NODESTATUS_STARTING A Node that is starting.
static int	NODESTATUS_STOPPED A Node that is stopped or not yet started.
static int	NODESTATUS_STOPPING A Node that is stopping.
static int	NODESTATUS_UNKNOWN A Node whose status is unknown.

Method Summary

Modifier and Type	Method and Description
AttributeValue	getConfigurationValue(String key) Gets a Configuration value from the Configuration Table for this Node.
int	getDesiredStatus() Gets the desired status of this Node.
String	getIfsHome() Gets the CM SDK home directory for this Node.
String	getNodeConfigurationName() Gets the name of the Node configuration used to start this Node.
String	getNodeName() Gets the name of this Node.
NodeState	getNodeState(LibrarySession session) Gets the NodeState for this Node.
String	getOracleHome() Gets the Oracle home directory for this Server's node.
String	getServiceConfigurationName() Gets the name of the Service Configuration.
String	getServiceName() Gets the name of the default service for this Node.
ServiceState	getServiceState(LibrarySession session) Gets the ServiceState for the service that this Node manages.
int	getStatus() Gets the status of this Node.
void	postServerDisposedRequest(AttributeValue ssValue, Server server) Post request to respond to a Server indicating that it has been disposed.

Field Detail

NODESTATUS_UNKNOWN

static final int NODESTATUS_UNKNOWN

A Node whose status is unknown.

See Also:

Constant Field Values

(Published)

NODESTATUS_STOPPED

static final int NODESTATUS_STOPPED

A Node that is stopped or not yet started.

See Also:

Constant Field Values

(Published)

NODESTATUS_RUNNING

static final int NODESTATUS_RUNNING

A Node that is running.

See Also:

Constant Field Values

(Published)

NODESTATUS_STOPPING

static final int NODESTATUS_STOPPING

A Node that is stopping.

See Also:

Constant Field Values

(Published)

NODESTATUS_STARTING

static final int NODESTATUS_STARTING

A Node that is starting.

See Also:

Constant Field Values

(Published)

NODESTATUS_DISPOSED

static final int NODESTATUS_DISPOSED

A Node that has been disposed.

See Also:

Constant Field Values

(Published)

Method Detail

getNodeName

String getNodeName()

Gets the name of this Node.

Returns:

the name

(Published)

getNodeConfigurationName

String getNodeConfigurationName()

Gets the name of the Node configuration used to start this Node.

Returns:

the Node configuration name

(Published)

getServiceName

String getServiceName()

Gets the name of the default service for this Node.

Returns:

the service name

(Published)

getServiceConfigurationName

String getServiceConfigurationName()

Gets the name of the Service Configuration.

Returns:

the service configuration name

(Published)

getStatus

int getStatus()

Gets the status of this Node.

Returns:

the enumerated status

(Published)

getDesiredStatus

int getDesiredStatus()

Gets the desired status of this Node.

Returns:

the enumerated status

(Published)

getOracleHome

String getOracleHome()
              throws IfsException

Gets the Oracle home directory for this Server's node.

Returns:

the Oracle home directory

Throws:

IfsException - if the operation fails

(Published)

getIfsHome

String getIfsHome()
           throws IfsException

Gets the CM SDK home directory for this Node.

Returns:

the CM SDK home directory

Throws:

IfsException - if the operation fails

(Published)

getConfigurationValue

AttributeValue getConfigurationValue(String key)
                              throws IfsException

Gets a Configuration value from the Configuration Table for this Node.

Parameters:

key - the configuration property key

Returns:

the Configuration value, or null if not defined

Throws:

IfsException - if the operation fails

(Published)

getServiceState

ServiceState getServiceState(LibrarySession session)
                      throws IfsException

Gets the ServiceState for the service that this Node manages.

Returns:

the ServiceState associated with the Service managed by this Node

Throws:

IfsException - if the operation fails

(Published)

getNodeState

NodeState getNodeState(LibrarySession session)
                throws IfsException

Gets the NodeState for this Node.

Returns:

the NodeState associated with this Node

Throws:

IfsException - if the operation fails

(Published)

postServerDisposedRequest

void postServerDisposedRequest(AttributeValue ssValue,
                               Server server)

Post request to respond to a Server indicating that it has been disposed.

Parameters:

ssValue - the ServerState value for the Server that was disposed

server - the Server that was disposed

(Published)