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

Interface NetworkServiceService

All Superinterfaces:

Serializable

All Known Implementing Classes:

NetworkServiceServiceImpl

@Path("networkServices")
public interface NetworkServiceService
extends Serializable

REST operations for Self Keymaster's service discovery.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	NetworkServiceService.Action

Method Summary

Modifier and Type	Method	Description
void	action(@NotNull NetworkService networkService, NetworkServiceService.Action action)	(Un)registers the given service.
NetworkService	get(NetworkService.Type serviceType)	Returns the service instance to invoke, for the given type.
List<NetworkService>	list(NetworkService.Type serviceType)	Returns the list of registered services.

Method Detail

list

@GET
@Path("{serviceType}")
@Produces("application/json")
List<NetworkService> list(@NotNull @PathParam("serviceType")
                          NetworkService.Type serviceType)

Returns the list of registered services.

Parameters:

serviceType - service type

Returns:

list of registered services

get

@GET
@Path("{serviceType}/get")
@Produces("application/json")
NetworkService get(@NotNull @PathParam("serviceType")
                   NetworkService.Type serviceType)

Returns the service instance to invoke, for the given type.

Parameters:

serviceType - service type

Returns:

service instance to invoke, for the given type

action

@POST
@Consumes("application/json")
@Produces("application/json")
void action(@NotNull
            @NotNull NetworkService networkService,
            @QueryParam("action")
            NetworkServiceService.Action action)

(Un)registers the given service.

Parameters:

networkService - service instance

action - action to perform on the given service