org.eclipse.ptp.ems.core

Class EnvManagerRegistry

java.lang.Object

org.eclipse.ptp.ems.core.EnvManagerRegistry

public final class EnvManagerRegistry
extends java.lang.Object

Provides IEnvManager objects, which provide access to remote machines' environment management systems.

The set of supported environment management systems (and, consequently, the set of possible IEnvManager objects) is determined by contributions to an extension point. See IEnvManager.

Since:

6.0

Method Summary

Methods

Modifier and Type	Method and Description
static IEnvManager	getEnvManager(org.eclipse.core.runtime.IProgressMonitor pm, IRemoteConnection remoteConnection) Detects the environment management system on the remote machine, if any, and returns an IEnvManager capable of interfacing with that system.
static IEnvManager	getNullEnvManager()

Methods inherited from class java.lang.Object

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

Method Detail

getNullEnvManager

public static IEnvManager getNullEnvManager()

Returns:

an object which represents the absence of a supported environment management system (a Null Object).

getEnvManager

public static IEnvManager getEnvManager(org.eclipse.core.runtime.IProgressMonitor pm,
                        IRemoteConnection remoteConnection)

Detects the environment management system on the remote machine, if any, and returns an IEnvManager capable of interfacing with that system.

If no supported environment managment system was detected, the result will be equal to getNullEnvManager().

Parameters:

pm - progress monitor used to report the status of potentially long-running operations to the user (non- null)

remoteConnection - IRemoteConnection providing a connection to a particular remote machine (non-null)

Returns:

IEnvManager (non-null)

Since:

3.0