IBM Branch Transformation Toolkit Javadoc

com.ibm.connector2.sna.lu62.host
Class Lu62Conversation

java.lang.Object
  extended bycom.ibm.connector2.sna.lu62.host.Lu62Conversation
All Implemented Interfaces:
Lu62ConversationService

public class Lu62Conversation
extends java.lang.Object
implements Lu62ConversationService

This class provides the Lu62Conversation service.


Field Summary
 boolean listenThreadAlive
           
 Semaphore receiveSem
           
 
Fields inherited from interface com.ibm.connector2.sna.lu62.host.Lu62ConversationService
ACCEPT_CONVERSATION, ALLOCATEERROR, BUFFER_LENGTH, CLOSED, CM_ALLOCATE_FAILURE_NO_RETRY, CM_ALLOCATE_FAILURE_RETRY, CM_ALLOCATION_ERROR, CM_BASIC_CONVERSATION, CM_BLOCKING, CM_BUFFER_DATA, CM_BUFFER_TOO_SMALL, CM_CALL_NOT_SUPPORTED, CM_COMPLETE_DATA_RECEIVED, CM_CONFIRM, CM_CONFIRM_DEALLOC_RECEIVED, CM_CONFIRM_RECEIVED, CM_CONFIRM_SEND_RECEIVED, CM_CONV_DEALLOC_AFTER_SYNCPT, CM_CONVERSATION_CANCELLED, CM_CONVERSATION_ENDING, CM_CONVERSATION_TYPE_MISMATCH, CM_DATA_RECEIVED, CM_DEALLOC_CONFIRM_REJECT, CM_DEALLOCATE_ABEND, CM_DEALLOCATE_CONFIRM, CM_DEALLOCATE_FLUSH, CM_DEALLOCATE_SYNC_LEVEL, CM_DEALLOCATED_ABEND, CM_DEALLOCATED_ABEND_BO, CM_DEALLOCATED_ABEND_SVC, CM_DEALLOCATED_ABEND_SVC_BO, CM_DEALLOCATED_ABEND_TIMER, CM_DEALLOCATED_ABEND_TIMER_BO, CM_DEALLOCATED_NORMAL, CM_DEALLOCATED_NORMAL_BO, CM_EXP_DATA_NOT_SUPPORTED, CM_INCLUDE_PARTNER_REJECT_BO, CM_INCOMPLETE_DATA_RECEIVED, CM_JOIN_TRANSACTION, CM_MAPPED_CONVERSATION, CM_NO_DATA_RECEIVED, CM_NO_SECONDARY_INFORMATION, CM_NO_STATUS_RECEIVED, CM_NON_BLOCKING, CM_NONE, CM_OK, CM_OPERATION_INCOMPLETE, CM_OPERATION_NOT_ACCEPTED, CM_PARAMETER_ERROR, CM_PARM_VALUE_NOT_SUPPORTED, CM_PIP_NOT_SPECIFIED_CORRECTLY, CM_PREPARE_OK, CM_PRODUCT_SPECIFIC_ERROR, CM_PROGRAM_ERROR_NO_TRUNC, CM_PROGRAM_ERROR_PURGING, CM_PROGRAM_ERROR_TRUNC, CM_PROGRAM_PARAMETER_CHECK, CM_PROGRAM_STATE_CHECK, CM_RECEIVE_AND_WAIT, CM_RECEIVE_IMMEDIATE, CM_RESOURCE_FAIL_NO_RETRY_BO, CM_RESOURCE_FAILURE_NO_RETRY, CM_RESOURCE_FAILURE_RETRY, CM_RESOURCE_FAILURE_RETRY_BO, CM_RETRY_LIMIT_EXCEEDED, CM_SECURITY_MUTUAL_FAILED, CM_SECURITY_NOT_SUPPORTED, CM_SECURITY_NOT_VALID, CM_SEND_AND_CONFIRM, CM_SEND_AND_DEALLOCATE, CM_SEND_AND_FLUSH, CM_SEND_AND_PREP_TO_RECEIVE, CM_SEND_RCV_MODE_NOT_SUPPORTED, CM_SEND_RECEIVED, CM_SVC_ERROR_NO_TRUNC, CM_SVC_ERROR_PURGING, CM_SVC_ERROR_TRUNC, CM_SYNC_LEVEL_NOT_SUPPORTED_LU, CM_SYNC_LEVEL_NOT_SUPPORTED_PGM, CM_SYNC_LVL_NOT_SUPPORTED_LU, CM_SYNC_LVL_NOT_SUPPORTED_PGM, CM_SYNC_LVL_NOT_SUPPORTED_SYS, CM_SYSTEM_EVENT, CM_TAKE_BACKOUT, CM_TAKE_COMMIT, CM_TAKE_COMMIT_DATA_OK, CM_TAKE_COMMIT_DEALLOC_DATA_OK, CM_TAKE_COMMIT_DEALLOCATE, CM_TAKE_COMMIT_SEND, CM_TAKE_COMMIT_SEND_DATA_OK, CM_TP_NOT_AVAILABLE_NO_RETRY, CM_TP_NOT_AVAILABLE_RETRY, CM_TPN_NOT_RECOGNISED, CM_TPN_NOT_RECOGNIZED, CM_UNSUCCESSFUL, COMPLETE, CONFIRM, CONFIRM_CONVERSATION, CONFIRM_DEALLOCATE, CONFIRM_SEND, CONFIRMED_RECEIVED, CONVERSATION_CLOSED, CONVERSATION_DOWN, CONVERSATION_ESTABLISHED, CONVERSATION_NOT_ESTABLISHED, DATA, DATA_CANCELLED, DATASENT, DEALLOCATE_CONVERSATION, ERROR, ERROR_RECEIVED, IBM_AIX, IBM_OS2, INCOMING, INFO, INITIALIZE, LISTEN, LU62_WRAPPER_DLL, LUNAME, MVS, OPENED, OSNAME, OUTGOING, RECEIVE, RECEIVERC, REGISTERERROR, RESET, RESET_PENDING, SDN, SEND, SEND_PENDING, SENDERROR, SRTERROR, TIMEOUT, TPNAME, WINDOWS_NT, zOS
 
