org.zanata.rest.service

Class MockFileResource

java.lang.Object

org.zanata.rest.service.MockFileResource

All Implemented Interfaces:

Serializable, FileResource, RestResource

@Path(value="/file")
public class MockFileResource
extends Object
implements FileResource

Author:

Patrick Huang pahuang@redhat.com

See Also:

Serialized Form

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
MockFileResource()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockFileResource

public MockFileResource()

Method Detail

acceptedFileTypes

@Deprecated
public javax.ws.rs.core.Response acceptedFileTypes()

Deprecated.

Description copied from interface: FileResource

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

Specified by:

acceptedFileTypes in interface FileResource

Returns:

a semicolon-separated list of file extensions

See Also:

DocumentType#getSourceExtensions(), FileResource.fileTypeInfoList()

acceptedFileTypeList

@Deprecated
public javax.ws.rs.core.Response acceptedFileTypeList()

Deprecated.

Description copied from interface: FileResource

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.

Specified by:

acceptedFileTypeList in interface FileResource

Returns:

a List of DocumentType

See Also:

DocumentType, FileResource.fileTypeInfoList()

fileTypeInfoList

public javax.ws.rs.core.Response fileTypeInfoList()

Description copied from interface: FileResource

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

Specified by:

fileTypeInfoList in interface FileResource

Returns:

a List of FileTypeInfo

See Also:

FileTypeInfo

uploadSourceFile

public javax.ws.rs.core.Response uploadSourceFile(String projectSlug,
                                                  String iterationSlug,
                                                  String docId,
                                                  DocumentFileUploadForm uploadForm)

Description copied from interface: FileResource

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.

Specified by:

uploadSourceFile in interface FileResource

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

public javax.ws.rs.core.Response uploadTranslationFile(String projectSlug,
                                                       String iterationSlug,
                                                       String localeId,
                                                       String docId,
                                                       String merge,
                                                       DocumentFileUploadForm uploadForm)

Description copied from interface: FileResource

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.

Specified by:

uploadTranslationFile in interface FileResource

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

public javax.ws.rs.core.Response downloadSourceFile(String projectSlug,
                                                    String iterationSlug,
                                                    String fileType,
                                                    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

public javax.ws.rs.core.Response downloadTranslationFile(String projectSlug,
                                                         String iterationSlug,
                                                         String locale,
                                                         String fileExtension,
                                                         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.

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

public javax.ws.rs.core.Response download(String downloadId)

Description copied from interface: FileResource

Downloads a previously generated file.

Specified by:

download in interface FileResource

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.