Interface ECIConnection

Defines the interface for connection to a server.

java.lang.Object

extended by com.microfocus.cics.client.ECIBINPConnection

All Known Implementing Classes

Class Specifications

public interface ECIConnection

Methods

Method Summary
`void`	`close()` Close the connection and perform any necessary cleanup
`ConnectionType`	`getConnectionType()` Get ConnectionType
`String`	`getHost()` Get the name of the connected host
`int`	`getOpenTimeout()` Get the openTimeout
`int`	`getPort()` Get the port number
`int`	`getReadTimeout()` Get the readTimeout
`boolean`	`IsGUIDGenerationStyleSecure ()` Check if GUID generation is secure
`boolean`	`IsTraceEnabled()` Check if the trace is enabled
`void`	`open()` Open the connection
`void`	`open(String keyStoreName, String keyStorePassword)` Open the connection
`ECIConnection`	`setConnectionType(ConnectionType aType)` Set connection type
`ECIConnection`	`setHost(String host)` Set the name of the host
`ECIConnection`	`setOpenTimeout(int openTimeoutInSeconds)` Set open timeout for the connection
`ECIConnection`	`setPort(int port)` Set the port number
`ECIConnection`	`setReadTimeout(int inSeconds)` Set read timeout for the connection
`ECIConnection`	`setSecureConnection(boolean isSecure)` Set security for the connection
`ECIConnection`	`setSecureGUID(boolean val)` Set the value of the secure GUID
`ECIConnection`	`setTrace(boolean val)` Set the value of trace

Method Detail

close

public void close()
                   throws CICSException

Close the connection and perform any necessary cleanup

Throws:: CICSException

getConnectionType

public ConnectionType getConnectionType()

Get connection type

Returns:: ConnectionType

getHost

public String getHost()

Get the name of the connected host

Returns:: The host

getOpenTimeout

int getOpenTimeout()

Get the openTimeout

Returns:: OpenTimeout in seconds

getPort

public int getPort()

Get the port number

Returns:: The port number

getReadTimeout

public int getReadTimeout()

Get the readTimeout

Returns:: ReadTimeout in seconds

isGUIDGenerationStyleSecure

public boolean isGUIDGenerationStyleSecure()

Check if GUID generation is secure

Returns:: true if it is, false otherwise

isTraceEnabled

public boolean isTraceEnabled()

Check if trace is enabled

Returns:: true if it is, false otherwise

open

public void open()
                  throws CICSException

Open the connection. This is required to start communicating with the server.

Throws:: CICSException

open

public void open(String keyStoreName, 
          String keyStorePassword)
                throws CICSException

Open the connection. This is required to start communicating with the server.

Parameters:

`keyStoreName`	Name of keystore
`keyStorePassword`	Password of keystore

Throws:

CICSException

setConnectionType

public ECIConnection setConnectionType(ConnectionType aType)

Set Connection type. Default type is NO_LUW.

Returns:: ECIConnection
See Also:: ConnectionType

setHost

public ECIConnection setHost(String host)

Set the name of the host

Parameters:

host

The host name

Returns:

ECIConnection object

setOpenTimeout

ECIConnection setOpenTimeout(int openTimeOutInSeconds)

Set open timeout for the connection. The connection times out after the number of seconds set if there is no response from the server.

Parameters:

openTimeOutInSeconds

The number of seconds

Returns:

ECIConnection

setPort

public ECIConnection setPort(int port)

Set the port number

Parameters:

port

The port number

Returns:

ECIConnection

setReadTimeout

public ECIConnection setReadTimeout(int inSeconds)

Set read timeout for the connection. The connection times out after "readTimeout" seconds if there is no response from the server.

Parameters:

inSeconds

In seconds

Returns:

ECIConnection

setSecureConnection

public ECIConnection setSecureConnection(boolean isSecure)

Set security for the connection. The connection uses SSL if true.

Parameters:

isSecure

true or false

Returns:

ECIConnection

setSecureGUID

public ECIConnection setSecureGUID(boolean val)

Set the value of secure GUID

Parameters:

val

Value of the secure GUID

Returns:

ECIConnection

setTrace

public ECIConnection setTrace(boolean val)

Set the value of trace

Parameters:

val

Trace value

Returns:

ECIConnection