info.magnolia.rest.service.command.v2

Class CommandEndpoint

java.lang.Object

info.magnolia.rest.AbstractEndpoint<D>

info.magnolia.rest.service.command.AbstractCommandEndpoint<CommandEndpointDefinition>

info.magnolia.rest.service.command.v2.CommandEndpoint

@Path(value="/commands/v2")
public class CommandEndpoint
extends AbstractCommandEndpoint<CommandEndpointDefinition>

REST service for executing commands. Executable commands have to be white listed by adding them to the configuration.

See Also:

CommandEndpointDefinition

Field Summary

Fields inherited from class info.magnolia.rest.service.command.AbstractCommandEndpoint

commandsManager, STATUS_MESSAGE_COMMAND_NOT_FOUND, STATUS_MESSAGE_ERROR_OCCURRED, STATUS_MESSAGE_FORBIDDEN, STATUS_MESSAGE_OK

Constructor Summary

Constructors

Constructor and Description
CommandEndpoint(CommandEndpointDefinition commandEndpointDefinition, info.magnolia.commands.CommandsManager commandsManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	executeCommand(String commandName, Map<String,Object> commandMap)
javax.ws.rs.core.Response	executeCommand(String catalogName, String commandName, Map<String,Object> commandMap)
protected Collection<String>	getResponseContextParametersForCommand(String catalogName, String commandName) Returns context parameters for particular Command that will be added to the response after successful command execution.

Methods inherited from class info.magnolia.rest.service.command.AbstractCommandEndpoint

isCommandExecutableByCurrentUser

Methods inherited from class info.magnolia.rest.AbstractEndpoint

getEndpointDefinition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandEndpoint

@Inject
public CommandEndpoint(CommandEndpointDefinition commandEndpointDefinition,
                               info.magnolia.commands.CommandsManager commandsManager)

Method Detail

executeCommand

@POST
 @Path(value="/{catalogName}/{commandName:(.)*}")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response executeCommand(@PathParam(value="catalogName")
                                                                                                                                                                                                                          String catalogName,
                                                                                                                                                                                                                          @PathParam(value="commandName")
                                                                                                                                                                                                                          String commandName,
                                                                                                                                                                                                                          Map<String,Object> commandMap)
                                                                                                                                                                                                                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

executeCommand

@POST
 @Path(value="/{commandName:(.)*}")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response executeCommand(@PathParam(value="commandName")
                                                                                                                                                                                                            String commandName,
                                                                                                                                                                                                            Map<String,Object> commandMap)
                                                                                                                                                                                                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getResponseContextParametersForCommand

protected Collection<String> getResponseContextParametersForCommand(String catalogName,
                                                                    String commandName)

Returns context parameters for particular Command that will be added to the response after successful command execution.