com.gentics.contentnode.rest.resource

Interface ContentRepositoryResource

@Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
 @Path(value="/contentrepositories")
public interface ContentRepositoryResource

Resource for handling ContentRepositories

Method Summary

Modifier and Type	Method and Description
ContentRepositoryResponse	add(ContentRepositoryModel item) Create a new ContentRepository
javax.ws.rs.core.Response	addCrFragment(String id, String crFragmentId) Assign a ContentRepository Fragment to the ContentRepository
TagmapEntryResponse	addEntry(String id, TagmapEntryModel item) Create a new tagmap entry
ContentRepositoryResponse	check(String id, long waitMs) Check the connectivity and structure of the given contentrepository
ContentRepositoryResponse	checkData(String id) Check the data in the given contentrepository
TagmapEntryConsistencyResponse	checkEntryConsistency(String id) Check consistency of tagmap entries and return inconsistencies
ContentRepositoryResponse	copy(String id) Copy a ContentRepotiroy
javax.ws.rs.core.Response	delete(String id) Delete the ContentRepository with given id
javax.ws.rs.core.Response	deleteEntry(String id, String entryId) Delete the tagmap entry
ContentRepositoryResponse	get(String id) Get the ContentRepository with given id
MeshRolesResponse	getAvailableRoles(String id) Get the roles available in the Mesh instance for the Mesh ContentRepository
ContentRepositoryFragmentResponse	getCrFragment(String id, String crFragmentId) Get a ContentRepository Fragment assigned to the ContentRepository
TagmapEntryResponse	getEntry(String id, String entryId) Get a tagmap entry
MeshRolesResponse	getRoles(String id) Get the roles currently set in the datasource used in the roles object property for the Mesh ContentRepository
ContentRepositoryListResponse	list(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms) List available ContentRepositories. The result can be filtered by id globalId name crType dbType username url basepath and sorted by id globalId name crType dbType username url basepath instantPublishing languageInformation permissionInformation diffDelete checkDate checkStatus statusDate dataStatus
ContentRepositoryFragmentListResponse	listCrFragments(String id, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms) Get the ContnetRepository Fragments assigned to the ContentRepository. The result can be filtered by id globalId name and sorted by id globalId name
TagmapEntryListResponse	listEntries(String id, boolean fragments, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging) Get the entries in the ContentRepository. The result can be filtered by id globalId tagname mapname foreignlinkAttribute foreignlinkAttributeRule category fragmentName and sorted by id globalId tagname mapname object attributeType targetType multivalue optimized filesystem foreignlinkAttribute foreignlinkAttributeRule category segmentfield displayfield urlfield fragmentName
javax.ws.rs.core.Response	removeCrFragment(String id, String crFragmentId) Remove the ContentRepository Fragment from the ContentRepository
ContentRepositoryResponse	repair(String id, long waitMs) Check and repair the connectivity and structure of the given contentrepository
ContentRepositoryResponse	repairData(String id) Check and repair the data in the given contentrepository
MeshRolesResponse	setRoles(String id, MeshRolesRequest request) Set the roles to be used in the datasource of the roles object property for the Mesh ContentRepository
ContentRepositoryResponse	update(String id, ContentRepositoryModel item) Update ContentRepository with given id
TagmapEntryResponse	updateEntry(String id, String entryId, TagmapEntryModel item) Update tagmap entry

Method Detail

list

@GET
ContentRepositoryListResponse list(@BeanParam
                                        FilterParameterBean filter,
                                        @BeanParam
                                        SortParameterBean sorting,
                                        @BeanParam
                                        PagingParameterBean paging,
                                        @BeanParam
                                        PermsParameterBean perms)
                                 throws Exception

List available ContentRepositories.
The result can be filtered by

• id
• globalId
• name
• crType
• dbType
• username
• url
• basepath

and sorted by

• id
• globalId
• name
• crType
• dbType
• username
• url
• basepath
• instantPublishing
• languageInformation
• permissionInformation
• diffDelete
• checkDate
• checkStatus
• statusDate
• dataStatus

Parameters:

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

Returns:

List of ContentRepositories

Throws:

Exception

add

@POST
ContentRepositoryResponse add(ContentRepositoryModel item)
                             throws Exception

Create a new ContentRepository

Parameters:

item - ContentRepository to create

Returns:

created ContentRepository

Throws:

Exception

get

@GET
 @Path(value="/{id}")
ContentRepositoryResponse get(@PathParam(value="id")
                                                         String id)
                                                  throws Exception

Get the ContentRepository with given id

Parameters:

id - internal or external ContentRepository ID

Returns:

Response containing the ContentRepository

Throws:

Exception

update

@PUT
 @Path(value="/{id}")
