org.codice.ddf.endpoints.rest

Interface RESTService

All Known Implementing Classes:

RESTEndpoint

@Path(value="/")
public interface RESTService

REST endpoint interface

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_ROOT
static String	SOURCES_PATH

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addDocument(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo requestUriInfo, javax.servlet.http.HttpServletRequest httpRequest, org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody, String transformerParam, InputStream message) REST Post.
javax.ws.rs.core.Response	addDocument(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo requestUriInfo, javax.servlet.http.HttpServletRequest httpRequest, String transformerParam, InputStream message) REST Post.
javax.ws.rs.core.Response	deleteDocument(String id, javax.servlet.http.HttpServletRequest httpRequest) REST Delete.
javax.ws.rs.core.Response	getDocument(String sourceid, String id, String transformerParam, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest httpRequest) REST Get.
javax.ws.rs.core.Response	getDocument(String id, String transformerParam, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest httpRequest) REST Get.
javax.ws.rs.core.Response	getDocument(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest httpRequest) REST Get.
javax.ws.rs.core.Response	updateDocument(String id, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest httpRequest, org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody, String transformerParam, InputStream message) REST Put.
javax.ws.rs.core.Response	updateDocument(String id, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest httpRequest, String transformerParam, InputStream message) REST Put.

Field Detail

CONTEXT_ROOT

static final String CONTEXT_ROOT

See Also:

Constant Field Values

SOURCES_PATH

static final String SOURCES_PATH

See Also:

Constant Field Values

Method Detail

getDocument

@GET
 @Path(value="/{id}")
javax.ws.rs.core.Response getDocument(@PathParam(value="id")
                                                                 String id,
                                                                 @QueryParam(value="transform")
                                                                 String transformerParam,
                                                                 @Context
                                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                                 @Context
                                                                 javax.servlet.http.HttpServletRequest httpRequest)

REST Get. Retrieves the metadata entry specified by the id. Transformer argument is optional, but is used to specify what format the data should be returned.

Parameters:

id -

transformerParam - (OPTIONAL)

uriInfo -

Returns:

Throws:

InternalServerErrorException

getDocument

@GET
 @Path(value="/sources")
javax.ws.rs.core.Response getDocument(@Context
                                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                                    @Context
                                                                    javax.servlet.http.HttpServletRequest httpRequest)

REST Get. Retrieves information regarding sources available.

Parameters:

uriInfo -

httpRequest -

Returns:

getDocument

@GET
 @Path(value="/sources/{sourceid}/{id}")
javax.ws.rs.core.Response getDocument(@PathParam(value="sourceid")
                                                                                    String sourceid,
                                                                                    @PathParam(value="id")
                                                                                    String id,
                                                                                    @QueryParam(value="transform")
                                                                                    String transformerParam,
                                                                                    @Context
                                                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                                                    @Context
                                                                                    javax.servlet.http.HttpServletRequest httpRequest)

REST Get. Retrieves the metadata entry specified by the id from the federated source specified by sourceid. Transformer argument is optional, but is used to specify what format the data should be returned.

Parameters:

sourceid -

id -

transformerParam -

uriInfo -

Returns:

updateDocument

@PUT
 @Path(value="/{id}")
javax.ws.rs.core.Response updateDocument(@PathParam(value="id")
                                                                    String id,
                                                                    @Context
                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                    @Context
                                                                    javax.servlet.http.HttpServletRequest httpRequest,
                                                                    @QueryParam(value="transform")
                                                                    String transformerParam,
                                                                    InputStream message)

REST Put. Updates the specified metadata entry with the provided metadata.

Parameters:

id -

message -

Returns:

updateDocument

@PUT
 @Path(value="/{id}")
javax.ws.rs.core.Response updateDocument(@PathParam(value="id")
                                                                    String id,
                                                                    @Context
                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                    @Context
                                                                    javax.servlet.http.HttpServletRequest httpRequest,
                                                                    org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody,
                                                                    @QueryParam(value="transform")
                                                                    String transformerParam,
                                                                    InputStream message)

REST Put. Updates the specified metadata entry with the provided metadata.

Parameters:

id -

message -

Returns:

addDocument

@POST
javax.ws.rs.core.Response addDocument(@Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @Context
                                            javax.ws.rs.core.UriInfo requestUriInfo,
                                            @Context
                                            javax.servlet.http.HttpServletRequest httpRequest,
                                            @QueryParam(value="transform")
                                            String transformerParam,
                                            InputStream message)

REST Post. Creates a new metadata entry in the catalog.

Parameters:

message -

Returns:

addDocument

@POST
javax.ws.rs.core.Response addDocument(@Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @Context
                                            javax.ws.rs.core.UriInfo requestUriInfo,
                                            @Context
                                            javax.servlet.http.HttpServletRequest httpRequest,
                                            org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody,
                                            @QueryParam(value="transform")
                                            String transformerParam,
                                            InputStream message)

REST Post. Creates a new metadata entry in the catalog.

Parameters:

message -

Returns:

deleteDocument

@DELETE
 @Path(value="/{id}")
javax.ws.rs.core.Response deleteDocument(@PathParam(value="id")
                                                                       String id,
                                                                       @Context
                                                                       javax.servlet.http.HttpServletRequest httpRequest)

REST Delete. Deletes a record from the catalog.

Parameters:

id -

Returns: