|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.businesslink.sgi.api.sef.SefClient
Class used to send new Strategi Events. Method calls must be made in proper order or a SefEscape with error code EAPISEQ is thrown.
Constructor Summary | |
SefClient()
Constructs and initializes a new event client. |
Method Summary | |
void |
close()
Performs necessary event client cleanup. |
static void |
enableCache(boolean ena)
Enables or disables internal UserQueue object caching. |
void |
endEvent()
Ends the current event. |
protected void |
finalize()
Automatically calls the close method. |
java.io.InputStream |
getInputStream()
Gets the input stream used to receive data from the event handler. |
java.io.InputStream |
getInputStream(int ccs)
Gets the input stream used to receive data from the event handler. |
java.io.OutputStream |
getOutputStream()
Gets the output stream used to send data to the event handler. |
java.io.OutputStream |
getOutputStream(int ccs)
Gets the output stream used to send data to the event handler. |
java.util.Properties |
getProperties()
Gets all properties associated with this event. |
java.lang.String |
getProperty(java.lang.String kwd)
Gets the property value associated with the specified keyword in the event property list. |
java.lang.String |
getProperty(java.lang.String kwd,
java.lang.String dftval)
Gets the property value associated with the specified keyword in the event property list. |
java.io.Reader |
getReader()
Gets the Reader used to receive data from the event handler. |
java.io.Writer |
getWriter()
Gets the Writer used to send data to the event handler. |
boolean |
hasProperty(java.lang.String kwd)
Determines if a property with the specified keyword is present in the event property list. |
void |
receiveResponse()
Blocks until response data is available from the event handler. |
void |
sendProperty(java.lang.String kwd,
java.lang.String val)
Sends a property to the event handler. |
boolean |
setOption(java.lang.String kwd,
java.lang.String val)
Sets a particular event client option. |
void |
startEvent(java.lang.String hdlnam,
java.lang.String opc)
Starts a new event. |
long |
writeDataTo(java.io.OutputStream out)
Writes all input data to the specified output stream. |
long |
writeDataTo(java.io.OutputStream out,
int ccs)
Writes all input data to the specified output stream, translating to the specified CCSID. |
long |
writeDataTo(java.io.Writer wtr)
Writes all input data to the specified Writer. |
Constructor Detail |
public SefClient()
Method Detail |
public void close()
protected void finalize() throws java.lang.Throwable
public boolean setOption(java.lang.String kwd, java.lang.String val)
Supported option keywords:
SndTimeout
- Send timeout for the client output stream, in seconds.
If set to -1, timeout will never occur.
RcvTimeout
- Receive timeout for the client input stream, in seconds.
If set to -1, timeout will never occur.
Timeout
- Set the SndTimeout and RcvTimeout in seconds.
If set to -1, timeouts will never occur.
kwd
- keyword identifying the option to set.val
- value to set.public void startEvent(java.lang.String hdlnam, java.lang.String opc)
hdlnam
- name of the event handler to handle this event.opc
- the event opcode.public void sendProperty(java.lang.String kwd, java.lang.String val)
kwd
- property keyword.val
- property value.public java.io.OutputStream getOutputStream()
public java.io.OutputStream getOutputStream(int ccs)
ccs
- CCSID used to mark this output stream.public java.io.Writer getWriter()
public void receiveResponse()
public boolean hasProperty(java.lang.String kwd)
kwd
- property keyword.public java.lang.String getProperty(java.lang.String kwd)
kwd
- property keyword.null
if the property is not found.public java.lang.String getProperty(java.lang.String kwd, java.lang.String dftval)
kwd
- property keyword.dftval
- a default value.public java.util.Properties getProperties()
public java.io.InputStream getInputStream()
public java.io.InputStream getInputStream(int ccs)
ccs
- the CCSID to receive data in.public java.io.Reader getReader()
public long writeDataTo(java.io.OutputStream out)
out
- the output stream to write to.public long writeDataTo(java.io.OutputStream out, int ccs)
out
- the output stream to write to.ccs
- CCSID to translate input data to.public long writeDataTo(java.io.Writer wtr)
wtr
- the Writer to use for writing.public void endEvent()
public static void enableCache(boolean ena)
ena
- if true, enable object caching; if false, disable object caching.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |