org.apache.oodt.pcs.util

Class FileManagerUtils

java.lang.Object

org.apache.oodt.pcs.util.FileManagerUtils

All Implemented Interfaces:

PCSConfigMetadata

public class FileManagerUtils
extends Object
implements PCSConfigMetadata

A set of utility methods for use by the PCS in communicating with the File Manager.

Version:

$Revision$

Author:

mattmann

Field Summary

Fields inherited from interface org.apache.oodt.pcs.metadata.PCSConfigMetadata

CLIENT_TRANSFER_SERVICE_FACTORY, CONF_FILE_BUILD, CONFIG_FILE_SCHEMA_PATH, CRAWLER_CLEANUP, CRAWLER_CRAWLDIRS, CRAWLING, FILE_MANAGER_URL, JAVA_EXT_DIR, JAVA_MAIN_CLASS, MAX_ALLOWABLE_GAP_MINUTES, NUM_JAVA_EXT_DIRS, PGE_CONFIG_FILE_NAME, PGE_CONFIG_FILE_PROPERTY_ADDER_CLASS, PGE_LOG_FILE_NAME, PGE_TASK_TYPE, PGE_TYPE_GDS_ADAPTOR, PGE_TYPE_GDS_PGE, RUNNING_PGE, SCF_FILE_MANAGER_URL, STAGING_INPUT, UNKNOWN, WORKFLOW_INST_ID, WORKFLOW_MANAGER_URL, WORKFLOW_MGR_URL

Constructor Summary

Constructors

Constructor and Description
FileManagerUtils(String fmUrlStr)
FileManagerUtils(URL fileMgrUrl)
FileManagerUtils(XmlRpcFileManagerClient client)

Method Summary

Modifier and Type	Method and Description
static boolean	check(String propName, String propValue, Metadata metadata)
static String	getDirProductFilePath(Product p, String prodName)
String	getFilePath(Product prod)
XmlRpcFileManagerClient	getFmgrClient()
URL	getFmUrl()
Product	getLatestProduct(Query query, ProductType type)
Product	getLatestProduct(Query query, String productTypeName)
Product	getLatestProductByName(String prodName, ProductType type)
Product	getLatestProductByName(String prodName, String productTypeName)
static Reference	getRootReference(String productName, List refs)
static boolean	isRootDir(Reference r, String prodName)
List	queryAllTypes(Query query)
List	queryAllTypes(Query query, List excludeTypeList)
List	queryAndReturnMetadata(Query query, ProductType type)
List<Product>	querySpecifiedTypes(Query query, List<String> typeList)
List	queryTypeList(Query query, List typeList)
ProductPage	safeFirstPage(ProductType type) Get a first page of Products using the pagination API.
Element	safeGetElementByName(String elemName)
static File	safeGetFileFromUri(String uri)
Metadata	safeGetMetadata(Product product)
int	safeGetNumProducts(ProductType type) Gets the number of products for the given type.
Product	safeGetProductByName(String prodName)
List	safeGetProductReferences(Product product)
ProductType	safeGetProductTypeById(String productTypeId)
ProductType	safeGetProductTypeByName(String productTypeName)
List	safeGetProductTypes()
List	safeGetTopNProducts(int n)
static URL	safeGetUrlFromString(String urlStr)
List	safeIssueQuery(Query query, ProductType type)
void	setFmgrClient(XmlRpcFileManagerClient fmgrClient)
static List	toProductNameList(List productList)
List	toProductTypeList(List typeNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileManagerUtils

public FileManagerUtils(URL fileMgrUrl)

FileManagerUtils

public FileManagerUtils(String fmUrlStr)

FileManagerUtils

public FileManagerUtils(XmlRpcFileManagerClient client)

Method Detail

safeGetTopNProducts

public List safeGetTopNProducts(int n)

getLatestProductByName

public Product getLatestProductByName(String prodName,
                                      String productTypeName)

getLatestProductByName

public Product getLatestProductByName(String prodName,
                                      ProductType type)

getLatestProduct

public Product getLatestProduct(Query query,
                                String productTypeName)

toProductTypeList

public List toProductTypeList(List typeNames)

queryTypeList

public List queryTypeList(Query query,
                          List typeList)

queryAllTypes

public List queryAllTypes(Query query)

querySpecifiedTypes

public List<Product> querySpecifiedTypes(Query query,
                                         List<String> typeList)

queryAllTypes

public List queryAllTypes(Query query,
                          List excludeTypeList)

queryAndReturnMetadata

public List queryAndReturnMetadata(Query query,
                                   ProductType type)

safeIssueQuery

public List safeIssueQuery(Query query,
                           ProductType type)

safeGetElementByName

public Element safeGetElementByName(String elemName)

safeGetProductTypeByName

public ProductType safeGetProductTypeByName(String productTypeName)

safeGetProductTypeById

public ProductType safeGetProductTypeById(String productTypeId)

safeGetProductReferences

public List safeGetProductReferences(Product product)

safeGetMetadata

public Metadata safeGetMetadata(Product product)

safeGetProductTypes

public List safeGetProductTypes()

getLatestProduct

public Product getLatestProduct(Query query,
                                ProductType type)

safeGetProductByName

public Product safeGetProductByName(String prodName)

safeGetNumProducts

public int safeGetNumProducts(ProductType type)

Gets the number of products for the given type.

Parameters:

type - The given type.

Returns:

The number of products.

safeFirstPage

public ProductPage safeFirstPage(ProductType type)

Get a first page of Products using the pagination API.

Parameters:

type - Gets the first page of products for this type.

Returns:

The first page of products for this type.

getFilePath

public String getFilePath(Product prod)

toProductNameList

public static List toProductNameList(List productList)

check

public static boolean check(String propName,
                            String propValue,
                            Metadata metadata)

safeGetUrlFromString

public static URL safeGetUrlFromString(String urlStr)

safeGetFileFromUri

public static File safeGetFileFromUri(String uri)

getFmgrClient

public XmlRpcFileManagerClient getFmgrClient()

Returns:

the fmgrClient

setFmgrClient

public void setFmgrClient(XmlRpcFileManagerClient fmgrClient)

Parameters:

fmgrClient - the fmgrClient to set

getFmUrl

public URL getFmUrl()

Returns:

The URL to the File Manager that this FileManagerUtils object connects to.

getDirProductFilePath

public static String getDirProductFilePath(Product p,
                                           String prodName)

getRootReference

public static Reference getRootReference(String productName,
                                         List refs)

isRootDir

public static boolean isRootDir(Reference r,
                                String prodName)