ContentRepositoryResponse update(@PathParam(value="id")
                                                            String id,
                                                            ContentRepositoryModel item)
                                                     throws Exception

Update ContentRepository with given id

Parameters:

id - internal or external ContentRepository ID

item - updated ContentRepository

Returns:

updated ContentRepository

Throws:

Exception

delete

@DELETE
 @Path(value="/{id}")
javax.ws.rs.core.Response delete(@PathParam(value="id")
                                                               String id)
                                                        throws Exception

Delete the ContentRepository with given id

Parameters:

id - internal or external ContentRepository ID

Returns:

response

Throws:

Exception

check

@PUT
 @Path(value="/{id}/structure/check")
ContentRepositoryResponse check(@PathParam(value="id")
                                                                           String id,
                                                                           @QueryParam(value="wait") @DefaultValue(value="0")
                                                                           long waitMs)
                                                                    throws Exception

Check the connectivity and structure of the given contentrepository

Parameters:

id - internal or external ContentRepository ID

waitMs - wait timeout in ms. When set to 0, response will be sent, when the action completes

Returns:

response

Throws:

Exception

repair

@PUT
 @Path(value="/{id}/structure/repair")
ContentRepositoryResponse repair(@PathParam(value="id")
                                                                             String id,
                                                                             @QueryParam(value="wait") @DefaultValue(value="0")
                                                                             long waitMs)
                                                                      throws Exception

Check and repair the connectivity and structure of the given contentrepository

Parameters:

id - internal or external ContentRepository ID

waitMs - wait timeout in ms. When set to 0, response will be sent, when the action completes

Returns:

response

Throws:

Exception

checkData

@PUT
 @Path(value="/{id}/data/check")
ContentRepositoryResponse checkData(@PathParam(value="id")
                                                                          String id)
                                                                   throws Exception

Check the data in the given contentrepository

Parameters:

id - internal or external ContentRepository ID

Returns:

response

Throws:

Exception

repairData

@PUT
 @Path(value="/{id}/data/repair")
ContentRepositoryResponse repairData(@PathParam(value="id")
                                                                            String id)
                                                                     throws Exception

Check and repair the data in the given contentrepository

Parameters:

id - internal or external ContentRepository ID

Returns:

response

Throws:

Exception

copy

@PUT
 @Path(value="/{id}/copy")
ContentRepositoryResponse copy(@PathParam(value="id")
                                                               String id)
                                                        throws Exception

Copy a ContentRepotiroy

Parameters:

id - internal or external ID of the ContentRepository to copy

Returns:

response containing the copy

Throws:

Exception

listEntries

@GET
 @Path(value="/{id}/entries")
TagmapEntryListResponse listEntries(@PathParam(value="id")
                                                                       String id,
                                                                       @QueryParam(value="fragments") @DefaultValue(value="false")
                                                                       boolean fragments,
                                                                       @BeanParam
                                                                       FilterParameterBean filter,
                                                                       @BeanParam
                                                                       SortParameterBean sorting,
                                                                       @BeanParam
                                                                       PagingParameterBean paging)
                                                                throws Exception

Get the entries in the ContentRepository.
The result can be filtered by

• id
• globalId
• tagname
• mapname
• foreignlinkAttribute
• foreignlinkAttributeRule
• category
• fragmentName

and sorted by

• id
• globalId
• tagname
• mapname
• object
• attributeType
• targetType
• multivalue
• optimized
• filesystem
• foreignlinkAttribute
• foreignlinkAttributeRule
• category
• segmentfield
• displayfield
• urlfield
• fragmentName

Parameters:

id - internal or external ID

fragments - true to include entries from assigned fragments, false (which is the default) to only list entries of the ContentRepository itself

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

Returns:

list of entries

Throws:

Exception

checkEntryConsistency

@GET
 @Path(value="/{id}/entries/check")
TagmapEntryConsistencyResponse checkEntryConsistency(@PathParam(value="id")
                                                                                              String id)
                                                                                       throws Exception

Check consistency of tagmap entries and return inconsistencies

Parameters:

id - internal or external ID

Returns:

consistency check result

Throws:

Exception

addEntry

@POST
 @Path(value="/{id}/entries")
TagmapEntryResponse addEntry(@PathParam(value="id")
                                                                 String id,
                                                                 TagmapEntryModel item)
                                                          throws Exception

Create a new tagmap entry

Parameters:

id - internal or external ID of the ContentRepository

item - entry to create

Returns:

created entry

Throws:

Exception

getEntry

@GET
 @Path(value="/{id}/entries/{entryId}")
TagmapEntryResponse getEntry(@PathParam(value="id")
                                                                          String id,
                                                                          @PathParam(value="entryId")
                                                                          String entryId)
                                                                   throws Exception

Get a tagmap entry

Parameters:

id - internal or external ID of the ContentRepository

entryId - internal or external ID of the entry

Returns:

response containing the entry

Throws:

Exception

updateEntry

@PUT
 @Path(value="/{id}/entries/{entryId}")
TagmapEntryResponse updateEntry(@PathParam(value="id")
                                                                             String id,
                                                                             @PathParam(value="entryId")
                                                                             String entryId,
                                                                             TagmapEntryModel item)
                                                                      throws Exception

Update tagmap entry

Parameters:

id - internal or external ContentRepository ID

entryId - internal or external entry ID

item - updated entry

Returns:

updated entry

Throws:

Exception

deleteEntry

@DELETE
 @Path(value="/{id}/entries/{entryId}")
javax.ws.rs.core.Response deleteEntry(@PathParam(value="id")
                                                                                      String id,
                                                                                      @PathParam(value="entryId")
                                                                                      String entryId)
                                                                               throws Exception

Delete the tagmap entry

Parameters:

id - internal or external ContentRepository ID

entryId - internal or external entry ID

Returns:

response

Throws:

Exception

listCrFragments

@GET
 @Path(value="/{id}/cr_fragments")
ContentRepositoryFragmentListResponse listCrFragments(@PathParam(value="id")
                                                                                              String id,
                                                                                              @BeanParam
                                                                                              FilterParameterBean filter,
                                                                                              @BeanParam
                                                                                              SortParameterBean sorting,
                                                                                              @BeanParam
                                                                                              PagingParameterBean paging,
                                                                                              @BeanParam
                                                                                              PermsParameterBean perms)
                                                                                       throws Exception

Get the ContnetRepository Fragments assigned to the ContentRepository.
The result can be filtered by

• id
• globalId
• name

and sorted by

• id
• globalId
• name

Parameters:

id - internal or external ID

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

Returns:

list of Cr Fragments

Throws:

Exception

getCrFragment

@GET
 @Path(value="/{id}/cr_fragments/{crFragmentId}")
ContentRepositoryFragmentResponse getCrFragment(@PathParam(value="id")
                                                                                                       String id,
                                                                                                       @PathParam(value="crFragmentId")
                                                                                                       String crFragmentId)
                                                                                                throws Exception

Get a ContentRepository Fragment assigned to the ContentRepository

Parameters:

id - internal or external ID of the ContentRepository

crFragmentId - internal or external ID of the ContentRepository Fragment

Returns:

response containing the ContentRepository Fragment

Throws:

Exception

addCrFragment

@PUT
 @Path(value="/{id}/cr_fragments/{crFragmentId}")
javax.ws.rs.core.Response addCrFragment(@PathParam(value="id")
                                                                                               String id,
                                                                                               @PathParam(value="crFragmentId")
                                                                                               String crFragmentId)
                                                                                        throws Exception

Assign a ContentRepository Fragment to the ContentRepository

Parameters:

id - internal or external ContentRepository ID

crFragmentId - internal or external ContentRepository Fragment ID

Returns:

Response

Throws:

Exception

removeCrFragment

@DELETE
 @Path(value="/{id}/cr_fragments/{crFragmentId}")
javax.ws.rs.core.Response removeCrFragment(@PathParam(value="id")
                                                                                                     String id,
                                                                                                     @PathParam(value="crFragmentId")
                                                                                                     String crFragmentId)
                                                                                              throws Exception

Remove the ContentRepository Fragment from the ContentRepository

Parameters:

id - internal or external ContentRepository ID

crFragmentId - internal or external ContentRepository Fragment ID

Returns:

response

Throws:

Exception

getRoles

@GET
 @Path(value="/{id}/roles")
MeshRolesResponse getRoles(@PathParam(value="id")
                                                            String id)
                                                     throws Exception

Get the roles currently set in the datasource used in the roles object property for the Mesh ContentRepository

Parameters:

id - ID of the Mesh ContentRepository

Returns:

response containing list of role names

Throws:

Exception

getAvailableRoles

@GET
 @Path(value="/{id}/availableroles")
MeshRolesResponse getAvailableRoles(@PathParam(value="id")
                                                                              String id)
                                                                       throws Exception

Get the roles available in the Mesh instance for the Mesh ContentRepository

Parameters:

id - ID of the Mesh ContentRepository

Returns:

response containing list of role names

Throws:

Exception

setRoles

@POST
 @Path(value="/{id}/roles")
MeshRolesResponse setRoles(@PathParam(value="id")
                                                             String id,
                                                             MeshRolesRequest request)
                                                      throws Exception

Set the roles to be used in the datasource of the roles object property for the Mesh ContentRepository

Parameters:

id - ID of the Mesh ContentRepository

request - request containing the roles to set

Returns:

response containing the list of set role names

Throws:

Exception