edu.isi.pegasus.planner.catalog.replica.impl

Class LRC

java.lang.Object

edu.isi.pegasus.planner.catalog.replica.impl.LRC

All Implemented Interfaces:

Catalog, ReplicaCatalog

public class LRC
extends Object
implements ReplicaCatalog

This class implements the VDS replica catalog interface on top of the LRC. This class implementation ends up talking to a single LRC. It is accessed internally from the RLI implementation. RLS Exceptions are being caught here. They probably should be thrown and caught at the calling class (i.e the RLI implementation).

Version:

$Revision$

Author:

Karan Vahi, Gaurang Mehta

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	LRC.MyRLSString2Bulk The class that extends RLSString2Bulk and adds on the equals method, that allows me to do the set operations
private class	LRC.RLSAttributeComparator The comparator that is used to group the RLSAttributeObject objects by the value in the key field.
private class	LRC.RLSString2BulkComparator The comparator that is used to group the RLSString2Bulk objects by the value in the s1 field.
private class	LRC.RLSString2Comparator The comparator that is used to group the RLSString2 objects by the value in the s1 field.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LRC_TIMEOUT The default timeout in seconds to be used while querying the LRC.
static String	LRC_NOT_CONNECTED_MSG The error message for not connected to LRC.
static String	LRC_SITE_TO_LRC_URL_KEY The properties key that allow us to associate a site with a LRC URL, and hence providing a value for the SITE_ATTRIBUTE.
static String	LRC_TIMEOUT_KEY The key that is used to get hold of the timeout value from the properties object.
private int	mBatchSize The batch size while querying the LRC in the bulk mode.
private String	mDefaultSiteAttribute The default site attribute to be associated with the results.
private LogManager	mLogger The handle to the logging object.
private String	mLogMsg The string holding the message that is logged in the logger.
private org.globus.replica.rls.RLSClient.LRC	mLRC The handle to the client that allows access to the LRC running at the url specified while connecting.
private String	mLRCURL The URL pointing to the LRC to which this instance of class talks to.
private org.globus.replica.rls.RLSClient	mRLS The handle to the client that allows access to the RLS running at the url specified while connecting.
private int	mTimeout The timeout in seconds while querying to the LRC.
static String	PROXY_KEY The key that if set, specifies the proxy to be picked up while connecting to the RLS.
static int	RLS_BULK_QUERY_SIZE The number of entries searched in each bulk query to RLS.
static String	RLS_TIMEOUT_KEY The key that is used to get hold of the timeout value from the properties object.
static String	SITE_ATTRIBUTE The attribute in RLS that maps to a site handle.
static String	UNDEFINED_SITE The undefined pool attribute value.
static String	URL_KEY The key that is used to get hold of the url from the properties object.

Fields inherited from interface edu.isi.pegasus.planner.catalog.ReplicaCatalog

BATCH_KEY, c_prefix, DB_PREFIX

Fields inherited from interface edu.isi.pegasus.planner.catalog.Catalog

DB_ALL_PREFIX

Constructor Summary

Constructors

Constructor and Description
LRC() The default constructor, that creates an object which is not linked with any RLS.

Method Summary

Methods

Modifier and Type	Method and Description
private int	bulkDelete(List lfnPfns) Calls the bulk delete on the mappings.
private int	bulkInsert(List lfnPfns, Map attrMap) Calls the bulk insert on the mappings.
private Map	bulkLookup(Set lfns, String attrKey) Retrieves multiple entries for a given logical filename, up to the complete LRC.
private Map	bulkLookup(Set lfns, String attrKey, Object attrVal) Retrieves multiple entries for a given logical filename, up to the complete LRC.
private Map	bulkLookupNoAttributes(Set lfns) Retrieves multiple entries for a given logical filename, up to the complete LRC.
int	clear() Removes everything.
void	close() Explicitely free resources before the garbage collection hits.
boolean	connect(Properties props) Establishes a connection to the LRC.
boolean	connect(String url) Establishes a connection to the LRC, picking up the proxy from the default location usually /tmp/ directory.
boolean	connect(String url, String proxy) Establishes a connection to the LRC.
private org.globus.replica.rls.RLSString2Bulk	convert(org.globus.replica.rls.RLSString2 obj) A helper method that converts RLSString2 to MyRLSString2Bulk object.
private String	defaultResourceHandle() Returns the default value that is to be assigned to site handle for a replica catalog entry.
int	delete(Map x, boolean matchAttributes) Deletes multiple mappings into the replica catalog.
int	delete(String lfn, ReplicaCatalogEntry tuple) Deletes a very specific mapping from the replica catalog.
int	delete(String lfn, String pfn) Deletes a specific mapping from the replica catalog.
int	delete(String lfn, String name, Object value) Deletes all PFN entries for a given LFN from the replica catalog where the PFN attribute is found, and matches exactly the object value.
int	deleteByResource(String lfn, String handle) Deletes all PFN entries for a given LFN from the replica catalog where the resource handle is found.
private ReplicaCatalogException	exception(org.globus.replica.rls.RLSString2Bulk rs) Constructs an exception from the RLSString2Bulk object.
private ReplicaCatalogException	exception(String prefix, org.globus.replica.rls.RLSException e) Constructs replica catalog exception out the RLSException that is thrown by the API underneath.
private String	getAttribute(org.globus.replica.rls.RLSClient.LRC lrc, String pfn, String name) Retrieves from the lrc, the attribute value associated with the pfn for a given attribute name.
private String	getAttribute(String pfn, String name) Retrieves from the lrc associated with this instance all, the attribute value associated with the pfn for a given attribute name.
private Map	getAttributes(List lfnPfns, String attrKey, Object attrVal) Retrieves from the lrc associated with this instance, all the attributes associated with the lfn-pfns in a map indexed by the lfn.
private Map	getAttributes(org.globus.replica.rls.RLSClient.LRC lrc, String pfn) Retrieves from the lrc, all the attributes associated with the pfn in a map.
private Map	getAttributes(String pfn) Retrieves from the lrc, associated with this instance all the attributes associated with the pfn in a map.
private Object	getAttributeValue(org.globus.replica.rls.RLSAttribute attr) Retrieves the attribute value as an object from the RLSAttribute object.
private int	getBatchSize() Returns the number of lfns in each batch while querying the lrc in the bulk mode.
org.globus.replica.rls.RLSClient.LRC	getLRC() Gets a handle to the LRC that is associated with the RLS running at url.
private String	getSiteHandle(org.globus.replica.rls.RLSClient.LRC lrc, String pfn) Returns the site handle associated with a pfn at the lrc associated with the RLSClient passed.
private String	getSiteHandle(String pfn) Returns the site handle associated with the pfn at the lrc to which the instance of this application binds.
protected int	getTimeout(Properties properties) It returns the timeout value in seconds after which to timeout in case of no activity from the LRC.
int	insert(Map x) Inserts multiple mappings into the replica catalog.
int	insert(String lfn, ReplicaCatalogEntry tuple) Inserts a new mapping into the replica catalog.
int	insert(String lfn, String pfn, String handle) Inserts a new mapping into the replica catalog.
boolean	isClosed() Returns whether the connection to the RLS with which this instance is associated is closed or not.
Set	list() Lists all logical filenames in the catalog.
Set	list(String constraint) Lists a subset of all logical filenames in the catalog.
List	listLFNPFN(String constraint, boolean lfnConstraint) Lists a subset of all LFN,PFN pairs in the catalog matching to a pfn or a lfn constraint.
private void	log(String message, Exception e, int level) Logs to the logger object.
private void	log(String message, int level) Logs to the logger object.
Map	lookup(Map constraints) Retrieves multiple entries for a given logical filename, up to the complete catalog.
Map	lookup(Set lfns) Retrieves multiple entries for a given logical filename, up to the complete LRC.
Map	lookup(Set lfns, String handle) Retrieves multiple entries for a given logical filename, up to the complete LRC.
Map	lookup(Set lfns, String name, Object value) Retrieves multiple entries for a given logical filename, up to the complete LRC.
Collection	lookup(String lfn) Retrieves all entries for a given LFN from the LRC.
String	lookup(String lfn, String handle) Retrieves the entry for a given filename and resource handle from the LRC.
List	lookupLFNPFN(Map constraints) Retrieves multiple entries for a given logical filename, up to the complete catalog.
Map	lookupNoAttributes(Set lfns) Retrieves multiple entries for a given logical filename, up to the complete catalog.
Map	lookupNoAttributes(Set lfns, String handle) Retrieves multiple entries for a given logical filename, up to the complete catalog.
Map	lookupNoAttributes(Set lfns, String name, Object value) Retrieves multiple entries for a given logical filename, up to the complete catalog.
Set	lookupNoAttributes(String lfn) Retrieves all entries for a given LFN from the replica catalog.
static void	main(String[] args) Testing function.
int	remove(Set lfns) Removes all mappings for a set of LFNs.
int	remove(String lfn) Removes all mappings for a set of LFNs.
int	removeByAttribute(String handle) Removes all entries associated with a particular resource handle.
int	removeByAttribute(String name, Object value) Removes all entries from the replica catalog where the PFN attribute is found, and matches exactly the object value.
private void	setBatchSize(Properties properties) Sets the number of lfns in each batch while querying the lrc in the bulk mode.
private void	setResourceHandle(Map<String,String> m) Sets the resource handle in an attribute map.
private void	setResourceHandle(ReplicaCatalogEntry rce) Sets the resource handle in an attribute map.
private Set	subset(Collection collection, String name, Object value) Returns a subset of a collection of ReplicaCatalogEntry objects that have attributes matchin to the attribute identified by the parameters passed.
private Set	subset(Collection collection, String name, Object value, boolean onlyPFN) Returns a subset of a collection of ReplicaCatalogEntry objects that have attributes matchin to the attribute identified by the parameters passed.

Methods inherited from class java.lang.Object

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

Field Detail

RLS_BULK_QUERY_SIZE

public static final int RLS_BULK_QUERY_SIZE

The number of entries searched in each bulk query to RLS.

See Also:

Constant Field Values

DEFAULT_LRC_TIMEOUT

public static final String DEFAULT_LRC_TIMEOUT

The default timeout in seconds to be used while querying the LRC.

See Also:

Constant Field Values

RLS_TIMEOUT_KEY

public static final String RLS_TIMEOUT_KEY

The key that is used to get hold of the timeout value from the properties object.

See Also:

Constant Field Values

LRC_TIMEOUT_KEY

public static final String LRC_TIMEOUT_KEY

The key that is used to get hold of the timeout value from the properties object.

See Also:

Constant Field Values

LRC_SITE_TO_LRC_URL_KEY

public static final String LRC_SITE_TO_LRC_URL_KEY

The properties key that allow us to associate a site with a LRC URL, and hence providing a value for the SITE_ATTRIBUTE. User will specify lrc.site.isi_viz rls://isi.edu to associate site isi_viz with rls://isi.edu

See Also:

Constant Field Values

SITE_ATTRIBUTE

public static final String SITE_ATTRIBUTE

The attribute in RLS that maps to a site handle.

See Also:

Constant Field Values

UNDEFINED_SITE

public static final String UNDEFINED_SITE

The undefined pool attribute value. The pool attribute is assigned this value if the pfn queried does not have a pool associated with it.

See Also:

Constant Field Values

URL_KEY

public static final String URL_KEY

The key that is used to get hold of the url from the properties object.

See Also:

Constant Field Values

PROXY_KEY

public static final String PROXY_KEY

The key that if set, specifies the proxy to be picked up while connecting to the RLS.

See Also:

Constant Field Values

LRC_NOT_CONNECTED_MSG

public static final String LRC_NOT_CONNECTED_MSG

The error message for not connected to LRC.

See Also:

Constant Field Values

mLogger

private LogManager mLogger

The handle to the logging object. Should be log4j soon.

mLogMsg

private String mLogMsg

The string holding the message that is logged in the logger.

mLRCURL

private String mLRCURL

The URL pointing to the LRC to which this instance of class talks to.

mRLS

private org.globus.replica.rls.RLSClient mRLS

The handle to the client that allows access to the RLS running at the url specified while connecting.

mLRC

private org.globus.replica.rls.RLSClient.LRC mLRC

The handle to the client that allows access to the LRC running at the url specified while connecting.

mBatchSize

private int mBatchSize

The batch size while querying the LRC in the bulk mode.

mTimeout

private int mTimeout

The timeout in seconds while querying to the LRC.

mDefaultSiteAttribute

private String mDefaultSiteAttribute

The default site attribute to be associated with the results.

Constructor Detail

LRC

public LRC()

The default constructor, that creates an object which is not linked with any RLS. Use the connect method to connect to the LRC and use it.

See Also:

connect(Properties).

Method Detail

connect

public boolean connect(Properties props)

Establishes a connection to the LRC.

Specified by:

connect in interface Catalog

Parameters:

props - contains all necessary data to establish the link.

Returns:

true if connected now, or false to indicate a failure.

connect

public boolean connect(String url)

Establishes a connection to the LRC, picking up the proxy from the default location usually /tmp/ directory.

Parameters:

url - the url to lrc to connect to.

Returns:

true if connected now, or false to indicate a failure.

connect

public boolean connect(String url,
              String proxy)

Establishes a connection to the LRC.

Parameters:

url - the url to lrc to connect to.

proxy - the path to the proxy file to be picked up. null denotes default location.

Returns:

true if connected now, or false to indicate a failure.

Throws:

ReplicaCatalogException - in case of

getLRC

public org.globus.replica.rls.RLSClient.LRC getLRC()

Gets a handle to the LRC that is associated with the RLS running at url.

Returns:

RLSClient.LRC that points to the RLI that is running , or null in case connect method not being called.

See Also:

mLRCURL

lookup

public String lookup(String lfn,
            String handle)

Retrieves the entry for a given filename and resource handle from the LRC.

Specified by:

lookup in interface ReplicaCatalog

Parameters:

lfn - is the logical filename to obtain information for.

handle - is the resource handle to obtain entries for.

Returns:

the (first) matching physical filename, or null if no match was found.

Throws:

ReplicaCatalogException - in case of any error that is throw by LRC that can't be handled.

lookup

public Collection lookup(String lfn)
                  throws ReplicaCatalogException

Retrieves all entries for a given LFN from the LRC. Each entry in the result set is a tuple of a PFN and all its attributes.

Specified by:

lookup in interface ReplicaCatalog

Parameters:

lfn - is the logical filename to obtain information for.

Returns:

a collection of replica catalog entries, or null in case of unable to connect to RLS or error.

Throws:

ReplicaCatalogException - in case of any error that is throw by LRC that can't be handled.

See Also:

ReplicaCatalogEntry

lookupNoAttributes

public Set lookupNoAttributes(String lfn)

Retrieves all entries for a given LFN from the replica catalog. Each entry in the result set is just a PFN string. Duplicates are reduced through the set paradigm.

Specified by:

lookupNoAttributes in interface ReplicaCatalog

Parameters:

lfn - is the logical filename to obtain information for.

Returns:

a set of PFN strings, or null in case of unable to connect to RLS.

lookup

public Map lookup(Set lfns)
           throws ReplicaCatalogException

Retrieves multiple entries for a given logical filename, up to the complete LRC. It uses the bulk query api to the LRC to query for stuff. Bulk query has been in RLS since version 2.0.8. Internally, the bulk queries are done is sizes specified by variable mBatchSize.

Specified by:

lookup in interface ReplicaCatalog

Parameters:

lfns - is a set of logical filename strings to look up.

Returns:

a map indexed by the LFN. Each value is a collection of replica catalog entries for the LFN.

Throws:

ReplicaCatalogException

See Also:

ReplicaCatalogEntry, getBatchSize()

lookup

public Map lookup(Set lfns,
         String handle)

Retrieves multiple entries for a given logical filename, up to the complete LRC. The noAttributes flag is missing on purpose, because due to the resource handle, attribute lookups are already required.

Specified by:

lookup in interface ReplicaCatalog

Parameters:

lfns - is a set of logical filename strings to look up.

handle - is the resource handle, restricting the LFNs.

Returns:

a map indexed by the LFN. Each value is a collection of replica catalog entries.

See Also:

ReplicaCatalogEntry

lookup

public Map lookup(Set lfns,
         String name,
         Object value)

Retrieves multiple entries for a given logical filename, up to the complete LRC. It returns the complete RCE for each entry i.e all the attributes a pfn is associated with in addition to the one that is the key for matching.

Parameters:

lfns - is a set of logical filename strings to look up.

name - is the name of the attribute.

value - is the value of the attribute.

Returns:

a map indexed by the LFN. Each value is a collection of replica catalog entries.

See Also:

ReplicaCatalogEntry

lookupNoAttributes

public Map lookupNoAttributes(Set lfns)

Retrieves multiple entries for a given logical filename, up to the complete catalog. Retrieving full catalogs should be harmful, but may be helpful in an online display or portal.

Specified by:

lookupNoAttributes in interface ReplicaCatalog

Parameters:

lfns - is a set of logical filename strings to look up.

Returns:

a map indexed by the LFN. Each value is a set of PFN strings.

lookupNoAttributes

public Map lookupNoAttributes(Set lfns,
                     String handle)

Retrieves multiple entries for a given logical filename, up to the complete catalog. Retrieving full catalogs should be harmful, but may be helpful in online display or portal.

Specified by:

lookupNoAttributes in interface ReplicaCatalog

Parameters:

lfns - is a set of logical filename strings to look up.

handle - is the resource handle, restricting the LFNs.

Returns:

a map indexed by the LFN. Each value is a set of physical filenames.

lookupNoAttributes

public Map lookupNoAttributes(Set lfns,
                     String name,
                     Object value)

Retrieves multiple entries for a given logical filename, up to the complete catalog. Retrieving full catalogs should be harmful, but may be helpful in online display or portal.

Parameters:

lfns - is a set of logical filename strings to look up.

name - is the PFN attribute name to look for.

value - is an exact match of the attribute value to match.

Returns:

a map indexed by the LFN. Each value is a set of physical filenames.

lookup

public Map lookup(Map constraints)
           throws ReplicaCatalogException

Retrieves multiple entries for a given logical filename, up to the complete catalog. Retrieving full catalogs should be harmful, but may be helpful in online display or portal.

At present it DOES NOT SUPPORT ATTRIBUTE MATCHING.

Specified by:

lookup in interface ReplicaCatalog

Parameters:

constraints - is mapping of keys 'lfn', 'pfn', to a string that has some meaning to the implementing system. This can be a SQL wildcard for queries, or a regular expression for Java-based memory collections. Unknown keys are ignored. Using an empty map requests the complete catalog.

Returns:

a map indexed by the LFN. Each value is a collection of replica catalog entries.

Throws:

ReplicaCatalogException

See Also:

ReplicaCatalogEntry

lookupLFNPFN

public List lookupLFNPFN(Map constraints)

Retrieves multiple entries for a given logical filename, up to the complete catalog. Retrieving full catalogs should be harmful, but may be helpful in online display or portal. At present it does not support attribute matching.

Parameters:

constraints - is mapping of keys 'lfn', 'pfn', or any attribute name, e.g. the resource handle 'site', to a string that has some meaning to the implementing system. This can be a SQL wildcard for queries, or a regular expression for Java-based memory collections. Unknown keys are ignored. Using an empty map requests the complete catalog.

Returns:

A list of MyRLSString2Bulk objects containing the lfn in s1 field, and pfn in s2 field. The list is grouped by lfns. The set may be empty.

list

public Set list()

Lists all logical filenames in the catalog.

Specified by:

list in interface ReplicaCatalog

Returns:

a set of all logical filenames known to the catalog or null in case of not connected to the LRC or error.

list

public Set list(String constraint)

Lists a subset of all logical filenames in the catalog.

Specified by:

list in interface ReplicaCatalog

Parameters:

constraint - is a constraint for the logical filename only. It is a string that has some meaning to the implementing system. This can be a SQL wildcard for queries, or a regular expression for Java-based memory collections.

Returns:

A set of logical filenames that match. The set may be empty

listLFNPFN

public List listLFNPFN(String constraint,
              boolean lfnConstraint)
                throws ReplicaCatalogException

Lists a subset of all LFN,PFN pairs in the catalog matching to a pfn or a lfn constraint.

Parameters:

constraint - is a constraint for the logical filename only. It is a string that has some meaning to the implementing system. This can be a SQL wildcard for queries, or a regular expression for Java-based memory collections.

Returns:

A set a list of MyRLSString2Bulk objects containing the lfn in s1 field, and pfn in s2 field. The list is grouped by lfns. The set may be empty.

Throws:

ReplicaCatalogException

See Also:

getAttributes(List,String,Object)

insert

public int insert(Map x)

Inserts multiple mappings into the replica catalog. The input is a map indexed by the LFN. The value for each LFN key is a collection of replica catalog entries. Ends up doing a sequential insert for all the entries instead of doing a bulk insert. Easier to track failure this way.

Specified by:

insert in interface ReplicaCatalog

Parameters:

x - is a map from logical filename string to list of replica catalog entries.

Returns:

the number of insertions.

See Also:

ReplicaCatalogEntry

bulkDelete

private int bulkDelete(List lfnPfns)
                throws ReplicaCatalogException

Calls the bulk delete on the mappings. This function can timeout if the size of the list passed is too large.

Parameters:

lfnPfns - list of RLSString2 objects containing the lfn pfn mappings to be deleted.

Returns:

the number of items deleted

Throws:

ReplicaCatalogException - in case of error

bulkInsert

private int bulkInsert(List lfnPfns,
             Map attrMap)

Calls the bulk insert on the mappings. This function can timeout if the size of the list passed is too large.

Parameters:

lfnPfns - list of RLSString2 objects containing the lfn pfn mappings to be inserted.

attrMap - a map indexed by pfn and values as RLSAttributeObject objects.

Returns:

the number of items inserted

Throws:

ReplicaCatalogException - in case of error

insert

public int insert(String lfn,
         ReplicaCatalogEntry tuple)

Inserts a new mapping into the replica catalog. The attributes are added in bulk assuming the attribute definitions already exist. If an attribute definition does not exist, it is created and inserted. Note there is no notion of transactions in LRC. It assumes all the attributes are of type String.

Specified by:

insert in interface ReplicaCatalog

Parameters:

lfn - is the logical filename under which to book the entry.

tuple - is the physical filename and associated PFN attributes.

Returns:

number of insertions, should always be 1. On failure, throws an exception instead of returning zero.

insert

public int insert(String lfn,
         String pfn,
         String handle)

Inserts a new mapping into the replica catalog. This is a convenience function exposing the resource handle. Internally, the ReplicaCatalogEntry element will be contructed, and passed to the appropriate insert function.

Specified by:

insert in interface ReplicaCatalog

Parameters:

lfn - is the logical filename under which to book the entry.

pfn - is the physical filename associated with it.

