org.zanata.rest.service

Interface FileResource

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

Represents various types of translatable files to be processed by the server instead of the REST client. This REST interface provides endpoints for uploading and downloading files in multiple formats.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPTED_TYPE_LIST_RESOURCE
static String	ACCEPTED_TYPES_RESOURCE
static String	DOWNLOAD_TEMPLATE
static String	FILE_DOWNLOAD_TEMPLATE
static String	FILE_RESOURCE Deprecated.
static String	FILE_TYPE_INFO_RESOURCE
static String	FILETYPE_RAW_SOURCE_DOCUMENT Specifies to download the original source file that was uploaded, byte-for-byte.
static String	FILETYPE_TRANSLATED_APPROVED Specifies to download a completed version of a translated document in the original source format, showing only approved translations.
static String	FILETYPE_TRANSLATED_APPROVED_AND_FUZZY Specifies to download a preview of the translated document in the original source format, showing all non-empty translations (even if not approved).
static String	SERVICE_PATH
static String	SOURCE_DOWNLOAD_TEMPLATE
static String	SOURCE_UPLOAD_TEMPLATE
static String	TRANSLATION_UPLOAD_TEMPLATE

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	acceptedFileTypeList() Deprecated.
javax.ws.rs.core.Response	acceptedFileTypes() Deprecated.
javax.ws.rs.core.Response	download(String downloadId) Downloads a previously generated file.
javax.ws.rs.core.Response	downloadSourceFile(String projectSlug, String iterationSlug, String fileType, String docId) Downloads a single source file.
javax.ws.rs.core.Response	downloadTranslationFile(String projectSlug, String iterationSlug, String locale, String fileExtension, String docId) Downloads a single translation file.
javax.ws.rs.core.Response	fileTypeInfoList() A list of document types supported by the server, along with their default file extensions.
javax.ws.rs.core.Response	uploadSourceFile(String projectSlug, String iterationSlug, String docId, DocumentFileUploadForm uploadForm) Upload a source file (or file chunk) to Zanata.
javax.ws.rs.core.Response	uploadTranslationFile(String projectSlug, String iterationSlug, String localeId, String docId, String merge, DocumentFileUploadForm uploadForm) Upload a translation file (or file chunk) to Zanata.

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

FILE_RESOURCE

@Deprecated
static final String FILE_RESOURCE

Deprecated.

See Also:

Constant Field Values

ACCEPTED_TYPES_RESOURCE

static final String ACCEPTED_TYPES_RESOURCE

See Also:

Constant Field Values

ACCEPTED_TYPE_LIST_RESOURCE

static final String ACCEPTED_TYPE_LIST_RESOURCE

See Also:

Constant Field Values

FILE_TYPE_INFO_RESOURCE

static final String FILE_TYPE_INFO_RESOURCE

See Also:

Constant Field Values

DOWNLOAD_TEMPLATE

static final String DOWNLOAD_TEMPLATE

See Also:

Constant Field Values

FILE_DOWNLOAD_TEMPLATE

static final String FILE_DOWNLOAD_TEMPLATE

See Also:

Constant Field Values

TRANSLATION_UPLOAD_TEMPLATE

static final String TRANSLATION_UPLOAD_TEMPLATE

See Also:

Constant Field Values

SOURCE_UPLOAD_TEMPLATE

static final String SOURCE_UPLOAD_TEMPLATE

See Also:

Constant Field Values

SOURCE_DOWNLOAD_TEMPLATE

static final String SOURCE_DOWNLOAD_TEMPLATE

See Also:

Constant Field Values

FILETYPE_RAW_SOURCE_DOCUMENT

static final String FILETYPE_RAW_SOURCE_DOCUMENT

Specifies to download the original source file that was uploaded, byte-for-byte.

See Also:

Constant Field Values

FILETYPE_TRANSLATED_APPROVED_AND_FUZZY

static final String FILETYPE_TRANSLATED_APPROVED_AND_FUZZY

Specifies to download a preview of the translated document in the original source format, showing all non-empty translations (even if not approved). Where translations are empty, source strings are used.

See Also:

Constant Field Values

FILETYPE_TRANSLATED_APPROVED

static final String FILETYPE_TRANSLATED_APPROVED

Specifies to download a completed version of a translated document in the original source format, showing only approved translations. Where no approved translation is available, source strings are used.

See Also:

Constant Field Values

Method Detail

acceptedFileTypes

