com.gentics.contentnode.rest.resource

Interface ImageResource

All Superinterfaces:

AuthenticatedResource

@Path(value="/image")
public interface ImageResource
extends AuthenticatedResource

Resource for loading and manipulating Images in GCN

Author:

norbert

Method Summary

Modifier and Type	Method and Description
ImageLoadResponse	create(ImageCreateRequest request) Create a new image
GenericResponse	delete(String id, Integer nodeId) Delete the image denoted by id
GenericResponse	deleteFromWastebin(IdSetRequest request, long waitMs) Remove the given images from the wastebin
GenericResponse	deleteFromWastebin(String id, long waitMs) Remove the image denoted by the given id from the wastebin.
MultiDisinheritResponse	disinherit(List<String> ids, Integer nodeId) Get the multichannelling exclusion and disinherit status for a list of images
GenericResponse	disinherit(List<String> ids, Integer nodeId, long waitMs, DisinheritRequest request) Set the multichannelling exclusion and disinherit status for a list of images
DisinheritResponse	disinherit(String id, Integer nodeId) Get the multichannelling exclusion and disinherit status of the file
GenericResponse	disinherit(String id, Integer nodeId, long waitMs, DisinheritRequest request) Set the multichannelling exclusion and disinherit status
FileUsageListResponse	getFileUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> imageId, Integer nodeId, boolean returnFiles) Get the files using one of the given images
FolderUsageListResponse	getFolderUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> imageId, Integer nodeId, boolean returnFolders) Get the folders using one of the given images.
FileUsageListResponse	getImageUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> imageId, Integer nodeId, boolean returnImages) Get the images using one of the given images
LocalizationInfo	getLocalizationInfo(List<Integer> ids, Integer nodeId) Get localization info for a list of images for a given channel and all master channels
LocalizationInfo	getLocalizationInfo(String id, Integer nodeId) Get localization info for an image for a given channel and all master channels
PageUsageListResponse	getPageUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> imageId, Integer nodeId, boolean returnPages, PageModelParameterBean pageModel) Get the pages using one of the given images
PrivilegesResponse	getPrivileges(Integer id) Get the privileges of the current user on the given image
ReferencedSyncableObjectsListResponse	getSyncableObjects(List<Integer> imageIds, Integer srcNodeId, Integer dstNodeId) Get objects which are directly or indirectly linked by the specified images, which can be synchronised to a master channel along with the images themselves.
TemplateUsageListResponse	getTemplateUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> imageId, Integer nodeId, boolean returnTemplates) Get the templates using one of the given images
TotalUsageResponse	getTotalFileUsageInfo(List<Integer> imageId, Integer nodeId) Get the total usage info for the given images.
ImageListResponse	list(InFolderParameterBean inFolder, FileListParameterBean fileListParams, FilterParameterBean filterParams, SortParameterBean sortingParams, PagingParameterBean pagingParams, EditableParameterBean editableParams, WastebinParameterBean wastebinParams) Get a list of images in the specified folder. The result can be filtered by id name description niceUrl alternateUrls and sorted by id name niceUrl alternateUrls fileSize fileType
MultiImageLoadResponse	load(MultiObjectLoadRequest request, boolean fillWithNulls) Load a list of images specified in the given request.
ImageLoadResponse	load(String id, boolean update, boolean construct, Integer nodeId, String stagingPackageName) Load the image with given id
javax.ws.rs.core.Response	loadContent(Integer id) Get the content of the image with given id
LocalizationsResponse	localizations(Integer id) Get the IDs an their respective node IDs of localized copies of the specified image.
GenericResponse	localize(Integer id, LocalizeRequest request) Localize the given image
GenericResponse	move(MultiObjectMoveRequest request) Move multiple files to another folder
GenericResponse	move(String id, ObjectMoveRequest request) Mpve the given file to another folder
GenericResponse	pushToMaster(Integer id, PushToMasterRequest request) Push an image from a channel into a master
GenericResponse	pushToMaster(MultiPushToMasterRequest request) Push a list of images from a channel into a master
FileUploadResponse	resize(ImageResizeRequest imageResizeRequest) Rotate by 90° (optionally), crop (optionally) and resize an image (in this order).
GenericResponse	restoreFromWastebin(IdSetRequest request, long waitMs) Restore the given images from the wastebin
GenericResponse	restoreFromWastebin(String id, long waitMs) Restore the given image from the wastebin
ImageLoadResponse	rotate(ImageRotateRequest request) Rotate an image by 90°
GenericResponse	save(Integer id, ImageSaveRequest request) Save the given image
GenericResponse	saveContent(InputStream fileContent) Save the posted content into the given image
GenericResponse	unlocalize(Integer id, UnlocalizeRequest request) Unlocalize the given image
GenericResponse	unlocalize(MultiUnlocalizeRequest request) Unlocalize images in a channel

Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource

setSessionId

Method Detail

list

@GET
ImageListResponse list(@BeanParam
                            InFolderParameterBean inFolder,
                            @BeanParam
                            FileListParameterBean fileListParams,
                            @BeanParam
                            FilterParameterBean filterParams,
                            @BeanParam
                            SortParameterBean sortingParams,
                            @BeanParam
                            PagingParameterBean pagingParams,
                            @BeanParam
                            EditableParameterBean editableParams,
                            @BeanParam
                            WastebinParameterBean wastebinParams)

Get a list of images in the specified folder.
The result can be filtered by

• id
• name
• description
• niceUrl
• alternateUrls

and sorted by

• id
• name
• niceUrl
• alternateUrls
• fileSize
• fileType

Parameters:

inFolder - Folder ID and recursive parameters

fileListParams - Further file parameters

filterParams - Filter parameters

sortingParams - Sorting parameters

pagingParams - Paging parameters

editableParams - Editable parameters

wastebinParams - Wastebin parameters

Returns:

A list of images

load

@GET
 @Path(value="/load/{id}")
ImageLoadResponse load(@PathParam(value="id")
                                                       String id,
                                                       @DefaultValue(value="false") @QueryParam(value="update")
                                                       boolean update,
                                                       @DefaultValue(value="false") @QueryParam(value="construct")
                                                       boolean construct,
                                                       @QueryParam(value="nodeId")
                                                       Integer nodeId,
                                                       @QueryParam(value="package")
                                                       String stagingPackageName)

Load the image with given id

Parameters:

id - image id. This can either be a local or globalid

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

construct - if true, the construct information will be added to tags

nodeId - id of the node (channel) for which the image shall be loaded (when multichannelling is used).

stagingPackageName - name of a content staging package, to check the image status in it

Returns:

response containing the image meta data

load

@POST
 @Path(value="/load")
MultiImageLoadResponse load(MultiObjectLoadRequest request,
                                                        @QueryParam(value="fillWithNulls") @DefaultValue(value="false")
                                                        boolean fillWithNulls)

Load a list of images specified in the given request. Image ids for which no images exist, or the user does not have the necessary permissions, are silently ignored.

Parameters:

request - The request with he list of image ids to load.

fillWithNulls - flag to have items, which cannot be loaded returned as "null" objects in the response (instead of just omitting them)

Returns:

The list of found images, for which the user has enough permissions.

resize

@POST
 @Path(value="/resize/")
FileUploadResponse resize(ImageResizeRequest imageResizeRequest)

Rotate by 90° (optionally), crop (optionally) and resize an image (in this order).

Parameters:

imageResizeRequest - resize request

Returns:

response

rotate

@POST
 @Path(value="/rotate")
ImageLoadResponse rotate(ImageRotateRequest request)

Rotate an image by 90°

Parameters:

request - rotate request

Returns:

response

loadContent

javax.ws.rs.core.Response loadContent(@PathParam(value="id")
                                      Integer id)

Get the content of the image with given id

Parameters:

id - image id to get

Returns:

binary content of the image

create

ImageLoadResponse create(ImageCreateRequest request)

Create a new image

Parameters:

request - request with data for the image to be created

Returns:

response containing the image meta data

move

@POST
 @Path(value="/move/{id}")
GenericResponse move(@PathParam(value="id")
                                                      String id,
                                                      ObjectMoveRequest request)

Mpve the given file to another folder

Parameters:

id - file id

request - request

Returns:

generic response

move

@POST
 @Path(value="/move")
GenericResponse move(MultiObjectMoveRequest request)

Move multiple files to another folder

Parameters:

request - request

Returns:

generic response

save

@POST
 @Path(value="/save/{id}")
GenericResponse save(@PathParam(value="id")
                                                      Integer id,
                                                      ImageSaveRequest request)

Save the given image

Parameters:

request - request with the image to be saved

Returns:

generic response

saveContent

