org.zanata.rest.client

Interface IFileResource

All Superinterfaces:

FileResource

@Path(value="/file")
 @Produces(value="application/octet-stream")
 @Consumes(value="application/octet-stream")
public interface IFileResource
extends FileResource

REST client interface for file upload and download.

Author:

David Mason, damason@redhat.com

See Also:

DocumentFileUploadForm, FileResource

Field Summary

Fields inherited from interface org.zanata.rest.service.FileResource

ACCEPTED_TYPES_RESOURCE, DOWNLOAD_TEMPLATE, FILE_DOWNLOAD_TEMPLATE, FILE_RESOURCE, FILETYPE_RAW_SOURCE_DOCUMENT, FILETYPE_TRANSLATED_APPROVED, FILETYPE_TRANSLATED_APPROVED_AND_FUZZY, SERVICE_PATH, SOURCE_DOWNLOAD_TEMPLATE, SOURCE_UPLOAD_TEMPLATE, TRANSLATION_UPLOAD_TEMPLATE

Method Summary

Modifier and Type	Method and Description
org.jboss.resteasy.client.ClientResponse<String>	acceptedFileTypes()
org.jboss.resteasy.client.ClientResponse	downloadSourceFile(String projectSlug, String iterationSlug, String fileType, String docId) Downloads a single source file.
org.jboss.resteasy.client.ClientResponse	downloadTranslationFile(String projectSlug, String iterationSlug, String locale, String fileExtension, String docId) Downloads a single translation file.
org.jboss.resteasy.client.ClientResponse<ChunkUploadResponse>	uploadSourceFile(String projectSlug, String iterationSlug, String docId, DocumentFileUploadForm uploadForm)
org.jboss.resteasy.client.ClientResponse<ChunkUploadResponse>	uploadTranslationFile(String projectSlug, String iterationSlug, String localeId, String docId, String merge, DocumentFileUploadForm uploadForm)

Methods inherited from interface org.zanata.rest.service.FileResource

download

Method Detail

acceptedFileTypes

@GET
 @Path(value="/accepted_types")
 @Produces(value="text/plain")
org.jboss.resteasy.client.ClientResponse<String> acceptedFileTypes()

Specified by:

acceptedFileTypes in interface FileResource

uploadSourceFile

@POST
 @Path(value="/source/{projectSlug}/{iterationSlug}")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/xml")
org.jboss.resteasy.client.ClientResponse<ChunkUploadResponse> uploadSourceFile(@PathParam(value="projectSlug")
                                                                                                                                                                                                                       String projectSlug,
                                                                                                                                                                                                                       @PathParam(value="iterationSlug")
                                                                                                                                                                                                                       String iterationSlug,
                                                                                                                                                                                                                       @QueryParam(value="docId")
                                                                                                                                                                                                                       String docId,
                                                                                                                                                                                                                       DocumentFileUploadForm uploadForm)

Specified by:

uploadSourceFile in interface FileResource

uploadTranslationFile

@POST
 @Path(value="/translation/{projectSlug}/{iterationSlug}/{locale}")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/xml")
org.jboss.resteasy.client.ClientResponse<ChunkUploadResponse> uploadTranslationFile(@PathParam(value="projectSlug")
                                                                                                                                                                                                                                          String projectSlug,
                                                                                                                                                                                                                                          @PathParam(value="iterationSlug")
                                                                                                                                                                                                                                          String iterationSlug,
                                                                                                                                                                                                                                          @PathParam(value="locale")
                                                                                                                                                                                                                                          String localeId,
                                                                                                                                                                                                                                          @QueryParam(value="docId")
                                                                                                                                                                                                                                          String docId,
                                                                                                                                                                                                                                          @QueryParam(value="merge")
                                                                                                                                                                                                                                          String merge,
                                                                                                                                                                                                                                          DocumentFileUploadForm uploadForm)

Specified by:

uploadTranslationFile in interface FileResource

downloadSourceFile

@GET
 @Path(value="/source/{projectSlug}/{iterationSlug}/{fileType}")
org.jboss.resteasy.client.ClientResponse downloadSourceFile(@PathParam(value="projectSlug")
                                                                                                                                  String projectSlug,
                                                                                                                                  @PathParam(value="iterationSlug")
                                                                                                                                  String iterationSlug,
                                                                                                                                  @PathParam(value="fileType")
                                                                                                                                  String fileType,
                                                                                                                                  @QueryParam(value="docId")
                                                                                                                                  String docId)

Description copied from interface: FileResource

Downloads a single source file.

Specified by:

downloadSourceFile in interface FileResource

fileType - use 'raw' for original source if available, or 'pot' to generate pot from source strings

Returns:

response with status code 404 if the document is not found, 415 if fileType is not valid for the document, otherwise 200 with attached document.

downloadTranslationFile

@GET
 @Path(value="/translation/{projectSlug}/{iterationSlug}/{locale}/{fileType}")
org.jboss.resteasy.client.ClientResponse downloadTranslationFile(@PathParam(value="projectSlug")
                                                                                                                                                     String projectSlug,
                                                                                                                                                     @PathParam(value="iterationSlug")
                                                                                                                                                     String iterationSlug,
                                                                                                                                                     @PathParam(value="locale")
                                                                                                                                                     String locale,
                                                                                                                                                     @PathParam(value="fileType")
                                                                                                                                                     String fileExtension,
                                                                                                                                                     @QueryParam(value="docId")
                                                                                                                                                     String docId)

Description copied from interface: FileResource

Downloads a single translation file. To download a preview-document or translated document where a raw source document is available, use fileType 'half_baked' and 'baked' respectively.

Specified by:

downloadTranslationFile in interface FileResource

Parameters:

projectSlug - Project identifier.

iterationSlug - Project iteration identifier.

locale - Translations for this locale will be contained in the downloaded document.

docId - Document identifier to fetch translations for.

Returns:

The following response status codes will be returned from this operation:
OK(200) - A translation file in the requested format with translations for the requested document in a project, iteration and locale.
NOT FOUND(404) - If a document is not found with the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.