A B C D E F G H I J L M N O P Q R S T U V W

A

Abort - Static variable in interface cl.obcom.netclient.Message.Reply

ABORT (or unrecoverable) reply code ["].

ACK - Static variable in interface cl.obcom.netclient.Message.Reply

ACK (or successful) reply code [#].

addField(int, String, int, int, String) - Method in class cl.obcom.netclient.Layout

Appends a new field to the collection of fields of this Layout.

ALPHA - Static variable in class cl.obcom.netclient.LayoutField

Alphanumeric layout field (A).

B

beginTransaction(String, Message) - Method in class cl.obcom.netclient.ServerChannel

Called before a transaction request is processed by processTransaction.

BootHost - Static variable in interface cl.obcom.netclient.Message.Label

NetServer boot host name [b].

Broadcast - Static variable in interface cl.obcom.netclient.Message.Oper

Broadcast message [3].

BroadcastEnc - Static variable in interface cl.obcom.netclient.Message.Oper

Encrypted broadcast message [C].

C

cancelTimer() - Method in class cl.obcom.netclient.ServerChannel

Cancels the execution of the processTimer method.

Ciphered - Static variable in interface cl.obcom.netclient.Message.Type

Encrypted data message [B].

CipherKey - Static variable in interface cl.obcom.netclient.Message.Type

Change cipher key message [K].

cl.obcom.netclient - package cl.obcom.netclient

Classes used to build client and server applications that communicate through OBCOM NetServer using normal or secure (TLS) connections.

clear() - Method in class cl.obcom.netclient.LayoutManager

Clears (removes) all layouts from the cache.

ClientChannel - Class in cl.obcom.netclient

Communication channel between a client application and the OBCOM NetServer.

ClientListener - Class in cl.obcom.netclient

Implements methods that are called when special events occurs to a ClientChannel object.

ClientListener() - Constructor for class cl.obcom.netclient.ClientListener

Constructs a new ClientListener instance.

ClientSlot - Class in cl.obcom.netclient

Implements a sub channel within a ClientChannel TCP/IP communication channel.

clone() - Method in class cl.obcom.netclient.Message

Returns a "deep" copy of this Message.

commitTransaction(String, Object) - Method in class cl.obcom.netclient.ServerChannel

Called after a transaction request has been successfuly processed by processTransaction.

compile(String) - Method in class cl.obcom.netclient.Layout

Compiles the given specification into a Layout.

compileEcu(String) - Method in class cl.obcom.netclient.Layout

Compiles an ECUSER specification into a Layout.

complete(String) - Method in class cl.obcom.netclient.Layout

Completes the definition of the collection of fields of this Layout.

Connect - Static variable in interface cl.obcom.netclient.Message.Oper

Server connect message [1].

connect(String, String) - Method in class cl.obcom.netclient.ServerChannel

Connects this ServerChannel to the NetServer specified by the supplied arguments.

connect(String, String, String) - Method in class cl.obcom.netclient.ServerChannel

Connects this ServerChannel to the NetServer specified by the supplied arguments.

connect(String, String, LayoutManager) - Method in class cl.obcom.netclient.ServerChannel

Connects this ServerChannel to the NetServer specified by the supplied arguments.

ConnectException - Exception in cl.obcom.netclient

Exception thrown when a connect operation fails.

ConnectException() - Constructor for exception cl.obcom.netclient.ConnectException

Constructs a new ConnectException with "null" as its detail message.

ConnectException(String) - Constructor for exception cl.obcom.netclient.ConnectException

Constructs a new ConnectException with the specified detail message.

ConnectException(Throwable) - Constructor for exception cl.obcom.netclient.ConnectException

Constructs a new ConnectException with the specified cause .

ConnectException(String, Throwable) - Constructor for exception cl.obcom.netclient.ConnectException

Constructs a new ConnectException with the specified detail message and cause.

CorrelationID - Static variable in interface cl.obcom.netclient.Message.Label

Correlation identification [Q].

Count - Static variable in interface cl.obcom.netclient.Message.Label

Total number of labels [75].

create(String, String, String) - Static method in class cl.obcom.netclient.ClientChannel

Returns a ClientChannel named channelName with netserURI and layoutsURI.

create(String, String, LayoutManager) - Static method in class cl.obcom.netclient.ClientChannel

Returns a ClientChannel named channelName with netserURI and layouts.

create(String, String, String, ClientListener) - Static method in class cl.obcom.netclient.ClientChannel

Returns a ClientChannel named channelName with netserURI, layoutsURI and listener.

create(String, String, LayoutManager, ClientListener) - Static method in class cl.obcom.netclient.ClientChannel

Returns a ClientChannel named channelName with netserURI, layouts and listener.

D

Data - Static variable in interface cl.obcom.netclient.Message.Type

Normal data message [ ].

DATE - Static variable in class cl.obcom.netclient.LayoutField

Date layout field (D).

DefaultHost - Static variable in interface cl.obcom.netclient.Message.Label

NetServer default host name [d].

delete(String) - Static method in class cl.obcom.netclient.ClientChannel

Deletes a ClientChannel named channelName.

disableMulticast(String) - Method in class cl.obcom.netclient.ClientSlot

Disables the reception of multicast messages identified by the specified name.

disableMulticast(String) - Method in class cl.obcom.netclient.ServerChannel

Disables the reception of multicast messages identified by the specified name.

E

enableMulticast(String, MulticastListener) - Method in class cl.obcom.netclient.ClientSlot

Enables the reception of multicast messages identified by the specified name.

enableMulticast(String) - Method in class cl.obcom.netclient.ServerChannel

Enables the reception of multicast messages identified by the specified name.

enableMulticast(String, MulticastListener) - Method in class cl.obcom.netclient.ServerChannel

Enables the reception of multicast messages identified by the specified name.

Encoding - Static variable in interface cl.obcom.netclient.Message.Label

Device message data encoding [X].

ErrorName - Static variable in interface cl.obcom.netclient.Message.Label

NetServer error name [E].

execute(String, String) - Method in class cl.obcom.netclient.ServerChannel

Starts the execution of this ServerChannel using the supplied arguments.

execute(String, String, String) - Method in class cl.obcom.netclient.ServerChannel

Starts the execution of this ServerChannel using the supplied arguments.

execute(String, String, LayoutManager) - Method in class cl.obcom.netclient.ServerChannel

Starts the execution of this ServerChannel using the supplied arguments.

exists(String) - Static method in class cl.obcom.netclient.ClientChannel

Returns true if a ClientChannel named channelName is defined.

exists(String) - Method in class cl.obcom.netclient.Layout

Returns true if the layout field indexed by the supplied name exists in this Layout.

exists(String) - Method in class cl.obcom.netclient.Message

Returns true if the field indexed by fieldName exists in the Layout of this Message.

F

FatalAndHold - Static variable in interface cl.obcom.netclient.Message.Oper

Fatal error and hold server message [X].

ForceMessage - Static variable in interface cl.obcom.netclient.Message.Prot

Force message for client [0].

ForceReboot - Static variable in interface cl.obcom.netclient.Message.Prot

Force reboot the client [3].

G

getAlwaysEncrypt() - Method in class cl.obcom.netclient.ClientChannel

Returns true if messages sent to the NetServer are always encrypted.

getAlwaysEncrypt() - Method in class cl.obcom.netclient.ClientSlot

Returns true if messages are always sent encrypted to OBCOM NetServer.

getChannel() - Method in class cl.obcom.netclient.ClientSlot

Returns the ClientChannel that owns this ClientSlot.

getChar(Message, int) - Method in class cl.obcom.netclient.LayoutField

Returns the first character of the value of the index occurence of this field stored in message.

getChar(String) - Method in class cl.obcom.netclient.Message

Returns the character value of the field identified by fieldName .

getChar(String, int) - Method in class cl.obcom.netclient.Message

Returns the character value of the field identified by fieldName and index.

getClientListener() - Method in class cl.obcom.netclient.ClientChannel

Returns the ClientListener associatted with this ClientChannel.

getData(Message, int) - Method in class cl.obcom.netclient.LayoutField

Returns the internal character sequence of the index occurence of this field in message.

getData() - Method in class cl.obcom.netclient.Message

Returns the text data of this Message with trailing space characters removed (right trimmed).

getData(String) - Method in class cl.obcom.netclient.Message

Returns the internal character sequence of the field identified by fieldName.

getData(String, int) - Method in class cl.obcom.netclient.Message

Returns the internal character sequence of the field identified by fieldName and index.

getDataAll() - Method in class cl.obcom.netclient.Message

Returns all text data of this Message.

getDataBytes() - Method in class cl.obcom.netclient.Message

Returns the binary data of this Message.

getDate(Message, int) - Method in class cl.obcom.netclient.LayoutField

Returns the date value of the index occurence of this field stored in message.

getDate(String) - Method in class cl.obcom.netclient.Message

Returns the date value of the field identified by fieldName.

getDate(String, int) - Method in class cl.obcom.netclient.Message

Returns the date value of the field identified by fieldName and index.

getDefault() - Method in class cl.obcom.netclient.LayoutField

Returns the default value of this LayoutField.

getDefaultSignANSI() - Static method in class cl.obcom.netclient.Message

Returns true if, by default, numeric fields are stored in messages using the ANSI mechanism.

getDefinedDefault() - Method in class cl.obcom.netclient.LayoutField

Returns the defined default value of this LayoutField.

getDouble(Message, int) - Method in class cl.obcom.netclient.LayoutField

Returns the double value of the index occurence of this field stored in message.

getDouble(String) - Method in class cl.obcom.netclient.Message

Returns the double value of the field identified by fieldName.

getDouble(String, int) - Method in class cl.obcom.netclient.Message

Returns the double value of the field identified by fieldName and index.

getField(String) - Method in class cl.obcom.netclient.Layout

Returns the layout field indexed by the supplied name.

getField(String) - Method in class cl.obcom.netclient.Message

Returns the field identified by fieldName.

getFormCode() - Method in class cl.obcom.netclient.Message

Returns the form code of this Message.

getID() - Method in class cl.obcom.netclient.ClientSlot

Returns the ID of this ClientSlot.

getInteger(Message, int) - Method in class cl.obcom.netclient.LayoutField

Returns the integer value of the index occurence of this field stored in message.

getInteger(String) - Method in class cl.obcom.netclient.Message

Returns the integer value of the field identified by fieldName.

getInteger(String, int) - Method in class cl.obcom.netclient.Message

Returns the integer value of the field identified by fieldName and index.

getLabel(int) - Method in class cl.obcom.netclient.Message

Returns the string value of the label identified by key.

getLayout(String) - Method in class cl.obcom.netclient.ClientChannel

Returns the layout identified by the supplied layoutName.

getLayout(String) - Method in class cl.obcom.netclient.ClientSlot

Returns the message layout identified by the supplied layoutName.

getLayout(String) - Method in class cl.obcom.netclient.LayoutManager

Returns a Layout with the specified name.

getLayout() - Method in class cl.obcom.netclient.Message

Returns the current layout of this Message.

getLayout(String) - Method in class cl.obcom.netclient.ServerChannel

Returns the message layout identified by the supplied name.

getLayoutManager() - Method in class cl.obcom.netclient.ClientChannel

Returns the LayoutManager associatted with this ClientChannel.

getLayoutManager() - Method in class cl.obcom.netclient.ClientSlot

Returns the LayoutManager associatted with this ClientSlot.

getLayoutManager() - Method in class cl.obcom.netclient.ServerChannel

Returns the LayoutManager in use by this ServerChannel.

getLength() - Method in class cl.obcom.netclient.Layout

Returns the sum of the sizes of all the fields of this Layout.

getLength() - Method in class cl.obcom.netclient.LayoutField

Returns the length of this LayoutField.

getMaxLabelKey() - Method in class cl.obcom.netclient.Message

Returns the maximum label key of all Message labels.

getMessage() - Method in class cl.obcom.netclient.ServerEvent

Returns the message of this ServerEvent.

getMetaServerPID() - Method in class cl.obcom.netclient.ServerChannel

Returns the MetaServer Process ID of this ServerChannel.

getMinLabelKey() - Method in class cl.obcom.netclient.Message

Returns the minimum label key of all Message labels.

getMulticastName() - Method in class cl.obcom.netclient.Message

Returns the multicast name of this Message.

getName() - Method in class cl.obcom.netclient.ClientChannel

Returns the name of this ClientChannel.

getName() - Method in class cl.obcom.netclient.ClientSlot

Returns the name of this ClientSlot.

getName() - Method in class cl.obcom.netclient.Layout

Returns the name of this Layout.

getName() - Method in class cl.obcom.netclient.LayoutField

Returns the name of this LayoutField.

getName() - Method in class cl.obcom.netclient.ServerChannel

Returns the name of this ServerChannel.

getName() - Method in class cl.obcom.netclient.ServerEvent

Returns the name of the transaction or multicast message.

getNetServerHost() - Method in class cl.obcom.netclient.ServerChannel

Returns the NetServer host address (name or IP number).

getNetServerPort() - Method in class cl.obcom.netclient.ServerChannel

Returns the NetServer port number.

getNetServerURI() - Method in class cl.obcom.netclient.ClientChannel

Returns the NetServer URI (protocol, host and port).

getNetServerURI() - Method in class cl.obcom.netclient.ServerChannel

Returns the NetServer URI (protocol, host and port).

getNumber(Message, int) - Method in class cl.obcom.netclient.LayoutField

Returns the decimal value of the index occurence of this field stored in message.

getNumber(String) - Method in class cl.obcom.netclient.Message

Returns the decimal value of the field identified by fieldName.

getNumber(String, int) - Method in class cl.obcom.netclient.Message

Returns the decimal value of the field identified by fieldName and index.

getOccurs() - Method in class cl.obcom.netclient.LayoutField

Returns the number of occurrences of this LayoutField.

getOccurs(String) - Method in class cl.obcom.netclient.Message

Returns the number of occurrences of the field identified by fieldName.

getOffset(int) - Method in class cl.obcom.netclient.LayoutField

Returns the offset position of the index occurence of this field in the Message or it's parent list.

getOperCode() - Method in class cl.obcom.netclient.Message

Returns the operation code of the Message (Message.Oper).

getParent() - Method in class cl.obcom.netclient.LayoutField

Returns the list field that contains this LayoutField.

getProtCode() - Method in class cl.obcom.netclient.Message

Returns the protection code of this Message (Message.Prot).

getReplyCode() - Method in class cl.obcom.netclient.Message

Returns the reply code of this Message (Message.Reply).

getReplyMissing() - Method in class cl.obcom.netclient.ServerChannel

Returns true if no reply message has been sent for the current transaction.

getRunnable() - Method in class cl.obcom.netclient.ServerEvent

Returns the runnable of this ServerEvent.

getScale() - Method in class cl.obcom.netclient.LayoutField

Returns the numeric scale of this LayoutField.

getSequence() - Method in class cl.obcom.netclient.Message

Returns the sequence number of the Message.

getServerCode() - Method in class cl.obcom.netclient.Message

Returns the server code of this Message.

getSessionID() - Method in class cl.obcom.netclient.Message

Returns the session ID of this Message.

getSessionID() - Method in class cl.obcom.netclient.ServerChannel

Returns the session ID of this ServerChannel.

getSignANSI() - Method in class cl.obcom.netclient.Message

Returns true if numeric fields are stored in this Message using the ANSI mechanism.

getSignature() - Method in class cl.obcom.netclient.Layout

Returns the signature (or checksum) of this Layout.

getStationKey() - Method in class cl.obcom.netclient.ClientChannel

Returns the station key of this ClientChannel.

getString(Message, int) - Method in class cl.obcom.netclient.LayoutField

Returns the string value of the index occurence of this field stored in message.

getString(String) - Method in class cl.obcom.netclient.Message

Returns the string value of the field identified by fieldName.

getString(String, int) - Method in class cl.obcom.netclient.Message

Returns the string value of the field identified by fieldName and index.

getTimeout() - Method in class cl.obcom.netclient.ServerChannel

Returns the server's event timeout in milliseconds.

getTimestamp() - Method in class cl.obcom.netclient.ClientSlot

Returns an OBCOM NetServer timestamp.

getTimestamp() - Method in class cl.obcom.netclient.ServerChannel

Returns an NetServer timestamp.

getTranBootHost() - Method in class cl.obcom.netclient.ServerChannel

Returns the boot host name of the current transaction.

getTranClientName() - Method in class cl.obcom.netclient.ServerChannel

Returns the client name of the current transaction.

getTranCode() - Method in class cl.obcom.netclient.Message

Returns the transaction code of this Message.

getTranDefaultHost() - Method in class cl.obcom.netclient.ServerChannel

Returns the default host name of the current transaction.

getTranLocalHost() - Method in class cl.obcom.netclient.ServerChannel

Returns the local host name of the current transaction.

getTranOriginator() - Method in class cl.obcom.netclient.ServerChannel

Returns the originator name of the current transaction.

getTranOriginatorSession() - Method in class cl.obcom.netclient.ServerChannel

Returns the originator session name of the current transaction.

getTranOriginatorStation() - Method in class cl.obcom.netclient.ServerChannel

Returns the originator station name of the current transaction.

getTranProcessName() - Method in class cl.obcom.netclient.ServerChannel

Returns the process name of the current transaction.

getTranSecurityHost() - Method in class cl.obcom.netclient.ServerChannel

Returns the security host name of the current transaction.

getTranSequence() - Method in class cl.obcom.netclient.ServerChannel

Returns the sequence code of the current transaction.

getTranSessionID() - Method in class cl.obcom.netclient.ServerChannel

Returns the session ID of the current transaction.

getTranTimestamp() - Method in class cl.obcom.netclient.ServerChannel

Returns the timestamp of the current transaction.

getType() - Method in class cl.obcom.netclient.LayoutField

Returns the type code of this LayoutField.

getType() - Method in class cl.obcom.netclient.Message

Returns the type of the Message (Message.Type).

getType() - Method in class cl.obcom.netclient.ServerEvent

Returns the type of this ServerEvent.

getURI() - Method in class cl.obcom.netclient.LayoutManager

Returns the Uniform Resource Identifier (URI) of this LayoutManager.

getVersion() - Method in class cl.obcom.netclient.ClientChannel

Returns the implementation version of this ClientChannel.

getVersion() - Method in class cl.obcom.netclient.ServerChannel

Returns the implementation version of this ServerChannel.

GsLocation - Static variable in interface cl.obcom.netclient.Message.Label

Message group separator location [G].

H

hasLabel(int) - Method in class cl.obcom.netclient.Message

Returns true if the label indexed by key exists.

Hello - Static variable in interface cl.obcom.netclient.Message.Type

Client initialization message [N].

HostName - Static variable in interface cl.obcom.netclient.Message.Label

NetServer host name [H].

HostTransaction - Static variable in interface cl.obcom.netclient.Message.Oper

Host transaction message [9].

I

INIT - Static variable in class cl.obcom.netclient.ServerEvent

Successfully connected to NetServer [8].

initFields() - Method in class cl.obcom.netclient.Message

Set the value of each field of this Message to its default value.

initFields(Message) - Method in class cl.obcom.netclient.Message

Set the value of each field of this Message to the value of its corresponding field in source.

isAlive() - Method in class cl.obcom.netclient.ClientChannel

Returns true if this ClientChannel is alive.

isAlive() - Method in class cl.obcom.netclient.ClientSlot

Returns true if this ClientSlot is alive.

isComplete() - Method in class cl.obcom.netclient.Layout

Returns true if this Layout is complete.

isDataOnly() - Method in class cl.obcom.netclient.Message

Returns true if this is a data-only Message.

isNull(Message, int) - Method in class cl.obcom.netclient.LayoutField

Returns true is the data of the index occurence of this field stored in message is NULL.

isNull(String) - Method in class cl.obcom.netclient.Message

Returns true if the value of the field identified by fieldName is NULL.

isNull(String, int) - Method in class cl.obcom.netclient.Message

Returns true if the value of the field identified by fieldName and index is NULL.

isStrict() - Method in class cl.obcom.netclient.Message

Returns true if this Message is strict.

iterator() - Method in class cl.obcom.netclient.Layout

Returns a "read-only" iterator over the collection of fields in this Layout.

iterator() - Method in class cl.obcom.netclient.LayoutManager

Returns a "read-only" iterator over the collection of layouts in this LayoutManager.

J

JobID - Static variable in interface cl.obcom.netclient.Message.Label

NetServer job identification [J].

L

Layout - Class in cl.obcom.netclient

Defines a collection of data items (fields) whose values can be stored in a Message.

Layout() - Constructor for class cl.obcom.netclient.Layout

Creates a new Layout instance.

Layout(String) - Constructor for class cl.obcom.netclient.Layout

Creates a new Layout with the given name.

LayoutChecksum - Static variable in interface cl.obcom.netclient.Message.Label

Message layout checksum [K].

LayoutField - Class in cl.obcom.netclient

Defines the properties of a data item whose value can be stored in a Message.

LayoutManager - Class in cl.obcom.netclient

Implements a collection (cache) of reusable Layout instances.

LayoutManager(String) - Constructor for class cl.obcom.netclient.LayoutManager

Creates a new LayoutManager for the specified Uniform Resource Identifier (URI).

LayoutName - Static variable in interface cl.obcom.netclient.Message.Label

Message layout name [F].

LayoutSignature - Static variable in interface cl.obcom.netclient.Message.Label

Message layout signature [M].

LIST - Static variable in class cl.obcom.netclient.LayoutField

List layout field (LB).

LISTEND - Static variable in class cl.obcom.netclient.LayoutField

End-of-list pseudo layout field (LE).

loadProperties(String) - Static method in class cl.obcom.netclient.ClientChannel

Returns the properties contained in the file fileName.

loadProperties(String) - Static method in class cl.obcom.netclient.ServerChannel

Returns the properties contained in the file fileName.

LocalHost - Static variable in interface cl.obcom.netclient.Message.Label

NetServer local host name [l].

lookup(String) - Static method in class cl.obcom.netclient.ClientChannel

Returns a ClientChannel named channelName, or null if the ClientChannel is not defined.

M

MaxKey - Static variable in interface cl.obcom.netclient.Message.Label

Maximum label key value [z].

Message - Class in cl.obcom.netclient

Used to exchange information with a NetServer.

Message() - Constructor for class cl.obcom.netclient.Message

Creates a new Message instance with zero length data.

Message(String) - Constructor for class cl.obcom.netclient.Message

Creates a new Message with the supplied data.

Message - Static variable in interface cl.obcom.netclient.Message.Prot

Message for client [4].

Message.Label - Interface in cl.obcom.netclient

Defines the possible labels of a Message.

Message.Oper - Interface in cl.obcom.netclient

Defines the operation codes of a Message.

Message.Prot - Interface in cl.obcom.netclient

Defines the protection codes of a Message.

Message.Reply - Interface in cl.obcom.netclient

Defines the reply codes of a Message.

Message.Type - Interface in cl.obcom.netclient

Defines the possible types of a Message.

MinKey - Static variable in interface cl.obcom.netclient.Message.Label

Minimum label key value [0].

Multicast - Static variable in interface cl.obcom.netclient.Message.Oper

Multicast message [U].

MULTICAST - Static variable in class cl.obcom.netclient.ServerEvent

Received a multicast message [9].

MulticastChat - Static variable in interface cl.obcom.netclient.Message.Label

Multicast chat group name [7].

MulticastClass - Static variable in interface cl.obcom.netclient.Message.Label

Multicast class name [1].

MulticastClient - Static variable in interface cl.obcom.netclient.Message.Label

Multicast client name [5].

MulticastEnc - Static variable in interface cl.obcom.netclient.Message.Oper

Multicast message with encryption [Z].

MulticastGroup - Static variable in interface cl.obcom.netclient.Message.Label

Multicast group name [2].

MulticastListener - Interface in cl.obcom.netclient

Listener interface for receiving multicast messages.

MulticastPriority - Static variable in interface cl.obcom.netclient.Message.Label

Multicast priority [4].

MulticastQueue - Static variable in interface cl.obcom.netclient.Message.Label

Multicast queue name [3].

MulticastUser - Static variable in interface cl.obcom.netclient.Message.Label

Multicast user name [6].

N

NAK - Static variable in interface cl.obcom.netclient.Message.Reply

NAK (or unsuccessful) reply code [$].

NetException - Exception in cl.obcom.netclient

Exception thrown when an error of some sort has occurred.

NetException() - Constructor for exception cl.obcom.netclient.NetException

Constructs a new NetException with "null" as its detail message.

NetException(String) - Constructor for exception cl.obcom.netclient.NetException

Constructs a new NetException with the specified detail message.

NetException(Throwable) - Constructor for exception cl.obcom.netclient.NetException

Constructs a new NetException with the specified cause .

NetException(String, Throwable) - Constructor for exception cl.obcom.netclient.NetException

Constructs a new NetException with the specified detail message and cause.

newSlot() - Method in class cl.obcom.netclient.ClientChannel

Returns a new ClientSlot for this ClientChannel.

NUMERIC - Static variable in class cl.obcom.netclient.LayoutField

Unsigned number layout field (N).

O

OneWay - Static variable in interface cl.obcom.netclient.Message.Oper

One-way message [Y].

OneWayListener - Interface in cl.obcom.netclient

Listener interface for receiving one-way messages.

OpenCiphered - Static variable in interface cl.obcom.netclient.Message.Type

Open encrypted data message [b].

OPERATOR_REPLY - Static variable in class cl.obcom.netclient.ServerEvent

Received a reply message of an operator transaction [10].

OperatorReply - Static variable in interface cl.obcom.netclient.Message.Oper

Operator reply message [9].

P

Poll - Static variable in interface cl.obcom.netclient.Message.Type

Poll data message [E].

PollAck - Static variable in interface cl.obcom.netclient.Message.Type

Poll ACK data message [A].

processConnect(ClientChannel) - Method in class cl.obcom.netclient.ClientListener

Called after a ClientChannel has connected to an NetServer.

processCreate(ClientChannel) - Method in class cl.obcom.netclient.ClientListener

Called after a ClientChannel is created.

processDisconnect(ClientChannel) - Method in class cl.obcom.netclient.ClientListener

Called after a ClientChannel has disconnected from an NetServer.

processDispose(ClientChannel) - Method in class cl.obcom.netclient.ClientListener

Called after a ClientChannel is disposed and can no longer be used.

processHalt() - Method in class cl.obcom.netclient.ServerChannel

Called when a halt message is received from the NetServer.

ProcessID - Static variable in interface cl.obcom.netclient.Message.Label

NetServer process identification [P].

processInit(boolean) - Method in class cl.obcom.netclient.ServerChannel

Called when an initialize or reinitialize message is received from the NetServer.

processMulticast(String, Message) - Method in interface cl.obcom.netclient.MulticastListener

Called when a multicast message is received from the NetServer.

processMulticast(String, Message) - Method in class cl.obcom.netclient.ServerChannel

Called when a multicast message is received from the NetServer.

ProcessName - Static variable in interface cl.obcom.netclient.Message.Label

NetServer process name [p].

processOneWay(String, Message) - Method in interface cl.obcom.netclient.OneWayListener

Called when a one-way message is received.

processOneWay(String, Message) - Method in class cl.obcom.netclient.ServerChannel

Called when a one-way message is received.

processReply(int, Message, Object) - Method in interface cl.obcom.netclient.ReplyListener

Called when an asynchronous transaction reply message is received from the NetServer.

processReply(int, Message, Object) - Method in class cl.obcom.netclient.ServerChannel

Called when an asynchronous transaction reply message is received from the NetServer.

processTimeout() - Method in class cl.obcom.netclient.ServerChannel

Called when a timeout event occurs.

processTimer() - Method in class cl.obcom.netclient.ServerChannel

Called when a timer event occurs.

processTimer() - Method in interface cl.obcom.netclient.TimerListener

Called when a timer event occurs.

processTransaction(String, Message) - Method in class cl.obcom.netclient.ServerChannel

Called when a transaction request message is received from the NetServer.

processTransaction(String, Message) - Method in interface cl.obcom.netclient.TransactionListener

Called when a transaction message is received from the NetServer.

putLayout(Layout) - Method in class cl.obcom.netclient.LayoutManager

Adds a layout to the collection of layouts of this LayoutManager.

Q

Quit - Static variable in interface cl.obcom.netclient.Message.Oper

Stop server message [5].

QUIT - Static variable in class cl.obcom.netclient.ServerEvent

Received a quit (halt) command [2].

R

ReadException - Exception in cl.obcom.netclient

Exception thrown when a read operation fails.

ReadException() - Constructor for exception cl.obcom.netclient.ReadException

Constructs a new ReadException with "null" as its detail message.

ReadException(String) - Constructor for exception cl.obcom.netclient.ReadException

Constructs a new ReadException with the specified detail message.

ReadException(Throwable) - Constructor for exception cl.obcom.netclient.ReadException

Constructs a new ReadException with the specified cause.

ReadException(String, Throwable) - Constructor for exception cl.obcom.netclient.ReadException

Constructs a new ReadException with the specified detail message and cause.

Reboot - Static variable in interface cl.obcom.netclient.Message.Prot

Reboot the client [$].

RebootGranted - Static variable in interface cl.obcom.netclient.Message.Prot

Reboot permission granted [5].

registerTransaction(String, TransactionListener) - Method in class cl.obcom.netclient.ServerChannel

Registers a listener for transactions identified by name.

Reinit - Static variable in interface cl.obcom.netclient.Message.Oper

Reinit server message [R].

REINIT - Static variable in class cl.obcom.netclient.ServerEvent

Received a reinitialize command [6].

release() - Method in class cl.obcom.netclient.ClientSlot

Releases this ClientSlot and free allocated resources.

ReleaseHold - Static variable in interface cl.obcom.netclient.Message.Oper

Release server hold message [7].

releaseHold() - Method in class cl.obcom.netclient.ServerChannel

Releases the hold on this server so it can continue to receive messages.

removeLabel(int) - Method in class cl.obcom.netclient.Message

Removes the label identified by key from this Message.

removeLabels() - Method in class cl.obcom.netclient.Message

Removes all the labels defined in this Message.

replace(int, int, String) - Method in class cl.obcom.netclient.Message

Replaces the characters in a substring of the message data with characters in the specified String.

Reply - Static variable in interface cl.obcom.netclient.Message.Oper

Reply message [2].

REPLY - Static variable in class cl.obcom.netclient.ServerEvent

Received a reply message of an asynchronous transaction [5].

ReplyAndHold - Static variable in interface cl.obcom.netclient.Message.Oper

Reply and hold the server message [6].

ReplyEnc - Static variable in interface cl.obcom.netclient.Message.Oper

Encrypted reply message [B].

ReplyListener - Interface in cl.obcom.netclient

Listener interface for receiving reply messages.

rollbackTransaction(String, Object, Exception) - Method in class cl.obcom.netclient.ServerChannel

Called when an exception is thrown while processing a transaction.

runAsync(Runnable) - Method in class cl.obcom.netclient.ServerChannel

Submits a runnable for later execution on the server's thread.

RUNNABLE - Static variable in class cl.obcom.netclient.ServerEvent

A runnable for asynchronous execution has been submitted [51].

RUT - Static variable in class cl.obcom.netclient.LayoutField

RUT layout field (R).

S

SecurityHost - Static variable in interface cl.obcom.netclient.Message.Label

NetServer security host name [s].

sendAckReply(Object) - Method in class cl.obcom.netclient.ServerChannel

Sends a transaction reply message with an ACK code, indicating successful completion.

sendConsole(String) - Method in class cl.obcom.netclient.ServerChannel

Sends a console command to the NetServer.

sendError(String, String) - Method in class cl.obcom.netclient.ServerChannel

Sends an error report message to the NetServer.

sendMulticast(String, Object) - Method in class cl.obcom.netclient.ServerChannel

Sends a multicast message to the NetServer.

sendMulticast(String, Object, boolean) - Method in class cl.obcom.netclient.ServerChannel

Sends an multicast message to the NetServer.

sendNakReply(Object) - Method in class cl.obcom.netclient.ServerChannel

Sends a transaction reply message with a NAK code, indicating unsuccessful completion.

sendOneWay(String, Object) - Method in class cl.obcom.netclient.ServerChannel

Sends a one-way message to the named destination with encryption.

sendOperator(String) - Method in class cl.obcom.netclient.ServerChannel

Sends a operator command to the NetServer.

sendReply(Object, int) - Method in class cl.obcom.netclient.ServerChannel

Sends a transaction reply message with the supplied replyCode.

sendReply(Object, int, boolean) - Method in class cl.obcom.netclient.ServerChannel

Sends a transaction reply message with the supplied replyCode and required server hold state.

sendRequest(String, Object) - Method in class cl.obcom.netclient.ServerChannel

Sends an asynchronous transaction to the specified service with supplied request data.

sendRequest(String, Object, ReplyListener) - Method in class cl.obcom.netclient.ServerChannel

Sends an asynchronous transaction to the specified service with supplied request data and listener.

sendRequest(String, Object, ReplyListener, Object) - Method in class cl.obcom.netclient.ServerChannel

Sends an asynchronous transaction to the specified service with supplied request data, listener and context.

sendTransaction(String, Object) - Method in class cl.obcom.netclient.ClientSlot

Sends a transaction request to a service using the supplied request data.

sendTransaction(String, Object, boolean) - Method in class cl.obcom.netclient.ClientSlot

Sends a transaction request to a service using the supplied request data and encryption option.

sendTransaction(String, Object, boolean, boolean) - Method in class cl.obcom.netclient.ClientSlot

Sends a transaction request to a service using the supplied request data, encryption and signature options.

sendTransaction(String, Object, boolean, boolean, long) - Method in class cl.obcom.netclient.ClientSlot

Sends a transaction request to a service using the supplied request data, encryption, signature and timeout options.

sendTransaction(String, Object) - Method in class cl.obcom.netclient.ServerChannel

Sends an synchronous transaction request to the specified service using the supplied request data.

sendTransaction(String, Object, long) - Method in class cl.obcom.netclient.ServerChannel

Sends an synchronous transaction request to the specified service using the supplied request data and timeout option.

serialize() - Method in class cl.obcom.netclient.Message

Returns a serialized version of this Message.

serialize(boolean) - Method in class cl.obcom.netclient.Message

Returns a serialized version of this Message with optional type code.

ServerChannel - Class in cl.obcom.netclient

Communication channel between a server application and the OBCOM NetServer.

ServerChannel() - Constructor for class cl.obcom.netclient.ServerChannel

Constructs a new ServerChannel instance.

ServerEvent - Class in cl.obcom.netclient

Provides information associatted with a ServerChannel event.

ServerEvent() - Constructor for class cl.obcom.netclient.ServerEvent

Creates a new ServerEvent instance.

ServerName - Static variable in interface cl.obcom.netclient.Message.Label

NetServer name [e].

SessionID - Static variable in interface cl.obcom.netclient.Message.Oper

Session ID message [8].

setAlwaysEncrypt(boolean) - Method in class cl.obcom.netclient.ClientChannel

Changes whether messages sent to the NetServer are always encrypted.

setAlwaysEncrypt(boolean) - Method in class cl.obcom.netclient.ClientSlot

Changes whether messages are always sent encrypted to OBCOM NetServer.

setChar(Message, int, char) - Method in class cl.obcom.netclient.LayoutField

Updates the character value of the index occurence of this field stored in message.

setChar(String, char) - Method in class cl.obcom.netclient.Message

Updates the character value of the field identified by fieldName.

setChar(String, int, char) - Method in class cl.obcom.netclient.Message

Updates the character value of the field identified by fieldName and index.

setData(Message, int, String) - Method in class cl.obcom.netclient.LayoutField

Updates the internal character sequence of the index occurence of this field in message.

setData(String) - Method in class cl.obcom.netclient.Message

Changes the text data of this Message.

setData(String, String) - Method in class cl.obcom.netclient.Message

Updates the internal character sequence of the field identified by fieldName.

setData(String, int, String) - Method in class cl.obcom.netclient.Message

Updates the internal character sequence of the field identified by fieldName and index.

setDataBytes(byte[]) - Method in class cl.obcom.netclient.Message

Changes the binary data of this Message.

setDataOnly(boolean) - Method in class cl.obcom.netclient.Message

Changes whether this is a data-only Message.

setDate(Message, int, Date) - Method in class cl.obcom.netclient.LayoutField

Updates the date value of the index occurence of this field stored in message.

setDate(String, Date) - Method in class cl.obcom.netclient.Message

Updates the date value of the field identified by fieldName.

setDate(String, int, Date) - Method in class cl.obcom.netclient.Message

Updates the date value of the field identified by fieldName and index.

setDefault(Message, int) - Method in class cl.obcom.netclient.LayoutField

Updates the value of the index occurence of this field in message to its default value.

setDefaultSignANSI(boolean) - Static method in class cl.obcom.netclient.Message

Defines if, by default, numeric fields are stored in messages using the ANSI or the TANDEM mechanism.

setDouble(Message, int, double) - Method in class cl.obcom.netclient.LayoutField

Updates the double value of the index occurence of this field stored in message.

setDouble(String, double) - Method in class cl.obcom.netclient.Message

Updates the double value of the field identified by fieldName.

setDouble(String, int, double) - Method in class cl.obcom.netclient.Message

Updates the double value of the field identified by fieldName and index.

setFormCode(int) - Method in class cl.obcom.netclient.Message

Changes the form code of this Message.

setInteger(Message, int, int) - Method in class cl.obcom.netclient.LayoutField

Updates the integer value of the index occurence of this field stored in message.

setInteger(String, int) - Method in class cl.obcom.netclient.Message

Updates the integer value of the field identified by fieldName.

setInteger(String, int, int) - Method in class cl.obcom.netclient.Message

Updates the integer value of the field identified by fieldName and index.

setLabel(int, String) - Method in class cl.obcom.netclient.Message

Changes the string value of the label identified by key.

setLayout(Layout) - Method in class cl.obcom.netclient.Message

Changes the layout of this Message.

setNull(Message, int) - Method in class cl.obcom.netclient.LayoutField

Updates the data value of the index occurence of this field with the NULL value.

setNull(String) - Method in class cl.obcom.netclient.Message

Updates the value of the field identified by fieldName to NULL.

setNull(String, int) - Method in class cl.obcom.netclient.Message

Changes the value of the field identified by fieldName and index to NULL.

setNumber(Message, int, BigDecimal) - Method in class cl.obcom.netclient.LayoutField

Updates the decimal value of the index occurence of this field stored in message.

setNumber(String, BigDecimal) - Method in class cl.obcom.netclient.Message

Updates the decimal value of the field identified by fieldName.

setNumber(String, int, BigDecimal) - Method in class cl.obcom.netclient.Message

Updates the decimal value of the field identified by fieldName and index.

setOperCode(int) - Method in class cl.obcom.netclient.Message

Changes the operation code of the Message (Message.Oper).

setProtCode(int) - Method in class cl.obcom.netclient.Message

Changes the protection code of this Message (Message.Prot).

setReplyCode(int) - Method in class cl.obcom.netclient.Message

Changes the reply code of this Message (Message.Reply).

setSequence(int) - Method in class cl.obcom.netclient.Message

Changes the sequence number of the Message.

setServerCode(int) - Method in class cl.obcom.netclient.Message

Changes the server code of this Message.

setSessionID(int) - Method in class cl.obcom.netclient.Message

Changes the session ID of this Message.

setSignANSI(boolean) - Method in class cl.obcom.netclient.Message

Defines whether numeric fields are stored in this Message using the ANSI or the TANDEM mechanism.

setStrict(boolean) - Method in class cl.obcom.netclient.Message

Defines whether this Message is strict or not strict.

setString(Message, int, String) - Method in class cl.obcom.netclient.LayoutField

Updates the string value of the index occurence of this field stored in message.

setString(String, String) - Method in class cl.obcom.netclient.Message

Updates the string value of the field identified by fieldName.

setString(String, int, String) - Method in class cl.obcom.netclient.Message

Updates the string value of the field identified by fieldName and index.

setTimeout(long) - Method in class cl.obcom.netclient.ServerChannel

Changes the server's event timeout.

setTranCode(int) - Method in class cl.obcom.netclient.Message

Changes the transaction code of this Message.

setType(int) - Method in class cl.obcom.netclient.Message

Changes the type of the Message (Message.Type).

Shutdown - Static variable in interface cl.obcom.netclient.Message.Prot

Shutdown the client [1].

Signature - Static variable in interface cl.obcom.netclient.Message.Label

Message digital signature [f].

SIGNED - Static variable in class cl.obcom.netclient.LayoutField

Signed number layout field (S).

startTimer(long) - Method in class cl.obcom.netclient.ServerChannel

Schedules the execution of the processTimer method of this ServerChannel at approximately regular intervals separated by period.

startTimer(long, TimerListener) - Method in class cl.obcom.netclient.ServerChannel

Schedules the execution of the processTimer method of the supplied listener at approximately regular intervals separated by period.

stop() - Method in class cl.obcom.netclient.ServerChannel

Stops the execution of this ServerChannel.

substring(int, int) - Method in class cl.obcom.netclient.Message

Returns a new string that is a substring of this Message.

T

TEXT - Static variable in class cl.obcom.netclient.LayoutField

Text layout field (X).

TIMEOUT - Static variable in class cl.obcom.netclient.ServerEvent

Timeout expired while waiting for an event [11].

TimeoutException - Exception in cl.obcom.netclient

Exception thrown when a blocking operation times out.

TimeoutException() - Constructor for exception cl.obcom.netclient.TimeoutException

Constructs a new TimeoutException with "null" as its detail message.

TimeoutException(String) - Constructor for exception cl.obcom.netclient.TimeoutException

Constructs a new TimeoutException with the specified detail message.

TimeoutException(Throwable) - Constructor for exception cl.obcom.netclient.TimeoutException

Constructs a new TimeoutException with the specified cause.

TimeoutException(String, Throwable) - Constructor for exception cl.obcom.netclient.TimeoutException

Constructs a new TimeoutException with the specified detail message and cause.

TIMER - Static variable in class cl.obcom.netclient.ServerEvent

The server's timer interval period expired [50].

TimerListener - Interface in cl.obcom.netclient

Listener interface for receiving timer events.

toMessage(Object) - Static method in class cl.obcom.netclient.Message

Converts the supplied object value to a Message.

toString() - Method in class cl.obcom.netclient.Layout

Creates and returns a string serialization of this Layout.

toString() - Method in class cl.obcom.netclient.Message

Returns a string representation of this Message.

toTagString(String) - Method in class cl.obcom.netclient.Message

Returns a string with the TAG representation of the data stored in this Message.

toXml(boolean) - Method in class cl.obcom.netclient.Message

Returns the XML string representation of the data stored in this Message.

TranClient - Static variable in interface cl.obcom.netclient.Message.Label

Transaction client name [C].

TranName - Static variable in interface cl.obcom.netclient.Message.Label

Transaction name [T].

TranOriginator - Static variable in interface cl.obcom.netclient.Message.Label

Transaction originator station [o].

Transaction - Static variable in interface cl.obcom.netclient.Message.Oper

Transaction message [ ].

TRANSACTION - Static variable in class cl.obcom.netclient.ServerEvent

Received a transaction message [7].

TransactionEnc - Static variable in interface cl.obcom.netclient.Message.Oper

Encrypted transaction message [E].

TransactionListener - Interface in cl.obcom.netclient

Listener interface for receiving transaction messages.

TranServer - Static variable in interface cl.obcom.netclient.Message.Label

Transaction server name [S].

TranTimestamp - Static variable in interface cl.obcom.netclient.Message.Label

Transaction timestamp [t].

U

UniqueID - Static variable in interface cl.obcom.netclient.Message.Label

NetServer unique identification [U].

unregisterTransaction(String) - Method in class cl.obcom.netclient.ServerChannel

Unregisters the transaction listener identified by name.

unserialize(byte[], int, int) - Static method in class cl.obcom.netclient.Message

Creates a new Message by unserializing the supplied byte array.

unserialize(byte[], int, int, boolean) - Static method in class cl.obcom.netclient.Message

Creates a new Message by unserializing the supplied byte array with optional type code.

User1 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code one [%].

User2 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code two [&].

User3 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code three ['].

User4 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code four [(].

User5 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code five [)].

User6 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code six [*].

User7 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code seven [+].

User8 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code eight [,].

User9 - Static variable in interface cl.obcom.netclient.Message.Reply

User-defined reply code nine [-].

V

verifyLayout(String) - Method in class cl.obcom.netclient.Message

Verifies that the name of the layout of this Message matches the supplied layoutName.

Version - Static variable in interface cl.obcom.netclient.Message.Label

NetServer library version [V].

W

waitForEvent(ServerEvent, long) - Method in class cl.obcom.netclient.ServerChannel

Blocks waiting for the next server event or until a specified amount of time has elapsed.

Window - Static variable in interface cl.obcom.netclient.Message.Label

NetServer window [W].

WriteException - Exception in cl.obcom.netclient

Exception thrown when a write operation fails.

WriteException() - Constructor for exception cl.obcom.netclient.WriteException

Constructs a new WriteException with "null" as its detail message.

WriteException(String) - Constructor for exception cl.obcom.netclient.WriteException

Constructs a new WriteException with the specified detail message.

WriteException(Throwable) - Constructor for exception cl.obcom.netclient.WriteException

Constructs a new WriteException with the specified cause.

WriteException(String, Throwable) - Constructor for exception cl.obcom.netclient.WriteException

Constructs a new WriteException with the specified detail message and cause.

A B C D E F G H I J L M N O P Q R S T U V W