GenericResponse saveContent(InputStream fileContent)

Save the posted content into the given image

Parameters:

fileContent - image content

Returns:

generic response

delete

@POST
 @Path(value="/delete/{id}")
GenericResponse delete(@PathParam(value="id")
                                                          String id,
                                                          @QueryParam(value="nodeId")
                                                          Integer nodeId)

Delete the image denoted by id

Parameters:

id - id of the image to delete

nodeId - id of the node (channel) of the image

Returns:

response object

deleteFromWastebin

@POST
 @Path(value="/wastebin/delete/{id}")
GenericResponse deleteFromWastebin(@PathParam(value="id")
                                                                               String id,
                                                                               @QueryParam(value="wait") @DefaultValue(value="0")
                                                                               long waitMs)

Remove the image denoted by the given id from the wastebin.

Parameters:

id - id of the image to remove from the wastebin. This can either be a local or global id

waitMs - time in ms for the request to be done in foreground

Returns:

response object

deleteFromWastebin

@POST
 @Path(value="/wastebin/delete")
GenericResponse deleteFromWastebin(IdSetRequest request,
                                                                          @QueryParam(value="wait") @DefaultValue(value="0")
                                                                          long waitMs)

Remove the given images from the wastebin

Parameters:

request - request containing the image IDs

waitMs - time in ms for the request to be done in foreground

Returns:

response object

restoreFromWastebin

@POST
 @Path(value="/wastebin/restore/{id}")
GenericResponse restoreFromWastebin(@PathParam(value="id")
                                                                                 String id,
                                                                                 @QueryParam(value="wait") @DefaultValue(value="0")
                                                                                 long waitMs)

Restore the given image from the wastebin

Parameters:

id - id of the image to restore from the wastebin. This can either be a local or global id

waitMs - time in ms for the request to be done in foreground

Returns:

response object

restoreFromWastebin

@POST
 @Path(value="/wastebin/restore")
GenericResponse restoreFromWastebin(IdSetRequest request,
                                                                            @QueryParam(value="wait") @DefaultValue(value="0")
                                                                            long waitMs)

Restore the given images from the wastebin

Parameters:

request - request containing the image IDs

waitMs - time in ms for the request to be done in foreground

Returns:

response object

getPrivileges

PrivilegesResponse getPrivileges(@PathParam(value="id")
                                 Integer id)

Get the privileges of the current user on the given image

Parameters:

id - id of the image

Returns:

privileges response

getTotalFileUsageInfo

@GET
 @Path(value="/usage/total")
TotalUsageResponse getTotalFileUsageInfo(@QueryParam(value="id")
                                                                           List<Integer> imageId,
                                                                           @QueryParam(value="nodeId")
                                                                           Integer nodeId)

Get the total usage info for the given images.

Parameters:

imageId - list of image ids, for which the usage shall be fetched

nodeId - id of the node

Returns:

Response which contains the total usage info

getFolderUsageInfo

@GET
 @Path(value="/usage/folder")
FolderUsageListResponse getFolderUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                              Integer skipCount,
                                                                              @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                              Integer maxItems,
                                                                              @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                              String sortBy,
                                                                              @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                              String sortOrder,
                                                                              @QueryParam(value="id")
                                                                              List<Integer> imageId,
                                                                              @QueryParam(value="nodeId")
                                                                              Integer nodeId,
                                                                              @QueryParam(value="folders") @DefaultValue(value="true")
                                                                              boolean returnFolders)

Get the folders using one of the given images.

Parameters:

skipCount - number of items to be skipped, set to 0 for skipping no items

maxItems - maximum number of items to be returned, set to -1 for returning all items

sortBy - (optional) attribute to sort by. defaults to name

sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".

imageId - list of image ids, for which the usage shall be fetched

nodeId - id of the node

returnFolders - true (default) if the folders shall be returned, false for only returning the counts

Returns:

response

getPageUsageInfo

@GET
 @Path(value="/usage/page")
PageUsageListResponse getPageUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                        Integer skipCount,
                                                                        @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                        Integer maxItems,
                                                                        @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                        String sortBy,
                                                                        @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                        String sortOrder,
                                                                        @QueryParam(value="id")
                                                                        List<Integer> imageId,
                                                                        @QueryParam(value="nodeId")
                                                                        Integer nodeId,
                                                                        @QueryParam(value="pages") @DefaultValue(value="true")
                                                                        boolean returnPages,
                                                                        @BeanParam
                                                                        PageModelParameterBean pageModel)