handle - is a resource handle where the PFN resides.

Returns:

number of insertions, should always be 1. On failure, throw an exception, don't use zero.

See Also:

insert( String, ReplicaCatalogEntry ), ReplicaCatalogEntry

delete

public int delete(Map x,
         boolean matchAttributes)

Deletes multiple mappings into the replica catalog. The input is a map indexed by the LFN. The value for each LFN key is a collection of replica catalog entries. On setting matchAttributes to false, all entries having matching lfn pfn mapping to an entry in the Map are deleted. However, upon removal of an entry, all attributes associated with the pfn also evaporate (cascaded deletion). The deletes are done in batches.

Specified by:

delete in interface ReplicaCatalog

Parameters:

x - is a map from logical filename string to list of replica catalog entries.

matchAttributes - whether mapping should be deleted only if all attributes match.

Returns:

the number of deletions.

See Also:

ReplicaCatalogEntry

delete

public int delete(String lfn,
         String pfn)

Deletes a specific mapping from the replica catalog. We don't care about the resource handle. More than one entry could theoretically be removed. Upon removal of an entry, all attributes associated with the PFN also evaporate (cascading deletion) automatically at the RLS server end.

Specified by:

delete in interface ReplicaCatalog

Parameters:

lfn - is the logical filename in the tuple.

pfn - is the physical filename in the tuple.

Returns:

the number of removed entries.

delete

public int delete(String lfn,
         ReplicaCatalogEntry tuple)

Deletes a very specific mapping from the replica catalog. The LFN must be matches, the PFN, and all PFN attributes specified in the replica catalog entry. More than one entry could theoretically be removed. Upon removal of an entry, all attributes associated with the PFN also evaporate (cascading deletion).

Specified by:

delete in interface ReplicaCatalog

Parameters:

lfn - is the logical filename in the tuple.

tuple - is a description of the PFN and its attributes.

Returns:

the number of removed entries, either 0 or 1.

delete

public int delete(String lfn,
         String name,
         Object value)

Deletes all PFN entries for a given LFN from the replica catalog where the PFN attribute is found, and matches exactly the object value. This method may be useful to remove all replica entries that have a certain MD5 sum associated with them. It may also be harmful overkill.

Specified by:

delete in interface ReplicaCatalog

Parameters:

lfn - is the logical filename to look for.

name - is the PFN attribute name to look for.

value - is an exact match of the attribute value to match.

Returns:

the number of removed entries.

deleteByResource

public int deleteByResource(String lfn,
                   String handle)

Deletes all PFN entries for a given LFN from the replica catalog where the resource handle is found. Karan requested this convenience method, which can be coded like

  delete( lfn, SITE_ATTRIBUTE, handle )
 

Specified by:

deleteByResource in interface ReplicaCatalog

Parameters:

lfn - is the logical filename to look for.

handle - is the resource handle

Returns:

the number of entries removed.

See Also:

SITE_ATTRIBUTE

remove

public int remove(String lfn)

Removes all mappings for a set of LFNs.

Specified by:

remove in interface ReplicaCatalog

Parameters:

lfn - is a set of logical filename to remove all mappings for.

Returns:

the number of removed entries.

remove

public int remove(Set lfns)

Removes all mappings for a set of LFNs.

Specified by:

remove in interface ReplicaCatalog

Parameters:

lfns - is a set of logical filename to remove all mappings for.

Returns:

the number of removed entries.

removeByAttribute

public int removeByAttribute(String handle)

Removes all entries associated with a particular resource handle. This is useful, if a site goes offline. It is a convenience method, which calls the generic removeByAttribute method.

Specified by:

removeByAttribute in interface ReplicaCatalog

Parameters:

handle - is the site handle to remove all entries for.

Returns:

the number of removed entries.

See Also:

removeByAttribute( String, Object )

removeByAttribute

public int removeByAttribute(String name,
                    Object value)

Removes all entries from the replica catalog where the PFN attribute is found, and matches exactly the object value.

Specified by:

removeByAttribute in interface ReplicaCatalog

Parameters:

name - is the PFN attribute name to look for.

value - is an exact match of the attribute value to match.

Returns:

the number of removed entries.

clear

public int clear()

Removes everything. Use with caution!

Specified by:

clear in interface ReplicaCatalog

Returns:

the number of removed entries.

close

public void close()

Explicitely free resources before the garbage collection hits.

Specified by:

close in interface Catalog

isClosed

public boolean isClosed()

Returns whether the connection to the RLS with which this instance is associated is closed or not.

Specified by:

isClosed in interface Catalog

Returns:

true, if the implementation is disassociated, false otherwise.

See Also:

close()

getTimeout

protected int getTimeout(Properties properties)

