org.imixs.archive.service.api

Class ArchiveRestService

java.lang.Object

org.imixs.archive.service.api.ArchiveRestService

@Path(value="/archive")
 @Produces(value={"text/html","application/xml","application/json","text/xml"})
public class ArchiveRestService
extends Object

The ArchiveRestService provides a Rest API to be used by external clients.

The API provides methods to read and write snapshot data into the cassandra cluster.

Author:

rsoika

Constructor Summary

Constructors

Constructor and Description
ArchiveRestService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getMetadata(String format) Loads the metadata from the archive and returns a HTML representation.
javax.ws.rs.core.Response	getSnapshot(String id, String format) Loads a snapshot from the archive and returns a HTML representation.
javax.ws.rs.core.Response	getSnapshotFileByMD5Checksum(String md5, String contentType) Returns a file attachment based on its MD5 Checksum The query parameter 'contentType' can be added to specify the returned content type.
javax.ws.rs.core.Response	getSnapshotFileByName(String id, String file, javax.ws.rs.core.UriInfo uriInfo) Returns a file attachment located in the property $file of the specified snapshot The file name will be encoded.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveRestService

public ArchiveRestService()

Method Detail

getSnapshot

@GET
 @Path(value="/snapshot/{id : ([0-9a-f]{8}-.*|[0-9a-f]{11}-.*)}")
public javax.ws.rs.core.Response getSnapshot(@PathParam(value="id")
                                                                                                                    String id,
                                                                                                                    @QueryParam(value="format")
                                                                                                                    String format)

Loads a snapshot from the archive and returns a HTML representation.

Parameters:

id - - snapshot id

Returns:

XMLDataCollection

getMetadata

@GET
 @Path(value="/metadata")
public javax.ws.rs.core.Response getMetadata(@QueryParam(value="format")
                                                                            String format)

Loads the metadata from the archive and returns a HTML representation.

Returns:

XMLDataCollection

getSnapshotFileByMD5Checksum

@GET
 @Path(value="/md5/{md5}")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getSnapshotFileByMD5Checksum(@PathParam(value="md5") @Encoded
                                                                                                                                           String md5,
                                                                                                                                           @QueryParam(value="contentType")
                                                                                                                                           String contentType)

Returns a file attachment based on its MD5 Checksum

The query parameter 'contentType' can be added to specify the returned content type.

Parameters:

md5 - - md5 checksum to identify the file content

Returns:

getSnapshotFileByName

@GET
 @Path(value="/snapshot/{id}/file/{file}")
public javax.ws.rs.core.Response getSnapshotFileByName(@PathParam(value="snapshotid")
                                                                                                       String id,
                                                                                                       @PathParam(value="file") @Encoded
                                                                                                       String file,
                                                                                                       @Context
                                                                                                       javax.ws.rs.core.UriInfo uriInfo)

Returns a file attachment located in the property $file of the specified snapshot

The file name will be encoded. With a URLDecode the filename is decoded in different formats and searched in the file list. This is not a nice solution.

Parameters:

uniqueid -

Returns: