|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.iseries.core.api.ISeriesConnection
ISeriesConnection
This is the starting point for using the communication APIs to access ISeries resources using the Remote Systems Explorer communications layer.
Field Summary | |
---|---|
static String |
copyright
|
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection |
---|
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 this iSeries, when we don't have a Shell parent |
boolean |
connect(Shell shell)
Connect to this iSeries |
com.ibm.as400.access.AS400 |
getAS400ToolboxObject(Shell shell)
Retrieve an AS400 (Toolbox) object for the current connection. |
com.ibm.as400.access.AS400 |
getAS400ToolboxObject(Shell shell,
boolean createNew)
Retrieve an AS400 (Toolbox) object for the current connection. |
static com.ibm.as400.access.AS400 |
getAS400ToolboxObject(String profileName,
String connectionName,
Shell shell)
|
CacheManager |
getCacheManager()
Get the caching manager used for this connection. |
String |
getCODEAlias()
Retrieve the CODE communications alias for this connection. |
String |
getCODEAlias(Shell shell)
Retrieve the CODE communications alias for this connection. |
static ISeriesConnection |
getConnection(String connectionName)
Retrieves the specified connection from the RSE, given only the connection name. |
static ISeriesConnection |
getConnection(String profileName,
String connectionName)
Retrieves the specified connection from the RSE, given the profile and connection name |
static ISeriesConnection |
getConnection(com.ibm.etools.systems.model.SystemConnection systemConnection)
Converts the given generic connection into a typed ISeriesConnection |
String |
getConnectionName()
Retrieve the connection name for this connection. |
static ISeriesConnection[] |
getConnections()
Retrieves all connections in the RSE of type "iSeries" |
ISeriesCodepageConverter |
getConverter(Shell shell)
Return a converter object for this connection, for codepage conversion. |
static ISeriesCodepageConverter |
getConverter(String profileName,
String connectionName,
Shell shell)
Returns the converter object given a profile and connection name. |
com.ibm.etools.iseries.comm.interfaces.IISeriesEditDescriptionsInfo |
getEditDescriptions()
Retrieve the edit description information from the iSeries. |
String |
getHostName()
Retrieve the host name for this connection. |
ISeriesRSEInteractiveJob |
getInteractiveServerJob(Shell shell)
Retrieve the ISeriesRSEInteractiveJob class which represents the interactive job (5250) that is associated with this RSE connection. |
CmdSubSystemImpl |
getISeriesCmdSubSystem()
Get the iSeries command subsystem ("iSeries Commands") for this connection. |
CmdSubSystemImpl |
getISeriesCmdSubSystem(Shell shell)
Get the iSeries command subsystem ("iSeries Commands") for this connection. |
ISeriesFile |
getISeriesFile(Shell shell,
String libraryName,
String fileName)
Return an ISeriesFile from this connection, given its name |
com.ibm.etools.iseries.comm.interfaces.IISeriesFile |
getISeriesFile(String libraryName,
String fileName)
Return an ISeriesFile from this connection, given its name |
FileSubSystemImpl |
getISeriesFileSubSystem()
Get the iSeries file subsystem ("iSeries Objects") for this connection. |
FileSubSystemImpl |
getISeriesFileSubSystem(Shell shell)
Get the iSeries file subsystem ("iSeries Objects") for this connection. |
AS400ifsCmdSubSystemImpl |
getISeriesIFSCmdSubSystem()
Get the iSeries IFS cmd subsystem ("IFS Commands") for this connection. |
AS400ifsCmdSubSystemImpl |
getISeriesIFSCmdSubSystem(Shell shell)
Get the iSeries IFS cmd subsystem ("IFS Commands") for this connection. |
AS400ifsFileSubSystemImpl |
getISeriesIFSFileSubSystem()
Get the iSeries IFS file subsystem ("IFS Files") for this connection. |
AS400ifsFileSubSystemImpl |
getISeriesIFSFileSubSystem(Shell shell)
Get the iSeries IFS file subsystem ("IFS Files") for this connection. |
ISeriesJob |
getISeriesJob(Shell shell,
com.ibm.etools.iseries.comm.filters.ISeriesJobFilterString jobNameFilter)
Returns an ISeriesJob from this connection, given job number, job user, and job name. |
ISeriesJob |
getISeriesJob(Shell shell,
String jobNumber,
String userName,
String jobName)
Returns an ISeriesJob from this connection, given job number, job user, and job name. |
JobSubSystemImpl |
getISeriesJobSubSystem()
Get the iSeries job subsystem ("iSeries Jobs") for this connection. |
JobSubSystemImpl |
getISeriesJobSubSystem(Shell shell)
Get the iSeries job subsystem ("iSeries Jobs") for this connection. |
ISeriesLibrary |
getISeriesLibrary(Shell shell,
String libraryName)
Return an ISeriesLibrary from this connection, given its name |
ISeriesMember |
getISeriesMember(Shell shell,
String libraryName,
String fileName,
String memberName)
Return an ISeriesMember from this connection, given its name, file name and library name |
com.ibm.etools.iseries.comm.interfaces.IISeriesMember |
getISeriesMember(String libraryName,
String fileName,
String memberName)
Return an ISeriesMember from this connection, given its name, file name and library name |
ISeriesObject |
getISeriesObject(Shell shell,
String libraryName,
String objectName,
String type)
Return an ISeriesObject from this connection, given its name and type |
ISeriesSystemDataStore |
getISeriesSystem()
Return the shared ISystem object for this connection. |
Connection |
getJDBCConnection(String properties,
boolean forceConnect)
Get a JDBC Connection object to DB2/400, pre-connected, for this connection. |
ISeriesLibrary[] |
getLibraries(Shell shell)
Deprecated. Use listLibraries(Shell shell) |
ISeriesLibrary[] |
getLibraries(Shell shell,
String libraryFilter)
Deprecated. Use listLibraries(Shell shell, String libraryFilter) |
InetAddress |
getLocalAddress()
Returns the local TCP/IP address for the local system that is accessible from the iSeries. |
com.ibm.etools.iseries.comm.interfaces.IISeriesMessageDescription |
getMessageDescription(String msgFileLibrary,
String msgFileName,
String msgID)
Retrieve a message description from the remote system |
String |
getPasswordEncrypted()
Returns the password (encrypted) for this connection |
String |
getProfileName()
Retrieve the profile name for this connection. |
ISeriesJob |
getServerJob(Shell shell)
Returns an ISeriesJob instance representing the communications server job for this connection. |
com.ibm.etools.iseries.comm.interfaces.IISeriesSortSequenceTable |
getSortSequenceTable(String table,
String library,
String langID,
int ccsid)
Retrieve the edit description information from the iSeries. |
com.ibm.etools.systems.subsystems.SubSystem[] |
getSubSystems()
Get all subsystems for this connection |
com.ibm.etools.systems.model.SystemConnection |
getSystemConnection()
Returns the underlying SystemConnection that this ISeriesConnection object wraps |
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 as determined by the QIGC system value. |
boolean |
isOffline()
Test if this connection is offline. |
ISeriesLibrary[] |
listLibraries(Shell shell)
Retrieve the library list for this connection |
ISeriesLibrary[] |
listLibraries(Shell shell,
String libraryFilter)
Retrieve a list of libraries matching the specified filter string |
ISeriesMember[] |
listMembers(Shell shell,
String libraryNameFilter,
String fileNameFilter)
List all members in the specified file. |
ISeriesMember[] |
listMembers(Shell shell,
String libraryNameFilter,
String fileNameFilter,
String memberNameFilter)
Retrieve a list of all members matching the specified library name, object name and member name. |
ISeriesMember[] |
listMembers(Shell shell,
String libraryNameFilter,
String fileNameFilter,
String memberNameFilter,
String[] memberTypes)
Retrieve a list of all members matching the specified library name, object name and member name. |
ISeriesObject[] |
listObjects(Shell shell,
String libraryNameFilter)
List all objects in the specified library. |
ISeriesObject[] |
listObjects(Shell shell,
String libraryNameFilter,
String objectNameFilter)
Retrieve a list of all objects matching the specified library and object name filter strings. |
ISeriesObject[] |
listObjects(Shell shell,
String libraryNameFilter,
String objectNameFilter,
String[] objectTypes)
Retrieve a list of all objects matching the specified library name, object name and type filter strings. |
ISeriesMessage[] |
runCommand(Shell shell,
String command)
Run a command on the iSeries in the communication server job. |
String |
toString()
Retrieve the connection name. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String copyright
Method Detail |
public static ISeriesConnection[] getConnections()
public static ISeriesConnection getConnection(String profileName, String connectionName)
connectionName
- A string containing the connection name
public static ISeriesConnection getConnection(String connectionName)
connectionName
- A string containing the connection name
public static ISeriesConnection getConnection(com.ibm.etools.systems.model.SystemConnection systemConnection)
public com.ibm.etools.systems.model.SystemConnection getSystemConnection()
public com.ibm.etools.systems.subsystems.SubSystem[] getSubSystems()
public boolean connect(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean connect() throws com.ibm.etools.systems.core.messages.SystemMessageException
connect
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isConnected()
isConnected
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
public boolean isOffline()
public ISeriesSystemDataStore getISeriesSystem()
public FileSubSystemImpl getISeriesFileSubSystem(Shell shell)
public FileSubSystemImpl getISeriesFileSubSystem()
public CmdSubSystemImpl getISeriesCmdSubSystem(Shell shell)
public CmdSubSystemImpl getISeriesCmdSubSystem()
public JobSubSystemImpl getISeriesJobSubSystem(Shell shell)
public JobSubSystemImpl getISeriesJobSubSystem()
public AS400ifsFileSubSystemImpl getISeriesIFSFileSubSystem(Shell shell)
public AS400ifsFileSubSystemImpl getISeriesIFSFileSubSystem()
public AS400ifsCmdSubSystemImpl getISeriesIFSCmdSubSystem(Shell shell)
public AS400ifsCmdSubSystemImpl getISeriesIFSCmdSubSystem()
public String getProfileName()
public String getConnectionName()
getConnectionName
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
public String getHostName()
getHostName
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
public String toString()
public com.ibm.as400.access.AS400 getAS400ToolboxObject(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
Exception
- if user cancels signon or any other error occurs.
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.as400.access.AS400 getAS400ToolboxObject(Shell shell, boolean createNew) throws com.ibm.etools.systems.core.messages.SystemMessageException
Exception
- if user cancels signon or any other error occurs.
com.ibm.etools.systems.core.messages.SystemMessageException
public static com.ibm.as400.access.AS400 getAS400ToolboxObject(String profileName, String connectionName, Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public Connection getJDBCConnection(String properties, boolean forceConnect) throws SQLException
Important notes:
properties
- A list of properties to append to the url, as per the
JDBC/400 getConnection(...) support. This string is appended to the
string "jdbc:as400://" + getHostName(), and so must start with a semicolon.
If null is passed, the following is used: ";prompt=false;big decimal=false"forceConnect
- whether to prompt user to signon if not already.
SQLException
public String getCODEAlias() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String getCODEAlias(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
shell
- Shell used for connection dialogs if the connection is
not already connected.
com.ibm.etools.systems.core.messages.SystemMessageException
public String getUserID()
getUserID
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
public String getPasswordEncrypted()
public ISeriesLibrary[] getLibraries(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the
library list.public ISeriesLibrary[] getLibraries(Shell shell, String libraryFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesLibrary getISeriesLibrary(Shell shell, String libraryName) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- if an error occurs while retrieving the
library information.public ISeriesFile getISeriesFile(Shell shell, String libraryName, String fileName) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- if an error occurs while retrieving the
file information.public com.ibm.etools.iseries.comm.interfaces.IISeriesFile getISeriesFile(String libraryName, String fileName) throws Exception
getISeriesFile
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
com.ibm.etools.systems.core.messages.SystemMessageException
- if an error occurs while retrieving the
file information.
Exception
public ISeriesObject getISeriesObject(Shell shell, String libraryName, String objectName, String type) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesMember getISeriesMember(Shell shell, String libraryName, String fileName, String memberName) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.etools.iseries.comm.interfaces.IISeriesMember getISeriesMember(String libraryName, String fileName, String memberName) throws Exception
getISeriesMember
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
Exception
public ISeriesJob getISeriesJob(Shell shell, String jobNumber, String userName, String jobName) throws com.ibm.etools.systems.core.messages.SystemMessageException
shell
- specify null if no progress monitor is needed.jobNumber
- the job numberuserName
- the user name of the jobjobName
- the job name
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesJob getISeriesJob(Shell shell, com.ibm.etools.iseries.comm.filters.ISeriesJobFilterString jobNameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
shell
- specify null if no progress monitor is needed.jobNameFilter
- the filter to resolve job name
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesJob getServerJob(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesRSEInteractiveJob getInteractiveServerJob(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If a communications error occurs or the user cancels the prompt to associate
an interactive job with this RSE connection.public ISeriesLibrary[] listLibraries(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesLibrary[] listLibraries(Shell shell, String libraryFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesObject[] listObjects(Shell shell, String libraryNameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesObject[] listObjects(Shell shell, String libraryNameFilter, String objectNameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesObject[] listObjects(Shell shell, String libraryNameFilter, String objectNameFilter, String[] objectTypes) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesMember[] listMembers(Shell shell, String libraryNameFilter, String fileNameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
libraryNameFilter
- fileNameFilter
-
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesMember[] listMembers(Shell shell, String libraryNameFilter, String fileNameFilter, String memberNameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesMember[] listMembers(Shell shell, String libraryNameFilter, String fileNameFilter, String memberNameFilter, String[] memberTypes) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
- If an error occurs while retrieving the list.public ISeriesCodepageConverter getConverter(Shell shell) throws Exception
an
- exception if the converter can not be obtained
Exception
public static ISeriesCodepageConverter getConverter(String profileName, String connectionName, Shell shell) throws Exception
an
- exception if the converter can not be obtained
Exception
public InetAddress getLocalAddress()
public ISeriesMessage[] runCommand(Shell shell, String command) throws com.ibm.etools.systems.core.messages.SystemMessageException
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.
com.ibm.etools.systems.core.messages.SystemMessageException
- if an error occurs while executing the command (i.e.
the network connection goes down.)public com.ibm.etools.iseries.comm.interfaces.IISeriesEditDescriptionsInfo getEditDescriptions() throws com.ibm.etools.systems.core.messages.SystemMessageException
getEditDescriptions
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.etools.iseries.comm.interfaces.IISeriesMessageDescription getMessageDescription(String msgFileLibrary, String msgFileName, String msgID) throws com.ibm.etools.systems.core.messages.SystemMessageException
getMessageDescription
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
com.ibm.etools.systems.core.messages.SystemMessageException
- if the message file does not exists.public com.ibm.etools.iseries.comm.interfaces.IISeriesSortSequenceTable getSortSequenceTable(String table, String library, String langID, int ccsid) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isDBCSEnabled() throws com.ibm.etools.systems.core.messages.SystemMessageException
isDBCSEnabled
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
com.ibm.etools.systems.core.messages.SystemMessageException
public String getVersionReleaseModification()
getVersionReleaseModification
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
public CacheManager getCacheManager()
public boolean checkAuthority(String library, String object, String objType, String[] authList) throws com.ibm.etools.systems.core.messages.SystemMessageException
checkAuthority
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
library
- The library which contains the object to checkobject
- The object to checkobjType
- The object typeauthList
- Array of authorities to check, use the constants from IISeriesAuthorityConstants
com.ibm.etools.systems.core.messages.SystemMessageException
IISeriesAuthorityConstants
public boolean checkAuthority(String library, String object, String objType, String authList) throws com.ibm.etools.systems.core.messages.SystemMessageException
checkAuthority
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesConnection
library
- The library which contains the object to checkobject
- The object to checkobjType
- The object typeauthList
- 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
com.ibm.etools.systems.core.messages.SystemMessageException
IISeriesAuthorityConstants
|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |