jpl.eda.archive
Class ArchiveProfileHandler

java.lang.Object
  jpl.eda.archive.ArchiveProfileHandler

All Implemented Interfaces:

jpl.eda.profile.handlers.ProfileHandler

public class ArchiveProfileHandler

extends java.lang.Object

implements jpl.eda.profile.handlers.ProfileHandler

This class implements the ProfileHandler interface enabling a Profile Server to access the Catalog and Archive Service (CAS). This handler also features an optional mapping capability. This feature allows incoming query element names and values to be mapped to source specific names and values.

In order to use this handler the following property must be specified for the Profile Server as follows:

<key>jpl.eda.profile.handlers</key>
<value>jpl.eda.archive.ArchiveProfileHandler</value>

This class uses the following properties:

• jpl.eda.archive.ArchiveProfileHandler.archiveServerName
  Must contain the name of the Catalog and Archive Service. For example, urn:eda:rmi:JPL.Test.Archive.
• jpl.eda.archive.ArchiveProfileHandler.mapFileSpec
  May contain the specification of the SDE/CDE name and value mapping file. For example, /usr/local/cas/etc/cas_profile_map.csv. For more information on the file format see the Mapping class.
• jpl.eda.archive.ArchiveProfileHandler.resContext
  May contain the resource context value to be included in each returned profile. For example, JPL.EDM.Archive.
• jpl.eda.archive.ArchiveProfileHandler.productServer
  May contain the name of the Product Service to be used in determining the resLocation value in each returned profile. For example, urn:eda:rmi:JPL.Test.Product.
• jpl.eda.archive.ArchiveProfileHandler.productServlet
  May contain the reference to a Product Servlet to be used in determining the resLocation value in each returned profile. For example, http://cas.jpl.nasa.gov/get.

The above properties may be defined in the Profile Server's properties element.

Version:

$Revision: 1.1 $

Author:

S. Hardman

Constructor Summary

ArchiveProfileHandler()

Method Summary

java.util.List	findProfiles(jpl.eda.xmlquery.XMLQuery xmlQuery) This method accepts a XMLQuery object as input, maps the element names and values according to the optional map and sends the query onto the CAS getProfiles() method.
jpl.eda.profile.Profile	get(java.lang.String profileId) This method is not fully implemented at this time.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveProfileHandler

public ArchiveProfileHandler()

Method Detail

findProfiles

public java.util.List findProfiles(jpl.eda.xmlquery.XMLQuery xmlQuery)
                            throws jpl.eda.profile.ProfileException

This method accepts a XMLQuery object as input, maps the element names and values according to the optional map and sends the query onto the CAS getProfiles() method.

Specified by:

findProfiles in interface jpl.eda.profile.handlers.ProfileHandler

Parameters:

xmlQuery - The XMLQuery object containing the query to resolve.

Returns:

A list of Profile objects representing the products matching the query criteria.

Throws:

jpl.eda.profile.ProfileException - If an error occurs resolving the required property, mapping the elements, finding the specified CAS instance or the CAS generates an internal error when performing the query.

get

public jpl.eda.profile.Profile get(java.lang.String profileId)
                            throws jpl.eda.profile.ProfileException

This method is not fully implemented at this time.

Specified by:

get in interface jpl.eda.profile.handlers.ProfileHandler

Parameters:

profileId - The Profile identifier.

Returns:

The Profile object with the specified profile identifier. An empty Profile is returned at this time.

Throws:

jpl.eda.profile.ProfileException - If an error occurs retrieving the Profile.