org.rhq.core.clientapi.server.operation

Interface OperationServerService

public interface OperationServerService

The interface to a JON server's operation subsystem.

Method Summary

Methods

Modifier and Type	Method and Description
void	operationCanceled(String jobId, org.rhq.core.domain.configuration.Configuration result, ExceptionPackage error, long invocationTime, long canceledTime) Called by the agent when a server-scheduled operation was canceled.
void	operationFailed(String jobId, org.rhq.core.domain.configuration.Configuration result, ExceptionPackage error, long invocationTime, long completionTime) Called by the agent when a server-scheduled operation fails.
void	operationSucceeded(String jobId, org.rhq.core.domain.configuration.Configuration result, long invocationTime, long completionTime) Called by the agent when a server-scheduled operation completes successfully.
void	operationTimedOut(String jobId, long invocationTime, long timeoutTime) Called by the agent when a server-scheduled operation times out.

Method Detail

operationSucceeded

@Asynchronous(guaranteedDelivery=true)
void operationSucceeded(String jobId,
                                                     org.rhq.core.domain.configuration.Configuration result,
                                                     long invocationTime,
                                                     long completionTime)

Called by the agent when a server-scheduled operation completes successfully.

Parameters:

jobId - the server-assigned unique job id for this operation

result - the result of the operation

invocationTime - the time at which the agent was asked to invoke the operation (epoch millis)

completionTime - the time at which the operation completed (epoch millis)

operationFailed

@Asynchronous(guaranteedDelivery=true)
void operationFailed(String jobId,
                                                  org.rhq.core.domain.configuration.Configuration result,
                                                  ExceptionPackage error,
                                                  long invocationTime,
                                                  long completionTime)

Called by the agent when a server-scheduled operation fails.

Parameters:

jobId - the server-assigned unique job id for this operation

result - a result object that can be used to capture any information available up to the point of failure

error - an exception describing why the operation failed

invocationTime - the time at which the agent was asked to invoke the operation (epoch millis)

completionTime - the time at which the operation completed (i.e. failed) (epoch millis)

operationCanceled

@Asynchronous(guaranteedDelivery=true)
void operationCanceled(String jobId,
                                                    org.rhq.core.domain.configuration.Configuration result,
                                                    ExceptionPackage error,
                                                    long invocationTime,
                                                    long canceledTime)

Called by the agent when a server-scheduled operation was canceled.

Parameters:

jobId - the server-assigned unique job id for this operation

result - a result object that can be used to capture any information available up to the point of cancelation.

error - an exception describing the cancelation

invocationTime - the time at which the agent was asked to invoke the operation (epoch millis)

canceledTime - the time at which the operation was canceled (epoch millis)

operationTimedOut

@Asynchronous(guaranteedDelivery=true)
void operationTimedOut(String jobId,
                                                    long invocationTime,
                                                    long timeoutTime)

Called by the agent when a server-scheduled operation times out.

Parameters:

jobId - the server-assigned unique job id for this operation

invocationTime - the time at which the agent was asked to invoke the operation (epoch millis)

timeoutTime - the time at which the operation timed out (epoch millis)