org.zanata.rest.service

Interface SourceDocResource

@Produces(value={"application/xml","application/json"})
 @Consumes(value={"application/xml","application/json"})
public interface SourceDocResource

projectSlug: Project Identifier. iterationSlug: Project Iteration identifier.

Author:

Carlos Munoz camunoz@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_NAME_REGEX
static String	RESOURCE_SLUG_REGEX
static String	RESOURCE_SLUG_TEMPLATE
static String	SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteResource(String idNoSlash) Delete a Document.
javax.ws.rs.core.Response	get(Set<String> extensions) Retrieve the List of Documents (Resources) belonging to a Project iteration.
javax.ws.rs.core.Response	getResource(String idNoSlash, Set<String> extensions) Retrieves information for a Document.
javax.ws.rs.core.Response	getResourceMeta(String idNoSlash, Set<String> extensions) Retrieves meta-data information for a Document.
javax.ws.rs.core.Response	head() Returns header information for a Project's iteration translations.
javax.ws.rs.core.Response	post(Resource resource, Set<String> extensions, boolean copytrans) Creates a new Document.
javax.ws.rs.core.Response	putResource(String idNoSlash, Resource resource, Set<String> extensions, boolean copytrans) Creates or modifies a Document.
javax.ws.rs.core.Response	putResourceMeta(String idNoSlash, ResourceMeta messageBody, Set<String> extensions) Modifies an existing document's meta-data.

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

RESOURCE_SLUG_REGEX

static final String RESOURCE_SLUG_REGEX

See Also:

Constant Field Values

RESOURCE_NAME_REGEX

static final String RESOURCE_NAME_REGEX

See Also:

Constant Field Values

RESOURCE_SLUG_TEMPLATE

static final String RESOURCE_SLUG_TEMPLATE

See Also:

Constant Field Values

Method Detail

head

@HEAD
javax.ws.rs.core.Response head()

Returns header information for a Project's iteration translations.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing an "Etag" header for the requested project iteration translations.
NOT FOUND(404) - If a project iteration could not be found for the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

get

@GET
javax.ws.rs.core.Response get(@QueryParam(value="ext")
                                   Set<String> extensions)

Retrieve the List of Documents (Resources) belonging to a Project iteration.

Parameters:

extensions - The document extensions to fetch along with the documents (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response with a list of documents wrapped in a "resources" element. Each child element will be a "resource-meta".
NOT FOUND(404) - If a Project iteration could not be found with the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

post

@POST
javax.ws.rs.core.Response post(Resource resource,
                                     @QueryParam(value="ext")
                                     Set<String> extensions,
                                     @QueryParam(value="copyTrans") @DefaultValue(value="true")
                                     boolean copytrans)

Creates a new Document.

Parameters:

resource - The document information.

extensions - The document extensions to save with the new document (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

copytrans - Boolean value that indicates whether reasonably close translations from other projects should be found to initially populate this document's translations.

Returns:

The following response status codes will be returned from this operation:
CREATED (201) - If the document was successfully created.
CONFLICT(409) - If another document already exists with the same name, on the same project iteration.
UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

getResource

@GET
 @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}")
javax.ws.rs.core.Response getResource(@PathParam(value="id")
                                                                                                                 String idNoSlash,
                                                                                                                 @QueryParam(value="ext")
                                                                                                                 Set<String> extensions)

Retrieves information for a Document.

Parameters:

idNoSlash - The document identifier. Some document ids could have forward slashes ('/') in them which would cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/' characters replaced with commas (',').

extensions - The document extensions to fetch along with the document (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response with the document's information.
NOT FOUND(404) - If a document could not be found with the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

putResource

@PUT
 @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}")
javax.ws.rs.core.Response putResource(@PathParam(value="id")
                                                                                                                 String idNoSlash,
                                                                                                                 Resource resource,
                                                                                                                 @QueryParam(value="ext")
                                                                                                                 Set<String> extensions,
                                                                                                                 @QueryParam(value="copyTrans") @DefaultValue(value="true")
                                                                                                                 boolean copytrans)

Creates or modifies a Document.

Parameters:

idNoSlash - The document identifier. Some document ids could have forward slashes ('/') in them which would cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/' characters replaced with commas (',').

resource - The document information.

extensions - The document extensions to save with the document (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

copytrans - Boolean value that indicates whether reasonably close translations from other projects should be found to initially populate this document's translations.

Returns:

The following response status codes will be returned from this operation:
CREATED(201) - If a new document was successfully created.
OK(200) - If an already existing document was modified.
NOT FOUND(404) - If a project or project iteration could not be found with the given parameters.
FORBIDDEN(403) - If the user is not allowed to modify the project, project iteration or document. This might be due to the project or iteration being in Read-Only mode.
UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

deleteResource

@DELETE
 @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}")
javax.ws.rs.core.Response deleteResource(@PathParam(value="id")
                                                                                                                       String idNoSlash)

Delete a Document. The system keeps the history of this document however.

Parameters:

idNoSlash - The document identifier. Some document ids could have forward slashes ('/') in them which would cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/' characters replaced with commas (',').

Returns:

The following response status codes will be returned from this operation:
OK(200) - If The document was successfully deleted.
NOT FOUND(404) - If a project or project iteration could not be found with the given parameters.
FORBIDDEN(403) - If the user is not allowed to modify the project, project iteration or document. This might be due to the project or iteration being in Read-Only mode.
UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

getResourceMeta

@GET
 @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}/meta")
javax.ws.rs.core.Response getResourceMeta(@PathParam(value="id")
                                                                                                                          String idNoSlash,
                                                                                                                          @QueryParam(value="ext")
                                                                                                                          Set<String> extensions)

Retrieves meta-data information for a Document.

Parameters:

idNoSlash - The document identifier. Some document ids could have forward slashes ('/') in them which would cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/' characters replaced with commas (',').

extensions - The document extensions to retrieve with the document's meta-data (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the Document's meta-data was found. The data will be contained in the response.
NOT FOUND(404) - If a project, project iteration or document could not be found with the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

putResourceMeta

@PUT
 @Path(value="/{id:[a-zA-Z0-9]+([a-zA-Z0-9_\\-,{.}]*[a-zA-Z0-9]+)?}/meta")
javax.ws.rs.core.Response putResourceMeta(@PathParam(value="id")
                                                                                                                          String idNoSlash,
                                                                                                                          ResourceMeta messageBody,
                                                                                                                          @QueryParam(value="ext")
                                                                                                                          Set<String> extensions)

Modifies an existing document's meta-data.

Parameters:

idNoSlash - The document identifier. Some document ids could have forward slashes ('/') in them which would cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/' characters replaced with commas (',').

messageBody - The document's meta-data.

extensions - The document extensions to save with the document (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the Document's meta-data was successfully modified.
NOT FOUND(404) - If a document was not found using the given parameters.
UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.