com.basis.bbj.bridge

Interface BBjBridgeRequest

public interface BBjBridgeRequest

BBjBridgeRequest is used to specify a program that is to be called by JavaBBjBridge, to pass parameters to that program and to provide data that can be read by that program from an ALIAS bbj channel.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all existing data including program name, program command-line parameters and any data that has been placed in request through calls to setBytes or put().
void	clearData() Clear all data placed in request through calls to setBytes or put().
boolean	getPersistOnTimeout()
boolean	isRecordOriented() Indicates whether this Request contains record-oriented data.
void	put(byte[] key, byte[] value) Create a key/value pair available to be read by the BBj program using record-oriented reads.
void	put(java.lang.String key, java.lang.String value) Create a key/value pair available to be read by the BBj program using record-oriented reads.
void	setBytes(byte[] p_bytes) setBytes() makes bytes available to be read by the BBj program using byte-oriented reads.
void	setPersistOnTimeout(boolean p_persist) used by BridgeServerInstance to inform heartStopped methods that it does not wish to disconnect on timeout
void	setProgramName(java.lang.String p_programName) Sets the name of the program to be run.
void	setProgramParameters(java.lang.String p_params) Sets command-line parameters to be provided to the program.

Method Detail

setProgramName

void setProgramName(java.lang.String p_programName)

Sets the name of the program to be run.

setProgramParameters

void setProgramParameters(java.lang.String p_params)

Sets command-line parameters to be provided to the program.

setBytes

void setBytes(byte[] p_bytes)
       throws java.lang.IllegalStateException

setBytes() makes bytes available to be read by the BBj program using byte-oriented reads.

NOTE that either but not both of the methods setBytes() and put() may be used to place data in the ALIASed channel.

Parameters:

p_bytes - The bytes that are to be available to the BBj program.

Throws:

java.lang.IllegalStateException - thrown if there has been a previous call to put().

put

void put(byte[] key,
         byte[] value)
  throws java.lang.IllegalStateException,
         BBjBridgeException

Create a key/value pair available to be read by the BBj program using record-oriented reads.

NOTE that either but not both of the methods setBytes() and put() may be used to place data in the ALIASed channel.

Parameters:

p_key - The key.

p_value - The value.

Throws:

java.lang.IllegalStateException - Thrown if there has been a previous call to setBytes().

BBjBridgeException

put

void put(java.lang.String key,
         java.lang.String value)
  throws java.lang.IllegalStateException,
         BBjBridgeException

Create a key/value pair available to be read by the BBj program using record-oriented reads.

NOTE that either but not both of the methods setBytes() and put() may be used to place data in the ALIASed channel.

Parameters:

p_key - The key.

p_value - The value.

Throws:

java.lang.IllegalStateException - Thrown if there has been a previous call to setBytes().

BBjBridgeException

isRecordOriented

boolean isRecordOriented()

Indicates whether this Request contains record-oriented data.

clear

void clear()

Clear all existing data including program name, program command-line parameters and any data that has been placed in request through calls to setBytes or put().

clearData

void clearData()

Clear all data placed in request through calls to setBytes or put(). It does not clear programName, configFile.

setPersistOnTimeout

void setPersistOnTimeout(boolean p_persist)

used by BridgeServerInstance to inform heartStopped methods that it does not wish to disconnect on timeout

getPersistOnTimeout

boolean getPersistOnTimeout()