org.zanata.rest.client

Interface IFileResource

All Superinterfaces:

FileResource

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, SOURCE_DOWNLOAD_TEMPLATE, SOURCE_UPLOAD_TEMPLATE, TRANSLATION_UPLOAD_TEMPLATE

Method Summary

Methods

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)
org.jboss.resteasy.client.ClientResponse	downloadTranslationFile(String projectSlug, String iterationSlug, String locale, String fileExtension, String docId)
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")
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")
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)

Specified by:

downloadSourceFile in interface FileResource

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)

Specified by:

downloadTranslationFile in interface FileResource