Constructor Summary
Lu62Conversation(Lu62ConversationConfigurationProperties configurationProperties)
          This constructor creates a Lu62Conversation object.
 
Method Summary
 void acceptConversation()
          Accepts an incoming conversation from a 390 system.
 void acceptIncoming()
          Accepts an incoming conversation that has previously been initialized with initializeForIncoming.
 void addLu62ConversationEventListener(Lu62ConversationEventListener listener)
          addLu62ConversationEventListener method comment.
 void allocateConversation(java.lang.String aTPName)
          Allocate a conversation from a OS/390 system.
 void cancelConversation()
          Ends a specified conversation, cancels any incomplete operation (a previous call that returned with CM_OPERATION_INCOMPLETE) on this conversation, and ends the session used by the conversation.
 void closeConversation()
          Closes the communications session.
 void confirm()
          Sends the contents of the local LU's send buffer and a confirmation request to the partner program.
 void deallocate()
          Closes the conversation between two programs.
 void establishConversation()
          Establishes the conversation based on the value of the outgoing attribute.
 void establishConversation(java.lang.String aTPName)
          Establishes the conversation based on the value of the outgoing attribute.
 void finalize()
          Clears all the atributes when there is no reference to this instance.
 void flush()
          Sends the contents of the local LU's send buffer (if it is not empty) to the partner LU (and program).
 boolean getClosedIssued()
          Gets the closedIssued property (boolean) value.
 boolean getConfirmMode()
          Gets the confirmMode property value.
 java.lang.String getConversationId()
          Gets the conversationId property (char[]) value.
 java.lang.String getConversationStatus()
          Gets the conversationStatus property value.
 int getConversationTimeout()
           
 int getEstablishConversationRetries()
          Gets the establishConversationRetries property value.
 boolean getFlushMode()
          Gets the flushMode property value.
 boolean getInUse()
          Gets the inUse property value.
