B.3 Grid Package

The Java classes included in the Grid package form the basis of the ZENworks Orchestrator infrastructure. For complete documentation of each class, click on the links to access the online documentation Javadoc.

B.3.1 AgentListener

Provides the interface necessary for processing messages sent from the Orchestrator Server.

For complete documentation, see AgentListener.

B.3.2 ClientAgent

API for client communication with server for job and datagrid operations.

For complete documentation, see ClientAgent.

B.3.3 Credential

A credential used for identity on the ZENworks Orchestrator system.

For complete documentation, see Credential.

B.3.4 Fact

The Grid Fact object.

For complete documentation, see Fact.

B.3.5 FactSet

Definition of a set of facts.

For complete documentation, see FactSet.

B.3.6 GridObjectInfo

Client interface to any Grid object.

For complete documentation, see GridObjectInfo.

B.3.7 ID

A unique identifier for an engine or a facility or Grid object.

For complete documentation, see ID.

B.3.8 JobInfo

A client representation of a deployed job.

For complete documentation, see JobInfo.

B.3.9 Message

A base interface for all the messages in the system.

For complete documentation, see Message.

B.3.10 Message.Ack

A general acknowledgement of “action” message.

For complete documentation, see Message.Ack.

B.3.11 Message.AuthFailure

Authentication failure messages indicates that processing of a client message will not occur because client credentials are invalid.

For complete documentation, see Message.AuthFailure.

B.3.12 Message.ClientResponse

Message All messages that can optionally carry an error string back to the client extend this.

For complete documentation, see Message.ClientResponse.

B.3.13 Message.Event

An Event is used to signal clients and workflows.

For complete documentation, see Message.Event.

B.3.14 Message.GetGridObjects

Client request to retrieve an (optionally ordered) set of grid objects that match a search criteria (constraint).

For complete documentation, see Message.GetGridObjects.

B.3.15 Message.GridObjects

Server response to client request to retrieve grid a grid object set.

For complete documentation, see Message.GridObjects.

B.3.16 Message.JobAccepted

A JobAccepted message is sent in response to a RunJob message when a job is successfully accepted into the system.

For complete documentation, see Message.JobAccepted.

B.3.17 Message.JobError

A JobError message is sent when an unrecoverable error occurs in a job.

For complete documentation, see Message.JobError.

B.3.18 Message.JobFinished

A JobFinished message is sent when processing of a job completes.

For complete documentation, see Message.JobFinished.

B.3.19 Message.JobIdEvent

Base Event interface for retrieving JobID used for jobid messages.

For complete documentation, see Message.JobIdEvent.

B.3.20 Message.JobInfo

A JobInfo message contains information describing a deployed job.

For complete documentation, see Message.JobInfo.

B.3.21 Message.Jobs

A Jobs message contains a list of deployed job names.

For complete documentation, see Message.Jobs.

B.3.22 Message.JobStarted

A JobStarted message is sent when a job is successfully started.

For complete documentation, see Message.JobStarted.

B.3.23 Message.JobStatus

A JobStatus message contains the state of the specified job.

For complete documentation, see Message.JobStatus.

B.3.24 Message.LoginFailed

Response message for an unsuccessful login

For complete documentation, see Message.LoginFailed.

B.3.25 Message.LoginSuccess

Response message for a successful login.

For complete documentation, see Message.LoginSuccess.

B.3.26 Message.LogoutAck

A LogoutAck indicates success or failure of logout operation.

For complete documentation, see Message.LogoutAck.

B.3.27 Message.NeedUpgrade

to be documented

For complete documentation, see Message.NeedUpgrade.

B.3.28 Message.RunningJobs

A RunningJobs message contains the list of running jobs.

For complete documentation, see Message.RunningJobs.

B.3.29 Message.ServerStatus

A ServerStatus message.

For complete documentation, see Message.ServerStatus.

B.3.30 Message.SessionAck

to be documented

For complete documentation, see Message.SessionAck.

B.3.31 Message.SessionChallenge

to be documented

For complete documentation, see Message.SessionChallenge.

B.3.32 Message.SessionResponse

to be documented

For complete documentation, see Message.SessionResponse.

B.3.33 Message.SessionStatus

to be documented

For complete documentation, see Message.SessionStatus.

B.3.34 Node

Internal interface for Node (Resource) Grid object.

For complete documentation, see Node.

B.3.35 Priority

Priority information.

For complete documentation, see Priority.

B.3.36 WorkflowInfo

A WorkflowInfo can represent either a snapshot of a running instance or an historical record of an instance.

For complete documentation, see WorkflowInfo.

B.3.37 ClientOutOfDateException

Grid exception indicating the client is not compatible with the server.

For complete documentation, see ClientOutOfDateException.

B.3.38 FactException

For exceptions that occur in accessing or setting facts.

For complete documentation, see FactException.

B.3.39 GridAuthenticationException

Thrown when authentication is denied by a ZENworks Orchestrator Server.

For complete documentation, see GridAuthenticationException.

B.3.40 GridAuthorizationException

Thrown when credentials are insufficient for the desired grid operation.

For complete documentation, see GridAuthorizationException.

B.3.41 GridConfigurationException

Grid exception thrown to indicate a Grid configuration error.

For complete documentation, see GridConfigurationException.

B.3.42 GridDeploymentException

Thrown when credentials are insufficient for the desired grid operation.

For complete documentation, see GridDeploymentException.

B.3.43 GridException

The base exception for all Grid exceptions.

For complete documentation, see GridException.

B.3.44 GridObjectNotFoundException

Thrown when a grid object lookup does not find the requested object.

For complete documentation, see GridObjectNotFoundException.