Package org.apache.synapse.api.rest
Class RestRequestHandler
- java.lang.Object
-
- org.apache.synapse.api.AbstractApiHandler
-
- org.apache.synapse.api.rest.RestRequestHandler
-
public class RestRequestHandler extends AbstractApiHandler
This class is responsible for receiving requests from various sources and dispatching them to a suitable REST API for further processing. This is the main entry point for mediating messages through APIs and Resources.
-
-
Constructor Summary
Constructors Constructor Description RestRequestHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
dispatchToAPI(MessageContext synCtx)
boolean
process(MessageContext synCtx)
Attempt to process the given message through one of the available APIs.-
Methods inherited from class org.apache.synapse.api.AbstractApiHandler
apiProcess, apiProcessNonDefaultStrategy, dispatchToAPI, identifyAPI
-
-
-
-
Method Detail
-
process
public boolean process(MessageContext synCtx)
Attempt to process the given message through one of the available APIs. This method will first try to locate a suitable API for the given message by running it through the API validation routines available. If a matching API is found it will dispatch the message to the located API. If a matching API cannot be found, message will be left intact so any other handlers (eg: main sequence) can pick it up later.- Specified by:
process
in classAbstractApiHandler
- Parameters:
synCtx
- MessageContext of the request to be processed- Returns:
- true if the message was dispatched to an API and false otherwise
-
dispatchToAPI
protected boolean dispatchToAPI(MessageContext synCtx)
- Specified by:
dispatchToAPI
in classAbstractApiHandler
-
-