static java.lang.String getLevel()
          Returns the WrapperLU62 version.
 Lu62Message getLu62Message()
          Gets the lu62Message property value.
 java.lang.String getLUName()
          Gets the LUName property value.
 boolean getManageResponses()
          Gets the manageResponses property value.
 boolean getOutgoing()
          Gets the outgoing property value.
(package private)  Semaphore getReceiveSem()
          Gets the receiveSem property value.
 int getSendSize()
           
 java.lang.String getSymbolicDestinationName()
          Gets the symbolicDestinationName property () value.
 boolean getSynchronousMode()
          Gets the synchronousMode property value.
 int getTimeBetweenRetries()
          Gets the timeBetweenRetries property value.
 java.lang.String getTpName()
          Gets the tpName property value.
protected  void initializeCounter()
          Sets the EstablishConversationCounter property to its default value.
 void initInstance()
          Instantiates all handlers that have a default treatment.
 boolean isFree()
          Returns whether the conversation is free.
 boolean isOffline()
          Returns if the conversation is offline.
protected  Lu62Message lu62SendReceive(java.lang.String aString, long aTimeout)
          Sends aString to the communication service and waits for the response until the timeout expires.
 Lu62Message peekData()
          Returns the received Lu62Message without reading it.
 Lu62Message readData()
          Returns the received Lu62Message.
 Lu62Message readData(long timeout)
          Returns the received Lu62Message.
 void receive()
          Receives any data that is currently available from the partner program.
 Lu62Message receiveAndRequestToSend()
           
 void removeLu62ConversationEventListener()
          removeLu62ConversationEventListener method comment.
 void send(java.lang.String aMessage)
          Puts data in the local LU's send buffer to transmit it to the partner LU program.
 void sendAndPrepareToReceive(java.lang.String aMessage)
          Sends the data with the SEND indicator to the remote LU partner.
 void sendCancel(java.lang.String aMessage)
          Cancels the current block of data by sending an error indicator to the remote LU and keeping the local LU in a SEND state.
 void sendConfirmed()
          Replies to a confirmation request from the partner program.
 void sendError()
          Notifies the partner program that the local program has encountered an application-level error.
 Lu62Message sendReceive(java.lang.String aString, long aTimeout)
          Sends aString to the communication service and waits for up the aTimeout period for the response.
 Lu62Message sendReceiveSYNC(java.lang.String aString, long aTimeout)
          Send a string and read data till conversation deallocated
protected  void setClosedIssued(boolean closedIssued)
          Sets the closedIssued property (boolean) value.
 void setConfirmMode(boolean aConfirmMode)
          Sets the confirmMode property value.
 void setConversationTimeout(int conversationTimeout)
          Sets the conversationTimeout property value
 void setEstablishConversationRetries(int establishConversationRetries)
          Sets the establishConversationRetries property value.
 void setFlushMode(boolean aFlushMode)
          Sets the flushMode property value.
 void setInUse(boolean anInUse)
          Sets the inUse property value.
 void setLU_Name(java.lang.String aLUName)
          Specifies the local LU for a conversation.
 void setLUName(java.lang.String aLUName)
          Specifies the local LU for a conversation.
 void setManageResponses(boolean aManageResponses)
          Sets the manageResponses property value.
 void setOutgoing(boolean aOutgoing)
          Sets the outgoing property value.
 void setSendSize(int aSendSize)
          Sets the sendSize property value
 void setSendType(int aSendType)
          Specifies how data is sent by the next send call.
 void setSynchronousMode(boolean aSynchronousMode)
          Sets the synchronousMode property value.
 void setTimeBetweenRetries(int timeBetweenRetries)
          Sets the timeBetweenRetries property value.
 void setTpName(java.lang.String aTpName)
          Sets the tpName property value.
 void terminate()
          Terminates the conversation.
 java.lang.String toString()
          Returns a visual representation of this object.
protected  void unregister()
          Unregisters conversations already registered for allocation.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

receiveSem

public Semaphore receiveSem

listenThreadAlive

public boolean listenThreadAlive
Constructor Detail

Lu62Conversation

public Lu62Conversation(Lu62ConversationConfigurationProperties configurationProperties)
This constructor creates a Lu62Conversation object.

Method Detail

addLu62ConversationEventListener

public void addLu62ConversationEventListener(Lu62ConversationEventListener listener)
addLu62ConversationEventListener method comment.


removeLu62ConversationEventListener

public void removeLu62ConversationEventListener()
removeLu62ConversationEventListener method comment.


acceptConversation

public void acceptConversation()
                        throws Lu62InternalErrorException,
                               Lu62InvalidRequestException
Accepts an incoming conversation from a 390 system. The invoked program calls this method.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

acceptIncoming

public void acceptIncoming()
                    throws Lu62InternalErrorException,
                           Lu62InvalidRequestException
Accepts an incoming conversation that has previously been initialized with initializeForIncoming. The invoked program calls this method.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

allocateConversation

public void allocateConversation(java.lang.String aTPName)
                          throws Lu62InternalErrorException,
                                 Lu62InvalidRequestException
Allocate a conversation from a OS/390 system.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

cancelConversation

public void cancelConversation()
                        throws Lu62InternalErrorException,
                               Lu62InvalidRequestException
Ends a specified conversation, cancels any incomplete operation (a previous call that returned with CM_OPERATION_INCOMPLETE) on this conversation, and ends the session used by the conversation.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

closeConversation

public void closeConversation()
                       throws Lu62Exception
Closes the communications session. To re-establish it, invoke the establishConversation method.

Throws:
Lu62Exception

confirm

public void confirm()
             throws Lu62InternalErrorException,
                    Lu62InvalidRequestException
Sends the contents of the local LU's send buffer and a confirmation request to the partner program. When the confirmation arrives, this method signals a confirmedReceived or errorReceived.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

deallocate

public void deallocate()
                throws Lu62InternalErrorException
Closes the conversation between two programs.

Throws:
Lu62InternalErrorException

establishConversation

public void establishConversation()
                           throws Lu62InternalErrorException,
                                  Lu62InvalidRequestException
Establishes the conversation based on the value of the outgoing attribute. When Outgoing is true, this method allocates the conversation to a session in which the local LU is the contention winner (the one that can send data right after session setup - SEND state). When Outgoing is false, this method allocates the conversation to a contention loser session (the one that has to wait for data right after session setup - RECEIVE state).

As soon as the method allocates the conversation, it signals the conversationEstablished event and both partners can begin exchanging data using a half-duplex flip flop protocol.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

establishConversation

public void establishConversation(java.lang.String aTPName)
                           throws Lu62Exception
Establishes the conversation based on the value of the outgoing attribute. When Outgoing is true, this method allocates the conversation to a session in which the local LU is the contention winner (the one that can send data right after session setup - SEND state). When Outgoing is false, this method allocates the conversation to a contention loser session (the one that has to wait for data right after session setup - RECEIVE state).

As soon as the method allocates the conversation, it signals the conversationEstablished event and both partners can begin exchanging data using a half-duplex flip flop protocol.

Parameters:
aTPName - java.lang.String
Throws:
Lu62Exception

finalize

public void finalize()
Clears all the atributes when there is no reference to this instance.


flush

public void flush()
           throws Lu62InternalErrorException,
                  Lu62InvalidRequestException
Sends the contents of the local LU's send buffer (if it is not empty) to the partner LU (and program).

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

getConfirmMode

public boolean getConfirmMode()
Gets the confirmMode property value. If confirmMode is true, the data is sent immediately with a request for confirmation.

