| org.griphyn.common.catalog.ReplicaCatalog
All known Subclasses: org.griphyn.common.catalog.replica.SimpleFile, org.griphyn.common.catalog.replica.Windward, org.griphyn.common.catalog.replica.MRC, org.griphyn.common.catalog.replica.RLI, org.griphyn.common.catalog.replica.LRC, org.griphyn.common.catalog.replica.JDBCRC,
| ReplicaCatalog | | public interface ReplicaCatalog extends Catalog(Code) | | This interface describes a minimum set of essential tasks required
from a replica catalog. The method verbs have a steering meaning
associated with them:
- lookup
- retrieves physical filenames or replica entries
- list
- retrieves only lists of logical filenames
- delete
- removes an entry specified by LFN and PFN
- remove
- removes en-bulk by LFN
author:
Jens-S. Vöckler
author:
Karan Vahi
version:
$Revision: 83 $ |
| Field Summary | |
| final public static String | BATCH_KEY
The suffix for the property that if set, specifies the size of the chunk
in which the implementations handle multiple queries. | | final public static String | DB_PREFIX
The DB Driver properties prefix. | | final public static String | c_prefix
Prefix for the property subset to use with this catalog. |
| Method Summary | |
| public int | clear()
Removes everything. | | public int | delete(Map x, boolean matchAttributes)
Deletes multiple mappings into the replica catalog. | | public int | delete(String lfn, String pfn)
Deletes a specific mapping from the replica catalog. | | public int | delete(String lfn, ReplicaCatalogEntry tuple)
Deletes a very specific mapping from the replica catalog. | | 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. | | 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. | | public int | insert(String lfn, ReplicaCatalogEntry tuple)
Inserts a new mapping into the replica catalog.
Parameters:
lfn - is the logical filename under which to book the entry.
Parameters:
tuple - is the physical filename and associated PFN attributes. | | public int | insert(String lfn, String pfn, String handle)
Inserts a new mapping into the replica catalog. | | public int | insert(Map x)
Inserts multiple mappings into the replica catalog. | | public Set | list()
Lists all logical filenames in the catalog. | | public Set | list(String constraint)
Lists a subset of all logical filenames in the catalog.
Parameters:
constraint - is a constraint for the logical filename only. | | public String | lookup(String lfn, String handle)
Retrieves the entry for a given filename and resource handle from
the replica catalog.
Parameters:
lfn - is the logical filename to obtain information for.
Parameters:
handle - is the resource handle to obtain entries for. | | public Collection | lookup(String lfn)
Retrieves all entries for a given LFN from the replica catalog.
Each entry in the result set is a tuple of a PFN and all its
attributes.
Parameters:
lfn - is the logical filename to obtain information for. | | public Map | lookup(Set lfns)
Retrieves multiple entries for a given logical filename, up to the
complete catalog. | | public Map | lookup(Set lfns, String handle)
Retrieves multiple entries for a given logical filename, up to the
complete catalog. | | public Map | lookup(Map constraints)
Retrieves multiple entries for a given logical filename, up to the
complete catalog. | | 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. | | public Map | lookupNoAttributes(Set lfns)
Retrieves multiple entries for a given logical filename, up to the
complete catalog. | | public Map | lookupNoAttributes(Set lfns, String handle)
Retrieves multiple entries for a given logical filename, up to the
complete catalog. | | public int | remove(String lfn)
Removes all mappings for an LFN from the replica catalog.
Parameters:
lfn - is the logical filename to remove all mappings for. | | public int | remove(Set lfns)
Removes all mappings for a set of LFNs.
Parameters:
lfns - is a set of logical filename to remove all mappings for. | | 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.
Parameters:
name - is the PFN attribute name to look for.
Parameters:
value - is an exact match of the attribute value to match. | | public int | removeByAttribute(String handle)
Removes all entries associated with a particular resource handle.
This is useful, if a site goes offline. |
| BATCH_KEY | | final public static String BATCH_KEY(Code) | | The suffix for the property that if set, specifies the size of the chunk
in which the implementations handle multiple queries. The property that
needs to be specified is vds.rc.chunk.size.
|
| DB_PREFIX | | final public static String DB_PREFIX(Code) | | The DB Driver properties prefix.
|
| c_prefix | | final public static String c_prefix(Code) | | Prefix for the property subset to use with this catalog.
|
| clear | | public int clear()(Code) | | Removes everything. Use with caution!
the number of removed entries. |
| delete | | public int delete(Map x, boolean matchAttributes)(Code) | | 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).
Parameters:
x - is a map from logical filename string to list ofreplica catalog entries.
Parameters:
matchAttributes - whether mapping should be deleted only if allattributes match. the number of deletions.
See Also: ReplicaCatalogEntry |
| delete | | public int delete(String lfn, String pfn)(Code) | | 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).
Parameters:
lfn - is the logical filename in the tuple.
Parameters:
pfn - is the physical filename in the tuple. the number of removed entries. |
| delete | | public int delete(String lfn, ReplicaCatalogEntry tuple)(Code) | | 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).
Parameters:
lfn - is the logical filename in the tuple.
Parameters:
tuple - is a description of the PFN and its attributes. the number of removed entries, either 0 or 1. |
| delete | | public int delete(String lfn, String name, Object value)(Code) | | 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.
Parameters:
lfn - is the logical filename to look for.
Parameters:
name - is the PFN attribute name to look for.
Parameters:
value - is an exact match of the attribute value to match. the number of removed entries. |
| deleteByResource | | public int deleteByResource(String lfn, String handle)(Code) | | 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, RESOURCE_HANDLE, handle )
Parameters:
lfn - is the logical filename to look for.
Parameters:
handle - is the resource handle the number of entries removed. |
| insert | | public int insert(String lfn, ReplicaCatalogEntry tuple)(Code) | | Inserts a new mapping into the replica catalog.
Parameters:
lfn - is the logical filename under which to book the entry.
Parameters:
tuple - is the physical filename and associated PFN attributes. number of insertions, should always be 1. On failure,throw an exception, don't use zero. |
| insert | | public int insert(String lfn, String pfn, String handle)(Code) | | 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.
Parameters:
lfn - is the logical filename under which to book the entry.
Parameters:
pfn - is the physical filename associated with it.
Parameters:
handle - is a resource handle where the PFN resides. number of insertions, should always be 1. On failure,throw an exception, don't use zero.
See Also: ReplicaCatalog.insert(String,ReplicaCatalogEntry)
See Also: ReplicaCatalogEntry |
| insert | | public int insert(Map x)(Code) | | 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.
Parameters:
x - is a map from logical filename string to list of replicacatalog entries. the number of insertions.
See Also: ReplicaCatalogEntry |
| list | | public Set list()(Code) | | Lists all logical filenames in the catalog.
A set of all logical filenames known to the catalog. |
| list | | public Set list(String constraint)(Code) | | Lists a subset of all logical filenames in the catalog.
Parameters:
constraint - is a constraint for the logical filename only. Itis a string that has some meaning to the implementing system. Thiscan be a SQL wildcard for queries, or a regular expression forJava-based memory collections. A set of logical filenames that match. The set may be empty |
| lookup | | public String lookup(String lfn, String handle)(Code) | | Retrieves the entry for a given filename and resource handle from
the replica catalog.
Parameters:
lfn - is the logical filename to obtain information for.
Parameters:
handle - is the resource handle to obtain entries for. the (first) matching physical filename, ornull if no match was found. |
| lookup | | public Collection lookup(String lfn)(Code) | | Retrieves all entries for a given LFN from the replica catalog.
Each entry in the result set is a tuple of a PFN and all its
attributes.
Parameters:
lfn - is the logical filename to obtain information for. a collection of replica catalog entries
See Also: ReplicaCatalogEntry |
| lookup | | public Map lookup(Set lfns)(Code) | | 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.
Parameters:
lfns - is a set of logical filename strings to look up. a map indexed by the LFN. Each value is a collectionof replica catalog entries for the LFN.
See Also: ReplicaCatalogEntry |
| lookup | | public Map lookup(Set lfns, String handle)(Code) | | 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.
Parameters:
handle - is the resource handle, restricting the LFNs. a map indexed by the LFN. Each value is a collectionof replica catalog entries (all attributes).
See Also: ReplicaCatalogEntry |
| lookup | | public Map lookup(Map constraints)(Code) | | 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:
constraints - is mapping of keys 'lfn', 'pfn', or anyattribute name, e.g. the resource handle 'site', to a string thathas some meaning to the implementing system. This can be a SQLwildcard for queries, or a regular expression for Java-based memorycollections. Unknown keys are ignored. Using an empty map requeststhe complete catalog. a map indexed by the LFN. Each value is a collectionof replica catalog entries.
See Also: ReplicaCatalogEntry |
| lookupNoAttributes | | public Set lookupNoAttributes(String lfn)(Code) | | 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.
Parameters:
lfn - is the logical filename to obtain information for. a set of PFN strings |
| lookupNoAttributes | | public Map lookupNoAttributes(Set lfns)(Code) | | 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.
Parameters:
lfns - is a set of logical filename strings to look up. a map indexed by the LFN. Each value is a setof PFN strings. |
| lookupNoAttributes | | public Map lookupNoAttributes(Set lfns, String handle)(Code) | | 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.
Parameters:
handle - is the resource handle, restricting the LFNs. a map indexed by the LFN. Each value is a set ofphysical filenames. |
| remove | | public int remove(String lfn)(Code) | | Removes all mappings for an LFN from the replica catalog.
Parameters:
lfn - is the logical filename to remove all mappings for. the number of removed entries. |
| remove | | public int remove(Set lfns)(Code) | | Removes all mappings for a set of LFNs.
Parameters:
lfns - is a set of logical filename to remove all mappings for. the number of removed entries. |
| removeByAttribute | | public int removeByAttribute(String name, Object value)(Code) | | Removes all entries from the replica catalog where the PFN attribute
is found, and matches exactly the object value.
Parameters:
name - is the PFN attribute name to look for.
Parameters:
value - is an exact match of the attribute value to match. the number of removed entries. |
| removeByAttribute | | public int removeByAttribute(String handle)(Code) | | 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.
Parameters:
handle - is the site handle to remove all entries for. the number of removed entries.
See Also: ReplicaCatalog.removeByAttribute(String,Object) |
|
|