Skip navigation links
A C D E G I M N P R S U 

A

AbstractCommandEndpoint<D extends CommandEndpointDefinition> - Class in info.magnolia.rest.service.command
Base class for all command endpoints.
AbstractCommandEndpoint(D, CommandsManager) - Constructor for class info.magnolia.rest.service.command.AbstractCommandEndpoint
 
addNode(RepositoryNode) - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 

C

CommandDefinition - Interface in info.magnolia.rest.service.command.definition
Command definition for white listing commands in command-enabling endpoints.
CommandEndpoint - Class in info.magnolia.rest.service.command.v1
Deprecated.
since 1.1 use CommandEndpoint instead.
CommandEndpoint(CommandEndpointDefinition, CommandsManager) - Constructor for class info.magnolia.rest.service.command.v1.CommandEndpoint
Deprecated.
 
CommandEndpoint - Class in info.magnolia.rest.service.command.v2
REST service for executing commands.
CommandEndpoint(CommandEndpointDefinition, CommandsManager) - Constructor for class info.magnolia.rest.service.command.v2.CommandEndpoint
 
CommandEndpointDefinition - Interface in info.magnolia.rest.service.command.definition
Endpoint definition for CommandEndpointDefinition.
commandsManager - Variable in class info.magnolia.rest.service.command.AbstractCommandEndpoint
 
ConfiguredCommandDefinition - Class in info.magnolia.rest.service.command.definition
Configured command definition.
ConfiguredCommandDefinition() - Constructor for class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
ConfiguredCommandEndpointDefinition - Class in info.magnolia.rest.service.command.definition
Command endpoint definition adding a white-list for enabled commands.
ConfiguredCommandEndpointDefinition() - Constructor for class info.magnolia.rest.service.command.definition.ConfiguredCommandEndpointDefinition
 
ConfiguredNodeEndpointDefinition - Class in info.magnolia.rest.service.node.definition
Endpoint definition class for NodeEndpoint.
ConfiguredNodeEndpointDefinition() - Constructor for class info.magnolia.rest.service.node.definition.ConfiguredNodeEndpointDefinition
 
ConfiguredPropertyEndpointDefinition - Class in info.magnolia.rest.service.property.definition
Endpoint definition class for PropertyEndpoint.
ConfiguredPropertyEndpointDefinition() - Constructor for class info.magnolia.rest.service.property.definition.ConfiguredPropertyEndpointDefinition
 
ConfiguredStatusEndpointDefinition - Class in info.magnolia.rest.service.status
Endpoint definition class for StatusEndpoint.
ConfiguredStatusEndpointDefinition() - Constructor for class info.magnolia.rest.service.status.ConfiguredStatusEndpointDefinition
 
createNode(String, String, RepositoryNode) - Method in class info.magnolia.rest.service.node.v1.NodeEndpoint
Creates a new node and populates it with the supplied properties.
createProperty(String, String, String, List<String>, String, boolean) - Method in class info.magnolia.rest.service.property.v1.PropertyEndpoint
Adds a property to a node.

D

deleteNode(String, String) - Method in class info.magnolia.rest.service.node.v1.NodeEndpoint
Delete a node.
deleteProperty(String, String) - Method in class info.magnolia.rest.service.property.v1.PropertyEndpoint
Deletes a property.

E

executeCommand(String, String, Map<String, Object>) - Method in class info.magnolia.rest.service.command.v1.CommandEndpoint
Deprecated.
 
executeCommand(String, Map<String, Object>) - Method in class info.magnolia.rest.service.command.v1.CommandEndpoint
Deprecated.
 
executeCommand(String, String, Map<String, Object>) - Method in class info.magnolia.rest.service.command.v2.CommandEndpoint
 
executeCommand(String, Map<String, Object>) - Method in class info.magnolia.rest.service.command.v2.CommandEndpoint
 

G

getAccess() - Method in interface info.magnolia.rest.service.command.definition.CommandDefinition
 
getAccess() - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
getCatalogName() - Method in interface info.magnolia.rest.service.command.definition.CommandDefinition
 
getCatalogName() - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
getCommandName() - Method in interface info.magnolia.rest.service.command.definition.CommandDefinition
 
