com.ibm.etools.iseries.subsystems.qsys
Class QSYSAbstractSubSystem

java.lang.Object
  SubSystem
      com.ibm.etools.iseries.subsystems.qsys.QSYSAbstractSubSystem

All Implemented Interfaces:

IISeriesSubSystem

Direct Known Subclasses:

QSYSCommandSubSystem, QSYSJobSubSystem, QSYSObjectSubSystem

public abstract class QSYSAbstractSubSystem
extends SubSystem
implements IISeriesSubSystem

Abstract parent class for QSYS subsystems.

Field Summary

static String

copyright

Constructor Summary

protected

QSYSAbstractSubSystem(IHost host, IConnectorService connectorService)

Method Summary

void	checkIsConnected() This is a helper method you can call when performing actions that must be certain there is a connection.
void	checkIsConnected(IProgressMonitor monitor) This is a helper method you can call when performing actions that must be certain there is a connection.
void	checkIsConnected(IProgressMonitor monitor, boolean force) This is a helper method you can call when performing actions that must be certain there is a connection.
ISubSystem	getCmdSubSystem() Return the command subsystem ("iSeries Commands") for executing remote QSYS commands
ISubSystem	getObjectSubSystem() Return the objects subsystem ("iSeries Objects") for accessing remote QSYS libs, objs, mbrs, etc.
protected SystemMessageObject	processListRetrieveError(SystemMessageException e, String filterString) Wrap a SystemMessage to a SystemMessageObject.
void	verifyConnected(IProgressMonitor monitor, boolean force) Checks if the connection is connected and tries to connect if not.

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

Constructor Detail

QSYSAbstractSubSystem

protected QSYSAbstractSubSystem(IHost host,
                                IConnectorService connectorService)

Method Detail

getCmdSubSystem

public ISubSystem getCmdSubSystem()

Description copied from interface: IISeriesSubSystem

Return the command subsystem ("iSeries Commands") for executing remote QSYS commands

Specified by:

getCmdSubSystem in interface IISeriesSubSystem

getObjectSubSystem

public ISubSystem getObjectSubSystem()

Description copied from interface: IISeriesSubSystem

Return the objects subsystem ("iSeries Objects") for accessing remote QSYS libs, objs, mbrs, etc. For historical reasons, this is also known as the "file subsystem".

Specified by:

getObjectSubSystem in interface IISeriesSubSystem

processListRetrieveError

protected SystemMessageObject processListRetrieveError(SystemMessageException e,
                                                       String filterString)

Wrap a SystemMessage to a SystemMessageObject.

Parameters:

e -

checkIsConnected

public void checkIsConnected()
                      throws SystemMessageException

This is a helper method you can call when performing actions that must be certain there is a connection. If there is no connection it will attempt to connect, and if that fails will throw a SystemMessageException you can easily display to the user by using a method in it.

Throws:

SystemMessageException

checkIsConnected

public void checkIsConnected(IProgressMonitor monitor)
                      throws SystemMessageException

This is a helper method you can call when performing actions that must be certain there is a connection. If there is no connection it will attempt to connect, and if that fails will throw a SystemMessageException you can easily display to the user by using a method in it.

Throws:

SystemMessageException

checkIsConnected

public void checkIsConnected(IProgressMonitor monitor,
                             boolean force)
                      throws SystemMessageException

This is a helper method you can call when performing actions that must be certain there is a connection. If there is no connection it will attempt to connect, and if that fails will throw a SystemMessageException you can easily display to the user by using a method in it.

Throws:

SystemMessageException

verifyConnected

public void verifyConnected(IProgressMonitor monitor,
                            boolean force)
                     throws SystemMessageException

Checks if the connection is connected and tries to connect if not. If in offline mode throws an exception to stop callers from calling toolbox api after.

Throws:

SystemMessageException