com.ibm.etools.iseries.subsystems.qsys.api
Class IBMiConnection

java.lang.Object
  com.ibm.etools.iseries.subsystems.qsys.api.IBMiConnection

public class IBMiConnection
extends Object

This class provides an API starting point for access to an remote IBM i system. Each IBMiConnection instance is associated with a single RSE IBM i connection.

Field Summary

static String

copyright

Method Summary

boolean	checkAuthority(String library, String object, String objType, String authList) Check if the current user profile has the required authorities to the specified object.
boolean	checkAuthority(String library, String object, String objType, String[] authList) Check if the current user profile has the required authorities to the specified object.
boolean	connect() Synchronous connection to this connection
void	connect(IRSECallback callback) Asynchronous connect to this RSE connection.
void	downloadSavf(IFile targetFile, IQSYSSaveFile saveFileObject, IProgressMonitor monitor) Download a save file from IBM i to a workspace file.
AS400	getAS400ToolboxObject() Retrieve an AS400 (Toolbox) object for the current connection.
AS400	getAS400ToolboxObject(boolean createNew) Retrieve an AS400 (Toolbox) object for the current connection.
IQSYSCacheManager	getCacheManager() Get the caching manager used for this connection.
QSYSCommandSubSystem	getCommandSubSystem() Get the command subsystem for this connection.
static IBMiConnection	getConnection(IHost host) Converts the IHost connection into a wrapper IBMiConnection
static IBMiConnection	getConnection(String profileName, String connectionName) Retrieves the specified connection from the RSE, given the profile and connection name
String	getConnectionName() Retrieve the connection name for this connection.
static IBMiConnection[]	getConnections() Retrieves all connections in the RSE of type "IBM i"
IConnectorService	getConnectorService() Returns the connector service used by this connection
IQSYSLibrary	getCurrentLibrary(IProgressMonitor monitor) Return the current library for the connection
IISeriesEditDescriptionsInfo	getEditDescriptions() Retrieve the edit description information from the iSeries.
IQSYSFile	getFile(String libraryName, String objectName, IProgressMonitor monitor) Return an ISeriesObject from this connection, given its name and type or null if the object is not found.
IQSYSFileRecordFormat	getFileRecord(String libraryName, String fileName, String recordName, IProgressMonitor monitor) Return an IQSYSFileRecord from this connection, given its library, file and name
IHost	getHost() Returns the underlying SystemConnection that this ISeriesConnection object wraps
String	getHostName() Retrieve the host name for this connection.
QSYSRSEInteractiveJob	getInteractiveServerJob() Retrieve the ISeriesRSEInteractiveJob class which represents the interactive job (5250) that is associated with this RSE connection.
Connection	getJDBCConnection(String properties, boolean forceConnect)
IQSYSLibrary	getLibrary(String libraryName, IProgressMonitor monitor) Return an IQSYSLibrary from this connection, given its name
IQSYSLibrary[]	getLibraryList(IProgressMonitor monitor) Return the library list for this connection
IQSYSLibrary[]	getLibraryList(IProgressMonitor monitor, boolean excludeCurLib) Return the library list for this connection
IQSYSLibrary[]	getLibraryList(String libFilterString, IProgressMonitor monitor, boolean excludeCurLib) Return the libraries for this connection, given the library filter string.
InetAddress	getLocalAddress() Returns the local TCP/IP address for the local system that is accessible from the iSeries.
IQSYSMember	getMember(String libraryName, String fileName, String memberName, IProgressMonitor monitor) Returns the member with the specified library, file, and member name.
IQSYSMessageDescription	getMessageDescription(String msgFileLibrary, String msgFileName, String msgID) Retrieve a message description from the remote system
IQSYSObject	getObject(String libraryName, String objectName, String type, IProgressMonitor monitor) Return an ISeriesObject from this connection, given its name and type or null if the object is not found.
String	getPasswordEncrypted() Returns the password (encrypted) for this connection
String	getProfileName() Retrieve the profile name for this connection.
IQSYSJob	getQSYSJob(ISeriesJobFilterString jobNameFilter, IProgressMonitor monitor) Returns an ISeriesJob from this connection, given a job filter.
IQSYSJob	getQSYSJob(String jobNumber, String userName, String jobName, IProgressMonitor monitor) Returns an IQSYSJob from this connection, given job number, job user, and job name.
QSYSJobSubSystem	getQSYSJobSubSystem() Get the Objects subsystem for this connection.
QSYSObjectSubSystem	getQSYSObjectSubSystem() Get the Objects subsystem for this connection.
IQSYSJob	getServerJob(IProgressMonitor monitor) Returns the server job for this RSE connection.
ISubSystem	getSubSystemByClass(String factoryID) Retrieve a subsystem for this connection given the subsystems factory id
ISubSystem[]	getSubSystems() Get all subsystems for this connection
String	getUserID() Returns the userid for this connection
boolean	isConnected() Test if we are currently connected to this iSeries
boolean	isDBCSEnabled() Check if the system is DBCS enabled as determined by the QIGC system value.
boolean	isOffline() Test if this connection is offline.
IQSYSFileField[]	listFields(String library, String file, IProgressMonitor monitor) List all fields in all records that match the specified library, file name patterns
IQSYSFileField[]	listFields(String library, String file, String record, IProgressMonitor monitor) List all fields that match the specified library, file, and record name patterns
IQSYSFileField[]	listFields(String library, String file, String record, String field, IProgressMonitor monitor) List all fields that match the specified library, file, record and field name patterns
IQSYSJob[]	listJobs(ISeriesJobFilterString filter, IProgressMonitor monitor) Retrieve a list of IBM i jobs that match the specified filter criteria.
IQSYSLibrary[]	listLibraries(String libraryFilter, IProgressMonitor monitor) Retrieve a list of libraries matching the specified filter string
String[]	listLibraryNames(String nameFilter, IProgressMonitor monitor) This is a high performance way to query library names only, optionally subset by library name.
String[]	listMemberNames(String library, String file, String nameFilter, String[] typeFilters, IProgressMonitor monitor) This is a high performance way to query the members names only in this file, optionally subset by member name and type.
IQSYSMember[]	listMembers(String libraryName, String fileName, IProgressMonitor monitor) Return a list of members that match the specified library, file, and member name filters.
IQSYSMember[]	listMembers(String libraryName, String fileName, String memberName, IProgressMonitor monitor) Return a list of members that match the specified library, file, and member name filters.
IQSYSMember[]	listMembers(String libraryName, String fileName, String memberName, String[] types, IProgressMonitor monitor) Return a list of members that match the specified library, file, member name and type filters.
String[]	listObjectNames(String library, String nameFilter, String[] typeFilters, IProgressMonitor monitor) This is a high performance way to query the object names only in a given library, optionally subset by object name and type.
IQSYSObject[]	listObjects(String libraryNameFilter, IProgressMonitor monitor) List all objects in the specified library.
IQSYSObject[]	listObjects(String libraryNameFilter, String objectNameFilter, IProgressMonitor monitor) Retrieve a list of all objects matching the specified library and object name filter strings.
IQSYSObject[]	listObjects(String libraryNameFilter, String objectNameFilter, String[] objectTypes, IProgressMonitor monitor) Retrieve a list of all objects matching the specified library name, object name and type filter strings.
IQSYSFileRecordFormat[]	listRecords(String library, String file, IProgressMonitor monitor) Return a list of all records in the specified file.
IQSYSFileRecordFormat[]	listRecords(String library, String file, String record, IProgressMonitor monitor) Return a list of records that match the specified library, file, and record name filter.
ISeriesMessage[]	runCommand(String command) Run a command on the iSeries in the communication server job.
void	uploadSavf(String fullyQualifiedLocalFileName, String saveFileLibrary, String saveFileName) Upload a local save file to an IBM i save file.

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static String copyright