getCommandName() - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
getEnabledCommands() - Method in interface info.magnolia.rest.service.command.definition.CommandEndpointDefinition
 
getEnabledCommands() - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandEndpointDefinition
 
getExtraInstallTasks(InstallContext) - Method in class info.magnolia.rest.service.setup.RestServicesModuleVersionHandler
 
getIdentifier() - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
getName() - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
getName() - Method in class info.magnolia.rest.service.node.v1.RepositoryProperty
 
getNodes() - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
getPath() - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
getProperties() - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
getResponseContextParameters() - Method in interface info.magnolia.rest.service.command.definition.CommandDefinition
Returns configured context parameters that will be then returned in the response after successful command execution.
getResponseContextParameters() - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
getResponseContextParametersForCommand(String, String) - Method in class info.magnolia.rest.service.command.v2.CommandEndpoint
Returns context parameters for particular Command that will be added to the response after successful command execution.
getStringByValue(Value) - Method in class info.magnolia.rest.service.node.v1.RepositoryMarshaller
Gets a string representation of a Value.
getType() - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
getType() - Method in class info.magnolia.rest.service.node.v1.RepositoryProperty
 
getValueByType(int, String, ValueFactory) - Method in class info.magnolia.rest.service.node.v1.RepositoryMarshaller
Get the Value of a property value according to its type.
getValues() - Method in class info.magnolia.rest.service.node.v1.RepositoryProperty
 

I

info.magnolia.rest.service - package info.magnolia.rest.service
 
info.magnolia.rest.service.command - package info.magnolia.rest.service.command
 
info.magnolia.rest.service.command.definition - package info.magnolia.rest.service.command.definition
 
info.magnolia.rest.service.command.v1 - package info.magnolia.rest.service.command.v1
 
info.magnolia.rest.service.command.v2 - package info.magnolia.rest.service.command.v2
 
info.magnolia.rest.service.node.definition - package info.magnolia.rest.service.node.definition
 
info.magnolia.rest.service.node.v1 - package info.magnolia.rest.service.node.v1
 
info.magnolia.rest.service.property.definition - package info.magnolia.rest.service.property.definition
 
info.magnolia.rest.service.property.v1 - package info.magnolia.rest.service.property.v1
 
info.magnolia.rest.service.setup - package info.magnolia.rest.service.setup
 
info.magnolia.rest.service.status - package info.magnolia.rest.service.status
 
isCommandExecutableByCurrentUser(String, String) - Method in class info.magnolia.rest.service.command.AbstractCommandEndpoint
Checks whether the current user is allowed to execute the requested command.
isMultiple() - Method in class info.magnolia.rest.service.node.v1.RepositoryProperty
 

M

marshallNode(Node) - Method in class info.magnolia.rest.service.node.v1.RepositoryMarshaller
 
marshallNode(Node, int, List<String>, boolean) - Method in class info.magnolia.rest.service.node.v1.RepositoryMarshaller
 
marshallProperty(Property) - Method in class info.magnolia.rest.service.node.v1.RepositoryMarshaller
 

N

NodeEndpoint<D extends NodeEndpointDefinition> - Class in info.magnolia.rest.service.node.v1
Endpoint for accessing and manipulating nodes.
NodeEndpoint(D) - Constructor for class info.magnolia.rest.service.node.v1.NodeEndpoint
 
NodeEndpointDefinition - Interface in info.magnolia.rest.service.node.definition
Endpoint definition for NodeEndpoint.

P

PropertyEndpoint<D extends PropertyEndpointDefinition> - Class in info.magnolia.rest.service.property.v1
Endpoint for accessing and manipulating properties.
PropertyEndpoint(D) - Constructor for class info.magnolia.rest.service.property.v1.PropertyEndpoint
 
PropertyEndpointDefinition - Interface in info.magnolia.rest.service.property.definition
Endpoint definition for PropertyEndpoint.

R

