org.zanata.rest.service

Class MockSourceDocResource

java.lang.Object

org.zanata.rest.service.MockSourceDocResource

All Implemented Interfaces:

SourceDocResource

@Path(value="/projects/p/{projectSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}/iterations/i/{iterationSlug:[a-zA-Z0-9]+([a-zA-Z0-9_\\-{.}]*[a-zA-Z0-9]+)?}")
public class MockSourceDocResource
extends Object
implements SourceDocResource

Author:

Patrick Huang pahuang@redhat.com

Field Summary

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

DOCID_RESOURCE_PATH, RESOURCE_NAME_REGEX, RESOURCE_PATH, RESOURCE_SLUG_REGEX, RESOURCE_SLUG_TEMPLATE, SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
MockSourceDocResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteResource(String idNoSlash) Deprecated.
javax.ws.rs.core.Response	deleteResourceWithDocId(String docId) Delete a source 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) Deprecated.
javax.ws.rs.core.Response	getResourceMeta(String idNoSlash, Set<String> extensions) Deprecated.
javax.ws.rs.core.Response	getResourceMetaWithDocId(String docId, Set<String> extensions) Retrieves meta-data information for a source Document.
javax.ws.rs.core.Response	getResourceWithDocId(String docId, Set<String> extensions) Retrieves information for a source Document.
javax.ws.rs.core.Response	head() Returns header information for a Project's iteration source strings.
javax.ws.rs.core.Response	post(Resource resource, Set<String> extensions, boolean copyTrans) Creates a new source Document.
javax.ws.rs.core.Response	putResource(String idNoSlash, Resource resource, Set<String> extensions, boolean copyTrans) Deprecated.
javax.ws.rs.core.Response	putResourceMeta(String idNoSlash, ResourceMeta resourceMeta, Set<String> extensions) Deprecated.
javax.ws.rs.core.Response	putResourceMetaWithDocId(ResourceMeta messageBody, String docId, Set<String> extensions) Modifies an existing source document's meta-data.
javax.ws.rs.core.Response	putResourceWithDocId(Resource resource, String docId, Set<String> extensions, boolean copytrans) Creates or modifies a source Document.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockSourceDocResource

public MockSourceDocResource()

Method Detail

head

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

Description copied from interface: SourceDocResource

Returns header information for a Project's iteration source strings.

Specified by:

head in interface SourceDocResource

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

public javax.ws.rs.core.Response get(Set<String> extensions)

Description copied from interface: SourceDocResource

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

Specified by:

get in interface SourceDocResource

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

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

Description copied from interface: SourceDocResource

Creates a new source Document.

Specified by:

post in interface SourceDocResource

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

@Deprecated
public javax.ws.rs.core.Response getResource(String idNoSlash,
                                                         Set<String> extensions)

Deprecated.

Description copied from interface: SourceDocResource

Retrieves information for a source Document.

Specified by:

getResource in interface SourceDocResource

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. Deprecated. Use SourceDocResource.getResourceWithDocId(java.lang.String, java.util.Set<java.lang.String>)

getResourceWithDocId

public javax.ws.rs.core.Response getResourceWithDocId(String docId,
                                                      Set<String> extensions)

Description copied from interface: SourceDocResource

Retrieves information for a source Document.

Specified by:

getResourceWithDocId in interface SourceDocResource

Parameters:

docId - The document identifier.

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

@Deprecated
public javax.ws.rs.core.Response putResource(String idNoSlash,
                                                         Resource resource,
                                                         Set<String> extensions,
                                                         @DefaultValue(value="true")
                                                         boolean copyTrans)

Deprecated.

Description copied from interface: SourceDocResource

Creates or modifies a source Document.

Specified by:

putResource in interface SourceDocResource

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. Deprecated. Use SourceDocResource.putResourceWithDocId(org.zanata.rest.dto.resource.Resource, java.lang.String, java.util.Set<java.lang.String>, boolean)

putResourceWithDocId

public javax.ws.rs.core.Response putResourceWithDocId(Resource resource,
                                                      String docId,
                                                      Set<String> extensions,
                                                      boolean copytrans)

Description copied from interface: SourceDocResource

Creates or modifies a source Document.

Specified by:

putResourceWithDocId in interface SourceDocResource

Parameters:

resource - The document information.

docId - The document identifier.

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

@Deprecated
public javax.ws.rs.core.Response deleteResource(String idNoSlash)

Deprecated.

Description copied from interface: SourceDocResource

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

Specified by:

deleteResource in interface SourceDocResource

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. Deprecated. Use SourceDocResource.deleteResourceWithDocId(java.lang.String)

deleteResourceWithDocId

public javax.ws.rs.core.Response deleteResourceWithDocId(String docId)

Description copied from interface: SourceDocResource

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

Specified by:

deleteResourceWithDocId in interface SourceDocResource

Parameters:

docId - The document identifier.

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

@Deprecated
public javax.ws.rs.core.Response getResourceMeta(String idNoSlash,
                                                             Set<String> extensions)

Deprecated.

Description copied from interface: SourceDocResource

Retrieves meta-data information for a source Document.

Specified by:

getResourceMeta in interface SourceDocResource

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. Deprecated. Use SourceDocResource.getResourceMetaWithDocId(java.lang.String, java.util.Set<java.lang.String>)

getResourceMetaWithDocId

public javax.ws.rs.core.Response getResourceMetaWithDocId(String docId,
                                                          Set<String> extensions)

Description copied from interface: SourceDocResource

Retrieves meta-data information for a source Document.

Specified by:

getResourceMetaWithDocId in interface SourceDocResource

Parameters:

docId - The document identifier.

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

@Deprecated
public javax.ws.rs.core.Response putResourceMeta(String idNoSlash,
                                                             ResourceMeta resourceMeta,
                                                             Set<String> extensions)

Deprecated.

Description copied from interface: SourceDocResource

Modifies an existing source document's meta-data.

Specified by:

putResourceMeta in interface SourceDocResource

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 (',').

resourceMeta - 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. Deprecated. Use SourceDocResource.putResourceMetaWithDocId(org.zanata.rest.dto.resource.ResourceMeta, java.lang.String, java.util.Set<java.lang.String>)

putResourceMetaWithDocId

public javax.ws.rs.core.Response putResourceMetaWithDocId(ResourceMeta messageBody,
                                                          String docId,
                                                          Set<String> extensions)

Description copied from interface: SourceDocResource

Modifies an existing source document's meta-data.

Specified by:

putResourceMetaWithDocId in interface SourceDocResource

Parameters:

messageBody - The document's meta-data.

docId - The document identifier.

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.