Get the pages using one of the given images

Parameters:

skipCount - number of items to be skipped, set to 0 for skipping no items

maxItems - maximum number of items to be returned, set to -1 for returning all items

sortBy - (optional) attribute to sort by. defaults to name

sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".

imageId - list of image ids, for which the usage shall be fetched

nodeId - id of the node

returnPages - true (default) if the pages shall be returned, false for only returning the counts

pageModel - page model parameters

Returns:

response

getTemplateUsageInfo

@GET
 @Path(value="/usage/template")
TemplateUsageListResponse getTemplateUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                                    Integer skipCount,
                                                                                    @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                                    Integer maxItems,
                                                                                    @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                                    String sortBy,
                                                                                    @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                                    String sortOrder,
                                                                                    @QueryParam(value="id")
                                                                                    List<Integer> imageId,
                                                                                    @QueryParam(value="nodeId")
                                                                                    Integer nodeId,
                                                                                    @QueryParam(value="templates") @DefaultValue(value="true")
                                                                                    boolean returnTemplates)

Get the templates using one of the given images

Parameters:

skipCount - number of items to be skipped, set to 0 for skipping no items

maxItems - maximum number of items to be returned, set to -1 for returning all items

sortBy - (optional) attribute to sort by. defaults to name

sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".

imageId - list of image ids, for which the usage shall be fetched

nodeId - id of the node

returnTemplates - true (default) if the templates shall be returned, false for only returning the counts

Returns:

response

getImageUsageInfo

@GET
 @Path(value="/usage/image")
FileUsageListResponse getImageUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                          Integer skipCount,
                                                                          @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                          Integer maxItems,
                                                                          @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                          String sortBy,
                                                                          @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                          String sortOrder,
                                                                          @QueryParam(value="id")
                                                                          List<Integer> imageId,
                                                                          @QueryParam(value="nodeId")
                                                                          Integer nodeId,
                                                                          @QueryParam(value="images") @DefaultValue(value="true")
                                                                          boolean returnImages)

Get the images using one of the given images

Parameters:

skipCount - number of items to be skipped, set to 0 for skipping no items

maxItems - maximum number of items to be returned, set to -1 for returning all items

sortBy - (optional) attribute to sort by. defaults to name

sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".

imageId - list of image ids, for which the usage shall be fetched

nodeId - id of the node

returnImages - true (default) if the images shall be returned, false for only returning the counts

Returns:

response

getFileUsageInfo

@GET
 @Path(value="/usage/file")
FileUsageListResponse getFileUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0")
                                                                        Integer skipCount,
                                                                        @QueryParam(value="maxItems") @DefaultValue(value="-1")
                                                                        Integer maxItems,
                                                                        @QueryParam(value="sortby") @DefaultValue(value="name")
                                                                        String sortBy,
                                                                        @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                        String sortOrder,
                                                                        @QueryParam(value="id")
                                                                        List<Integer> imageId,
                                                                        @QueryParam(value="nodeId")
                                                                        Integer nodeId,
                                                                        @QueryParam(value="files") @DefaultValue(value="true")
                                                                        boolean returnFiles)

Get the files using one of the given images

Parameters:

skipCount - number of items to be skipped, set to 0 for skipping no items

maxItems - maximum number of items to be returned, set to -1 for returning all items

sortBy - (optional) attribute to sort by. defaults to name

sortOrder - (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc".

imageId - list of image ids, for which the usage shall be fetched

nodeId - id of the node

returnFiles - true (default) if the files shall be returned, false for only returning the counts

Returns:

response

pushToMaster

@POST
 @Path(value="/push2master/{id}")
GenericResponse pushToMaster(@PathParam(value="id")
                                                                     Integer id,
                                                                     PushToMasterRequest request)

Push an image from a channel into a master

Parameters:

id - id of the image

request - request

Returns:

generic response

getSyncableObjects

@GET
 @Path(value="/usage/syncableObjects")
ReferencedSyncableObjectsListResponse getSyncableObjects(@QueryParam(value="ids")
                                                                                                     List<Integer> imageIds,
                                                                                                     @QueryParam(value="srcNodeId")
                                                                                                     Integer srcNodeId,
                                                                                                     @QueryParam(value="dstNodeId")
                                                                                                     Integer dstNodeId)

Get objects which are directly or indirectly linked by the specified images, which can be synchronised to a master channel along with the images themselves. Linked objects are pages, files and images specified in UrlPartTypes of content or object tags. Direct dependencies are in the pages, files and images files of the response. Indirect dependencies are mapped in dependencies.

Parameters:

imageIds - The IDs of the images to get linked objects for

srcNodeId - The channel ID of the source channel

dstNodeId - The channel ID of the target channel

pushToMaster

@POST
 @Path(value="/push2master")
GenericResponse pushToMaster(MultiPushToMasterRequest request)

Push a list of images from a channel into a master

Parameters:

request - request

Returns:

generic response

unlocalize

@POST
 @Path(value="/unlocalize/{id}")
GenericResponse unlocalize(@PathParam(value="id")
                                                                  Integer id,
                                                                  UnlocalizeRequest request)

Unlocalize the given image

Parameters:

id - id of the image to unlocalize

request - request

Returns:

generic response

unlocalize

@POST
 @Path(value="/unlocalize")
GenericResponse unlocalize(MultiUnlocalizeRequest request)

Unlocalize images in a channel

Parameters:

request - request

Returns:

generic response

localize

@POST
 @Path(value="/localize/{id}")
GenericResponse localize(@PathParam(value="id")
                                                              Integer id,
                                                              LocalizeRequest request)

Localize the given image

Parameters:

id - id of the image to localize

request - request

Returns:

generic response

localizations

@GET
 @Path(value="/localizations/{id}")
LocalizationsResponse localizations(@PathParam(value="id")
                                                                             Integer id)

Get the IDs an their respective node IDs of localized copies of the specified image.

Parameters:

id - The ID of the master image.

Returns:

A map of folder IDs to node IDs of localized copies.

getLocalizationInfo

@GET
 @Path(value="/localizationinfo")
LocalizationInfo getLocalizationInfo(@QueryParam(value="id")
                                                                            List<Integer> ids,
                                                                            @QueryParam(value="nodeId")
                                                                            Integer nodeId)

Get localization info for a list of images for a given channel and all master channels

Parameters:

ids - list of image ids

nodeId - id of the node to start with

Returns:

localization info

getLocalizationInfo

@GET
 @Path(value="/localizationinfo/{id}")
LocalizationInfo getLocalizationInfo(@PathParam(value="id")
                                                                                 String id,
                                                                                 @QueryParam(value="nodeId")
                                                                                 Integer nodeId)

Get localization info for an image for a given channel and all master channels

Parameters:

id - id of the image. The id can either be the local or global id

nodeId - id of the node to start with

Returns:

localization info

disinherit

@GET
 @Path(value="/disinherit/{id}")
DisinheritResponse disinherit(@PathParam(value="id")
                                                                    String id,
                                                                    @QueryParam(value="nodeId")
                                                                    Integer nodeId)
                                                             throws Exception

Get the multichannelling exclusion and disinherit status of the file

Parameters:

id - file ID

nodeId - node ID

Returns:

response containing the exclusion and disinherit status

Throws:

Exception

disinherit

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

Set the multichannelling exclusion and disinherit status

Parameters:

id - file ID

nodeId - node ID

waitMs - wait timeout in milliseconds

request - request object

Returns:

generic response

Throws:

Exception

disinherit

@GET
 @Path(value="/disinherit")
MultiDisinheritResponse disinherit(@QueryParam(value="id")
                                                                    List<String> ids,
                                                                    @QueryParam(value="nodeId")
                                                                    Integer nodeId)
                                                             throws Exception

Get the multichannelling exclusion and disinherit status for a list of images

Parameters:

ids - list of image IDs

nodeId - node ID

Returns:

response containing the exclusion and disinherit status

Throws:

Exception

disinherit

@POST
 @Path(value="/disinherit")
GenericResponse disinherit(@QueryParam(value="id")
                                                             List<String> ids,
                                                             @QueryParam(value="nodeId")
                                                             Integer nodeId,
                                                             @QueryParam(value="wait") @DefaultValue(value="0")
                                                             long waitMs,
                                                             DisinheritRequest request)
                                                      throws Exception

Set the multichannelling exclusion and disinherit status for a list of images

Parameters:

ids - list of image IDs

nodeId - node ID

waitMs - wait timeout in milliseconds

request - request object

Returns:

generic response

Throws:

Exception