info.magnolia.rest.service.command

Class AbstractCommandEndpoint<D extends CommandEndpointDefinition>

java.lang.Object

info.magnolia.rest.AbstractEndpoint<D>

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

Type Parameters:

D - The command endpoint definition

Direct Known Subclasses:

CommandEndpoint, CommandEndpoint

public class AbstractCommandEndpoint<D extends CommandEndpointDefinition>
extends info.magnolia.rest.AbstractEndpoint<D>

Base class for all command endpoints.

See Also:

CommandEndpointDefinition

Field Summary

Fields

Modifier and Type	Field and Description
protected info.magnolia.commands.CommandsManager	commandsManager
protected static String	STATUS_MESSAGE_COMMAND_NOT_FOUND
protected static String	STATUS_MESSAGE_ERROR_OCCURRED
protected static String	STATUS_MESSAGE_FORBIDDEN
protected static String	STATUS_MESSAGE_OK

Constructor Summary

Constructors

Constructor and Description
AbstractCommandEndpoint(D endpointDefinition, info.magnolia.commands.CommandsManager commandsManager)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	isCommandExecutableByCurrentUser(String catalogName, String commandName) Checks whether the current user is allowed to execute the requested command.

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

Field Detail

STATUS_MESSAGE_OK

protected static final String STATUS_MESSAGE_OK

See Also:

Constant Field Values

STATUS_MESSAGE_FORBIDDEN

protected static final String STATUS_MESSAGE_FORBIDDEN

See Also:

Constant Field Values

STATUS_MESSAGE_COMMAND_NOT_FOUND

protected static final String STATUS_MESSAGE_COMMAND_NOT_FOUND

See Also:

Constant Field Values

STATUS_MESSAGE_ERROR_OCCURRED

protected static final String STATUS_MESSAGE_ERROR_OCCURRED

See Also:

Constant Field Values

commandsManager

protected final info.magnolia.commands.CommandsManager commandsManager

Constructor Detail

AbstractCommandEndpoint

@Inject
public AbstractCommandEndpoint(D endpointDefinition,
                              info.magnolia.commands.CommandsManager commandsManager)

Method Detail

isCommandExecutableByCurrentUser

protected boolean isCommandExecutableByCurrentUser(String catalogName,
                                       String commandName)

Checks whether the current user is allowed to execute the requested command.

Parameters:

catalogName - The catalog name (might be null)

commandName - The command name

Returns:

True if user is allowed to execute command

See Also:

AccessDefinition