org.zanata.rest.service

Interface SourceDocResource

All Known Subinterfaces:

ISourceDocResource

public interface SourceDocResource

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteResource(String idNoSlash)
javax.ws.rs.core.Response	get(Set<String> extensions) Retrieve the List of Resources
javax.ws.rs.core.Response	getResource(String idNoSlash, Set<String> extensions)
javax.ws.rs.core.Response	getResourceMeta(String idNoSlash, Set<String> extensions)
javax.ws.rs.core.Response	head()
javax.ws.rs.core.Response	post(Resource resource, Set<String> extensions, boolean copytrans)
javax.ws.rs.core.Response	putResource(String idNoSlash, Resource resource, Set<String> extensions, boolean copytrans)
javax.ws.rs.core.Response	putResourceMeta(String idNoSlash, ResourceMeta messageBody, Set<String> extensions)

Field Detail

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()

get

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

Retrieve the List of Resources

Returns:

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

post

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

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)

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)

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)

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)

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)