org.mule.components.rest
Class RestServiceWrapper

java.lang.Object
  extended by org.mule.components.rest.RestServiceWrapper
All Implemented Interfaces:
Callable, Initialisable, UMOEventListener

public class RestServiceWrapper
extends Object
implements Callable, Initialisable

This component can used to proxy REST style services as local Mule Components. It can be configured with a service URL plus a number of properties that allow you to configure the parameters and error conditions on the service.


Field Summary
static String CONTENT_TYPE
           
static String CONTENT_TYPE_VALUE
           
static String GET
           
static String HTTP_METHOD
           
protected  Log logger
          logger used by this class
static String REST_SERVICE_URL
           
 
Constructor Summary
RestServiceWrapper()
           
 
Method Summary
 String getErrorExpression()
           
 UMOFilter getErrorFilter()
           
 String getHttpMethod()
           
 Map getOptionalParams()
           
 List getPayloadParameterNames()
           
 Map getRequiredParams()
           
 String getServiceUrl()
           
protected  void handleException(RestServiceException e, UMOMessage result)
           
 void initialise()
          Method used to perform any initialisation work.
protected  boolean isErrorPayload(UMOMessage message)
           
 boolean isUrlFromMessage()
           
 Object onCall(UMOEventContext eventContext)
          Passes the event to the listener
 void setErrorExpression(String errorExpression)
           
 void setErrorFilter(UMOFilter errorFilter)
           
 void setHttpMethod(String httpMethod)
           
 void setOptionalParams(Map optionalParams)
           
 void setPayloadParameterNames(List payloadParameterNames)
           
 void setRequiredParams(Map requiredParams)
           
 void setServiceUrl(String serviceUrl)
           
 void setUrlFromMessage(boolean urlFromMessage)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REST_SERVICE_URL

public static final String REST_SERVICE_URL
See Also:
Constant Field Values

GET

public static final String GET
See Also:
Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE
See Also:
Constant Field Values

CONTENT_TYPE_VALUE

public static final String CONTENT_TYPE_VALUE
See Also:
Constant Field Values

HTTP_METHOD

public static final String HTTP_METHOD
See Also:
Constant Field Values

logger

protected transient Log logger
logger used by this class

Constructor Detail

RestServiceWrapper

public RestServiceWrapper()
Method Detail

getServiceUrl

public String getServiceUrl()

setServiceUrl

public void setServiceUrl(String serviceUrl)

isUrlFromMessage

public boolean isUrlFromMessage()

setUrlFromMessage

public void setUrlFromMessage(boolean urlFromMessage)

getRequiredParams

public Map getRequiredParams()

setRequiredParams

public void setRequiredParams(Map requiredParams)

getOptionalParams

public Map getOptionalParams()

setOptionalParams

public void setOptionalParams(Map optionalParams)

getHttpMethod

public String getHttpMethod()

setHttpMethod

public void setHttpMethod(String httpMethod)

getPayloadParameterNames

public List getPayloadParameterNames()

setPayloadParameterNames

public void setPayloadParameterNames(List payloadParameterNames)

getErrorFilter

public UMOFilter getErrorFilter()

setErrorFilter

public void setErrorFilter(UMOFilter errorFilter)

getErrorExpression

public String getErrorExpression()

setErrorExpression

public void setErrorExpression(String errorExpression)

initialise

public void initialise()
                throws InitialisationException
Description copied from interface: Initialisable
Method used to perform any initialisation work. If a fatal error occurs during initialisation an InitialisationException should be thrown, causing the Mule instance to shutdown. If the error is recoverable, say by retrying to connect, a RecoverableException should be thrown. There is no guarantee that by throwing a Recoverable exception that the Mule instance will not shut down.

Specified by:
initialise in interface Initialisable
Throws:
InitialisationException - if a fatal error occurs causing the Mule instance to shutdown
RecoverableException - if an error occurs that can be recovered from

onCall

public Object onCall(UMOEventContext eventContext)
              throws Exception
Description copied from interface: Callable
Passes the event to the listener

Specified by:
onCall in interface Callable
Parameters:
eventContext - the context of the current event being process
Returns:
Object this object can be anything. When the UMOLifecycleAdapter for the component receives this object it will first see if the Object is an UMOMessage if not and the Object is not null a new message will be created using the returned object as the payload. This new event will then get published via the configured outbound router if-
  1. One has been configured for the UMO.
  2. the setStopFurtherProcessing(true) wasn't called on the event context event.
Throws:
Exception - if the event fails to process properly. If exceptions aren't handled by the implementation they will be handled by the exceptionListener associated with the component

isErrorPayload

protected boolean isErrorPayload(UMOMessage message)

handleException

protected void handleException(RestServiceException e,
                               UMOMessage result)
                        throws Exception
Throws:
Exception


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.