Class ECIBINPConnection

The implementation of ECIConnection using MFBINP Protocol. MFBINP is a proprietary binary protocol from Micro Focus.

java.lang.Object

extended by com.microfocus.cics.client.ECIBINPConnection

All Implemented Interfaces

ECIConnection

Class Specifications

public class ECIBINPConnection

extends Object

implements ECIConnection

Constructor Summary

ECIBINPConnection()

Create an ECIBINPConnection

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 number
`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

Methods inherited from class java.lang.Object
equals, getClass, hashCode>, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ECIBINPConnection

public ECIBINPConnection()

Create a ECIBINPConnection. The default type for connection is NO_LUW

See Also:

ConnectionType

Method Detail

close

public void close()
                   throws CICSException

Close the connection and perform any necessary cleanup

Specified by:: close in interface ECIConnection
Throws:: CICSException

getConnectionType

public ConnectionType getConnectionType()

Get connection type

Specified by:: getConnectionType in interface ECIConnection
Returns:: ConnectionType

getHost

public String getHost()

Get the name of the connected host

Specified by:: getHost in interface ECIConnection
Returns:: The host

getOpenTimeout

public int getOpenTimeout()

Get the openTimeout

Specified by:: getOpenTimeout in interface ECIConnection
Returns:: OpenTimeout in seconds

getPort

public int getPort()

Get the port number

Specified by:: getPort in interface ECIConnection
Returns:: The port number

getReadTimeout

public int getReadTimeout()

Get the readTimeout

Specified by:: getReadTimeout in interface ECIConnection
Returns:: ReadTimeout in seconds

isGUIDGenerationStyleSecure

public boolean isGUIDGenerationStyleSecure()

Check if GUID generation is secure

Specified by:: isGUIDGenerationStyleSecure in interface ECIConnection
Returns:: true if it is, false otherwise

isTraceEnabled

public boolean isTraceEnabled()

Check if trace is enabled

Specified by:: isTraceEnabled in interface ECIConnection
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.

Specified by:: open in interface ECIConnection
Throws:: CICSException

open

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

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

Specified by:

open in interface ECIConnection

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.

Specified by:: setConnectionType in interface ECIConnection
Returns:: ECIConnection
See Also:: ConnectionType

setHost

public ECIConnection setHost(String host)

Set the name of the host

Specified by:

setHost in interface ECIConnection

Parameters:

host

The host name

Returns:

ECIConnection object

setOpenTimeout

public 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.

Specified by:

setOpenTimeout in interface ECIConnection

Parameters:

openTimeOutInSeconds

The number of seconds

Returns:

ECIConnection

setPort

public ECIConnection setPort(int port)

Set the port number

Specified by:

setPort in interface ECIConnection

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.

Specified by:

setReadTimeout in interface ECIConnection

Parameters:

inSeconds

In seconds

Returns:

ECIConnection

setSecureConnection

public ECIConnection setSecureConnection(boolean isSecure)

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

Specified by:

setSecureConnection in interface ECIConnection

Parameters:

isSecure

true or false

Returns:

ECIConnection

setSecureGUID

public ECIConnection setSecureGUID(boolean val)

Set the value of secure GUID

Specified by:

setSecureGUID in interface ECIConnection

Parameters:

val

Value of the secure GUID

Returns:

ECIConnection

setTrace

public ECIConnection setTrace(boolean val)

Set the value of trace

Specified by:

setTrace in interface ECIConnection

Parameters:

val

Trace value

Returns:

ECIConnection