com.ibm.etools.iseries.comm.interfaces
Interface IISeriesConnection

public interface IISeriesConnection

The IISeriesConnection interface represents a connection to a remote or local iSeries system. This interface should be used as the starting point for accessing the iSeries, methods are defined for running commands, accessing objects and jobs on the iSeries.
Depending only on this interface allows your code to run inside of WDSc using RSE connections for communications or outside of the iSeries directly using the IBM Toolbox for Java and the classes in com.ibm.etoools.iseries.comm package.

Since:

WDSc V5.1

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() Connect to the iSeries.
String	getConnectionName() Get the name for this connection.
IISeriesEditDescriptionsInfo	getEditDescriptions() Retrieve the edit description information from the iSeries.
String	getHostName() Retrieve the host name for this connection.
IISeriesFile	getISeriesFile(String libraryName, String fileName) Return an ISeriesFile from this connection, given its name
IISeriesMember	getISeriesMember(String libraryName, String fileName, String memberName) Return an ISeriesMember from this connection, given its name, file name and library name
IISeriesMessageDescription	getMessageDescription(String msgFileLibrary, String msgFileName, String msgID) Retrieve a message description from the remote system
String	getUserID() Returns the userid for this connection
String	getVersionReleaseModification() Get the version, release and modification level of the remote system.
boolean	isConnected() Test if we are currently connected to this iSeries.
boolean	isDBCSEnabled() Check if the system is DBCS enabled.

Field Detail

Copyright

static final String Copyright

See Also:

Constant Field Values

Method Detail

connect

boolean connect()
                throws Exception

Connect to the iSeries.

Throws:

Exception

getConnectionName

String getConnectionName()

Get the name for this connection.

Returns:

Connection name for this connection.

isConnected

boolean isConnected()

Test if we are currently connected to this iSeries.

Returns:

true if this connection is connected, false if it is not connected.

getEditDescriptions

IISeriesEditDescriptionsInfo getEditDescriptions()
                                                 throws Exception

Retrieve the edit description information from the iSeries.

Throws:

Exception

getHostName

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

String getUserID()

Returns the userid for this connection

isDBCSEnabled

boolean isDBCSEnabled()
                      throws Exception

Check if the system is DBCS enabled.

Returns:

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

Throws:

Exception

getVersionReleaseModification

String getVersionReleaseModification()

Get the version, release and modification level of the remote system.

Returns:

The version, release and modification level of the remote system in V.R.M format. null is returend if the remote system is not connected or the VRM cannot be retrieved.

getISeriesMember

IISeriesMember getISeriesMember(String libraryName,
                                String fileName,
                                String memberName)
                                throws Exception

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

Throws:

Exception

getMessageDescription

IISeriesMessageDescription getMessageDescription(String msgFileLibrary,
                                                 String msgFileName,
                                                 String msgID)
                                                 throws Exception

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.

Exception

getISeriesFile

IISeriesFile getISeriesFile(String libraryName,
                            String fileName)
                            throws Exception

Return an ISeriesFile from this connection, given its name

Returns:

The ISeriesFile representing this file, or null if the file was not found on the remote system.

Throws:

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

Exception

checkAuthority

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

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:

Exception

checkAuthority

boolean checkAuthority(String library,
                       String object,
                       String objType,
                       String authList)
                       throws Exception

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:

Exception