@Path(value="/devtools")
public interface PackageResource
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
add(String name)
Add the package with given name
|
javax.ws.rs.core.Response |
addConstruct(String name,
String construct)
Add a construct to a package
|
javax.ws.rs.core.Response |
addContentRepository(String name,
String contentrepository)
Add a ContentRepository to a package
|
javax.ws.rs.core.Response |
addCrFragment(String name,
String crFragment)
Add a ContentRepository Fragment to a package
|
javax.ws.rs.core.Response |
addDatasource(String name,
String datasource)
Add a datasource to a package
|
javax.ws.rs.core.Response |
addObjectProperty(String name,
String objectproperty)
Add an object property to a package
|
javax.ws.rs.core.Response |
addPackage(String nodeId,
Package addedPackage)
Add the package to the node.
|
javax.ws.rs.core.Response |
addPackage(String nodeId,
String packageName)
Add the package to the node.
|
javax.ws.rs.core.Response |
addTemplate(String name,
String template)
Add a template to a package
|
List<AutocompleteItem> |
autocompleteConstructs(String term)
Endpoint for autocomplete UI components for constructs.
|
List<AutocompleteItem> |
autocompleteContentRepositories(String term)
Endpoint for autocomplete UI components for contentrepositories.
|
List<AutocompleteItem> |
autocompleteCrFragments(String term)
Endpoint for autocomplete UI components for cr fragments.
|
List<AutocompleteItem> |
autocompleteDatasources(String term)
Endpoint for autocomplete UI components for datasources.
|
List<AutocompleteItem> |
autocompleteObjectProperties(String term)
Endpoint for autocomplete UI components for object properties.
|
List<AutocompleteItem> |
autocompleteTemplates(String term)
Endpoint for autocomplete UI components for templates.
|
javax.ws.rs.core.Response |
delete(String name)
Delete the package with given name
|
Package |
get(String name)
Get the package with given name
|
ConstructLoadResponse |
getConstruct(String name,
String construct)
Get the construct from the package
|
ContentRepositoryResponse |
getContentRepository(String name,
String contentrepository)
Get the ContentRepository in a package
|
ContentRepositoryFragmentResponse |
getCrFragment(String name,
String crFragment)
Get the ContentRepository Fragment in a package
|
DatasourceLoadResponse |
getDatasource(String name,
String datasource)
Get the datasource in a package
|
ObjectPropertyLoadResponse |
getObjectProperty(String name,
String objectproperty)
Get the object property in a package
|
SyncInfo |
getSyncInfo()
Get the current status information for the automatic synchronization.
|
TemplateLoadResponse |
getTemplate(String name,
String template)
Get the template in the package
|
PackageListResponse |
list(FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
List available packages
|
PagedConstructInPackageListResponse |
listConstructs(String name,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
Get the list of constructs assigned to the package
|
PagedContentRepositoryInPackageListResponse |
listContentRepositories(String name,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging,
EmbedParameterBean embed)
Get the ContentRepositories in a package
|
PagedContentRepositoryFragmentInPackageListResponse |
listCrFragments(String name,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging,
EmbedParameterBean embed)
Get the ContentRepository Fragments in a package
|
PagedDatasourceInPackageListResponse |
listDatasources(String name,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
Get the datasources in a package
|
org.glassfish.jersey.media.sse.EventOutput |
listenPageChange(String uuid)
Listen on changes on dependencies with the given UUID
|
PackageListResponse |
listNodePackages(String nodeId,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
List packages assigned to a node.
|
PagedObjectPropertyInPackageListResponse |
listObjectProperties(String name,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging,
EmbedParameterBean embed)
Get the object properties in a package
|
PagedTemplateInPackageListResponse |
listTemplates(String name,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
Get the templates of a package
|
String |
preview(String uuid)
Render the live preview of the page, which was registered before
|
javax.ws.rs.core.Response |
removeConstruct(String name,
String construct)
Remove a construct from a package
|
javax.ws.rs.core.Response |
removeContentRepository(String name,
String contentrepository)
Remove a ContentRepository from a package
|
javax.ws.rs.core.Response |
removeCrFragment(String name,
String crFragment)
Remove a ContentRepository Fragment from a package
|
javax.ws.rs.core.Response |
removeDatasource(String name,
String datasource)
Remove a datasource from a package
|
javax.ws.rs.core.Response |
removeObjectProperty(String name,
String objectproperty)
Remove an object property from a package
|
javax.ws.rs.core.Response |
removePackage(String nodeId,
String packageName)
Remove the package from the node.
|
javax.ws.rs.core.Response |
removeTemplate(String name,
String template)
Remove a template from a package
|
String |
renderPage(String id,
String nodeId)
Get self refreshing live preview of the given page
|
SyncInfo |
startSync()
Start the sync for the current user (if not started before)
|
javax.ws.rs.core.Response |
stopSync()
Stop the sync, if it was started by the current user
|
GenericResponse |
synchronizeFromFS(String name,
long waitMs)
Trigger synchronization of all objects in the given package to the cms
|
GenericResponse |
synchronizeToFS(String name,
long waitMs)
Trigger synchronization of all objects in the given package to the filesystem
|
@GET @Path(value="/packages") PackageListResponse list(@BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
filter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@GET @Path(value="/packages/{name}") Package get(@PathParam(value="name") String name) throws Exception
name
- Package nameException
@PUT @Path(value="/packages/{name}") javax.ws.rs.core.Response add(@PathParam(value="name") String name) throws Exception
name
- Package nameException
@DELETE @Path(value="/packages/{name}") javax.ws.rs.core.Response delete(@PathParam(value="name") String name) throws Exception
name
- Package nameException
@PUT @Path(value="/packages/{name}/cms2fs") GenericResponse synchronizeToFS(@PathParam(value="name") String name, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs) throws Exception
name
- name of the packagewaitMs
- wait timeout in ms. When set to 0, response will be sent, when the action completesException
@PUT @Path(value="/packages/{name}/fs2cms") GenericResponse synchronizeFromFS(@PathParam(value="name") String name, @QueryParam(value="wait") @DefaultValue(value="0") long waitMs) throws Exception
name
- name of the packagewaitMs
- wait timeout in ms. When set to 0, response will be sent, when the action completesException
@GET @Path(value="/packages/{name}/constructs") PagedConstructInPackageListResponse listConstructs(@PathParam(value="name") String name, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
name
- Package namefilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@GET @Path(value="/packages/{name}/constructs/{construct}") ConstructLoadResponse getConstruct(@PathParam(value="name") String name, @PathParam(value="construct") String construct) throws Exception
name
- Package nameconstruct
- construct ID (internal or global) or keywordException
@PUT @Path(value="/packages/{name}/constructs/{construct}") javax.ws.rs.core.Response addConstruct(@PathParam(value="name") String name, @PathParam(value="construct") String construct) throws Exception
name
- Package nameconstruct
- construct ID (internal or global) or keywordException
@DELETE @Path(value="/packages/{name}/constructs/{construct}") javax.ws.rs.core.Response removeConstruct(@PathParam(value="name") String name, @PathParam(value="construct") String construct) throws Exception
name
- Package nameconstruct
- construct ID (internal or global) or keywordException
@GET @Path(value="/packages/{name}/templates") PagedTemplateInPackageListResponse listTemplates(@PathParam(value="name") String name, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
name
- Package namefilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@GET @Path(value="/packages/{name}/templates/{template}") TemplateLoadResponse getTemplate(@PathParam(value="name") String name, @PathParam(value="template") String template) throws Exception
name
- Package nametemplate
- global template ID (uuid)Exception
@PUT @Path(value="/packages/{name}/templates/{template}") javax.ws.rs.core.Response addTemplate(@PathParam(value="name") String name, @PathParam(value="template") String template) throws Exception
name
- Package nametemplate
- global template ID (uuid)Exception
@DELETE @Path(value="/packages/{name}/templates/{template}") javax.ws.rs.core.Response removeTemplate(@PathParam(value="name") String name, @PathParam(value="template") String template) throws Exception
name
- Package nametemplate
- global template ID (uuid)Exception
@GET @Path(value="/packages/{name}/datasources") PagedDatasourceInPackageListResponse listDatasources(@PathParam(value="name") String name, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
name
- Package namefilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@GET @Path(value="/packages/{name}/datasources/{datasource}") DatasourceLoadResponse getDatasource(@PathParam(value="name") String name, @PathParam(value="datasource") String datasource) throws Exception
name
- Package namedatasource
- datasource nameException
@PUT @Path(value="/packages/{name}/datasources/{datasource}") javax.ws.rs.core.Response addDatasource(@PathParam(value="name") String name, @PathParam(value="datasource") String datasource) throws Exception
name
- Package namedatasource
- datasource nameException
@DELETE @Path(value="/packages/{name}/datasources/{datasource}") javax.ws.rs.core.Response removeDatasource(@PathParam(value="name") String name, @PathParam(value="datasource") String datasource) throws Exception
name
- Package namedatasource
- datasource nameException
@GET @Path(value="/packages/{name}/objectproperties") PagedObjectPropertyInPackageListResponse listObjectProperties(@PathParam(value="name") String name, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging, @BeanParam EmbedParameterBean embed) throws Exception
name
- Package namefilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersembed
- embed parametersException
@GET @Path(value="/packages/{name}/objectproperties/{objectproperty}") ObjectPropertyLoadResponse getObjectProperty(@PathParam(value="name") String name, @PathParam(value="objectproperty") String objectproperty) throws Exception
name
- Package nameobjectproperty
- object property keywordException
@PUT @Path(value="/packages/{name}/objectproperties/{objectproperty}") javax.ws.rs.core.Response addObjectProperty(@PathParam(value="name") String name, @PathParam(value="objectproperty") String objectproperty) throws Exception
name
- Package nameobjectproperty
- object property keywordException
@DELETE @Path(value="/packages/{name}/objectproperties/{objectproperty}") javax.ws.rs.core.Response removeObjectProperty(@PathParam(value="name") String name, @PathParam(value="objectproperty") String objectproperty) throws Exception
name
- Package nameobjectproperty
- object property keywordException
@GET @Path(value="/packages/{name}/cr_fragments") PagedContentRepositoryFragmentInPackageListResponse listCrFragments(@PathParam(value="name") String name, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging, @BeanParam EmbedParameterBean embed) throws Exception
name
- Package namefilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersembed
- embed parametersException
@GET @Path(value="/packages/{name}/cr_fragments/{cr_fragment}") ContentRepositoryFragmentResponse getCrFragment(@PathParam(value="name") String name, @PathParam(value="cr_fragment") String crFragment) throws Exception
name
- Package namecrFragment
- ContentRepository Fragment name, local ID or global IDException
@PUT @Path(value="/packages/{name}/cr_fragments/{cr_fragment}") javax.ws.rs.core.Response addCrFragment(@PathParam(value="name") String name, @PathParam(value="cr_fragment") String crFragment) throws Exception
name
- Package namecrFragment
- ContentRepository Fragment name, local ID or global IDException
@DELETE @Path(value="/packages/{name}/cr_fragments/{cr_fragment}") javax.ws.rs.core.Response removeCrFragment(@PathParam(value="name") String name, @PathParam(value="cr_fragment") String crFragment) throws Exception
name
- Package namecrFragment
- ContentRepository Fragment name, local ID or global IDException
@GET @Path(value="/packages/{name}/contentrepositories") PagedContentRepositoryInPackageListResponse listContentRepositories(@PathParam(value="name") String name, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging, @BeanParam EmbedParameterBean embed) throws Exception
name
- Package namefilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersembed
- embed parametersException
@GET @Path(value="/packages/{name}/contentrepositories/{contentrepository}") ContentRepositoryResponse getContentRepository(@PathParam(value="name") String name, @PathParam(value="contentrepository") String contentrepository) throws Exception
name
- Package namecontentrepository
- ContentRepository name, local ID or global IDException
@PUT @Path(value="/packages/{name}/contentrepositories/{contentrepository}") javax.ws.rs.core.Response addContentRepository(@PathParam(value="name") String name, @PathParam(value="contentrepository") String contentrepository) throws Exception
name
- Package namecontentrepository
- ContentRepository name, local ID or global IDException
@DELETE @Path(value="/packages/{name}/contentrepositories/{contentrepository}") javax.ws.rs.core.Response removeContentRepository(@PathParam(value="name") String name, @PathParam(value="contentrepository") String contentrepository) throws Exception
name
- Package namecontentrepository
- ContentRepository name, local ID or global IDException
@GET @Path(value="/nodes/{nodeId}/packages") PackageListResponse listNodePackages(@PathParam(value="nodeId") String nodeId, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
nodeId
- Node ID (either global or local)filter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@DELETE @Path(value="/nodes/{nodeId}/packages/{packageName}") javax.ws.rs.core.Response removePackage(@PathParam(value="nodeId") String nodeId, @PathParam(value="packageName") String packageName) throws Exception
nodeId
- node ID (either global or local)packageName
- Package nameException
@PUT @Path(value="/nodes/{nodeId}/packages/{packageName}") javax.ws.rs.core.Response addPackage(@PathParam(value="nodeId") String nodeId, @PathParam(value="packageName") String packageName) throws Exception
nodeId
- node ID (either global or local)packageName
- Package nameException
@PUT @Path(value="/nodes/{nodeId}/packages") javax.ws.rs.core.Response addPackage(@PathParam(value="nodeId") String nodeId, Package addedPackage) throws Exception
nodeId
- node ID (either global or local)addedPackage
- Package to addException
@GET @Path(value="/preview/page/{id}") @Produces(value="text/html") String renderPage(@PathParam(value="id") String id, @QueryParam(value="nodeId") String nodeId) throws Exception
id
- page IDnodeId
- node IDException
@GET @Path(value="/listen/{uuid}") @Produces(value="text/event-stream") org.glassfish.jersey.media.sse.EventOutput listenPageChange(@PathParam(value="uuid") String uuid) throws Exception
uuid
- UUID of the registrationException
@GET @Path(value="/preview/{uuid}") @Produces(value="text/html") String preview(@PathParam(value="uuid") String uuid) throws Exception
uuid
- UUID of the registrationException
@GET @Path(value="/autocomplete/constructs") List<AutocompleteItem> autocompleteConstructs(@QueryParam(value="term") String term) throws Exception
term
- term to matchException
@GET @Path(value="/autocomplete/templates") List<AutocompleteItem> autocompleteTemplates(@QueryParam(value="term") String term) throws Exception
term
- term to matchException
@GET @Path(value="/autocomplete/datasources") List<AutocompleteItem> autocompleteDatasources(@QueryParam(value="term") String term) throws Exception
term
- term to matchException
@GET @Path(value="/autocomplete/objectproperties") List<AutocompleteItem> autocompleteObjectProperties(@QueryParam(value="term") String term) throws Exception
term
- term to matchException
@GET @Path(value="/autocomplete/cr_fragments") List<AutocompleteItem> autocompleteCrFragments(@QueryParam(value="term") String term) throws Exception
term
- term to matchException
@GET @Path(value="/autocomplete/contentrepositories") List<AutocompleteItem> autocompleteContentRepositories(@QueryParam(value="term") String term) throws Exception
term
- term to matchException
@GET @Path(value="/sync") SyncInfo getSyncInfo() throws Exception
Exception
@PUT @Path(value="/sync") SyncInfo startSync() throws Exception
Exception
Copyright © 2019 Gentics Software. All rights reserved.