Package com.compuware.api.topaz.hostconnections.zos

Interface IZOSHostConnection

All Superinterfaces:

IHostConnection

public interface IZOSHostConnection
extends IHostConnection

A connection to a z/OS host.

z/OS host connections are used to connect to z/OS hosts and provide access to z/OS command providers.

connect(IZOSCredentials) must be called in order to establish a connection to the associated z/OS host. The IDataSetCommandProvider and IJESCommandProvider provided by this z/OS host connection will be unusable until a connection to the associated z/OS host has been established.

Examples:
To connect to a z/OS host:

 IZOSHost zosHost = ...
 String userID = ...
 String password = ...
 
 // use one of the several ZOSCredentialsFactory methods to get a z/OS
 // credentials object
 IZOSCredentials credentials = ZOSCredentialsFactory
         .createZOSCredentials(userID, password);
 
 // create a connection from the z/OS host
 IZOSHostConnection zosHostConnection = zosHost
         .createZOSHostConnection();
 
 try {
     // connect to the host
     zosHostConnection.connect(credentials);
 
     // the connection is now available for use
     ...
 } catch (HostCredentialsException e) {
     // credentials were invalid, likely caused by incorrect login
     // information or expired password
     ...
 }
 

Note: If writing a plug-in that runs in a Topaz Workbench installation, you can use the ZOSUIUserCredentialsManager class in the com.compuware.api.topaz.eclpse plug-in to retrieve the credentials of the currently logged in Topaz Workbench UI user. See com.compuware.api.topaz.eclipse.hostcredentials.zos.ZOSUIUserCredentialsManager for more details.

For examples on how to obtain IZOSHosts see IZOSHost.
For examples on how to obtain an IDataSetCommandProviders see IDataSetCommandProvider.
For examples on how to obtain an IJESCommandProviders see IJESCommandProvider.

Since:

1.0.0

Version:

2.0.0

See Also:

IZOSHost.createZOSHostConnection()

Restriction:

This interface is not intended to be extended by clients.

Restriction:

This interface is not intended to be implemented by clients.

Method Summary

Modifier and Type	Method	Description
void	connect(IZOSCredentials credentials)	Connects to the associated z/OS host.
IDataSetCommandProvider	getDataSetCommandProvider()	Returns the single instance of a dataset command provider for use on this z/OS host connection.
IZOSHost	getHost()	Returns the z/OS host associated with this z/OS host connection.
IJESCommandProvider	getJESCommandProvider()	Returns the single instance of a JES command provider for use on this z/OS host connection.
ITSOCommandProvider	getTSOCommandProvider()	Returns the single instance of a TSO command provider for use on this z/OS host conneciton.

Methods inherited from interface com.compuware.api.topaz.hostconnections.IHostConnection

disconnect, isConnected

Method Detail

connect

void connect(IZOSCredentials credentials)
      throws UserIDException,
             PasswordException,
             GroupException,
             DigitalCertificateException

Connects to the associated z/OS host.

Parameters:

credentials - the credentials to connect with

Throws:

IllegalArgumentException - if credentials is null

HostNotDefinedException - if the z/OS host is not defined

HostNotReachableException - if the z/OS host is not reachable

HostIOException - if an IOException occurs while attempting to connect to the z/OS host

MethodNotSupportedException - if the z/OS host does not support this version of the Topaz API

ZOSSystemException - if a z/OS system error occurs while attempting to connect to the z/OS host

ZOSAbendException - if a z/OS ABEND occurs while attempting to connect to the z/OS host

ZOSLicenseException - if no license is found on the z/OS host

UserIDException - if the user ID specified in the credentials is invalid

PasswordException - if an invalid password is specified in the credentials

GroupException - if an invalid group ID is specified in the credentials

DigitalCertificateException - if an invalid digital certificate is specified in the credentials

Since:

1.0.0

getHost

IZOSHost getHost()

Returns the z/OS host associated with this z/OS host connection.

Specified by:

getHost in interface IHostConnection

Returns:

the z/OS host

Since:

1.0.0

getDataSetCommandProvider

IDataSetCommandProvider getDataSetCommandProvider()

Returns the single instance of a dataset command provider for use on this z/OS host connection.

Returns:

the dataset provider instance

Since:

1.0.0

getJESCommandProvider

IJESCommandProvider getJESCommandProvider()

Returns the single instance of a JES command provider for use on this z/OS host connection.

Returns:

the JES command provider instance

Since:

1.0.0

getTSOCommandProvider

ITSOCommandProvider getTSOCommandProvider()

Returns the single instance of a TSO command provider for use on this z/OS host conneciton.

Returns:

the TSO command provider instance

Since:

2.2.0