se.entra.phantom.server.rapp

Class RequestThread

java.lang.Object

se.entra.phantom.server.rapp.RequestThread

All Implemented Interfaces:

Runnable

public class RequestThread
extends Object
implements Runnable

This class runs the request issued by a remote application in a separate thread (per requestID). It stores information about the request and then calls the method runRequest in the class DefaultRemoteApplication or the class that extends it).

The class also handles the XML document reply or error text that should be returned to the RAPP client.

Constructor Summary

Constructors

Constructor and Description
RequestThread(DefaultRemoteApplication dra, ClientConnectionData ccd, Document document, int requestID) Creates a new instance of the request thread and starts it.

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Gets the document for this request or null for none.
String	getError() Gets the error string, or null if no error exists or the request has not completed.
String	getReply() Gets the reply to the request as an XML string, or null if there is an error or the request has not completed.
int	getRequestID() Gets the request ID.
boolean	hasCompleted() Checks if the request has completed.
void	run() Called when the thread is started.
void	setError(String errorText) Call this method to set the XML string of the reply.
void	setReply(String xmlString) Call this method to set the XML string of the reply.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestThread

public RequestThread(DefaultRemoteApplication dra,
                     ClientConnectionData ccd,
                     Document document,
                     int requestID)

Creates a new instance of the request thread and starts it.

Method Detail

getRequestID

public int getRequestID()

Gets the request ID.

getDocument

public Document getDocument()

Gets the document for this request or null for none. The latter only occurs when a call to setReply or setError has been done, or if the request thread has completed execution.

See Also:

setReply(java.lang.String), setError(java.lang.String), hasCompleted()

run

public void run()

Called when the thread is started. This will make a call directly to the method runRequest in the class DefaultRemoteApplication or the class that extends it).

When the thread has finished executing, a check will be done to see that a reply or an error has been set using the method setReply or setError respectively. If this is the case, an error will be stored for the request indicating this fact.

Specified by:

run in interface Runnable

See Also:

setReply(java.lang.String), setError(java.lang.String), hasCompleted(), getError(), getReply()

setReply

public void setReply(String xmlString)

Call this method to set the XML string of the reply.

Only a single call to this method is allowed, and no prior call to setError must have been done.

See Also:

setError(java.lang.String), getReply(), hasCompleted()

setError

public void setError(String errorText)

Call this method to set the XML string of the reply.

Only a single call to this method is allowed, and no prior call to setError must have been done.

See Also:

setReply(java.lang.String), getError(), hasCompleted()

hasCompleted

public boolean hasCompleted()

Checks if the request has completed. The request is assumed to be completed when a reply or error has been set. This also implies the end of the running thread because if no reply or error has been set, it will be done at the end of the thread execution.

See Also:

getError(), getReply()

getError

public String getError()

Gets the error string, or null if no error exists or the request has not completed.

getReply

public String getReply()

Gets the reply to the request as an XML string, or null if there is an error or the request has not completed.