com.vmware.appliance.vmon

Interface Service

All Superinterfaces:

Service, ServiceTypes

public interface Service
extends Service, ServiceTypes

The Service interface provides methods to manage a single/set of services that are managed by vMon.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.vmon.ServiceTypes

ServiceTypes.Health, ServiceTypes.Info, ServiceTypes.StartupType, ServiceTypes.State, ServiceTypes.UpdateSpec

Method Summary

Methods

Modifier and Type	Method and Description
ServiceTypes.Info	get(String service) Returns the state of a service.
void	get(String service, AsyncCallback<ServiceTypes.Info> asyncCallback) Returns the state of a service.
void	get(String service, AsyncCallback<ServiceTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the state of a service.
ServiceTypes.Info	get(String service, InvocationConfig invocationConfig) Returns the state of a service.
Map<String,ServiceTypes.Info>	listDetails() Lists details of services managed by vMon.
void	listDetails(AsyncCallback<Map<String,ServiceTypes.Info>> asyncCallback) Lists details of services managed by vMon.
void	listDetails(AsyncCallback<Map<String,ServiceTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Lists details of services managed by vMon.
Map<String,ServiceTypes.Info>	listDetails(InvocationConfig invocationConfig) Lists details of services managed by vMon.
void	restart(String service) Restarts a service
void	restart(String service, AsyncCallback<Void> asyncCallback) Restarts a service
void	restart(String service, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Restarts a service
void	restart(String service, InvocationConfig invocationConfig) Restarts a service
void	start(String service) Starts a service
void	start(String service, AsyncCallback<Void> asyncCallback) Starts a service
void	start(String service, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Starts a service
void	start(String service, InvocationConfig invocationConfig) Starts a service
void	stop(String service) Stops a service
void	stop(String service, AsyncCallback<Void> asyncCallback) Stops a service
void	stop(String service, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Stops a service
void	stop(String service, InvocationConfig invocationConfig) Stops a service
void	update(String service, ServiceTypes.UpdateSpec spec) Updates the properties of a service.
void	update(String service, ServiceTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback) Updates the properties of a service.
void	update(String service, ServiceTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the properties of a service.
void	update(String service, ServiceTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the properties of a service.

Method Detail

start

void start(String service)

Starts a service

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

service - identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

Throws:

NotFound - if the service associated with service does not exist.

NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.

NotAllowedInCurrentState - if start operation is issued on a service which has startup type ServiceTypes.StartupType.DISABLED.

TimedOut - if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.

Error - if any other error occurs during the execution of the operation.

start

void start(String service,
         InvocationConfig invocationConfig)

Starts a service

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

service - identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the service associated with service does not exist.

NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.

NotAllowedInCurrentState - if start operation is issued on a service which has startup type ServiceTypes.StartupType.DISABLED.

TimedOut - if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.

Error - if any other error occurs during the execution of the operation.

start

void start(String service,
         AsyncCallback<Void> asyncCallback)

Starts a service

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the service associated with service does not exist.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
NotAllowedInCurrentState - if start operation is issued on a service which has startup type ServiceTypes.StartupType.DISABLED.
TimedOut - if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
Error - if any other error occurs during the execution of the operation.

Parameters:

service - identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

start

void start(String service,
         AsyncCallback<Void> asyncCallback,
         InvocationConfig invocationConfig)

Starts a service

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the service associated with service does not exist.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
NotAllowedInCurrentState - if start operation is issued on a service which has startup type ServiceTypes.StartupType.DISABLED.
TimedOut - if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
Error - if any other error occurs during the execution of the operation.

Parameters:

service - identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

stop

void stop(String service)

Stops a service

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

service - identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

Throws:

NotFound - if the service associated with service does not exist.

Error - if any other error occurs during the execution of the operation.

NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

stop

void stop(String service,
        InvocationConfig invocationConfig)

Stops a service

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

service - identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the service associated with service does not exist.

Error - if any other error occurs during the execution of the operation.

NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

stop

void stop(String service,
        AsyncCallback<Void> asyncCallback)

Stops a service

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

Parameters:

service - identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

stop

void stop(String service,
        AsyncCallback<Void> asyncCallback,
        InvocationConfig invocationConfig)

Stops a service

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

Parameters:

service - identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

restart

void restart(String service)

Restarts a service

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

service - identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

Throws:

NotFound - if the service associated with service does not exist.

TimedOut - if any timeout occurs during the execution of the restart operation.

NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.

NotAllowedInCurrentState - if a restart operation is issued on a service which has startup type ServiceTypes.StartupType.DISABLED

Error - if any other error occurs during the execution of the operation.

restart

void restart(String service,
           InvocationConfig invocationConfig)

Restarts a service

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

service - identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the service associated with service does not exist.

TimedOut - if any timeout occurs during the execution of the restart operation.

NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.

NotAllowedInCurrentState - if a restart operation is issued on a service which has startup type ServiceTypes.StartupType.DISABLED

Error - if any other error occurs during the execution of the operation.

restart

void restart(String service,
           AsyncCallback<Void> asyncCallback)

Restarts a service

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the service associated with service does not exist.
TimedOut - if any timeout occurs during the execution of the restart operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
NotAllowedInCurrentState - if a restart operation is issued on a service which has startup type ServiceTypes.StartupType.DISABLED
Error - if any other error occurs during the execution of the operation.

Parameters:

service - identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

restart

void restart(String service,
           AsyncCallback<Void> asyncCallback,
           InvocationConfig invocationConfig)

Restarts a service

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the service associated with service does not exist.
TimedOut - if any timeout occurs during the execution of the restart operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
NotAllowedInCurrentState - if a restart operation is issued on a service which has startup type ServiceTypes.StartupType.DISABLED
Error - if any other error occurs during the execution of the operation.

Parameters:

service - identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

ServiceTypes.Info get(String service)

Returns the state of a service.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

service - identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

Returns:

Service Info structure.

Throws:

NotFound - if the service associated with service does not exist.

Error - if any other error occurs during the execution of the operation.

get

ServiceTypes.Info get(String service,
                    InvocationConfig invocationConfig)

Returns the state of a service.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

service - identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

invocationConfig - Configuration for the method invocation.

Returns:

Service Info structure.

Throws:

NotFound - if the service associated with service does not exist.

Error - if any other error occurs during the execution of the operation.

get

void get(String service,
       AsyncCallback<ServiceTypes.Info> asyncCallback)

Returns the state of a service.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
Service Info structure.

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.

Parameters:

service - identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(String service,
       AsyncCallback<ServiceTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Returns the state of a service.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
Service Info structure.

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.

Parameters:

service - identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

void update(String service,
          ServiceTypes.UpdateSpec spec)

Updates the properties of a service.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

service - identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

spec - Service Update specification.

Throws:

NotFound - if the service associated with service does not exist.

Error - if any other error occurs during the execution of the operation.

NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a start, stop or restart operation is in progress, update operation will fail with this error.

NotAllowedInCurrentState - if a request to set the ServiceTypes.UpdateSpec.getStartupType() property of spec to ServiceTypes.StartupType.DISABLED comes in for a service that is not in ServiceTypes.State.STOPPED state.

update

void update(String service,
          ServiceTypes.UpdateSpec spec,
          InvocationConfig invocationConfig)

Updates the properties of a service.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

service - identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

spec - Service Update specification.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the service associated with service does not exist.

Error - if any other error occurs during the execution of the operation.

NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a start, stop or restart operation is in progress, update operation will fail with this error.

NotAllowedInCurrentState - if a request to set the ServiceTypes.UpdateSpec.getStartupType() property of spec to ServiceTypes.StartupType.DISABLED comes in for a service that is not in ServiceTypes.State.STOPPED state.

update

void update(String service,
          ServiceTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback)

Updates the properties of a service.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a start, stop or restart operation is in progress, update operation will fail with this error.
NotAllowedInCurrentState - if a request to set the ServiceTypes.UpdateSpec.getStartupType() property of spec to ServiceTypes.StartupType.DISABLED comes in for a service that is not in ServiceTypes.State.STOPPED state.

Parameters:

service - identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

spec - Service Update specification.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

void update(String service,
          ServiceTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Updates the properties of a service.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the service associated with service does not exist.
Error - if any other error occurs during the execution of the operation.
NotAllowedInCurrentState - if the operation is denied in the current state of the service. If a start, stop or restart operation is in progress, update operation will fail with this error.
NotAllowedInCurrentState - if a request to set the ServiceTypes.UpdateSpec.getStartupType() property of spec to ServiceTypes.StartupType.DISABLED comes in for a service that is not in ServiceTypes.State.STOPPED state.

Parameters:

service - identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: com.vmware.appliance.vmon.Service.

spec - Service Update specification.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

listDetails

Map<String,ServiceTypes.Info> listDetails()

Lists details of services managed by vMon.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

Map of service identifiers to service Info structures. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.vmon.Service.

Throws:

Error - if any error occurs during the execution of the operation.

listDetails

Map<String,ServiceTypes.Info> listDetails(InvocationConfig invocationConfig)

Lists details of services managed by vMon.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Map of service identifiers to service Info structures. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.vmon.Service.

Throws:

Error - if any error occurs during the execution of the operation.

listDetails

void listDetails(AsyncCallback<Map<String,ServiceTypes.Info>> asyncCallback)

Lists details of services managed by vMon.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
Map of service identifiers to service Info structures. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.vmon.Service.

Operation Errors:
Error - if any error occurs during the execution of the operation.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

listDetails

void listDetails(AsyncCallback<Map<String,ServiceTypes.Info>> asyncCallback,
               InvocationConfig invocationConfig)

Lists details of services managed by vMon.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
Map of service identifiers to service Info structures. The key in the return value Map will be an identifier for the resource type: com.vmware.appliance.vmon.Service.

Operation Errors:
Error - if any error occurs during the execution of the operation.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.