com.gentics.contentnode.rest.resource

Interface NodeResource

@Path(value="node")
public interface NodeResource

Resource for handling Nodes in GCN

Method Summary

Modifier and Type	Method and Description
GenericResponse	activateFeature(String nodeId, NodeFeature feature) Activate the feature for the node
GenericResponse	activateFeatures(String nodeId, NodeFeatureRequest request) Deprecated.
NodeLoadResponse	add(NodeSaveRequest request) Create a new node.
GenericResponse	addConstruct(String nodeId, String constructId) Add a construct to a node.
GenericResponse	addLanguage(String nodeId, String languageId) Add language to node
GenericResponse	addObjectProperty(String nodeId, String opId) Add an object property to a node.
GenericResponse	addTemplate(String nodeId, String templateId) Add a template to a node.
FeatureModelList	availableFeatures(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging) Get list of available node features. The result can be filtered by id name description and sorted by id name description
LanguageList	availableLanguages(String nodeId, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging) Get list of languages, which can be assigned to the node. The result can be filtered by id globalId name code and sorted by id globalId name code
GenericResponse	copy(String nodeId, long waitMs, NodeCopyRequest request) Copy the given node.
NodeLoadResponse	create(NodeSaveRequest request) Deprecated.
GenericResponse	deactivateFeature(String nodeId, NodeFeature feature) Deactivate the feature for the node
GenericResponse	deactivateFeatures(String nodeId, NodeFeatureRequest request) Deprecated.
GenericResponse	delete(String nodeId, long waitMs) Delete the given node
FeatureList	features(String nodeId, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging) Get list of features activated for the node. The result can be filtered by name and sorted by name
NodeLoadResponse	get(String nodeId, boolean update) Load a single node
PagedConstructListResponse	getConstructs(String nodeId, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms) Get the constructs assigned to this node. The result can be filtered by keyword name description and sorted by id globalId keyword name description
NodeFeatureResponse	getFeatures(String nodeId) Deprecated.
PagedObjectPropertyListResponse	getObjectProperties(String nodeId, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms) Get the object properties assigned to this node. The result can be filtered by keyword name description and sorted by keyword name description
TemplateLoadResponse	getTemplate(String nodeId, String templateId) Get the template, if it is assigned to the node
PagedTemplateListResponse	getTemplates(String nodeId, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms) Get the templates assigned to this node.
LanguageListResponse	languages(String nodeId) Deprecated.
LanguageList	languages(String nodeId, FilterParameterBean filter, PagingParameterBean paging) Get list of languages in the node.
NodeList	list(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms, String stagingPackageName) List nodes. The result can be filtered by id name and sorted by id name
NodeLoadResponse	load(String nodeId, boolean update) Deprecated.
GenericResponse	removeConstruct(String nodeId, String constructId) Remove a construct from a node.
GenericResponse	removeLanguage(String nodeId, String languageId) Remove language from node
GenericResponse	removeObjectProperty(String nodeId, String opId) Remove an object property from a node.
GenericResponse	removeTemplate(String nodeId, String templateId) Remove a template from a node.
GenericResponse	save(String nodeId, NodeSaveRequest request) Deprecated.
GenericResponse	setFeatures(String nodeId, NodeFeatureRequest request) Deprecated.
LanguageList	setLanguages(String nodeId, List<ContentLanguage> languages) Set ordered list of languages
NodeSettingsResponse	settings(String nodeId) Load settings specific to the specified node.
GenericResponse	update(String nodeId, NodeSaveRequest request) Saves the values specified in the request to the node.

Method Detail

add

@PUT
 @Path(value="/")
NodeLoadResponse add(NodeSaveRequest request)
                                     throws Exception

Create a new node. See NodeResourceImpl#checkCreateRequest for a detailed list of constraints on the given request. In short:

• the node and hostname must be provided
• no other node with the same hostname and (binary) publish directory may exist
• if the Aloha editor is to be used, utf8 must be enabled

Parameters:

request - The request containing a REST model of the node to be created.

Returns:

A node load response containing the values of the newly created node on success, or a response code indicating any errors on failure.

Throws:

Exception

get

@GET
 @Path(value="/{id}")
NodeLoadResponse get(@PathParam(value="id")
                                                String nodeId,
                                                @DefaultValue(value="false") @QueryParam(value="update")
                                                boolean update)
                                         throws Exception

Load a single node

Parameters:

nodeId - id of the node to load. This can be either the localid or a globalid

update - true when the folder is fetched for updating. Currently, nodes cannot be locked in the backend, but it is still recommended to set this parameter to true when the node shall be modified.

Returns:

response containing the node to load

Throws:

Exception

update

@POST
 @Path(value="/{id}")
GenericResponse update(@PathParam(value="id")
                                                   String nodeId,
                                                   NodeSaveRequest request)
                                            throws Exception

Saves the values specified in the request to the node. See NodeResourceImpl#checkRequestConsistency for a detailed list of constraints on the request. In short:

• any folder id that is given must be valid
• no other node with the same hostname and (binary) publish directory may exist
• if the Aloha editor is to be used, utf8 must be enabled

Parameters:

id - The id of the node to save.

request - The request containing the fields to be updated in the node.

Returns:

A generic response indicating the success or failure of the operation.

Throws:

Exception

delete

@DELETE
 @Path(value="/{id}")
GenericResponse delete(@PathParam(value="id")
                                                     String nodeId,
                                                     @QueryParam(value="wait") @DefaultValue(value="0")
                                                     long waitMs)
                                              throws Exception

Delete the given node

Parameters:

nodeId - id of the node

waitMs - wait timeout in milliseconds

Returns:

response

Throws:

Exception

list

@GET
NodeList list(@BeanParam
                   FilterParameterBean filter,
                   @BeanParam
                   SortParameterBean sorting,
                   @BeanParam
                   PagingParameterBean paging,
                   @BeanParam
                   PermsParameterBean perms,
                   @QueryParam(value="package")
                   String stagingPackageName)
            throws Exception

List nodes.
The result can be filtered by

• id
• name

and sorted by

• id
• name

Parameters:

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - perms parameters

stagingPackageName - if given, check the node status against the staging package

Returns:

node list

Throws:

Exception - in case of errors

languages

@GET
 @Path(value="/{id}/languages")
LanguageList languages(@PathParam(value="id")
                                                            String nodeId,
                                                            @BeanParam
                                                            FilterParameterBean filter,
                                                            @BeanParam
                                                            PagingParameterBean paging)
                                                     throws Exception

Get list of languages in the node. The result can be filtered by

• id
• globalId
• name
• code

Parameters:

nodeId - node id

filter - filter parameters

paging - paging parameters

Returns:

ordered list of languages

Throws:

Exception

availableLanguages

@GET
 @Path(value="/{id}/availableLanguages")
LanguageList availableLanguages(@PathParam(value="id")
                                                                              String nodeId,
                                                                              @BeanParam
                                                                              FilterParameterBean filter,
                                                                              @BeanParam
                                                                              SortParameterBean sorting,
                                                                              @BeanParam
                                                                              PagingParameterBean paging)
                                                                       throws Exception

Get list of languages, which can be assigned to the node.
The result can be filtered by

• id
• globalId
• name
• code

and sorted by

• id
• globalId
• name
• code

Parameters:

nodeId - node id

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

Returns:

list of available languages

Throws:

Exception

addLanguage

@PUT
 @Path(value="/{id}/languages/{languageId}")
GenericResponse addLanguage(@PathParam(value="id")
                                                                              String nodeId,
                                                                              @PathParam(value="languageId")
                                                                              String languageId)
                                                                       throws Exception

Add language to node

Parameters:

nodeId - node id

languageId - language id or language code

Returns:

response

Throws:

Exception

removeLanguage

@DELETE
 @Path(value="/{id}/languages/{languageId}")
GenericResponse removeLanguage(@PathParam(value="id")
                                                                                    String nodeId,
                                                                                    @PathParam(value="languageId")
                                                                                    String languageId)
                                                                             throws Exception

Remove language from node

Parameters:

nodeId - node id

languageId - language id or language code

Returns:

response

Throws:

Exception

setLanguages

@POST
 @Path(value="/{id}/languages")
LanguageList setLanguages(@PathParam(value="id")
                                                                String nodeId,
                                                                List<ContentLanguage> languages)
                                                         throws Exception

Set ordered list of languages

Parameters:

nodeId - node id

languages - ordered list of languages

Returns:

response

Throws:

Exception

create

@POST
 @Path(value="/create")
 @Deprecated
NodeLoadResponse create(NodeSaveRequest request)
                                                            throws Exception

Deprecated.

Create a new node. See NodeResourceImpl#checkCreateRequest for a detailed list of constraints on the given request. In short:

• the node and hostname must be provided
• no other node with the same hostname and (binary) publish directory may exist
• if the Aloha editor is to be used, utf8 must be enabled

Parameters:

request - The request containing a REST model of the node to be created.

Returns:

A node load response containing the values of the newly created node on success, or a response code indicating any errors on failure.

Throws:

Exception

save

@POST
 @Path(value="/save/{id}")
 @Deprecated
GenericResponse save(@PathParam(value="id")
                                                                   String nodeId,
                                                                   NodeSaveRequest request)
                                                            throws Exception

Deprecated.

Saves the values specified in the request to the node. See NodeResourceImpl#checkRequestConsistency for a detailed list of constraints on the request. In short:

• any folder id that is given must be valid
• no other node with the same hostname and (binary) publish directory may exist
• if the Aloha editor is to be used, utf8 must be enabled

Parameters:

id - The id of the node to save.

request - The request containing the fields to be updated in the node.

Returns:

A generic response indicating the success or failure of the operation.

Throws:

Exception

load

@GET
 @Path(value="/load/{id}")
 @Deprecated
NodeLoadResponse load(@PathParam(value="id")
                                                                   String nodeId,
                                                                   @DefaultValue(value="false") @QueryParam(value="update")
                                                                   boolean update)
                                                            throws Exception

Deprecated.

Load a single node

Parameters:

nodeId - id of the node to load. This can be either the localid or a globalid

update - true when the folder is fetched for updating. Currently, nodes cannot be locked in the backend, but it is still recommended to set this parameter to true when the node shall be modified.

Returns:

response containing the node to load

Throws:

Exception

languages

@GET
 @Path(value="/getLanguages/{id}")
 @Deprecated
LanguageListResponse languages(@PathParam(value="id")
                                                                                    String nodeId)
                                                                             throws Exception

Deprecated.

Get the ordered list of languages of the node

Parameters:

nodeId - node id

Returns:

ordered list of languages

Throws:

Exception

features

@GET
 @Path(value="/{id}/features")
FeatureList features(@PathParam(value="id")
                                                         String nodeId,
                                                         @BeanParam
                                                         FilterParameterBean filter,
                                                         @BeanParam
                                                         SortParameterBean sorting,
                                                         @BeanParam
                                                         PagingParameterBean paging)
                                                  throws Exception

Get list of features activated for the node.
The result can be filtered by

• name

and sorted by

• name

Parameters:

nodeId - node ID

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

Returns:

list of activated features

Throws:

Exception

activateFeature

@PUT
 @Path(value="/{id}/features/{feature}")
GenericResponse activateFeature(@PathParam(value="id")
                                                                              String nodeId,
                                                                              @PathParam(value="feature")
                                                                              NodeFeature feature)
                                                                       throws Exception

Activate the feature for the node

Parameters:

nodeId - node ID

feature - feature to activate

Returns:

response

Throws:

Exception

deactivateFeature

@DELETE
 @Path(value="/{id}/features/{feature}")
GenericResponse deactivateFeature(@PathParam(value="id")
                                                                                   String nodeId,
                                                                                   @PathParam(value="feature")
                                                                                   NodeFeature feature)
                                                                            throws Exception

Deactivate the feature for the node

Parameters:

nodeId - node ID

feature - feature to activate

Returns:

response

Throws:

Exception

getFeatures

@GET
 @Path(value="/features/{id}")
 @Deprecated
NodeFeatureResponse getFeatures(@PathParam(value="id")
                                                                                 String nodeId)
                                                                          throws Exception

Deprecated.

Load the activated features

Parameters:

nodeId - id of the node

Returns:

response containing the activated features

Throws:

Exception

activateFeatures

@POST
 @Path(value="/features/activate/{id}")
 @Deprecated
GenericResponse activateFeatures(@PathParam(value="id")
                                                                                            String nodeId,
                                                                                            NodeFeatureRequest request)
                                                                                     throws Exception

Deprecated.

Activate the given list of features (features not listed will not be changed)

Parameters:

nodeId - id of the node. This can be either the localid or the globalid

Returns:

generic response

Throws:

Exception

deactivateFeatures

@POST
 @Path(value="/features/deactivate/{id}")
 @Deprecated
GenericResponse deactivateFeatures(@PathParam(value="id")
                                                                                                String nodeId,
                                                                                                NodeFeatureRequest request)
                                                                                         throws Exception

Deprecated.

Deactivate the given list of features (features not listed will not be changed)

Parameters:

nodeId - id of the node. This can be either the localid or the globalid

Returns:

generic response

Throws:

Exception

setFeatures

@POST
 @Path(value="/features/set/{id}")
 @Deprecated
GenericResponse setFeatures(@PathParam(value="id")
                                                                                  String nodeId,
                                                                                  NodeFeatureRequest request)
                                                                           throws Exception

Deprecated.

Set the given list of features. Exactly the listed features will be activated, all other will be deactivated

Parameters:

nodeId - id of the node. This can be either the localid or the globalid

Returns:

generic response

Throws:

Exception

getTemplates

@GET
 @Path(value="/{nodeId}/templates")
PagedTemplateListResponse getTemplates(@PathParam(value="nodeId")
                                                                                String nodeId,
                                                                                @BeanParam
                                                                                FilterParameterBean filter,
                                                                                @BeanParam
                                                                                SortParameterBean sorting,
                                                                                @BeanParam
                                                                                PagingParameterBean paging,
                                                                                @BeanParam
                                                                                PermsParameterBean perms)
                                                                         throws Exception

Get the templates assigned to this node. The result can be filtered by

• name
• description

and sorted by

• name
• description

Parameters:

nodeId - Node ID (local or global)

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

Returns:

Response containing the templates assigned to this node

Throws:

Exception

getTemplate

@GET
 @Path(value="/{nodeId}/templates/{templateId}")
TemplateLoadResponse getTemplate(@PathParam(value="nodeId")
                                                                                       String nodeId,
                                                                                       @PathParam(value="templateId")
                                                                                       String templateId)
                                                                                throws Exception

Get the template, if it is assigned to the node

Parameters:

nodeId - Node ID (local or global)

templateId - Template ID (local or global)

Returns:

template load response

Throws:

Exception

addTemplate

@PUT
 @Path(value="/{nodeId}/templates/{templateId}")
GenericResponse addTemplate(@PathParam(value="nodeId")
                                                                                  String nodeId,
                                                                                  @PathParam(value="templateId")
                                                                                  String templateId)
                                                                           throws Exception

Add a template to a node. This will just assign the template to the node, but not link it to any folders.

Parameters:

nodeId - Node ID (local or global)

templateId - Template ID (local or global)

Returns:

Generic response

Throws:

Exception

removeTemplate

@DELETE
 @Path(value="/{nodeId}/templates/{templateId}")
GenericResponse removeTemplate(@PathParam(value="nodeId")
                                                                                        String nodeId,
                                                                                        @PathParam(value="templateId")
                                                                                        String templateId)
                                                                                 throws Exception

Remove a template from a node. This will also unlink the template from all folders of the node

Parameters:

nodeId - Node ID (local or global)

templateId - Template ID (local or global)

Returns:

Generic response

Throws:

Exception

getConstructs

@GET
 @Path(value="/{nodeId}/constructs")
PagedConstructListResponse getConstructs(@PathParam(value="nodeId")
                                                                                   String nodeId,
                                                                                   @BeanParam
                                                                                   FilterParameterBean filter,
                                                                                   @BeanParam
                                                                                   SortParameterBean sorting,
                                                                                   @BeanParam
                                                                                   PagingParameterBean paging,
                                                                                   @BeanParam
                                                                                   PermsParameterBean perms)
                                                                            throws Exception

Get the constructs assigned to this node.
The result can be filtered by

• keyword
• name
• description

and sorted by

• id
• globalId
• keyword
• name
• description

Parameters:

nodeId - Node ID (local or global)

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

Returns:

Response containing the constructs assigned to this node

Throws:

Exception

addConstruct

@PUT
 @Path(value="/{nodeId}/constructs/{constructId}")
GenericResponse addConstruct(@PathParam(value="nodeId")
                                                                                     String nodeId,
                                                                                     @PathParam(value="constructId")
                                                                                     String constructId)
                                                                              throws Exception

Add a construct to a node.

Parameters:

nodeId - Node ID (local or global)

constructId - Construct ID (local or global)

Returns:

Generic response

Throws:

Exception

removeConstruct

@DELETE
 @Path(value="/{nodeId}/constructs/{constructId}")
GenericResponse removeConstruct(@PathParam(value="nodeId")
                                                                                           String nodeId,
                                                                                           @PathParam(value="constructId")
                                                                                           String constructId)
                                                                                    throws Exception

Remove a construct from a node.

Parameters:

nodeId - Node ID (local or global)

constructId - Construct ID (local or global)

Returns:

Generic response

Throws:

Exception

getObjectProperties

@GET
 @Path(value="/{nodeId}/objectproperties")
PagedObjectPropertyListResponse getObjectProperties(@PathParam(value="nodeId")
                                                                                                    String nodeId,
                                                                                                    @BeanParam
                                                                                                    FilterParameterBean filter,
                                                                                                    @BeanParam
                                                                                                    SortParameterBean sorting,
                                                                                                    @BeanParam
                                                                                                    PagingParameterBean paging,
                                                                                                    @BeanParam
                                                                                                    PermsParameterBean perms)
                                                                                             throws Exception

Get the object properties assigned to this node.
The result can be filtered by

• keyword
• name
• description

and sorted by

• keyword
• name
• description

Parameters:

nodeId - Node ID (local or global)

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

Returns:

Response containing the object properties assigned to this node

Throws:

Exception

addObjectProperty

@PUT
 @Path(value="/{nodeId}/objectproperties/{objectPropertyId}")
GenericResponse addObjectProperty(@PathParam(value="nodeId")
                                                                                                     String nodeId,
                                                                                                     @PathParam(value="objectPropertyId")
                                                                                                     String opId)
                                                                                              throws Exception

Add an object property to a node.

Parameters:

nodeId - Node ID (local or global)

objectPropertyId - Property ID

Returns:

Generic response

Throws:

Exception

removeObjectProperty

@DELETE
 @Path(value="/{nodeId}/objectproperties/{objectPropertyId}")
GenericResponse removeObjectProperty(@PathParam(value="nodeId")
                                                                                                           String nodeId,
                                                                                                           @PathParam(value="objectPropertyId")
                                                                                                           String opId)
                                                                                                    throws Exception

Remove an object property from a node.

Parameters:

nodeId - Node ID (local or global)

opId - Construct ID (local or global)

Returns:

Generic response

Throws:

Exception

settings

@GET
 @Path(value="/{nodeId}/settings")
NodeSettingsResponse settings(@PathParam(value="nodeId")
                                                                      String nodeId)
                                                               throws Exception

Load settings specific to the specified node. To get the settings in $NODE_SETTINGS_GLOBAL are loaded and then the values from $NODE_SETTINGS[nodeId] are added.

Parameters:

nodeId - Node ID (local or global)

Returns:

The conigured settings for this node in JSON format

Throws:

Exception - On errors

availableFeatures

@GET
 @Path(value="/features")
FeatureModelList availableFeatures(@BeanParam
                                                                  FilterParameterBean filter,
                                                                  @BeanParam
                                                                  SortParameterBean sorting,
                                                                  @BeanParam
                                                                  PagingParameterBean paging)
                                                           throws Exception

Get list of available node features.
The result can be filtered by

• id
• name
• description

and sorted by

• id
• name
• description

Parameters:

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

Returns:

list response

Throws:

Exception

copy

@POST
 @Path(value="/{nodeId}/copy")
GenericResponse copy(@PathParam(value="nodeId")
                                                          String nodeId,
                                                          @QueryParam(value="wait") @DefaultValue(value="0")
                                                          long waitMs,
                                                          NodeCopyRequest request)
                                                   throws Exception

Copy the given node.

Parameters:

nodeId - node ID

waitMs - wait timeout in milliseconds

request - copy request

Returns:

response

Throws:

Exception