@Deprecated
 @GET
 @Path(value="/accepted_types")
 @Produces(value="text/plain")
javax.ws.rs.core.Response acceptedFileTypes()

Deprecated.

Deprecated. Returns the source file extensions supported by the server.

Returns:

a semicolon-separated list of file extensions

See Also:

DocumentType#getSourceExtensions(), fileTypeInfoList()

acceptedFileTypeList

@Deprecated
 @GET
 @Path(value="/accepted_document_types")
 @Produces(value="application/json")
javax.ws.rs.core.Response acceptedFileTypeList()

Deprecated.

Deprecated. A list of document types supported by the server. The result will not be deserializable if the server supports document types which the client does not know about (eg compiled against a newer version of zanata-api), also any changes to the list of supported file extensions for existing types will not be visible to the client.

Returns:

a List of DocumentType

See Also:

DocumentType, fileTypeInfoList()

fileTypeInfoList

@GET
 @Path(value="/file_type_info")
 @Produces(value="application/json")
javax.ws.rs.core.Response fileTypeInfoList()

A list of document types supported by the server, along with their default file extensions.

Returns:

a List of FileTypeInfo

See Also:

FileTypeInfo

uploadSourceFile

@POST
 @Path(value="/source/{projectSlug}/{iterationSlug}")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/xml")
javax.ws.rs.core.Response uploadSourceFile(@PathParam(value="projectSlug")
                                                                                                                                                                                   String projectSlug,
                                                                                                                                                                                   @PathParam(value="iterationSlug")
                                                                                                                                                                                   String iterationSlug,
                                                                                                                                                                                   @QueryParam(value="docId")
                                                                                                                                                                                   String docId,
                                                                                                                                                                                   DocumentFileUploadForm uploadForm)

Upload a source file (or file chunk) to Zanata. Allows breaking up files into smaller chunks for very large files. In this case, the first invocation of this service will return an 'upload id' which needs to be used in subsequent calls to tie all the uploaded chunks together. The file will only be processed when all chunks have been fully uploaded. With each uploaded chunk, the multipart message's 'last' parameter will indicate if it is the last expected chunk.

Parameters:

projectSlug - The project slug where to store the document.

iterationSlug - The project version slug where to store the document.

docId - The full Document identifier

uploadForm - The multi-part form body for the file or chunk.

Returns:

A message with information about the upload operation.

uploadTranslationFile

@POST
 @Path(value="/translation/{projectSlug}/{iterationSlug}/{locale}")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/xml")
javax.ws.rs.core.Response 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)

Upload a translation file (or file chunk) to Zanata. Allows breaking up files into smaller chunks for very large files. In this case, the first invocation of this service will return an 'upload id' which needs to be used in subsequent calls to tie all the uploaded chunks together. The file will only be processed when all chunks have been fully uploaded. With each uploaded chunk, the multipart message's 'last' parameter will indicate if it is the last expected chunk.

Parameters:

projectSlug - The project slug where to store the document.

iterationSlug - The project version slug where to store the document.

localeId - The locale (language) for the translation file.

docId - The full Document identifier.

merge - Indicates whether to merge translations or overwrite all translations with the contents of the uploaded file.

uploadForm - The multi-part form body for the file or chunk.

Returns:

A message with information about the upload operation.

downloadSourceFile

@GET
 @Path(value="/source/{projectSlug}/{iterationSlug}/{fileType}")
javax.ws.rs.core.Response downloadSourceFile(@PathParam(value="projectSlug")
                                                                                                                   String projectSlug,
                                                                                                                   @PathParam(value="iterationSlug")
                                                                                                                   String iterationSlug,
                                                                                                                   @PathParam(value="fileType")
                                                                                                                   String fileType,
                                                                                                                   @QueryParam(value="docId")
                                                                                                                   String docId)

Downloads a single source file.

Parameters:

projectSlug -

iterationSlug -

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

docId -

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}")
javax.ws.rs.core.Response 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)

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.

Parameters:

projectSlug - Project identifier.

iterationSlug - Project iteration identifier.

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

fileExtension - File type to be downloaded. (Options: 'po', 'half_baked', 'baked')

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.

download

@GET
 @Path(value="/download/{downloadId}")
javax.ws.rs.core.Response download(@PathParam(value="downloadId")
                                                                               String downloadId)

Downloads a previously generated file.

Parameters:

downloadId - The Zanata generated download id.

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 downloadable file is not found for the given id, or is not yet ready for download (i.e. the system is still preparing it).
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.