nxopen

Interface RemoteUtilities

All Superinterfaces:

BaseSession, Remote, TaggedObject

public interface RemoteUtilities
extends BaseSession

This class is primarily designed for use in a remote session, and allows client applications to access resources on a remote server.
Note that due to security considerations, this class is independent of the main Session . The server must explicitly export a RemoteUtilities object in order to allow clients to access the methods in this class. Application writers should be aware that this class will allow clients to delete and modify files on the server.

To obtain an instance of this class use nxopen.RemoteUtilities#getRemoteUtilities

Created in NX3.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface nxopen.BaseSession

BaseSession.LibraryUnloadOption

Method Summary

Modifier and Type	Method and Description
void	copyFile(String originalFilename, String newFilename) Copies a file.
void	createDirectory(String dirname) Creates a directory.
void	deleteFile(String filename) Deletes a file.
boolean	fileExists(String testFilename) Tests to see that a file exists License requirements: None.
String	getEnvironmentVariable(String variableName) Deprecated. Deprecated in NX8.0.0. Use Session.GetEnvironmentVariable instead.
boolean	isFileWritable(String filename) Returns true if a file exists, and is writable by the NX session.
void	removeDirectory(String dirname) Deletes a directory.
void	renameFile(String oldFilename, String newFilename) Renames a file.
void	setFileWritable(String filename, boolean writable) Sets a file's permissions to be writable by the NX session.

Methods inherited from interface nxopen.BaseSession

closeTestOutput, compareTestOutput, setTestOutput, setTestOutput, taggedObjectManager

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Method Detail

renameFile

void renameFile(String oldFilename,
                String newFilename)
         throws NXException,
                RemoteException

Renames a file.
License requirements: None.

Created in NX3.0.0

Parameters:

oldFilename - Old filename.

newFilename - New filename.

Throws:

NXException

RemoteException

copyFile

void copyFile(String originalFilename,
              String newFilename)
       throws NXException,
              RemoteException

Copies a file.
License requirements: None.

Created in NX3.0.0

Parameters:

originalFilename - Original filename.

newFilename - Newly copied filename.

Throws:

NXException

RemoteException

fileExists

boolean fileExists(String testFilename)
            throws NXException,
                   RemoteException

Tests to see that a file exists
License requirements: None.

Created in NX3.0.0

Parameters:

testFilename - Filename to query

Returns:

True if the file exists

Throws:

NXException

RemoteException

deleteFile

void deleteFile(String filename)
         throws NXException,
                RemoteException

Deletes a file. Note that if the file does not exist, this method returns without any errors.
License requirements: None.

Created in NX3.0.0

Parameters:

filename - File to be deleted.

Throws:

NXException

RemoteException

isFileWritable

boolean isFileWritable(String filename)
                throws NXException,
                       RemoteException

Returns true if a file exists, and is writable by the NX session.
License requirements: None.

Created in NX3.0.0

Parameters:

filename - File to be checked.

Returns:

True if the file exists, and is writable

Throws:

NXException

RemoteException

setFileWritable

void setFileWritable(String filename,
                     boolean writable)
              throws NXException,
                     RemoteException

Sets a file's permissions to be writable by the NX session.
License requirements: None.

Created in NX3.0.0

Parameters:

filename - File to be checked.

writable - True to make the file writable, false to make it readonly

Throws:

NXException

RemoteException

createDirectory

void createDirectory(String dirname)
              throws NXException,
                     RemoteException

Creates a directory.
License requirements: None.

Created in NX3.0.0

Parameters:

dirname - Name of new directory

Throws:

NXException

RemoteException

removeDirectory

void removeDirectory(String dirname)
              throws NXException,
                     RemoteException

Deletes a directory.
License requirements: None.

Created in NX3.0.0

Parameters:

dirname - Name of directory to be deleted

Throws:

NXException

RemoteException

getEnvironmentVariable

String getEnvironmentVariable(String variableName)
                       throws NXException,
                              RemoteException

Deprecated. Deprecated in NX8.0.0. Use Session.GetEnvironmentVariable instead.

Gets the value of an environment variable.
License requirements: None.

Created in NX3.0.0

Parameters:

variableName - The environment variable

Returns:

The value of the variable.

Throws:

NXException

RemoteException