Method Detail

getConnections

public static IBMiConnection[] getConnections()

Retrieves all connections in the RSE of type "IBM i"

Returns:

An array of IBMiConnection objects, each representing a connection defined in the RSE

getConnection

public static IBMiConnection getConnection(IHost host)

Converts the IHost connection into a wrapper IBMiConnection

Parameters:

host - An IHost instance

Returns:

The IBMiConnection object

getConnection

public static IBMiConnection getConnection(String profileName,
                                           String connectionName)

Retrieves the specified connection from the RSE, given the profile and connection name

Parameters:

profile - A string containing the name of the profile containing the connection

connectionName - A string containing the connection name

Returns:

The IBMiConnection object, null if no connection exists for the specified connection name

getHost

public IHost getHost()

Returns the underlying SystemConnection that this ISeriesConnection object wraps

getPasswordEncrypted

public String getPasswordEncrypted()

Returns the password (encrypted) for this connection

Returns:

null if the password prompt was canceled by the user

connect

public boolean connect()
                throws SystemMessageException

Synchronous connection to this connection

Throws:

SystemMessageException

connect

public void connect(IRSECallback callback)
             throws SystemMessageException

Asynchronous connect to this RSE connection. Specify an instance of IRSECallback if you want to be notified of the connection completion.

Throws:

SystemMessageException

isConnected

public boolean isConnected()

Test if we are currently connected to this iSeries

isOffline

public boolean isOffline()

Test if this connection is offline.

getQSYSObjectSubSystem

public QSYSObjectSubSystem getQSYSObjectSubSystem()

Get the Objects subsystem for this connection.

getQSYSJobSubSystem

public QSYSJobSubSystem getQSYSJobSubSystem()

Get the Objects subsystem for this connection.

getCommandSubSystem

public QSYSCommandSubSystem getCommandSubSystem()

Get the command subsystem for this connection.

runCommand

public ISeriesMessage[] runCommand(String command)
                            throws SystemMessageException

Run a command on the iSeries in the communication server job.

Parameters:

shell - to use to prompt for signon information if required and displaying a progress monitor while command is being run. If null is passed then no progress monitor is displayed (although the user will still be prompted for signon if required.)

command - The command to be run.

Throws:

SystemMessageException - if an error occurs while executing the command (i.e. the network connection goes down.)

getSubSystemByClass

public ISubSystem getSubSystemByClass(String factoryID)

Retrieve a subsystem for this connection given the subsystems factory id

Parameters:

factoryID - The factory ID for the required subsystem object

Returns:

Subsystem object for this connection created by the factory corresponding to factoryID, null if no factory could be found with ID factoryID.

getSubSystems

public ISubSystem[] getSubSystems()

Get all subsystems for this connection

listLibraries

public IQSYSLibrary[] listLibraries(String libraryFilter,
                                    IProgressMonitor monitor)
                             throws SystemMessageException,
                                    InterruptedException

Retrieve a list of libraries matching the specified filter string

Returns:

An array of ISeriesLibrary objects each representing a library that matches the filter. An empty array (length == 0) is returned if no libraries match the filter.

Throws:

SystemMessageException - If an error occurs while retrieving the list.

InterruptedException

getLibrary

public IQSYSLibrary getLibrary(String libraryName,
                               IProgressMonitor monitor)
                        throws SystemMessageException,
                               InterruptedException

Return an IQSYSLibrary from this connection, given its name

Returns:

The IQSYSLibrary object representing this library, or null if the library was not found on the remote system.

Throws:

SystemMessageException - if an error occurs while retrieving the library information.

InterruptedException

getLibraryList

public IQSYSLibrary[] getLibraryList(IProgressMonitor monitor)
                              throws SystemMessageException,
                                     InterruptedException

Return the library list for this connection

Throws:

SystemMessageException

InterruptedException

getLibraryList

public IQSYSLibrary[] getLibraryList(IProgressMonitor monitor,
                                     boolean excludeCurLib)
                              throws SystemMessageException,
                                     InterruptedException

Return the library list for this connection

Throws:

SystemMessageException

InterruptedException

getLibraryList

public IQSYSLibrary[] getLibraryList(String libFilterString,
                                     IProgressMonitor monitor,
                                     boolean excludeCurLib)
                              throws SystemMessageException,
                                     InterruptedException

Return the libraries for this connection, given the library filter string.

Throws:

SystemMessageException

InterruptedException

getCurrentLibrary

public IQSYSLibrary getCurrentLibrary(IProgressMonitor monitor)
                               throws SystemMessageException,
                                      InterruptedException

Return the current library for the connection

Throws:

SystemMessageException

InterruptedException

listObjects

public IQSYSObject[] listObjects(String libraryNameFilter,
                                 IProgressMonitor monitor)
                          throws SystemMessageException,
                                 InterruptedException

List all objects in the specified library.

Returns:

An array of IQSYSObject objects each representing an object that matches the specified filter criteria. An empty array (length == 0) is returned if no objects match the filter.

Throws:

SystemMessageException - If an error occurs while retrieving the list.

InterruptedException

listObjects

public IQSYSObject[] listObjects(String libraryNameFilter,
                                 String objectNameFilter,
                                 IProgressMonitor monitor)
                          throws SystemMessageException,
                                 InterruptedException

