SimulationResponse
- This object contains the execution status of a set of handlers used
in a simulation operation. The returned simulation response object
contains an array of HandlerSimulationStatus objects, which contains
the name of the handler the execution status.SimulationRequest
- This object contains the parameters required for performing a
simulation of handlers on the registry. This object can capture
information such as operation, mediaType, path and other optional
parameters.public interface IHandlerManagementService<SimulationResponse,SimulationRequest>
Modifier and Type | Method and Description |
---|---|
boolean |
createHandler(String payload)
Method to create a handler using the provided configuration.
|
boolean |
deleteHandler(String name)
Method to delete the configuration of a named handler.
|
String |
getHandlerCollectionLocation()
Method to obtain the location at which the handler collection is stored on the registry.
|
String |
getHandlerConfiguration(String name)
Method to obtain the configuration of a named handler.
|
String[] |
getHandlerList()
Method to obtain the list of handlers that have been configured through the Handler
Administration API.
|
void |
setHandlerCollectionLocation(String location)
Method to set the location at which the handler collection is stored on the registry.
|
SimulationResponse |
simulate(SimulationRequest request)
Method to simulate handlers on a registry.
|
boolean |
updateHandler(String name,
String payload)
Method to update the configuration of a named handler, using the provided configuration
|
String getHandlerCollectionLocation() throws Exception
Exception
- if the operation failed.void setHandlerCollectionLocation(String location) throws Exception
location
- the resource path of the handler collection.Exception
- if the operation failed.String[] getHandlerList() throws Exception
Exception
- if the operation failed.String getHandlerConfiguration(String name) throws Exception
name
- the name of the handler.Exception
- if the operation failed.boolean deleteHandler(String name) throws Exception
name
- the name of the handler.Exception
- if an error occurred.boolean createHandler(String payload) throws Exception
payload
- the handler configuration.Exception
- if an error occurred.boolean updateHandler(String name, String payload) throws Exception
name
- the name of the handler.payload
- the handler configuration.Exception
- if an error occurred.SimulationResponse simulate(SimulationRequest request) throws Exception
request
- the simulation request object.Exception
- if the operation failed.Copyright © 2016 WSO2. All Rights Reserved.