org.eclipse.hyades.ui.services
Class ConnectorService

java.lang.Object
  org.eclipse.hyades.automation.core.AbstractService
      org.eclipse.hyades.automation.server.AbstractService
          org.eclipse.hyades.ui.services.ConnectorService

All Implemented Interfaces:

java.io.Serializable, java.security.Principal, Service, org.eclipse.hyades.internal.execution.local.control.Application

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

The UI 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 and the credentials (user and password) are not passed in as service-related properties in the service properties state, then a UI will appear and query the user for the 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.

Support properties (default values) include:

• host (localhost)
• port (10002)
• user* (null)
• password* (null)
• showErrors (false)
• mutableNode (null)

*User and password are optional if connecting in a unsecure mode.

Implementation Note: 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.

This class requires the workbench to be running. For example:

if(PlatformUI.isWorkbenchRunning())

For establishing a connection with the Agent Controller in a headless environment, use the HeadlessConnectorService.

See Also:

HeadlessConnectorService, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface 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() Resolves the name of the service.

Methods inherited from class org.eclipse.hyades.automation.server.AbstractService

execute

Methods inherited from class org.eclipse.hyades.automation.core.AbstractService

configure, configure, createMemento, getIdentifier, getPublicProperties, getRoot, setMemento, toString

Methods inherited from class java.lang.Object

equals, 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).

Support properties (default values) include:

• host (localhost)
• port (10002)
• user* (null)
• password* (null)
• showErrors (false)
• mutableNode (null)

*User and password are optional if connecting in a unsecure mode.

Specified by:

execute in interface Service

Returns:

The status (IStatus) of the service.

See Also:

Service.execute()

getName

public java.lang.String getName()

Resolves the name of the service.

Specified by:

getName in interface java.security.Principal

Returns:

Name of the service

See Also:

Principal.getName()