readNode(String, String, int, String, boolean) - Method in class info.magnolia.rest.service.node.v1.NodeEndpoint
Returns a node including its properties and child nodes down to a certain depth.
readProperty(String, String) - Method in class info.magnolia.rest.service.property.v1.PropertyEndpoint
Returns the string representation of a property's value.
RepositoryMarshaller - Class in info.magnolia.rest.service.node.v1
Marshaller used to marshall JCR content into its transfer representation RepositoryNode and unmarshall back into the repository.
RepositoryMarshaller() - Constructor for class info.magnolia.rest.service.node.v1.RepositoryMarshaller
 
RepositoryNode - Class in info.magnolia.rest.service.node.v1
Represents a node in a workspace.
RepositoryNode() - Constructor for class info.magnolia.rest.service.node.v1.RepositoryNode
 
RepositoryProperty - Class in info.magnolia.rest.service.node.v1
Represent a property in the repository.
RepositoryProperty() - Constructor for class info.magnolia.rest.service.node.v1.RepositoryProperty
 
RestServicesModule - Class in info.magnolia.rest.service
Defines what has to be done upon start and stop of its module.
RestServicesModule() - Constructor for class info.magnolia.rest.service.RestServicesModule
 
RestServicesModuleVersionHandler - Class in info.magnolia.rest.service.setup
Module version handler for RestServicesModule.
RestServicesModuleVersionHandler() - Constructor for class info.magnolia.rest.service.setup.RestServicesModuleVersionHandler
 

S

setAccess(AccessDefinition) - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
setCatalogName(String) - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
setCommandName(String) - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
setContextParameters(Collection<String>) - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandDefinition
 
setEnabledCommands(Collection<CommandDefinition>) - Method in class info.magnolia.rest.service.command.definition.ConfiguredCommandEndpointDefinition
 
setIdentifier(String) - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
setMultiple(boolean) - Method in class info.magnolia.rest.service.node.v1.RepositoryProperty
 
setName(String) - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
setName(String) - Method in class info.magnolia.rest.service.node.v1.RepositoryProperty
 
setPath(String) - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
setProperties(List<RepositoryProperty>) - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
setType(String) - Method in class info.magnolia.rest.service.node.v1.RepositoryNode
 
setType(String) - Method in class info.magnolia.rest.service.node.v1.RepositoryProperty
 
setValues(List<String>) - Method in class info.magnolia.rest.service.node.v1.RepositoryProperty
 
splitExcludeNodeTypesString(String) - Method in class info.magnolia.rest.service.node.v1.NodeEndpoint
 
status() - Method in class info.magnolia.rest.service.status.StatusEndpoint
 
STATUS_MESSAGE_COMMAND_NOT_FOUND - Static variable in class info.magnolia.rest.service.command.AbstractCommandEndpoint
 
STATUS_MESSAGE_ERROR_OCCURRED - Static variable in class info.magnolia.rest.service.command.AbstractCommandEndpoint
 
STATUS_MESSAGE_FORBIDDEN - Static variable in class info.magnolia.rest.service.command.AbstractCommandEndpoint
 
STATUS_MESSAGE_OK - Static variable in class info.magnolia.rest.service.command.AbstractCommandEndpoint
 
StatusEndpoint - Class in info.magnolia.rest.service.status
Status endpoint implementation that returns a 200 HTTP status code as soon Magnolia is ready, 503 otherwise.
StatusEndpoint(StatusEndpointDefinition, ModuleManager) - Constructor for class info.magnolia.rest.service.status.StatusEndpoint
 
StatusEndpointDefinition - Interface in info.magnolia.rest.service.status
Endpoint definition for StatusEndpoint.

U

unmarshallProperties(Node, List<RepositoryProperty>) - Method in class info.magnolia.rest.service.node.v1.RepositoryMarshaller
 
unmarshallProperty(Node, RepositoryProperty) - Method in class info.magnolia.rest.service.node.v1.RepositoryMarshaller
 
updateNode(String, String, RepositoryNode) - Method in class info.magnolia.rest.service.node.v1.NodeEndpoint
Adds properties to a node.
updateProperty(String, String, List<String>, String, boolean) - Method in class info.magnolia.rest.service.property.v1.PropertyEndpoint
Sets the value of an existing property.
A C D E G I M N P R S U 
Skip navigation links

Copyright © 2020 Magnolia International Ltd.. All rights reserved.