Returns:
- Returns true if requests require confirmation
See Also:
setConfirmMode(boolean)

getConversationId

public java.lang.String getConversationId()
Gets the conversationId property (char[]) value. This is the identifier for the conversation. It is used by subsequent CPI-C calls.

Returns:
The conversationId property value

getConversationStatus

public java.lang.String getConversationStatus()

Gets the conversationStatus property value. It can have the following values

Returns:
The conversationStatus property value

getEstablishConversationRetries

public int getEstablishConversationRetries()
Gets the establishConversationRetries property value. If it is negative, the session never stops trying to re-establish itself. Otherwise this property sets the number of attempts are permitted.

Returns:
int - The establishConnectionRetries property value.
See Also:
setEstablishConversationRetries(int)

getFlushMode

public boolean getFlushMode()
Gets the flushMode property value. If flushMode is true, every time the application send data to a partner, the buffers containing the data are automatically flushed.

This method can be useful in some cases but care should be taken since it can affect the workstation and network performance.

Returns:
boolean - The flushMode property value
See Also:
setFlushMode(boolean)

getInUse

public boolean getInUse()
Gets the inUse property value.

Returns:
boolean - Returns true if the instance is being used
See Also:
setInUse(boolean)

getLevel

public static java.lang.String getLevel()
                                 throws Lu62Exception
Returns the WrapperLU62 version.

Returns:
java.lang.String
Throws:
Lu62Exception

getLu62Message

public Lu62Message getLu62Message()
Gets the lu62Message property value. This attribute points to the default Lu62Message class.

Returns:
Lu62Message - The lu62Message property value

getLUName

public java.lang.String getLUName()
Gets the LUName property value.

Returns:
java.lang.String - The LUName property value
See Also:
setLUName(java.lang.String)

getManageResponses

public boolean getManageResponses()
Gets the manageResponses property value. If manageResponses is true, the client application must send a response to each received message. If manageResponses is false, the client application does not send responses.

Returns:
boolean - The manageResponses property value
See Also:
setManageResponses(boolean)

getOutgoing

public boolean getOutgoing()
Gets the outgoing property value. If true, the Lu62Conversation requests to allocate a conversation to a contention winner session (the one that has to wait for data right after session setup - RECEIVE state). If false, the Lu62Conversation requests to allocate a conversation to a contention loser session (the one that has to wait for data right after session setup - SEND state).

Returns:
boolean - The symbolicDestinationName property value
See Also:
setOutgoing(boolean)

getReceiveSem

Semaphore getReceiveSem()
Gets the receiveSem property value.

Returns:
com.ibm.connector2.sna.lu62.host.Semaphore - The receiveSem property value

getSymbolicDestinationName

public java.lang.String getSymbolicDestinationName()
Gets the symbolicDestinationName property () value. This parameter specifies the symbolic destination name, which is the name associated with a side information entry loaded from the CS configuration file.

Returns:
java.lang.String - The symbolicDestinationName property value

getSynchronousMode

public boolean getSynchronousMode()
Gets the synchronousMode property value. If synchronousMode is true, Composer or Java events are not signaled.

Returns:
boolean - The synchronousMode property value
See Also:
setConfirmMode(boolean)

getTimeBetweenRetries

public int getTimeBetweenRetries()
Gets the timeBetweenRetries property value. It is the time (specified in seconds in the services XML file but stored in milliseconds) that passes between attempts to establish a conversation.

Returns:
int - The timeBetweenRetries property value
See Also:
setTimeBetweenRetries(int)

getTpName

public java.lang.String getTpName()
Gets the tpName property value.

Returns:
java.lang.String - The tpName property value
See Also:
setTpName(java.lang.String)

initializeCounter

protected void initializeCounter()
Sets the EstablishConversationCounter property to its default value.


initInstance

public void initInstance()
                  throws Lu62InternalErrorException,
                         Lu62InvalidRequestException
Instantiates all handlers that have a default treatment. The method also creates the listenThread.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

isFree

public boolean isFree()
Returns whether the conversation is free.

Returns:
boolean

isOffline

public boolean isOffline()
Returns if the conversation is offline.

Returns:
boolean

lu62SendReceive

protected Lu62Message lu62SendReceive(java.lang.String aString,
                                      long aTimeout)
Sends aString to the communication service and waits for the response until the timeout expires. lu62SendReceive() only available for MVS

Parameters:
aString - java.lang.String
aTimeout - long

peekData

public Lu62Message peekData()
Returns the received Lu62Message without reading it.

Returns:
com.ibm.connector2.sna.lu62.host.Lu62Message

readData

public Lu62Message readData()
                     throws Lu62Exception
Returns the received Lu62Message.

Returns:
com.ibm.connector2.sna.lu62.comms.Lu62Message
Throws:
Lu62Exception

readData

public Lu62Message readData(long timeout)
                     throws Lu62Exception
Returns the received Lu62Message.

Returns:
com.ibm.connector2.sna.lu62.host.Lu62Message
Throws:
Lu62Exception

receive

public void receive()
             throws Lu62Exception
Receives any data that is currently available from the partner program. This method should be called after a data ready notification has been received.

Throws:
Lu62Exception

receiveAndRequestToSend

public Lu62Message receiveAndRequestToSend()
                                    throws Lu62Exception
Returns:
com.ibm.connector2.sna.lu62.host.Lu62Message
Throws:
Lu62Exception

send

public void send(java.lang.String aMessage)
          throws Lu62InternalErrorException,
                 Lu62InvalidRequestException
Puts data in the local LU's send buffer to transmit it to the partner LU program. If flushMode is true, the data is purged from the buffer immediately after it is sent. If confirmMode is true, the data is purged from the buffer immediately after it is sent and the partner LU is requested to send a confirmation. the conversation must be in Send or Send-pending state

Parameters:
aMessage - The message to send.
Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

sendAndPrepareToReceive

public void sendAndPrepareToReceive(java.lang.String aMessage)
                             throws Lu62InternalErrorException,
                                    Lu62InvalidRequestException
Sends the data with the SEND indicator to the remote LU partner. The data enters the local LU in the RECEIVE state.

Parameters:
aMessage - The message to send
Throws:
Lu62InternalErrorException
Lu62InvalidRequestException
See Also:
send(java.lang.String)

sendReceiveSYNC

public Lu62Message sendReceiveSYNC(java.lang.String aString,
                                   long aTimeout)
Send a string and read data till conversation deallocated

Parameters:
aString - The String
aTimeout - The timeout

sendCancel

public void sendCancel(java.lang.String aMessage)
                throws Lu62InternalErrorException,
                       Lu62InvalidRequestException
Cancels the current block of data by sending an error indicator to the remote LU and keeping the local LU in a SEND state.

Parameters:
aMessage - The message to send
Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

sendConfirmed

public void sendConfirmed()
                   throws Lu62InternalErrorException,
                          Lu62InvalidRequestException
Replies to a confirmation request from the partner program. It informs the partner program that the local program has not detected an error in the received data.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

sendError

public void sendError()
               throws Lu62InternalErrorException,
                      Lu62InvalidRequestException
Notifies the partner program that the local program has encountered an application-level error. The local program can use the sendError for purposes such as as informing the partner program of an error encountered in received data, rejecting a confirmation request, or truncating an incomplete logical record it is sending.

Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

sendReceive

public Lu62Message sendReceive(java.lang.String aString,
                               long aTimeout)
Sends aString to the communication service and waits for up the aTimeout period for the response. sendReceive() only available for MVS

Parameters:
aString - java.lang.String
aTimeout - long

setConversationTimeout

public void setConversationTimeout(int conversationTimeout)
Sets the conversationTimeout property value

Parameters:
conversationTimeout - The new value for the property

getConversationTimeout

public int getConversationTimeout()

