Package com.progress.open4gl.broker

Interface Broker

public interface Broker

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ABNORMAL_EOF
static final int	CLOSE_ERROR
static final int	CLOSE_OK
static final int	CLOSE_WRITE_BAD
static final int	CLOSE_WRITE_GOOD
static final int	CLOSE_WRITE_STOP
static final int	EOF

Method Summary

Modifier and Type	Method	Description
void	allocate(String requestID)
void	connect(String requestID, String url, String userId, String password, String clientInfo)
void	deallocate()
void	disconnect()
int	getASKVersion()
String	getCapability(short key)
int	getClientASKActivityTimeout()
boolean	getClientASKEnabled()
int	getClientASKResponseTimeout()
String	getConnectionID()
String	getConnectionReturnValue()
String	getRequestID()
boolean	getServerASKEnabled()
String	getSSLSubjectName()
boolean	isConnected()
boolean	isReceiving()
boolean	isServerSessionValid()
boolean	isStopping()
void	manageASKPingRequest()
void	prepareToReceive(int mode)
int	read(byte[] buffer)
void	setSessionID(String id)
void	setStop()
void	unconditionalDisconnect()
void	write(byte[] buffer, int offset, int n)
void	xid(String requestID, String url, String username, String password, String connectionStr)

Field Details

EOF

static final int EOF

See Also:

• Constant Field Values

ABNORMAL_EOF

static final int ABNORMAL_EOF

See Also:

• Constant Field Values

CLOSE_OK

static final int CLOSE_OK

See Also:

• Constant Field Values

CLOSE_ERROR

static final int CLOSE_ERROR

See Also:

• Constant Field Values

CLOSE_WRITE_GOOD

static final int CLOSE_WRITE_GOOD

See Also:

• Constant Field Values

CLOSE_WRITE_BAD

static final int CLOSE_WRITE_BAD

See Also:

• Constant Field Values

CLOSE_WRITE_STOP

static final int CLOSE_WRITE_STOP

See Also:

• Constant Field Values

Method Details

connect

void connect(String requestID,
 String url,
 String userId,
 String password,
 String clientInfo)
      throws BrokerException,
ConnectException

Throws:

BrokerException

ConnectException

xid

void xid(String requestID,
 String url,
 String username,
 String password,
 String connectionStr)
  throws BrokerException,
ConnectException

Throws:

BrokerException

ConnectException

disconnect

void disconnect()
         throws BrokerException

Throws:

BrokerException

unconditionalDisconnect

void unconditionalDisconnect()

isConnected

boolean isConnected()

allocate

void allocate(String requestID)
       throws BrokerException

Throws:

BrokerException

deallocate

void deallocate()
         throws BrokerException

Throws:

BrokerException

write

void write(byte[] buffer,
 int offset,
 int n)
    throws BrokerException

Throws:

BrokerException

prepareToReceive

void prepareToReceive(int mode)
               throws BrokerException

Throws:

BrokerException

read

int read(byte[] buffer)
  throws BrokerException

Throws:

BrokerException

setStop

void setStop()
      throws BrokerException

Throws:

BrokerException

getConnectionID

String getConnectionID()
                throws BrokerException

Throws:

BrokerException

getRequestID

String getRequestID()
             throws BrokerException

Throws:

BrokerException

getSSLSubjectName

String getSSLSubjectName()
                  throws BrokerException

Throws:

BrokerException

getConnectionReturnValue

String getConnectionReturnValue()
                         throws BrokerException

Throws:

BrokerException

isReceiving

boolean isReceiving()

isStopping

boolean isStopping()

getCapability

String getCapability(short key)

getASKVersion

int getASKVersion()

getServerASKEnabled

boolean getServerASKEnabled()

getClientASKEnabled

boolean getClientASKEnabled()

getClientASKActivityTimeout

int getClientASKActivityTimeout()

getClientASKResponseTimeout

int getClientASKResponseTimeout()

manageASKPingRequest

void manageASKPingRequest()
                   throws BrokerException,
Open4GLException

Throws:

BrokerException

Open4GLException

setSessionID

void setSessionID(String id)

isServerSessionValid

boolean isServerSessionValid()