org.zanata.rest.client

Interface ISourceDocResource

All Superinterfaces:

SourceDocResource

@Produces(value="application/xml")
@Consumes(value="application/xml")
public interface ISourceDocResource
extends SourceDocResource

Client interface for Source document resources.

Author:

Carlos Munoz camunoz@redhat.com

Field Summary

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

RESOURCE_NAME_REGEX, RESOURCE_SLUG_REGEX, RESOURCE_SLUG_TEMPLATE

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.resteasy.client.ClientResponse<String>	deleteResource(String idNoSlash)
org.jboss.resteasy.client.ClientResponse<List<ResourceMeta>>	get(Set<String> extensions) Retrieve the List of Resources
org.jboss.resteasy.client.ClientResponse<Resource>	getResource(String idNoSlash, Set<String> extensions)
org.jboss.resteasy.client.ClientResponse<ResourceMeta>	getResourceMeta(String idNoSlash, Set<String> extensions)
org.jboss.resteasy.client.ClientResponse<String>	post(Resource messageBody, Set<String> extensions, boolean copytrans)
org.jboss.resteasy.client.ClientResponse<String>	putResource(String idNoSlash, Resource resource, Set<String> extensions)
org.jboss.resteasy.client.ClientResponse<String>	putResource(String idNoSlash, Resource resource, Set<String> extensions, boolean copytrans)
org.jboss.resteasy.client.ClientResponse<String>	putResourceMeta(String idNoSlash, ResourceMeta messageBody, Set<String> extensions)

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

head

Method Detail

get

@GET
org.jboss.resteasy.client.ClientResponse<List<ResourceMeta>> get(@QueryParam(value="ext")
                                                                   Set<String> extensions)

Description copied from interface: SourceDocResource

Retrieve the List of Resources

Specified by:

get in interface SourceDocResource

Returns:

Response.ok with ResourcesList or Response(404) if not found

post

@POST
org.jboss.resteasy.client.ClientResponse<String> post(Resource messageBody,
                                                         @QueryParam(value="ext")
                                                         Set<String> extensions,
                                                         @QueryParam(value="copyTrans")@DefaultValue(value="true")
                                                         boolean copytrans)

Specified by:

post in interface SourceDocResource

getResource

@GET
@Path(value="{id}")
org.jboss.resteasy.client.ClientResponse<Resource> getResource(@PathParam(value="id")
                                                                      String idNoSlash,
                                                                      @QueryParam(value="ext")
                                                                      Set<String> extensions)

Specified by:

getResource in interface SourceDocResource

putResource

@PUT
@Path(value="{id}")
org.jboss.resteasy.client.ClientResponse<String> putResource(@PathParam(value="id")
                                                                    String idNoSlash,
                                                                    Resource resource,
                                                                    @QueryParam(value="ext")
                                                                    Set<String> extensions,
                                                                    @QueryParam(value="copyTrans")@DefaultValue(value="true")
                                                                    boolean copytrans)

Specified by:

putResource in interface SourceDocResource

putResource

@PUT
@Path(value="{id}")
org.jboss.resteasy.client.ClientResponse<String> putResource(@PathParam(value="id")
                                                                    String idNoSlash,
                                                                    Resource resource,
                                                                    @QueryParam(value="ext")
                                                                    Set<String> extensions)

deleteResource

@DELETE
@Path(value="{id}")
org.jboss.resteasy.client.ClientResponse<String> deleteResource(@PathParam(value="id")
                                                                          String idNoSlash)

Specified by:

deleteResource in interface SourceDocResource

getResourceMeta

@GET
@Path(value="{id}/meta")
org.jboss.resteasy.client.ClientResponse<ResourceMeta> getResourceMeta(@PathParam(value="id")
                                                                              String idNoSlash,
                                                                              @QueryParam(value="ext")
                                                                              Set<String> extensions)

Specified by:

getResourceMeta in interface SourceDocResource

putResourceMeta

@PUT
@Path(value="{id}/meta")
org.jboss.resteasy.client.ClientResponse<String> putResourceMeta(@PathParam(value="id")
                                                                        String idNoSlash,
                                                                        ResourceMeta messageBody,
                                                                        @QueryParam(value="ext")
                                                                        Set<String> extensions)

Specified by:

putResourceMeta in interface SourceDocResource