setSendSize

public void setSendSize(int aSendSize)
Sets the sendSize property value

Parameters:
aSendSize - The new value for the property

getSendSize

public int getSendSize()

setConfirmMode

public void setConfirmMode(boolean aConfirmMode)
Sets the confirmMode property value.

Parameters:
aConfirmMode - The new value for the property.
See Also:
getConfirmMode()

setEstablishConversationRetries

public void setEstablishConversationRetries(int establishConversationRetries)
Sets the establishConversationRetries property value.

Parameters:
establishConversationRetries - The new value for the property
See Also:
getEstablishConversationRetries()

setFlushMode

public void setFlushMode(boolean aFlushMode)
Sets the flushMode property value.

Parameters:
aFlushMode - The new value for the property
See Also:
getFlushMode()

setInUse

public void setInUse(boolean anInUse)
Sets the inUse property value.

Parameters:
anInUse - The new value for the property
See Also:
getInUse()

setLU_Name

public void setLU_Name(java.lang.String aLUName)
                throws Lu62InternalErrorException,
                       Lu62InvalidRequestException
Specifies the local LU for a conversation. The invoking program calls this method after the initializeConversation call is issued. This call overrides the system-defined Local LU derived from the side information when initializeConversation was issued.

This call cannot be issued after the allocate call has been issued.

Parameters:
aLUName - java.lang.String
Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

setLUName

public void setLUName(java.lang.String aLUName)
               throws Lu62InternalErrorException,
                      Lu62InvalidRequestException
Specifies the local LU for a conversation. The invoking program calls this method after the initializeConversation call is issued.

This call cannot be issued after the allocate call has been issued.

Parameters:
aLUName - java.lang.String
Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

setManageResponses

public void setManageResponses(boolean aManageResponses)
Sets the manageResponses property value.

Parameters:
aManageResponses - The new value for the property.
See Also:
getManageResponses()

setOutgoing

public void setOutgoing(boolean aOutgoing)
Sets the outgoing property value.

Parameters:
aOutgoing - The new value for the property.
See Also:
getOutgoing()

setSendType

public void setSendType(int aSendType)
                 throws Lu62InternalErrorException,
                        Lu62InvalidRequestException
Specifies how data is sent by the next send call. The default send type is CM_BUFFER_DATA, which indicates that only data (and no control information) is to be sent.

The valid values are:

Parameters:
aSendType - (int)
Throws:
Lu62InternalErrorException
Lu62InvalidRequestException

setSynchronousMode

public void setSynchronousMode(boolean aSynchronousMode)
Sets the synchronousMode property value.

Parameters:
aSynchronousMode - The new value for the property
See Also:
getSynchronousMode()

setTimeBetweenRetries

public void setTimeBetweenRetries(int timeBetweenRetries)
Sets the timeBetweenRetries property value.

Parameters:
timeBetweenRetries - The new value for the property
See Also:
getTimeBetweenRetries()

setTpName

public void setTpName(java.lang.String aTpName)
Sets the tpName property value.

Parameters:
aTpName - The new value for the property
See Also:
getTpName()

terminate

public void terminate()
               throws Lu62InternalErrorException
Terminates the conversation. This method terminates the internal thread and closes the conversation ABNORMALY if needed (if it is in RECEIVE state).

Throws:
Lu62InternalErrorException

toString

public java.lang.String toString()
Returns a visual representation of this object.

Returns:
java.lang.String - The object visual representation.

unregister

protected void unregister()
                   throws Lu62InternalErrorException
Unregisters conversations already registered for allocation.

Throws:
Lu62InternalErrorException

getClosedIssued

public boolean getClosedIssued()

Gets the closedIssued property (boolean) value.

Returns:
The closedIssued property value.

setClosedIssued

protected void setClosedIssued(boolean closedIssued)

Sets the closedIssued property (boolean) value.

Parameters:
closedIssued - The new value for the property.
See Also:
getClosedIssued()

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005