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

Interface CommandService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

CommandServiceImpl

@Path("commands")
public interface CommandService
extends JAXRSService

REST operations for commands.

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_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method	Description
CommandTO	read(String key)	Returns the command for the given key, if found.
CommandOutput	run(CommandTO command)	Runs the given command with the given arguments and returns the resulting output.
PagedResult<CommandTO>	search(CommandQuery query)	Returns a paged list of all commands.

Method Details

search

@GET
@Produces({"application/json","application/yaml","application/xml"})
PagedResult<CommandTO> search(@BeanParam
 CommandQuery query)

Returns a paged list of all commands.

Parameters:

query - query conditions

Returns:

list of all commands.

read

@GET
@Path("{key}")
@Produces({"application/json","application/yaml","application/xml"})
CommandTO read(@PathParam("key")
 String key)

Returns the command for the given key, if found.

Parameters:

key - command key

Returns:

the command for the given key, if found

run

@POST
@Path("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
CommandOutput run(CommandTO command)

Runs the given command with the given arguments and returns the resulting output.

Parameters:

command - command to run, with arguments

Returns:

command output