Package org.codice.ddf.rest.api

Interface CatalogService

public interface CatalogService

Catalog service interface

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
String	addDocument(List<String> contentTypeList, javax.servlet.http.HttpServletRequest httpServletRequest, String transformerParam, InputStream message)	Creates a new metadata entry in the catalog.
String	addDocument(List<String> contentTypeList, org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody, String transformerParam, InputStream message)	Creates a new metadata entry in the catalog.
ddf.catalog.data.BinaryContent	createMetacard(javax.servlet.http.HttpServletRequest httpServletRequest, String transformerParam)	Creates a new metacard.
ddf.catalog.data.BinaryContent	createMetacard(org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody, String transformerParam)	Creates a new metacard.
void	deleteDocument(String id)	Deletes a record from the catalog.
String	doesLocalResourceExist(String metacardId, String sourceId)	Returns checksum if the local resource exists for the metacardId.
ddf.catalog.data.BinaryContent	getDocument(String encodedSourceId, String encodedId, String transformerParam, URI absolutePath, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, javax.servlet.http.HttpServletRequest httpRequest)	Retrieves the metadata entry specified by the id from the federated source specified by sourceid.
String	getFileExtensionForMimeType(String mimeType)	Retrieves the file extension fro the specified Mime Type.
ddf.catalog.data.BinaryContent	getHeaders(String sourceid, String id, URI absolutePath, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)	Retrieves header information regarding the entry specified by the id such as the Accept-Ranges and Content-Range headers.
ddf.catalog.data.BinaryContent	getSourcesInfo()	Retrieves information regarding available sources.
Map.Entry<org.codice.ddf.attachment.AttachmentInfo,ddf.catalog.data.Metacard>	parseParts(Collection<javax.servlet.http.Part> contentParts, String transformerParam)
void	updateDocument(String id, List<String> contentTypeList, javax.servlet.http.HttpServletRequest httpServletRequest, String transformerParam, InputStream message)	Updates the specified metadata entry with the provided metadata.
void	updateDocument(String id, List<String> contentTypeList, javax.servlet.http.HttpServletRequest httpServletRequest, String transformerParam, InputStream message, Map<String,Serializable> properties)
void	updateDocument(String id, List<String> contentTypeList, org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody, String transformerParam, InputStream message)	Updates the specified metadata entry with the provided metadata.
void	updateDocument(String id, List<String> contentTypeList, org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody, String transformerParam, InputStream message, Map<String,Serializable> properties)

Field Details

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 Details

getHeaders

ddf.catalog.data.BinaryContent getHeaders(String sourceid,
 String id,
 URI absolutePath,
 javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)
                                   throws CatalogServiceException,
javax.ws.rs.InternalServerErrorException

Retrieves header information regarding the entry specified by the id such as the Accept-Ranges and Content-Range headers.

Throws:

CatalogServiceException

javax.ws.rs.InternalServerErrorException

getSourcesInfo

ddf.catalog.data.BinaryContent getSourcesInfo()

Retrieves information regarding available sources.

getDocument

ddf.catalog.data.BinaryContent getDocument(String encodedSourceId,
 String encodedId,
 String transformerParam,
 URI absolutePath,
 javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
 javax.servlet.http.HttpServletRequest httpRequest)
                                    throws CatalogServiceException,
ddf.catalog.resource.DataUsageLimitExceededException,
javax.ws.rs.InternalServerErrorException

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.

Throws:

CatalogServiceException

ddf.catalog.resource.DataUsageLimitExceededException

javax.ws.rs.InternalServerErrorException

createMetacard

ddf.catalog.data.BinaryContent createMetacard(org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody,
 String transformerParam)
                                       throws CatalogServiceException

Creates a new metacard.

Throws:

CatalogServiceException

createMetacard

ddf.catalog.data.BinaryContent createMetacard(javax.servlet.http.HttpServletRequest httpServletRequest,
 String transformerParam)
                                       throws CatalogServiceException

Creates a new metacard.

Throws:

CatalogServiceException

updateDocument

void updateDocument(String id,
 List<String> contentTypeList,
 org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody,
 String transformerParam,
 InputStream message)
             throws CatalogServiceException

Updates the specified metadata entry with the provided metadata.

Throws:

CatalogServiceException

updateDocument

void updateDocument(String id,
 List<String> contentTypeList,
 org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody,
 String transformerParam,
 InputStream message,
 Map<String,Serializable> properties)
             throws CatalogServiceException

Throws:

CatalogServiceException

updateDocument

void updateDocument(String id,
 List<String> contentTypeList,
 javax.servlet.http.HttpServletRequest httpServletRequest,
 String transformerParam,
 InputStream message)
             throws CatalogServiceException

Updates the specified metadata entry with the provided metadata.

Throws:

CatalogServiceException

updateDocument

void updateDocument(String id,
 List<String> contentTypeList,
 javax.servlet.http.HttpServletRequest httpServletRequest,
 String transformerParam,
 InputStream message,
 Map<String,Serializable> properties)
             throws CatalogServiceException

Throws:

CatalogServiceException

addDocument

String addDocument(List<String> contentTypeList,
 org.apache.cxf.jaxrs.ext.multipart.MultipartBody multipartBody,
 String transformerParam,
 InputStream message)
            throws CatalogServiceException

Creates a new metadata entry in the catalog.

Throws:

CatalogServiceException

addDocument

String addDocument(List<String> contentTypeList,
 javax.servlet.http.HttpServletRequest httpServletRequest,
 String transformerParam,
 InputStream message)
            throws CatalogServiceException

Creates a new metadata entry in the catalog.

Throws:

CatalogServiceException

parseParts

Map.Entry<org.codice.ddf.attachment.AttachmentInfo,ddf.catalog.data.Metacard> parseParts(Collection<javax.servlet.http.Part> contentParts,
 String transformerParam)

deleteDocument

void deleteDocument(String id)
             throws CatalogServiceException

Deletes a record from the catalog.

Throws:

CatalogServiceException

getFileExtensionForMimeType

String getFileExtensionForMimeType(String mimeType)

Retrieves the file extension fro the specified Mime Type.

doesLocalResourceExist

String doesLocalResourceExist(String metacardId,
 String sourceId)
                       throws CatalogServiceException

Returns checksum if the local resource exists for the metacardId. Otherwise, null. Throws CatalogServiceException

Parameters:

metacardId -

sourceId -

Returns:

Throws:

CatalogServiceException