org.codice.ddf.endpoints.rest

Class RESTEndpoint

java.lang.Object

org.codice.ddf.endpoints.rest.RESTEndpoint

All Implemented Interfaces:

RESTService

@Path(value="/")
public class RESTEndpoint
extends Object
implements RESTService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RESTEndpoint.CreateInfo
protected static class	RESTEndpoint.IncomingContentItem

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_INPUT_SIZE

Fields inherited from interface org.codice.ddf.endpoints.rest.RESTService

CONTEXT_ROOT, SOURCES_PATH

Constructor Summary

Constructors

Constructor and Description
RESTEndpoint(CatalogFramework framework)

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	createMetacard(org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody, javax.ws.rs.core.UriInfo requestUriInfo, String transformerParam)
javax.ws.rs.core.Response	deleteDocument(String id, javax.servlet.http.HttpServletRequest httpRequest) REST Delete.
javax.ws.rs.core.Response	getDocument(String encodedSourceId, String encodedId, 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.
FilterBuilder	getFilterBuilder()
javax.ws.rs.core.Response	getHeaders(String sourceid, String id, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest httpRequest) REST Head.
javax.ws.rs.core.Response	getHeaders(String id, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest httpRequest) REST Head.
MimeTypeToTransformerMapper	getMimeTypeToTransformerMapper()
javax.ws.rs.core.Response	ping()
void	setFilterBuilder(FilterBuilder filterBuilder)
void	setMetacardTypes(List<MetacardType> metacardTypes)
void	setMimeTypeMapper(MimeTypeMapper mimeTypeMapper)
void	setMimeTypeToTransformerMapper(MimeTypeToTransformerMapper mimeTypeToTransformerMapper)
void	setTikaMimeTypeResolver(MimeTypeResolver mimeTypeResolver)
void	setUuidGenerator(UuidGenerator uuidGenerator)
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.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_INPUT_SIZE

public static final int MAX_INPUT_SIZE

See Also:

Constant Field Values

Constructor Detail

RESTEndpoint

public RESTEndpoint(CatalogFramework framework)

Method Detail

ping

@HEAD
 @Path(value="")
public javax.ws.rs.core.Response ping()

getHeaders

@HEAD
 @Path(value="/{id}")
public javax.ws.rs.core.Response getHeaders(@PathParam(value="id")
                                                                        String id,
                                                                        @Context
                                                                        javax.ws.rs.core.UriInfo uriInfo,
                                                                        @Context
                                                                        javax.servlet.http.HttpServletRequest httpRequest)

REST Head. Retrieves information regarding the entry specified by the id. This can be used to verify that the Range header is supported (the Accept-Ranges header is returned) and to get the size of the requested resource for use in Content-Range requests.

Parameters:

id -

uriInfo -

httpRequest -

Returns:

getHeaders

@HEAD
 @Path(value="/sources/{sourceid}/{id}")
public javax.ws.rs.core.Response getHeaders(@PathParam(value="sourceid")
                                                                                           String sourceid,
                                                                                           @PathParam(value="id")
                                                                                           String id,
                                                                                           @Context
                                                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                                                           @Context
                                                                                           javax.servlet.http.HttpServletRequest httpRequest)

REST Head. Returns headers only. Primarily used to let the client know that range requests (though limited) are accepted.

Parameters:

sourceid -

id -

uriInfo -

httpRequest -

Returns:

getDocument

@GET
 @Path(value="/{id}")
public 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.

Specified by:

getDocument in interface RESTService

Parameters:

id -

transformerParam - (OPTIONAL)

uriInfo -

Returns:

Throws:

InternalServerErrorException

getDocument

@GET
 @Path(value="/sources")
public 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.

Specified by:

getDocument in interface RESTService

Parameters:

uriInfo -

httpRequest -

Returns:

getDocument

@GET
 @Path(value="/sources/{sourceid}/{id}")
public javax.ws.rs.core.Response getDocument(@Encoded @PathParam(value="sourceid")
                                                                                           String encodedSourceId,
                                                                                           @Encoded @PathParam(value="id")
                                                                                           String encodedId,
                                                                                           @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.

Specified by:

getDocument in interface RESTService

Parameters:

encodedSourceId -

encodedId -

transformerParam -

uriInfo -

Returns:

createMetacard

@POST
 @Path(value="/metacard")
public javax.ws.rs.core.Response createMetacard(org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody,
                                                                                @Context
                                                                                javax.ws.rs.core.UriInfo requestUriInfo,
                                                                                @QueryParam(value="transform")
                                                                                String transformerParam)

updateDocument

@PUT
 @Path(value="/{id}")
 @Consumes(value={"text/*","application/*"})
public 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 entry with the provided document.

Specified by:

updateDocument in interface RESTService

Parameters:

id -

message -

Returns:

updateDocument

@PUT
 @Path(value="/{id}")
 @Consumes(value="multipart/*")
public 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 entry with the provided document.

Specified by:

updateDocument in interface RESTService

Parameters:

id -

message -

Returns:

addDocument

@POST
 @Consumes(value={"text/*","application/*"})
public 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)

Description copied from interface: RESTService

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

Specified by:

addDocument in interface RESTService

Returns:

addDocument

@POST
 @Consumes(value="multipart/*")
public 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.

Specified by:

addDocument in interface RESTService

Parameters:

message -

Returns:

deleteDocument

@DELETE
 @Path(value="/{id}")
public 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.

Specified by:

deleteDocument in interface RESTService

Parameters:

id -

Returns:

getMimeTypeToTransformerMapper

public MimeTypeToTransformerMapper getMimeTypeToTransformerMapper()

setMimeTypeToTransformerMapper

public void setMimeTypeToTransformerMapper(MimeTypeToTransformerMapper mimeTypeToTransformerMapper)

getFilterBuilder

public FilterBuilder getFilterBuilder()

setFilterBuilder

public void setFilterBuilder(FilterBuilder filterBuilder)

setTikaMimeTypeResolver

public void setTikaMimeTypeResolver(MimeTypeResolver mimeTypeResolver)

setMimeTypeMapper

public void setMimeTypeMapper(MimeTypeMapper mimeTypeMapper)

setMetacardTypes

public void setMetacardTypes(List<MetacardType> metacardTypes)

setUuidGenerator

public void setUuidGenerator(UuidGenerator uuidGenerator)