It returns the timeout value in seconds after which to timeout in case of no activity from the LRC. Referred to by the "lrc.timeout" property.

Returns:

the timeout value if specified else, the value specified by "rls.timeout" property, else DEFAULT_LRC_TIMEOUT.

See Also:

DEFAULT_LRC_TIMEOUT

getSiteHandle

private String getSiteHandle(String pfn)

Returns the site handle associated with the pfn at the lrc to which the instance of this application binds. It returns UNDEFINED_SITE even when the pfn is not in the lrc.

Parameters:

pfn - The pfn with which the attribute is associated.

Returns:

value of the attribute if found else UNDEFINED_POOL

getSiteHandle

private String getSiteHandle(org.globus.replica.rls.RLSClient.LRC lrc,
                   String pfn)

Returns the site handle associated with a pfn at the lrc associated with the RLSClient passed. It returns UNDEFINED_SITE even when the pfn is not in the lrc.

Parameters:

lrc - the handle to the lrc , where the attributes are stored.

pfn - the pfn with which the attribute is associated.

Returns:

value of the attribute if found else UNDEFINED_POOL

defaultResourceHandle

private String defaultResourceHandle()

Returns the default value that is to be assigned to site handle for a replica catalog entry.

Returns:

default site handle

setResourceHandle

private void setResourceHandle(Map<String,String> m)

Sets the resource handle in an attribute map. The resource handle is set to the default site handle if the map does not contain the site attribute key.

Parameters:

m - the attribute map.

See Also:

defaultResourceHandle()

setResourceHandle

private void setResourceHandle(ReplicaCatalogEntry rce)

Sets the resource handle in an attribute map. The resource handle is set to the default site handle if the map does not contain the site attribute key.

Parameters:

rce - the ReplicaCatalogEntry

See Also:

defaultResourceHandle()

getAttributes

private Map getAttributes(String pfn)

Retrieves from the lrc, associated with this instance all the attributes associated with the pfn in a map. All the attribute values are stored as String.

Parameters:

pfn - the pfn with which the attribute is associated.

Returns:

Mapcontaining the attribute keys and values, else an empty Map.

getAttributes

private Map getAttributes(List lfnPfns,
                String attrKey,
                Object attrVal)

Retrieves from the lrc associated with this instance, all the attributes associated with the lfn-pfns in a map indexed by the lfn. The value for each entry is a collection of ReplicaCatalogEntry objects. All the attribute values are stored as String. If the attribute value passed is not null, then explicit matching occurs on attribute values in addition.

Parameters:

lfnPfns - a list of RLSString2Bulk objects containing the lfn in s1 field, and pfn in s2 field. The list is assumed to be grouped by lfns.

attrKey - the name of attribute that needs to be queried for each pfn. a value of null denotes all attributes.

attrVal - the value of the attribute that should be matching.

Returns:

a map indexed by the LFN. Each value is a collection of replica catalog entries for the LFN.

getAttributes

private Map getAttributes(org.globus.replica.rls.RLSClient.LRC lrc,
                String pfn)

Retrieves from the lrc, all the attributes associated with the pfn in a map. All the attribute values are stored as String.

Parameters:

lrc - the handle to the lrc , where the attributes are stored.

pfn - the pfn with which the attribute is associated.

Returns:

Mapcontaining the attribute keys and values, else an empty Map.

getAttribute

private String getAttribute(String pfn,
                  String name)

Retrieves from the lrc associated with this instance all, the attribute value associated with the pfn for a given attribute name.

Parameters:

pfn - the pfn with which the attribute is associated.

name - the name of the attribute for which we want to search.

Returns:

value of the attribute if found else null

getAttribute

private String getAttribute(org.globus.replica.rls.RLSClient.LRC lrc,
                  String pfn,
                  String name)

Retrieves from the lrc, the attribute value associated with the pfn for a given attribute name.

Parameters:

lrc - the handle to the lrc , where the attributes are stored.

pfn - the pfn with which the attribute is associated.

name - the name of the attribute for which we want to search.

Returns:

value of the attribute if found else null

getAttributeValue

private Object getAttributeValue(org.globus.replica.rls.RLSAttribute attr)

Retrieves the attribute value as an object from the RLSAttribute object. Does automatic boxing (i.e converts int to Integer) etc. The value is returned of the type as determined from the internal value type.

Parameters:

attr - the RLSAttribute from which to extract the value.

Returns:

Object containing the value.

Throws:

ReplicaCatalogException - if illegal value associated.

setBatchSize

private void setBatchSize(Properties properties)

Sets the number of lfns in each batch while querying the lrc in the bulk mode.

Parameters:

properties - the properties passed while connecting.

getBatchSize

private int getBatchSize()

