com.insightful.splusserver.domain.cluster

Class ClusterNodeDetails

java.lang.Object

com.insightful.splusserver.domain.cluster.ClusterNode

com.insightful.splusserver.domain.cluster.ClusterNodeDetails

public class ClusterNodeDetails
extends ClusterNode

This class contains node details returned from the server.

Author:

TIBCO

Constructor Summary

Constructors

Constructor and Description
ClusterNodeDetails() Creates a new ClusterNodeDetails.
ClusterNodeDetails(int responseCode, java.lang.String errorMessage) Creates a new ClusterNodeDetails specifying the response code and an error message.
ClusterNodeDetails(java.lang.String nodeName, NodeType nodeType, NodeState nodeState, java.util.ArrayList<java.lang.Long> jobsQueued, int engineCount) Creates a new ClusterNodeDetails specifying the node name, the node type, the node state, and the jobs queued.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getEngineCount() Get the number of execution engines running on a given node.
java.lang.String	getErrorMessage() Retrieves the error message from the server for the cluster node.
java.util.ArrayList<java.lang.Long>	getJobsQueued() Retrieves a list of queued jobs from the server.
int	getResponseCode() Retrieves the response code from the server for the cluster node.
int	hashCode()
void	setEngineCount(int engineCount) Set the number of execution engines running on a given node.
void	setErrorMessage(java.lang.String errorMessage) Sets the error message for the cluster node.
void	setJobsQueued(java.util.ArrayList<java.lang.Long> jobsQueued) Sets the list of queued jobs.
void	setResponseCode(int responseCode) Sets the state of the node.
void	throwExceptionIfError() Translates between the response code and corresponding exception thrown on the client.

Methods inherited from class com.insightful.splusserver.domain.cluster.ClusterNode

getNodeName, getNodeState, getNodeType, setNodeName, setNodeState, setNodeType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClusterNodeDetails

public ClusterNodeDetails(int responseCode,
                  java.lang.String errorMessage)

Creates a new ClusterNodeDetails specifying the response code and an error message.

Parameters:

responseCode - An int specifying the response code.

errorMessage - A string containing the error message.

See Also:

ClusterNodeList, ClusterNode

ClusterNodeDetails

public ClusterNodeDetails(java.lang.String nodeName,
                  NodeType nodeType,
                  NodeState nodeState,
                  java.util.ArrayList<java.lang.Long> jobsQueued,
                  int engineCount)

Creates a new ClusterNodeDetails specifying the node name, the node type, the node state, and the jobs queued.

Parameters:

nodeName - The name of the node.

nodeType - The type of node. Can be Manager or Worker.

nodeState - The state of the node. Can be Started or Stopped.

jobsQueued - An array of queued jobs.

See Also:

ClusterNodeList, ClusterNode

ClusterNodeDetails

public ClusterNodeDetails()

Creates a new ClusterNodeDetails.

See Also:

ClusterNodeList, ClusterNode

Method Detail

getEngineCount

public int getEngineCount()

Get the number of execution engines running on a given node.

Returns:

The number of engines running on a node.

setEngineCount

public void setEngineCount(int engineCount)

Set the number of execution engines running on a given node.

Parameters:

engineCount - The number of engines running on a node.

getJobsQueued

public java.util.ArrayList<java.lang.Long> getJobsQueued()

Retrieves a list of queued jobs from the server.

Returns:

jobsQueued An array of queued jobs.

See Also:

ClusterNodeList

setJobsQueued

public void setJobsQueued(java.util.ArrayList<java.lang.Long> jobsQueued)

Sets the list of queued jobs.

Parameters:

jobsQueued - An array list containing the queued jobs.

See Also:

ClusterNodeList

getResponseCode

public int getResponseCode()

Retrieves the response code from the server for the cluster node.

Returns:

responseCode An int representing the response code.

See Also:

ClusterNodeList, ResponseCodes

setResponseCode

public void setResponseCode(int responseCode)

Sets the state of the node.

Parameters:

responseCode - An int response code.

See Also:

ClusterNodeList, ResponseCodes

getErrorMessage

public java.lang.String getErrorMessage()

Retrieves the error message from the server for the cluster node.

Returns:

errorMessage A string containing the error message.

See Also:

ClusterNodeList

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Sets the error message for the cluster node.

Parameters:

errorMessage - A string containing the error message.

See Also:

ClusterNodeList

throwExceptionIfError

public void throwExceptionIfError()
                           throws NotAuthenticatedException,
                                  java.lang.IllegalArgumentException

Translates between the response code and corresponding exception thrown on the client. Meant to be used internally by only the client API.

Throws:

JobDoesNotExistException

NotAuthenticatedException

java.lang.IllegalArgumentException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ClusterNode

hashCode

public int hashCode()

Overrides:

hashCode in class ClusterNode