TPTP 4.1.0 Platform Project
Public API Specification

org.eclipse.hyades.ui.services
Class ConnectorService

java.lang.Object
  extended byorg.eclipse.hyades.automation.core.AbstractService
      extended byorg.eclipse.hyades.automation.server.AbstractService
          extended byorg.eclipse.hyades.ui.services.ConnectorService
All Implemented Interfaces:
org.eclipse.hyades.internal.execution.local.control.Application, java.security.Principal, java.io.Serializable, Service

public class ConnectorService
extends AbstractService
implements org.eclipse.hyades.internal.execution.local.control.Application

The connector service will establish a connection with the agent controller in the appropriate security mode (secure or unsecure) and return back the node object that was connected through (by updating the mutable node in out parameter passed in). If credentials are required for a secure connection then a UI can potentially appear and query the user for these credentials. It is important than a mutable node is passed in, this is where the node return value is set and read once the service has completed and returned back to the client. Supported property parameters are host, port, user, password and showErrors; error dialogs will display if errors occur and this property is set to true. Default host if not specified is localhost, default port if not specified is 10002, default showErrors if not specified is false. User and password default to null if not specified and are optional; if security is required and the UI is available, the user will be prompted.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class org.eclipse.hyades.automation.core.Service
Service.Discoverable, Service.Executable, Service.Requestable
 
Constructor Summary
ConnectorService()
           
 
Method Summary
 java.lang.Object execute()
          The connector service will retrieve the various service-related properties from the service properties state and then use the profile connect utilities to make a connection to the agent controller (using secure or unsecure mode).
 java.lang.String getName()
           
 
Methods inherited from class org.eclipse.hyades.automation.server.AbstractService
execute
 
Methods inherited from class org.eclipse.hyades.automation.core.AbstractService
configure, createMemento, getIdentifier, getProperties, getProperty, getProperty, getRoot, setMemento
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.security.Principal
equals, hashCode, toString
 

Constructor Detail

ConnectorService

public ConnectorService()
Method Detail

execute

public java.lang.Object execute()
The connector service will retrieve the various service-related properties from the service properties state and then use the profile connect utilities to make a connection to the agent controller (using secure or unsecure mode). It is desirable for the dependency on test and profile to go away and move this service into the execution framework (as soon as the functionality supplied by the profile connect utility is migrated into the execution framework.

Specified by:
execute in interface Service
Returns:
return the return value, the return value currently only contains the java process execute command, unidirectional communication is only possible

getName

public java.lang.String getName()
Specified by:
getName in interface java.security.Principal

TPTP 4.1.0 Platform Project
Public API Specification