org.eclipse.hyades.automation.server
Class AutomationServer

java.lang.Object
  org.eclipse.hyades.automation.server.AutomationServer

All Implemented Interfaces:

IAutomationServer, org.eclipse.core.runtime.IPlatformRunnable, java.rmi.Remote, Service.Discoverable, Service.Executable

public class AutomationServer

extends java.lang.Object

implements Service.Discoverable, Service.Executable, IAutomationServer, org.eclipse.core.runtime.IPlatformRunnable

The automation server provides an internal front-end to automatable published services but is primarly used by the supplied automation client to service the requests of external automation clients. This public class is an internal class that should not be used directly by external clients; external clients should use the automation client adaptation layer to automate services. Internal clients should go through the client layer as well for consistency and maintainability purposes -- use the Java automation client adapters from plug-ins.

See Also:

AutomationClientAdapter

Field Summary

Fields inherited from interface org.eclipse.core.runtime.IPlatformRunnable

EXIT_OK, EXIT_RELAUNCH, EXIT_RESTART

Constructor Summary

AutomationServer()
Exposed for use by Eclipse extension mechanism

Method Summary

java.util.List	discover() Discover published services available for command, other peer methods will be added to constrain the list membership returned.
boolean	discover(java.lang.String identifier) Discover the given service on the server (within Eclipse)
java.lang.Object	execute(Service service) The most used method within the services framework, a key method that executes a remote server (Eclipse instance)
java.lang.Object	execute(Service service, ProgressiveTask.Synchronicity synchronicity) The most used method within the services framework, a key method that executes a remote server (Eclipse instance)
java.lang.Object	run(java.lang.Object object) This method duplicates the signature of the same method in the platform runnable interface but this one is remotable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutomationServer

public AutomationServer()

Exposed for use by Eclipse extension mechanism

Method Detail

discover

public java.util.List discover()

Description copied from interface: Service.Discoverable

Discover published services available for command, other peer methods will be added to constrain the list membership returned.

Specified by:

discover in interface Service.Discoverable

Returns:

the list of services available for command, the list contains the service identifiers available and not the services themselves -- a service identifier can then be requested and executed once an identifier is known

discover

public boolean discover(java.lang.String identifier)

Description copied from interface: Service.Discoverable

Discover the given service on the server (within Eclipse)

Specified by:

discover in interface Service.Discoverable

Parameters:

identifier - the service identifier

Returns:

true if the service is available

execute

public java.lang.Object execute(Service service)

Description copied from interface: Service.Executable

The most used method within the services framework, a key method that executes a remote server (Eclipse instance)

Specified by:

execute in interface Service.Executable

Parameters:

service - the service to execute

Returns:

the service to execute

execute

public java.lang.Object execute(Service service,
                                ProgressiveTask.Synchronicity synchronicity)

Description copied from interface: Service.Executable

The most used method within the services framework, a key method that executes a remote server (Eclipse instance)

Specified by:

execute in interface Service.Executable

Parameters:

service - the service to execute

Returns:

the service to execute

run

public java.lang.Object run(java.lang.Object object)

Description copied from interface: IAutomationServer

This method duplicates the signature of the same method in the platform runnable interface but this one is remotable

Specified by:

run in interface IAutomationServer

Parameters:

object - the args to pass to the automation server

Returns:

the return object