org.apache.oodt.cas.curation.service

Class MetadataResource

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.oodt.cas.curation.service.CurationService

org.apache.oodt.cas.curation.service.MetadataResource

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, CuratorConfMetKeys

public class MetadataResource
extends CurationService

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATALOG
static String	DELETE
static String	PRODUCT_TYPE
static String	STAGING
static String	UPDATE

Fields inherited from class org.apache.oodt.cas.curation.service.CurationService

config, FORMAT_HTML, FORMAT_JSON, sso, UNKNOWN_OUT_FORMAT

Fields inherited from interface org.apache.oodt.cas.curation.metadata.CuratorConfMetKeys

CATALOG_FACTORY_CLASS, CRAWLER_CONF_FILE, DEFAULT_TRANSFER_FACTORY, FM_PROPS, FM_URL, MET_AREA_PATH, MET_EXTENSION, MET_EXTRACTOR_CONF_UPLOAD_PATH, POLICY_UPLOAD_PATH, STAGING_AREA_PATH

Constructor Summary

Constructors

Constructor and Description
MetadataResource()
MetadataResource(javax.servlet.ServletContext context)

Method Summary

Modifier and Type	Method and Description
boolean	addElementsForProductType(String policy, String id, String elementIds)
boolean	addParentForProductType(String policy, String id, String parentId)
String	deleteCatalogMetadata(String id, String name) Method to delete a specific product from the catalog
void	deleteCatalogProduct(Product product) Deletes a given product from the catalog
Metadata	getCatalogMetadata(Product product) Retrieves the cataloged Metadata associated with a Product.
String	getCatalogMetadata(String id, String format, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
String	getElementsForProductType(String policy, String id, boolean direct)
protected String	getExtractorConfigIdsAsHTML(String[] configIds, String current)
protected String	getExtractorConfigIdsAsJSON(String[] configIds)
protected String	getMetadataAsHTML(Metadata metadata)
String	getMetadataInfo(String id)
String	getMetExtractorConfigList(String current, String format)
String	getParentTypeMap(String policy)
String	getProductTypeIdsHavingElement(String policy, String elementId)
String	getProductTypeMetadata(String id, String format, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
protected Metadata	getStagingMetadata(String id, String configId, Boolean overwrite)
String	getStagingMetadata(String id, String format, String configId, Boolean overwrite, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Metadata	readMetFile(String file) Reads a Metadata object from a String representation of a .met File.
boolean	removeAllElementsForProductType(String policy, String id)
boolean	removeElementsForProductType(String policy, String id, String elementIds)
boolean	removeParentForProductType(String policy, String id)
boolean	removeProductType(String policy, String id)
protected Metadata	runMetExtractor(String id, ExtractorConfig config)
String	setCatalogMetadata(javax.ws.rs.core.MultivaluedMap<String,String> formParams, String id)
String	setProductTypeMetadata(javax.ws.rs.core.MultivaluedMap<String,String> formParams)
String	setStagingMetadata(javax.ws.rs.core.MultivaluedMap<String,String> formParams)
void	updateCatalogMetadata(Product product, Metadata newMetadata) Updates the cataloged Metadata for a Product in the CAS File Manager.
String	updateMetadata(javax.ws.rs.core.MultivaluedMap<String,String> formParams, String id, String name, boolean replace, boolean remove) Method to update the catalog metadata for a given product.
void	writeMetFile(String id, Metadata metadata) Writes a CAS Metadata File using the given identifier.

Methods inherited from class org.apache.oodt.cas.curation.service.CurationService

cleansePath, getDirectoryAreaAsJSON, getFilesInDirectory, init, sendRedirect

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

STAGING

public static final String STAGING

See Also:

Constant Field Values

CATALOG

public static final String CATALOG

See Also:

Constant Field Values

PRODUCT_TYPE

public static final String PRODUCT_TYPE

See Also:

Constant Field Values

UPDATE

public static final String UPDATE

See Also:

Constant Field Values

DELETE

public static final String DELETE

See Also:

Constant Field Values

Constructor Detail

MetadataResource

public MetadataResource()

MetadataResource

public MetadataResource(@Context
                        javax.servlet.ServletContext context)

Method Detail

getStagingMetadata

public String getStagingMetadata(String id,
                                 String format,
                                 String configId,
                                 Boolean overwrite,
                                 @Context
                                 javax.servlet.http.HttpServletRequest req,
                                 @Context
                                 javax.servlet.http.HttpServletResponse res)

getMetExtractorConfigList

public String getMetExtractorConfigList(String current,
                                        String format)

getExtractorConfigIdsAsHTML

protected String getExtractorConfigIdsAsHTML(String[] configIds,
                                             String current)

getExtractorConfigIdsAsJSON

protected String getExtractorConfigIdsAsJSON(String[] configIds)

getStagingMetadata

protected Metadata getStagingMetadata(String id,
                                      String configId,
                                      Boolean overwrite)
                               throws InstantiationException,
                                      IOException,
                                      MetExtractionException

Parameters:

id - Relative path from staging root to product. The met extension will be added to this id to look up and see if a met file exists with in the met area.

configId - Reference to the extractor config. ExtractorConfigReader will load the configuration

overwrite - Flag to indicate whether or not to overwrite a met file if present in the staging area.

Returns:

The Metadata retrieved from the met area path if present or extracted using the met extractor config.

Throws:

FileNotFoundException

InstantiationException

IOException

MetExtractionException

runMetExtractor

protected Metadata runMetExtractor(String id,
                                   ExtractorConfig config)
                            throws MetExtractionException

Parameters:

id - Relative path from staging root to the product

config - Configuration to run this met extractor

Returns:

Throws:

MetExtractionException

getCatalogMetadata

public String getCatalogMetadata(String id,
                                 String format,
                                 @Context
                                 javax.servlet.http.HttpServletRequest req,
                                 @Context
                                 javax.servlet.http.HttpServletResponse res)

setCatalogMetadata

public String setCatalogMetadata(javax.ws.rs.core.MultivaluedMap<String,String> formParams,
                                 String id)

getProductTypeMetadata

public String getProductTypeMetadata(String id,
                                     String format,
                                     @Context
                                     javax.servlet.http.HttpServletRequest req,
                                     @Context
                                     javax.servlet.http.HttpServletResponse res)

setProductTypeMetadata

public String setProductTypeMetadata(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

setStagingMetadata

public String setStagingMetadata(javax.ws.rs.core.MultivaluedMap<String,String> formParams)

getMetadataInfo

public String getMetadataInfo(String id)

getMetadataAsHTML

protected String getMetadataAsHTML(Metadata metadata)

readMetFile

public Metadata readMetFile(String file)
                     throws InstantiationException,
                            IOException

Reads a Metadata object from a String representation of a .met File.

Parameters:

file - The full path to the .met File.

Returns:

The read-in CAS Metadata object.

Throws:

InstantiationException

InstantiationException - If there is an error instantiating the Metadata class.

IOException

FileNotFoundException

FileNotFoundException - If the .met File is not found.

IOException - If there is an IO problem opening the met file.

getCatalogMetadata

public Metadata getCatalogMetadata(Product product)
                            throws CatalogException

Retrieves the cataloged Metadata associated with a Product.

Parameters:

product - The Product to obtain cataloged Metadata for.

Returns:

The cataloged Metadata for Product.

Throws:

CatalogException - If there is an error talking to the CAS File Manager Catalog.

writeMetFile

public void writeMetFile(String id,
                         Metadata metadata)
                  throws IOException

Writes a CAS Metadata File using the given identifier.

Parameters:

id - The identifier of the .met file to write.

metadata - The Metadata object to persist and write to a File .

Throws:

FileNotFoundException - If the .met File cannot be written.

IOException - If there is an IO exception writing the File.

updateMetadata

public String updateMetadata(javax.ws.rs.core.MultivaluedMap<String,String> formParams,
                             String id,
                             String name,
                             boolean replace,
                             boolean remove)

Method to update the catalog metadata for a given product. All current metadata fields will be preserved, except those specified in the HTTP POST request as 'metadata.='.

Parameters:

id - identifier of CAS product - either 'id' or 'name' must be specified

name - name of CAS product - either 'id' or 'name' must be specified

formParams - HTTP (name, value) form parameters. The parameter names MUST start with "metadata."

replace - optional flag set to false to add the new metadata values to the existing values, for the given flags

updateCatalogMetadata

public void updateCatalogMetadata(Product product,
                                  Metadata newMetadata)
                           throws CatalogException,
                                  IOException

Updates the cataloged Metadata for a Product in the CAS File Manager.

Parameters:

product - The Product to update Metadata for.

Throws:

CatalogException - If any error occurs during the update.

IOException

FileNotFoundException

deleteCatalogMetadata

public String deleteCatalogMetadata(String id,
                                    String name)

Method to delete a specific product from the catalog

Parameters:

id - identifier of CAS product - either 'id' or 'name' must be specified

name - name of CAS product - either 'id' or 'name' must be specified

Returns:

the product ID of the deleted product if deletion successful

deleteCatalogProduct

public void deleteCatalogProduct(Product product)
                          throws CatalogException

Deletes a given product from the catalog

Parameters:

product - The Product to delete

Throws:

FileNotFoundException

IOException

CatalogException - If any error occurs during this delete operation.

removeProductType

public boolean removeProductType(String policy,
                                 String id)

getParentTypeMap

public String getParentTypeMap(String policy)

addParentForProductType

public boolean addParentForProductType(String policy,
                                       String id,
                                       String parentId)

removeParentForProductType

public boolean removeParentForProductType(String policy,
                                          String id)
                                   throws ValidationLayerException

Throws:

ValidationLayerException

addElementsForProductType

public boolean addElementsForProductType(String policy,
                                         String id,
                                         String elementIds)

getElementsForProductType

public String getElementsForProductType(String policy,
                                        String id,
                                        boolean direct)

removeAllElementsForProductType

public boolean removeAllElementsForProductType(String policy,
                                               String id)

removeElementsForProductType

public boolean removeElementsForProductType(String policy,
                                            String id,
                                            String elementIds)

getProductTypeIdsHavingElement

public String getProductTypeIdsHavingElement(String policy,
                                             String elementId)