Remote Systems
v6.4.1

com.ibm.etools.systems.launch.remoteexternaltools
Class RemoteExternalToolsUtil

java.lang.Object
  extended bycom.ibm.etools.systems.launch.remoteexternaltools.RemoteExternalToolsUtil

public class RemoteExternalToolsUtil
extends Object


Constructor Summary
RemoteExternalToolsUtil()
           
 
Method Summary
protected static void abort(String message, Throwable exception, int code)
          Throws a core exception with an error status object built from the given message, lower level exception, and error code.
static IFile getExport(ILaunchConfiguration configuration)
           
static String getLocation(ILaunchConfiguration configuration)
          Expands and returns the location attribute of the given launch configuration.
static IProject getProject(ILaunchConfiguration configuration)
           
static RemoteCmdSubSystem getRemoteCmdSubSystem(ILaunchConfiguration configuration)
          Expands and returns the RemoteCmdSubSystem of the given launch configuration.
static IRemoteFile getWorkingDirectory(ILaunchConfiguration configuration)
          Expands and returns the working directory attribute of the given launch configuration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RemoteExternalToolsUtil

public RemoteExternalToolsUtil()
Method Detail

getLocation

public static String getLocation(ILaunchConfiguration configuration)
                          throws CoreException
Expands and returns the location attribute of the given launch configuration. The location is verified to point to an existing file, in the remote file system.

Parameters:
configuration - launch configuration
Returns:
an IRemoteFile representing a file in a remote file system
Throws:
CoreException - if unable to retrieve the associated launch configuration attribute, if unable to resolve any variables, or if the resolved location does not point to an existing file in the local file system

abort

protected static void abort(String message,
                            Throwable exception,
                            int code)
                     throws CoreException
Throws a core exception with an error status object built from the given message, lower level exception, and error code.

Parameters:
message - the status message
exception - lower level exception associated with the error, or null if none
code - error code
Throws:
CoreException

getWorkingDirectory

public static IRemoteFile getWorkingDirectory(ILaunchConfiguration configuration)
                                       throws CoreException
Expands and returns the working directory attribute of the given launch configuration. Returns null if a working directory is not specified. If specified, the working is verified to point to an existing directory in the remote file system.

Parameters:
configuration - launch configuration
Returns:
an IRemoteFile representing a directory in the remote file system, or null if unspecified
Throws:
CoreException - if unable to retrieve the associated launch configuration attribute, if unable to resolve any variables, or if the resolved location does not point to an existing directory in the remote file system

getRemoteCmdSubSystem

public static RemoteCmdSubSystem getRemoteCmdSubSystem(ILaunchConfiguration configuration)
                                                throws CoreException
Expands and returns the RemoteCmdSubSystem of the given launch configuration. The connection is verified to point to an existing connection to a remote file system.

Parameters:
configuration - launch configuration
Returns:
the RemoteCmdSubSystem under the connection of the launch config
Throws:
CoreException - if unable to retrieve the associated launch configuration attribute, if unable to resolve any variables, or if the resolved location does not point to an existing connection

getProject

public static IProject getProject(ILaunchConfiguration configuration)
                           throws CoreException
Throws:
CoreException

getExport

public static IFile getExport(ILaunchConfiguration configuration)
                       throws CoreException
Throws:
CoreException

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.