Retrieve a list of all objects matching the specified library and object name filter strings.

Returns:

An array of IQSYSObject objects each representing an object that matches the specified filter criteria. An empty array (length == 0) is returned if no objects match the filter.

Throws:

SystemMessageException - If an error occurs while retrieving the list.

InterruptedException

listObjects

public IQSYSObject[] listObjects(String libraryNameFilter,
                                 String objectNameFilter,
                                 String[] objectTypes,
                                 IProgressMonitor monitor)
                          throws SystemMessageException,
                                 InterruptedException

Retrieve a list of all objects matching the specified library name, object name and type filter strings.

Returns:

An array of IQSYSObject objects each representing an object that matches the specified filter criteria. An empty array (length == 0) is returned if no objects match the filter.

Throws:

SystemMessageException - If an error occurs while retrieving the list.

InterruptedException

getObject

public IQSYSObject getObject(String libraryName,
                             String objectName,
                             String type,
                             IProgressMonitor monitor)
                      throws SystemMessageException,
                             InterruptedException

Return an ISeriesObject from this connection, given its name and type or null if the object is not found.

Throws:

SystemMessageException

InterruptedException

getFile

public IQSYSFile getFile(String libraryName,
                         String objectName,
                         IProgressMonitor monitor)
                  throws SystemMessageException,
                         InterruptedException

Return an ISeriesObject from this connection, given its name and type or null if the object is not found.

Throws:

SystemMessageException

InterruptedException

listMembers

public IQSYSMember[] listMembers(String libraryName,
                                 String fileName,
                                 IProgressMonitor monitor)
                          throws SystemMessageException,
                                 InterruptedException

Return a list of members that match the specified library, file, and member name filters.

Throws:

SystemMessageException

InterruptedException

listMembers

public IQSYSMember[] listMembers(String libraryName,
                                 String fileName,
                                 String memberName,
                                 IProgressMonitor monitor)
                          throws SystemMessageException,
                                 InterruptedException

Return a list of members that match the specified library, file, and member name filters.

Throws:

SystemMessageException

InterruptedException

listMembers

public IQSYSMember[] listMembers(String libraryName,
                                 String fileName,
                                 String memberName,
                                 String[] types,
                                 IProgressMonitor monitor)
                          throws SystemMessageException,
                                 InterruptedException

Return a list of members that match the specified library, file, member name and type filters.

Throws:

SystemMessageException

InterruptedException

listRecords

public IQSYSFileRecordFormat[] listRecords(String library,
                                           String file,
                                           IProgressMonitor monitor)
                                    throws SystemMessageException,
                                           InterruptedException

Return a list of all records in the specified file.

Throws:

SystemMessageException

InterruptedException

listRecords

public IQSYSFileRecordFormat[] listRecords(String library,
                                           String file,
                                           String record,
                                           IProgressMonitor monitor)
                                    throws SystemMessageException,
                                           InterruptedException

Return a list of records that match the specified library, file, and record name filter.

Throws:

SystemMessageException

InterruptedException

getFileRecord

public IQSYSFileRecordFormat getFileRecord(String libraryName,
                                           String fileName,
                                           String recordName,
                                           IProgressMonitor monitor)
                                    throws SystemMessageException,
                                           InterruptedException

Return an IQSYSFileRecord from this connection, given its library, file and name

Throws:

SystemMessageException

InterruptedException

listFields

public IQSYSFileField[] listFields(String library,
                                   String file,
                                   IProgressMonitor monitor)
                            throws SystemMessageException,
                                   InterruptedException

List all fields in all records that match the specified library, file name patterns

Throws:

SystemMessageException

InterruptedException

listFields

public IQSYSFileField[] listFields(String library,
                                   String file,
                                   String record,
                                   IProgressMonitor monitor)
                            throws SystemMessageException,
                                   InterruptedException

List all fields that match the specified library, file, and record name patterns

Throws:

SystemMessageException

InterruptedException

listFields

public IQSYSFileField[] listFields(String library,
                                   String file,
                                   String record,
                                   String field,
                                   IProgressMonitor monitor)
                            throws SystemMessageException,
                                   InterruptedException

List all fields that match the specified library, file, record and field name patterns

Throws:

SystemMessageException

InterruptedException

listObjectNames

public String[] listObjectNames(String library,
                                String nameFilter,
                                String[] typeFilters,
                                IProgressMonitor monitor)
                         throws SystemMessageException,
                                InterruptedException

