org.yawlfoundation.yawl.engine.interfce

Class Interface_Client

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

Direct Known Subclasses:

CaseCompletedObserver, ClientTest, CostGatewayClient, DocumentStoreClient, ForwardClient, InterfaceA_EnvironmentBasedClient, InterfaceB_EngineBasedClient, InterfaceB_EnvironmentBasedClient, InterfaceX_EngineSideClient, InterfaceX_ServiceSideClient, JMXReader, ResourceCalendarGatewayClient, ResourceGatewayClient, ResourceGatewayServer, ResourceLogGatewayClient, Sender, WorkletEventServer, WorkletGatewayClient, WorkQueueGatewayClient, YLogGatewayClient

public class Interface_Client
extends java.lang.Object

This class is used by clients and servers to execute GET and POST requests across the YAWL interfaces. Note that since v2.0up4 (12/08) all requests are sent as POSTS - increases efficiency, security and allows 'extended' chars to be included.

Author:

Lachlan Aldred Date: 22/03/2004 Time: 17:49:42, Michael Adams (refactored for v2.0, 06/2008; and again 12/2008 & 04/2010)

Constructor Summary

Constructors

Constructor and Description
Interface_Client()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	executeGet(java.lang.String urlStr, java.util.Map<java.lang.String,java.lang.String> paramsMap) Executes a rerouted HTTP GET request as a POST on the specified URL
protected java.lang.String	executePost(java.lang.String urlStr, java.util.Map<java.lang.String,java.lang.String> paramsMap) Executes a HTTP POST request on the url specified.
protected java.lang.String	getReply(java.io.InputStream is) Receives a reply from a HTTP submission
protected java.net.HttpURLConnection	initPostConnection(java.lang.String urlStr) Initialises a HTTP POST connection
protected java.util.Map<java.lang.String,java.lang.String>	prepareParamMap(java.lang.String action, java.lang.String handle) Initialises a map for transporting parameters - used by extending classes
protected java.lang.String	send(java.net.HttpURLConnection connection, java.util.Map<java.lang.String,java.lang.String> paramsMap, boolean stripOuterXML) Sends data to the specified url via a HTTP POST, and returns the reply
protected void	setReadTimeout(int timeout) Set the read timeout value for future connections
protected java.lang.String	stripOuterElement(java.lang.String xml) Removes the outermost set of xml tags from a string, if any
boolean	successful(java.lang.String message) Tests a response message for success or failure

Methods inherited from class java.lang.Object

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

Constructor Detail

Interface_Client

public Interface_Client()

Method Detail

executePost

protected java.lang.String executePost(java.lang.String urlStr,
                                       java.util.Map<java.lang.String,java.lang.String> paramsMap)
                                throws java.io.IOException

Executes a HTTP POST request on the url specified.

Parameters:

urlStr - the URL to send the POST to

paramsMap - a set of attribute-value pairs that make up the posted data

Returns:

the result of the POST request

Throws:

java.io.IOException - when there's some kind of communication problem

executeGet

protected java.lang.String executeGet(java.lang.String urlStr,
                                      java.util.Map<java.lang.String,java.lang.String> paramsMap)
                               throws java.io.IOException

Executes a rerouted HTTP GET request as a POST on the specified URL

Parameters:

urlStr - the URL to send the GET to

paramsMap - a set of attribute-value pairs that make up the posted data

Returns:

the result of the request

Throws:

java.io.IOException - when there's some kind of communication problem

prepareParamMap

protected java.util.Map<java.lang.String,java.lang.String> prepareParamMap(java.lang.String action,
                                                                           java.lang.String handle)

Initialises a map for transporting parameters - used by extending classes

Parameters:

action - the name of the action to take

handle - the current engine session handle

Returns:

the initialised Map

setReadTimeout

protected void setReadTimeout(int timeout)

Set the read timeout value for future connections

Parameters:

timeout - the timeout value in milliseconds. A value of -1 (the default) means a read will wait indefinitely.

stripOuterElement

protected java.lang.String stripOuterElement(java.lang.String xml)

Removes the outermost set of xml tags from a string, if any

Parameters:

xml - the xml string to strip

Returns:

the stripped xml string

send

protected java.lang.String send(java.net.HttpURLConnection connection,
                                java.util.Map<java.lang.String,java.lang.String> paramsMap,
                                boolean stripOuterXML)
                         throws java.io.IOException

Sends data to the specified url via a HTTP POST, and returns the reply

Parameters:

connection - the http url connection to send the request to

paramsMap - a map of attribute=value pairs representing the data to send

stripOuterXML - true if this was originally a POST request, false if a GET request

Returns:

the response from the url

Throws:

java.io.IOException - when there's some kind of communication problem

initPostConnection

protected java.net.HttpURLConnection initPostConnection(java.lang.String urlStr)
                                                 throws java.io.IOException

Initialises a HTTP POST connection

Parameters:

urlStr - the url to connect to

Returns:

an initialised POST connection

Throws:

java.io.IOException - when there's some kind of communication problem

successful

public boolean successful(java.lang.String message)

Tests a response message for success or failure

Parameters:

message - the response message to test

Returns:

true if the response represents success

getReply

protected java.lang.String getReply(java.io.InputStream is)
                             throws java.io.IOException

Receives a reply from a HTTP submission

Parameters:

is - the InputStream of a URL or Connection object

Returns:

the stream's contents (ie. the HTTP reply)

Throws:

java.io.IOException - when there's some kind of communication problem