org.apache.oodt.cas.product.jaxrs.services

Class CasProductJaxrsService

java.lang.Object

org.apache.oodt.cas.product.jaxrs.services.CasProductJaxrsService

public class CasProductJaxrsService
extends Object

Service class that handles HTTP requests and returns file manager entities such as references and products as JAX-RS resources converted to different formats.

Version:

$Revision$

Author:

rlaidlaw

Constructor Summary

Constructors

Constructor and Description
CasProductJaxrsService()

Method Summary

Modifier and Type	Method and Description
XmlRpcFileManagerClient	getContextClient() Gets the file manager client instance from the servlet context.
File	getContextWorkingDir() Gets the file manager's working directory from the servlet context.
DatasetResource	getDataset(String productTypeId) Gets an HTTP response that represents a set of products from the file manager.
ProductResource	getProduct(String productId) Gets an HTTP response that represents a Product from the file manager.
ReferenceResource	getReference(String productId, int refIndex) Gets an HTTP response that represents a Reference from a Product from the file manager.
TransferResource	getTransfer(String dataStoreRef) Gets an HTTP response that represents the status of a currently active file transfer for the file manager.
TransfersResource	getTransfers(String productId) Gets an HTTP response that represents the statuses of all currently active file transfers for the file manager, optionally filtered by product ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

CasProductJaxrsService

public CasProductJaxrsService()

Method Detail

getReference

public ReferenceResource getReference(String productId,
                                      int refIndex)

Gets an HTTP response that represents a Reference from a Product from the file manager.

Parameters:

productId - the ID of the product that the reference belongs to

refIndex - the index of the reference within the product's list of references

Returns:

an HTTP response that represents a Reference from a Product from the file manager

getProduct

public ProductResource getProduct(String productId)

Gets an HTTP response that represents a Product from the file manager.

Parameters:

productId - the ID of the product

Returns:

an HTTP response that represents a Product from the file manager

getDataset

public DatasetResource getDataset(String productTypeId)

Gets an HTTP response that represents a set of products from the file manager.

Parameters:

productTypeId - the ID of the ProductType for the data set or "ALL" to denote all product types

Returns:

an HTTP response that represents a set of products from the file manager

getTransfer

public TransferResource getTransfer(String dataStoreRef)

Gets an HTTP response that represents the status of a currently active file transfer for the file manager.

Parameters:

dataStoreRef - the data store reference for the file being transferred

Returns:

an HTTP response that represents the status of a currently active file transfer for the file manager

getTransfers

public TransfersResource getTransfers(String productId)

Gets an HTTP response that represents the statuses of all currently active file transfers for the file manager, optionally filtered by product ID.

Parameters:

productId - the ID of a product or ALL to denote all products

Returns:

an HTTP response that represents the statuses of all currently active file transfers for the file manager

getContextWorkingDir

public File getContextWorkingDir()
                          throws CasProductException

Gets the file manager's working directory from the servlet context.

Returns:

the file manager working directory

Throws:

Exception - if an object cannot be retrieved from the context attribute

CasProductException

getContextClient

public XmlRpcFileManagerClient getContextClient()
                                         throws CasProductException

Gets the file manager client instance from the servlet context.

Returns:

the file manager client instance from the servlet context attribute

Throws:

Exception - if an object cannot be retrieved from the context attribute

CasProductException