com.chemaxon.overlap.wui.resources

Class ExperimentalRawFilesResource

java.lang.Object

com.chemaxon.overlap.wui.resources.ExperimentalRawFilesResource

@Path(value="experimental-rawfiles")
public class ExperimentalRawFilesResource
extends Object

Experimental REST API endpoint for rawfile handling. Please note that endpoints of this resource are expected to be changed in an incompatible way in any of the future releases.

Constructor Summary

Constructors

Constructor and Description
ExperimentalRawFilesResource()

Method Summary

Modifier and Type	Method and Description
void	deleteRawFile(ExperimentalRawFile res) Delete a specific raw file.
byte[]	gerRawFileSegment(ExperimentalRawFile res, long start, long length) Get a segment of the raw file.
ExperimentalRawFileInfo	getRawFileInfo(ExperimentalRawFile res) Get raw file info DTO.
ExperimentalRawFilesInfo	getRawFilesInfo() List experimental raw files.
SizeInfoDto	getRawFileSizeinfo(ExperimentalRawFile res, SizeInfoMethod method) Experimental endpoint to estimate allocated size.
Response	getRawFileWithContentDisposition(ExperimentalRawFile res) Get the raw file content with content-disposition.
Response	getRawFileWithNoContentDisposition(ExperimentalRawFile res) Get the raw file content with no content-disposition.
ExperimentalRawFileInfo	postNewRawFile(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String description, String nameprefix, String contenttype) Experimental file upload.
ExperimentalRawFileInfo	putRawFile(String res, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String description, String contenttype) Experimental file upload.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExperimentalRawFilesResource

public ExperimentalRawFilesResource()

Method Detail

getRawFilesInfo

@GET
 @Produces(value="application/json")
public ExperimentalRawFilesInfo getRawFilesInfo()

List experimental raw files.

Returns:

Raw files info

Throws:

WuiForbiddenException - When rawfile listing is disabled (See ServerFeature.RAWFILES_LIST).

postNewRawFile

@POST
 @Produces(value="application/json")
 @Consumes(value="multipart/form-data")
public ExperimentalRawFileInfo postNewRawFile(InputStream uploadedInputStream,
                                                                                                                                 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                                                                                                                 String description,
                                                                                                                                 String nameprefix,
                                                                                                                                 String contenttype)
                                                                                                                          throws IOException

Experimental file upload. Experimental functionality with no auhorization/authentication. The posted content is visible for all users. Note that content type is not guessed / recognized from the file name / its contents.

Parameters:

uploadedInputStream - InputStream to read content data

fileDetail - Details containing original uploaded file name

description - Description of the uploaded resource

nameprefix - Resource name suggestion / prefix

contenttype - Optional content type to be used. When no content type is specified application/octet-stream will be used.

Returns:

New resource info

Throws:

IOException - propagated

WuiForbiddenException - When rawfile modifications are disabled (See ServerFeature.RAWFILES_MODIFY).

putRawFile

@PUT
 @Path(value="{res}")
 @Produces(value="application/json")
 @Consumes(value="multipart/form-data")
public ExperimentalRawFileInfo putRawFile(@PathParam(value="res")
                                                                                                                                                  String res,
                                                                                                                                                  InputStream uploadedInputStream,
                                                                                                                                                  org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                                                                                                                                  String description,
                                                                                                                                                  String contenttype)
                                                                                                                                           throws IOException

Experimental file upload. Experimental functionality with no auhorization/authentication. The posted content is visible for all users. If there is a rawfile stored with the same name it will be overwritten, otherwise a new resource with the given name will be created.

Parameters:

res - Resource name to add/update

uploadedInputStream - InputStream to read content data

fileDetail - Details containing original uploaded file name

description - Optional description of the uploaded resource

contenttype - Optional content type to be used. When no content type is specified application/octet-stream will be used.

Returns:

New resource info

Throws:

IOException - propagated

WuiForbiddenException - When rawfile modifications are disabled (See ServerFeature.RAWFILES_MODIFY).

deleteRawFile

@DELETE
 @Path(value="{res}")
public void deleteRawFile(@PathParam(value="res")
                                                        ExperimentalRawFile res)

Delete a specific raw file.

Parameters:

res - Resource name to delete

Throws:

WuiForbiddenException - When rawfile modifications are disabled (See ServerFeature.RAWFILES_MODIFY).

getRawFileInfo

@GET
 @Path(value="{res}")
 @Produces(value="application/json")
public ExperimentalRawFileInfo getRawFileInfo(@PathParam(value="res")
                                                                                                              ExperimentalRawFile res)

Get raw file info DTO.

Parameters:

res - Raw file

Returns:

File info

gerRawFileSegment

@GET
 @Path(value="{res}/segment")
 @Produces(value="application/octet-stream")
public byte[] gerRawFileSegment(@PathParam(value="res")
                                                                                                                ExperimentalRawFile res,
                                                                                                                @QueryParam(value="start")
                                                                                                                long start,
                                                                                                                @QueryParam(value="length")
                                                                                                                long length)

Get a segment of the raw file.

Parameters:

res - Raw file

start - Index (0-based) of the first byte to return.

length - Maximal number of bytes to return

Returns:

Response

getRawFileWithContentDisposition

@GET
 @Path(value="{res}/raw")
public Response getRawFileWithContentDisposition(@PathParam(value="res")
                                                                                ExperimentalRawFile res)

Get the raw file content with content-disposition. The response media type will be filled according to the stored media type.

Additionally the response will be filled with content-disposition header with value attachment; filename = [NAME] where [NAME] is the resource name. Accessing this endpoint from a browser typically opens a download dialog with the specified file name.

Parameters:

res - Raw file

Returns:

Response

See Also:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition

getRawFileWithNoContentDisposition

@GET
 @Path(value="{res}/raw-nocd")
public Response getRawFileWithNoContentDisposition(@PathParam(value="res")
                                                                                       ExperimentalRawFile res)

Get the raw file content with no content-disposition. The response media type will be filled according to the stored media type. The response is the same as the response of #getRawFileWithNoContentDisposition2(com.chemaxon.overlap.wui.res.ExperimentalRawFile). The path associated to this method (rawfiles/{res}/raw-nocd) represents REST semantics, where the response is a view/representation (raw-nocd) of the resource (rawfiles/{res}/raw-nocd).

Parameters:

res - Raw file

Returns:

Response

See Also:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition

getRawFileSizeinfo

@Beta
 @GET
 @Produces(value="application/json")
 @Path(value="{res}/get-sizeinfo")
public SizeInfoDto getRawFileSizeinfo(@PathParam(value="res")
                                                                                                                          ExperimentalRawFile res,
                                                                                                                          @QueryParam(value="method")
                                                                                                                          SizeInfoMethod method)

Experimental endpoint to estimate allocated size. Please note that this endpoint is under construction, use with caution: execution might fail and execution might have significant memory/cpu impact. The availability/functionality of this endpoint might change in any of the subsequent releases.

Parameters:

res - Content

method - Size info method to use.

Returns:

Size info description