org.apache.syncope.common.rest.api.service

Interface CamelRouteService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

CamelRouteServiceImpl

@Path(value="camelRoutes")
public interface CamelRouteService
extends JAXRSService

REST operations for Camel routes.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
List<CamelRouteTO>	list(@NotNull AnyTypeKind anyTypeKind) List all routes for the given any type kind.
CamelMetrics	metrics() Provides Camel metrics.
CamelRouteTO	read(@NotNull AnyTypeKind anyTypeKind, @NotNull String key) Read the route with the given key.
void	restartContext() Restart the underlying Apache Camel context.
void	update(@NotNull AnyTypeKind anyTypeKind, @NotNull CamelRouteTO route) Update the given route.

Method Detail

list

@GET
 @Path(value="{anyTypeKind}")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<CamelRouteTO> list(@NotNull @PathParam(value="anyTypeKind")
                                                                                                                                       @NotNull AnyTypeKind anyTypeKind)

List all routes for the given any type kind.

Parameters:

anyTypeKind - any type kind

Returns:

all routes for the given any type kind

read

@GET
 @Path(value="{anyTypeKind}/{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
CamelRouteTO read(@NotNull @PathParam(value="anyTypeKind")
                                                                                                                                       @NotNull AnyTypeKind anyTypeKind,
                                                                                                                                       @NotNull @PathParam(value="key")
                                                                                                                                       @NotNull String key)

Read the route with the given key.

Parameters:

anyTypeKind - any type kind

key - route key

Returns:

route with given key

update

@PUT
 @Path(value="{anyTypeKind}/{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull @PathParam(value="anyTypeKind")
                                                                                                                                                                                                             @NotNull AnyTypeKind anyTypeKind,
                                                                                                                                                                                                             @NotNull
                                                                                                                                                                                                             @NotNull CamelRouteTO route)

Update the given route.

Parameters:

anyTypeKind - any type kind

route - to be updated

restartContext

@POST
 @Path(value="restartContext")
 @Produces(value={"application/json","application/yaml","application/xml"})
void restartContext()

Restart the underlying Apache Camel context.

metrics

@GET
 @Path(value="metrics")
 @Produces(value={"application/json","application/yaml","application/xml"})
CamelMetrics metrics()

Provides Camel metrics.

Returns:

Camel metrics