org.safs.staf.embedded

Class EmbeddedHandle

java.lang.Object

org.safs.staf.embedded.EmbeddedHandle

All Implemented Interfaces:

HandleInterface

Direct Known Subclasses:

EmbeddedServiceHandle

public class EmbeddedHandle
extends java.lang.Object
implements HandleInterface

A handle subclass used by clients of Services.

Author:

Carl Nagle

See Also:

EmbeddedServiceHandle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_QUEUE_NAME
protected java.lang.String	handleId
protected boolean	isRegistered
protected Fifo<java.lang.String>	queue
protected com.ibm.staf.STAFHandle	stafHandle

Constructor Summary

Constructors

Constructor and Description
EmbeddedHandle(java.lang.String handleId) Create and Register our STAFHandle subclass with STAF *and* our non-STAF handlers.

Method Summary

Modifier and Type	Method and Description
com.ibm.staf.STAFResult	acceptQueueMessage(java.lang.String message) Receive a queue message into our (non-STAF) FIFO queue.
void	clearQueue()
int	getHandle()
com.ibm.staf.STAFResult	getQueueMessage(int timeout)
void	register() Subclasses call this to invoke the overridden registerHandle function and set the isRegistered flag.
protected void	registerHandle() Override in subclasses.
com.ibm.staf.STAFResult	sendQueueMessage(java.lang.String handler, java.lang.String message) Send a queue message to the FIFO queue of the specified (non-STAF) handler (handle/service).
void	setHandleId(java.lang.String handleId) If used, must be called before registering.
java.lang.String	submit(java.lang.String handler, java.lang.String request) Send a submit request to a registered (non-STAF) service Handle.
java.lang.String	submit(java.lang.String machine, java.lang.String handler, java.lang.String request) Tries to use a registered (non-STAF) Handler first before resorting to the super (STAF) submit.
com.ibm.staf.STAFResult	submit2(java.lang.String handler, java.lang.String request) Send a submit2 request to a registered (non-STAF) service Handle.
com.ibm.staf.STAFResult	submit2(java.lang.String machine, java.lang.String handler, java.lang.String request) Tries to use a registered (non-STAF) Handler first before resorting to the super (STAF) submit2.
void	unRegister() Unregisters the Handle from both our registered (non-STAF) handlers and STAF, if applicable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_QUEUE_NAME

public static final java.lang.String DEFAULT_QUEUE_NAME

See Also:

Constant Field Values

handleId

protected java.lang.String handleId

queue

protected Fifo<java.lang.String> queue

isRegistered

protected boolean isRegistered

stafHandle

protected com.ibm.staf.STAFHandle stafHandle

Constructor Detail

EmbeddedHandle

public EmbeddedHandle(java.lang.String handleId)
               throws com.ibm.staf.STAFException

Create and Register our STAFHandle subclass with STAF *and* our non-STAF handlers.

Parameters:

handleId -

Throws:

com.ibm.staf.STAFException

Method Detail

setHandleId

public void setHandleId(java.lang.String handleId)

If used, must be called before registering.

Specified by:

setHandleId in interface HandleInterface

register

public void register()
              throws com.ibm.staf.STAFException

Subclasses call this to invoke the overridden registerHandle function and set the isRegistered flag.

Specified by:

register in interface HandleInterface

Throws:

com.ibm.staf.STAFException

registerHandle

protected void registerHandle()
                       throws com.ibm.staf.STAFException

Override in subclasses. Will be called by the register() function.

Throws:

com.ibm.staf.STAFException

submit

public java.lang.String submit(java.lang.String handler,
                               java.lang.String request)
                        throws com.ibm.staf.STAFException

Send a submit request to a registered (non-STAF) service Handle.

Returns:

the String result from the service response.

Throws:

com.ibm.staf.STAFException - if the service is not registered.

See Also:

org.safs.staf.embedded.HandleInterface#submit(java.lang.String, java.lang.String)

submit2

public com.ibm.staf.STAFResult submit2(java.lang.String handler,
                                       java.lang.String request)
                                throws com.ibm.staf.STAFException

Send a submit2 request to a registered (non-STAF) service Handle.

Returns:

STAFResult service response.

Throws:

com.ibm.staf.STAFException - if the service is not registered.

See Also:

org.safs.staf.embedded.HandleInterface#submit2(java.lang.String, java.lang.String)

acceptQueueMessage

public com.ibm.staf.STAFResult acceptQueueMessage(java.lang.String message)

Receive a queue message into our (non-STAF) FIFO queue.

Specified by:

acceptQueueMessage in interface HandleInterface

See Also:

HandleInterface.acceptQueueMessage(java.lang.String)

sendQueueMessage

public com.ibm.staf.STAFResult sendQueueMessage(java.lang.String handler,
                                                java.lang.String message)
                                         throws com.ibm.staf.STAFException

Send a queue message to the FIFO queue of the specified (non-STAF) handler (handle/service).

Specified by:

sendQueueMessage in interface HandleInterface

Parameters:

handler - -- destination handle name for the message.

message - -- the message to send.

Throws:

com.ibm.staf.STAFException

See Also:

HandleInterface.sendQueueMessage(java.lang.String, java.lang.String)

getQueueMessage

public com.ibm.staf.STAFResult getQueueMessage(int timeout)

Specified by:

getQueueMessage in interface HandleInterface

Returns:

get a queue message from our (non-STAF) FIFO queue, or null if there are no messages.

submit

public java.lang.String submit(java.lang.String machine,
                               java.lang.String handler,
                               java.lang.String request)
                        throws com.ibm.staf.STAFException

Tries to use a registered (non-STAF) Handler first before resorting to the super (STAF) submit.

Specified by:

submit in interface HandleInterface

Throws:

com.ibm.staf.STAFException

See Also:

STAFHandle.submit(java.lang.String, java.lang.String, java.lang.String)

submit2

public com.ibm.staf.STAFResult submit2(java.lang.String machine,
                                       java.lang.String handler,
                                       java.lang.String request)

Tries to use a registered (non-STAF) Handler first before resorting to the super (STAF) submit2.

Specified by:

submit2 in interface HandleInterface

See Also:

STAFHandle.submit2(java.lang.String, java.lang.String, java.lang.String)

unRegister

public void unRegister()

Unregisters the Handle from both our registered (non-STAF) handlers and STAF, if applicable.

Specified by:

unRegister in interface HandleInterface

See Also:

STAFHandle.unRegister()

getHandle

public int getHandle()

Specified by:

getHandle in interface HandleInterface

clearQueue

public void clearQueue()