This is a high performance way to query the object names only in a given library, optionally subset by object name and type. This does not query all the properties usually returned for each object so is very efficient. It can be used to populate a ValidatorISeriesObject object, for example, to validate object names are unique. Please note that two objects can have the same name in a given library, as long as their types are different, so include a type filter is very important for this type of error checking.

Throws:

SystemMessageException

InterruptedException

listLibraryNames

public String[] listLibraryNames(String nameFilter,
                                 IProgressMonitor monitor)
                          throws SystemMessageException,
                                 InterruptedException

This is a high performance way to query library names only, optionally subset by library name. This does not query all the properties usually returned for each object so is very efficient. It can be used to populate a ValidatorISeriesLibrary object, for example, to validate library names are unique.

Throws:

SystemMessageException

InterruptedException

listMemberNames

public String[] listMemberNames(String library,
                                String file,
                                String nameFilter,
                                String[] typeFilters,
                                IProgressMonitor monitor)
                         throws SystemMessageException,
                                InterruptedException

This is a high performance way to query the members names only in this file, optionally subset by member name and type. This does not query all the properties usually returned for each member so is very efficient. It can be used to populate a ValidatorISeriesMember object, for example, to validate member names are unique.

Throws:

SystemMessageException

InterruptedException

getMember

public IQSYSMember getMember(String libraryName,
                             String fileName,
                             String memberName,
                             IProgressMonitor monitor)
                      throws SystemMessageException,
                             InterruptedException

Returns the member with the specified library, file, and member name.

Throws:

SystemMessageException

InterruptedException

getProfileName

public String getProfileName()

Retrieve the profile name for this connection.

Returns:

Profile name for this connection.

getConnectionName

public String getConnectionName()

Retrieve the connection name for this connection.

Returns:

Connection name for this connection.

getHostName

public String getHostName()

Retrieve the host name for this connection.

Returns:

The TCP/IP host name or address (whichever the user entered) for this connection.

getUserID

public String getUserID()

Returns the userid for this connection

getAS400ToolboxObject

public AS400 getAS400ToolboxObject()
                            throws SystemMessageException

Retrieve an AS400 (Toolbox) object for the current connection. The AS400 object will already have the hostname, userid and password fields set.

Returns:

An AS400 object already connected to host.

Throws:

Exception - if user cancels signon or any other error occurs.

SystemMessageException

getAS400ToolboxObject

public AS400 getAS400ToolboxObject(boolean createNew)
                            throws SystemMessageException

Retrieve an AS400 (Toolbox) object for the current connection. The AS400 object will already have the hostname, userid and password fields set.

Parameters:

boolean - createNew Pass true if a new copy of the AS400 object should be created, false if the original should be returned. If a new AS400 Object is created then the library list, current library, and signon program will be setup (as specified in the RSE communications properties for this connection.

Returns:

An AS400 object already connected to host.

Throws:

Exception - if user cancels signon or any other error occurs.

SystemMessageException

getMessageDescription

public IQSYSMessageDescription getMessageDescription(String msgFileLibrary,
                                                     String msgFileName,
                                                     String msgID)
                                              throws SystemMessageException,
                                                     InterruptedException

Retrieve a message description from the remote system

Parameters:

String - msgFileLibrary The library where the message file exists

String - msgFileName The name of the message file

String - msgID The ID of the message description to retrieve

Returns:

The message description if found or null a message description with msgID does not exist in the message file.

Throws:

SystemMessageException - if the message file does not exists.

InterruptedException

getCacheManager

public IQSYSCacheManager getCacheManager()

Get the caching manager used for this connection.

Returns:

The CacheManager used for this connection.

getConnectorService

public IConnectorService getConnectorService()

Returns the connector service used by this connection

listJobs

public IQSYSJob[] listJobs(ISeriesJobFilterString filter,
                           IProgressMonitor monitor)
                    throws SystemMessageException,
                           InterruptedException

Retrieve a list of IBM i jobs that match the specified filter criteria.

Throws:

SystemMessageException

InterruptedException

getQSYSJob

public IQSYSJob getQSYSJob(String jobNumber,
                           String userName,
                           String jobName,
                           IProgressMonitor monitor)
                    throws SystemMessageException,
                           InterruptedException

Returns an IQSYSJob from this connection, given job number, job user, and job name.

Parameters:

jobNumber - the job number

userName - the user name of the job

jobName - the job name

Returns:

an IQSYSJob

Throws:

SystemMessageException

InterruptedException

getQSYSJob

public IQSYSJob getQSYSJob(ISeriesJobFilterString jobNameFilter,
                           IProgressMonitor monitor)
                    throws SystemMessageException,
                           InterruptedException

Returns an ISeriesJob from this connection, given a job filter.

Parameters:

jobNameFilter - the filter to resolve job name

Returns:

an IQSYSJob

Throws:

SystemMessageException

InterruptedException

getServerJob

public IQSYSJob getServerJob(IProgressMonitor monitor)
                      throws SystemMessageException

Returns the server job for this RSE connection.

Throws:

SystemMessageException

isDBCSEnabled

public boolean isDBCSEnabled()
                      throws SystemMessageException

Check if the system is DBCS enabled as determined by the QIGC system value.

Returns:

true if the system is enabled, false if it is not.

Throws:

SystemMessageException

getEditDescriptions

public IISeriesEditDescriptionsInfo getEditDescriptions()
                                                 throws SystemMessageException

Retrieve the edit description information from the iSeries.

Throws:

SystemMessageException

checkAuthority

public boolean checkAuthority(String library,
                              String object,
                              String objType,
                              String[] authList)
                       throws SystemMessageException

Check if the current user profile has the required authorities to the specified object.

Parameters:

library - The library which contains the object to check

object - The object to check

objType - The object type

authList - Array of authorities to check, use the constants from IISeriesAuthorityConstants

Returns:

true if the current user profile has the specified authorities, false if the current user profile does not have the specified authorities to the object.

Throws:

SystemMessageException

See Also:

IISeriesAuthorityConstants

checkAuthority

public boolean checkAuthority(String library,
                              String object,
                              String objType,
                              String authList)
                       throws SystemMessageException

Check if the current user profile has the required authorities to the specified object.

Parameters:

library - The library which contains the object to check

object - The object to check

objType - The object type

authList - Authorities to check. Each authority must be 10 characters, appended together into a single String. Use the constants from IISeriesAuthorityConstants, or the other checkAuthority method which takes a String array

Returns:

true if the current user profile has the specified authorities, false if the current user profile does not have the specified authorities to the object.

Throws:

SystemMessageException

See Also:

IISeriesAuthorityConstants

getLocalAddress

public InetAddress getLocalAddress()

Returns the local TCP/IP address for the local system that is accessible from the iSeries. If the local system has multiple IP addresses (because of multiple network cards, or VPN) then this will return the address that the remote system can use to "call back" to the PC. There must be a network connection between the local PC and the remote system for this method to work correctly. If no network connection exists then this method returns null.

Returns:

The local TCP/IP address accessible from the remote iSeries or null if no address can be resolved.

getInteractiveServerJob

public QSYSRSEInteractiveJob getInteractiveServerJob()
                                              throws SystemMessageException

Retrieve the ISeriesRSEInteractiveJob class which represents the interactive job (5250) that is associated with this RSE connection. The user will be prompted to associate an interactive job with this connection if one is not already associated.

Returns:

The ISeriesRSEInteractiveJob instance representing this connection.

Throws:

SystemMessageException - If a communications error occurs or the user cancels the prompt to associate an interactive job with this RSE connection.

uploadSavf

public void uploadSavf(String fullyQualifiedLocalFileName,
                       String saveFileLibrary,
                       String saveFileName)
                throws SystemMessageException

Upload a local save file to an IBM i save file.

Parameters:

fullyQualifiedLocalFileName: - full qualified file name for local save file

saveFileLibrary: - target library name

saveFileName: - target save file name

Throws:

SystemMessageException - if there is any SystemMessage captured during upload

downloadSavf

public void downloadSavf(IFile targetFile,
                         IQSYSSaveFile saveFileObject,
                         IProgressMonitor monitor)
                  throws SystemMessageException

Download a save file from IBM i to a workspace file.

Parameters:

targetFile: - the target for downloaded save file. If the targetFile exists, its contents are silently replaced. No collision checking. If the targetFile does not exist, it is created. If the targetFile's parent does not exist, an exception is thrown.

saveFileObject: - save file on IBM i to be downloaded

monitor: - progress monitor

Throws:

SystemMessageException

getJDBCConnection

public Connection getJDBCConnection(String properties,
                                    boolean forceConnect)
                             throws SQLException

Throws:

SQLException