Returns the number of lfns in each batch while querying the lrc in the bulk mode.

Returns:

the batch size.

bulkLookup

private Map bulkLookup(Set lfns,
             String attrKey)

Retrieves multiple entries for a given logical filename, up to the complete LRC. It uses the bulk query api to the LRC to query for stuff. Bulk query has been in RLS since version 2.0.8. All the lfns in set are put in one single bulk query to the LRC. There is a risk of seeing a timeout error in case of large set of lfns. User should use the lookup function that internally does the bulk query in batches. Passing a null value for the attribute key results in the querying for all attributes. The function returns ReplicaCatalogEntry objects that have the attribute identified by attribute key passed.

Parameters:

lfns - set of logical filename strings to look up.

attrKey - the name of attribute that needs to be queried for each pfn. a value of null denotes all attributes.

Returns:

a map indexed by the LFN. Each value is a collection of replica catalog entries for the LFN.

See Also:

ReplicaCatalogEntry, lookup(Set)

bulkLookup

private Map bulkLookup(Set lfns,
             String attrKey,
             Object attrVal)

Retrieves multiple entries for a given logical filename, up to the complete LRC. It uses the bulk query api to the LRC to query for stuff. Bulk query has been in RLS since version 2.0.8. All the lfns in set are put in one single bulk query to the LRC. There is a risk of seeing a timeout error in case of large set of lfns. User should use the lookup function that internally does the bulk query in batches. Passing a null value for the attribute key results in the querying for all attributes. A null value for the attribute value, disables attribute matching and results in the ReplicaCatalogEntry objects that have the attribute identified by attribute key passed.

Parameters:

lfns - set of logical filename strings to look up.

attrKey - the name of attribute that needs to be queried for each pfn. a value of null denotes all attributes.

attrVal - the value of the attribute that should be matching.

Returns:

a map indexed by the LFN. Each value is a collection of replica catalog entries for the LFN.

See Also:

ReplicaCatalogEntry, lookup(Set)

bulkLookupNoAttributes

private Map bulkLookupNoAttributes(Set lfns)

Retrieves multiple entries for a given logical filename, up to the complete LRC. It uses the bulk query api to the LRC to query for stuff. Bulk query has been in RLS since version 2.0.8. All the lfns in set are put in one single bulk query to the LRC. There is a risk of seeing a timeout error in case of large set of lfns. User should use the lookup function that internally does the bulk query in batches.

Parameters:

lfns - is a set of logical filename strings to look up.

Returns:

a map indexed by the LFN. Each value is a set of PFN strings.

See Also:

lookupNoAttributes(Set)

exception

private ReplicaCatalogException exception(String prefix,
                                org.globus.replica.rls.RLSException e)

Constructs replica catalog exception out the RLSException that is thrown by the API underneath.

Parameters:

prefix - the prefix that is to be applied to the message passed while creating the exception.

e - the RLSException that is caught underneath.

Returns:

a ReplicaCatalogException

exception

private ReplicaCatalogException exception(org.globus.replica.rls.RLSString2Bulk rs)

Constructs an exception from the RLSString2Bulk object.

Returns:

a ReplicaCatalogException

subset

private Set subset(Collection collection,
         String name,
         Object value)

Returns a subset of a collection of ReplicaCatalogEntry objects that have attributes matchin to the attribute identified by the parameters passed.

Parameters:

collection - the collection of ReplicaCatalogEntry objects.

name - the attribute name to match.

value - the attribute value.

Returns:

Set of matching ReplicaCatalogEntry objects.

subset

private Set subset(Collection collection,
         String name,
         Object value,
         boolean onlyPFN)

Returns a subset of a collection of ReplicaCatalogEntry objects that have attributes matchin to the attribute identified by the parameters passed.

Parameters:

collection - the collection of ReplicaCatalogEntry objects.

name - the attribute name to match.

value - the attribute value.

onlyPFN - boolean to denote if we only want the PFN's

Returns:

Set of ReplicaCatalogEntry objects if onlyPfn parameter is set to false, else a Set of pfns.

convert

private org.globus.replica.rls.RLSString2Bulk convert(org.globus.replica.rls.RLSString2 obj)

A helper method that converts RLSString2 to MyRLSString2Bulk object.

Parameters:

obj - the RLSString2 to convert.

Returns:

the converted MyRLSString2 object.

log

private void log(String message,
       int level)

Logs to the logger object.

Parameters:

message - the message to be logged.

level - the logger level at which the message is to be logged.

log

private void log(String message,
       Exception e,
       int level)

Logs to the logger object.

Parameters:

message - the message to be logged.

e - the exception that occured.

level - the logger level at which the message is to be logged.

main

public static void main(String[] args)

Testing function.