Java Globus API: Class GRCCollection

org.globus.replica.catalog
Class GRCCollection

java.lang.Object
  |
  +--org.globus.replica.catalog.GRCEntry
        |
        +--org.globus.replica.catalog.GRCDirectory
              |
              +--org.globus.replica.catalog.GRCCollection

public class GRCCollection
extends GRCDirectory

The proxy for a replica catalog collection entry, containing methods for listing file and location entries that are part of the collection.

Version:
1.3
Author:
Chi Chen, Darcy Quesnel, Gaurang Mehta

Fields inherited from class org.globus.replica.catalog.GRCEntry
_ctx, _oc
 
Constructor Summary
GRCCollection(GRCContext ctx, String name)
          Construct a proxy for a collection entry in the given replica catalog context.
 
Method Summary
 void create(String[] filenames)
          Create a collection entry in the replica catalog.
 void destroy()
          Destroy a GRCCollection object in the replica catalog.
protected  String getRDN()
          Get the rdn of the GRCCollection object
 Vector listCollections()
          Lists all collections in the Catalog
 NamingEnumeration listFiles()
          List all file entries in the collection.
 NamingEnumeration listFiles(String[] attrs)
          List all file entries in the collection.
 NamingEnumeration listLocations()
          List all location entries in the collection.
 NamingEnumeration listLocations(String[] attrs)
          List all location entries in the collection.
 NamingEnumeration searchLocations(String[] filenames)
          Search for locations in the collection that contain all the given filenames.
 NamingEnumeration searchLocations(String[] filenames, String[] attrs)
          Search for locations in the collection that contain all the given filenames.
 
Methods inherited from class org.globus.replica.catalog.GRCDirectory
addFilenames, deleteFilenames, listFilenames
 
Methods inherited from class org.globus.replica.catalog.GRCEntry
addAttributes, create, deleteAttributes, getName, listAttributes, listAttributes, putAttrs, replaceAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GRCCollection

public GRCCollection(GRCContext ctx,
                     String name)
Construct a proxy for a collection entry in the given replica catalog context.
Parameters:
ctx - replica catalog context to connect with
name - name of the directory entry to create
Method Detail

create

public void create(String[] filenames)
            throws NamingException
Create a collection entry in the replica catalog.
Overrides:
create in class GRCDirectory
Parameters:
filenames - array of filenames to associate with the directory entry

destroy

public void destroy()
             throws NamingException
Destroy a GRCCollection object in the replica catalog.
Overrides:
destroy in class GRCEntry

getRDN

protected String getRDN()
Get the rdn of the GRCCollection object
Overrides:
getRDN in class GRCEntry
Returns:
a String presentation of the rdn of the collection object

listFiles

public NamingEnumeration listFiles()
                            throws NamingException
List all file entries in the collection.
Returns:
an enumeration of search results
See Also:
SearchResult, NamingEnumeration

listFiles

public NamingEnumeration listFiles(String[] attrs)
                            throws NamingException
List all file entries in the collection.
Parameters:
attrs - names of attributes to return.
Returns:
an enumeration of search results
See Also:
SearchResult, NamingEnumeration

listLocations

public NamingEnumeration listLocations()
                                throws NamingException
List all location entries in the collection.
Returns:
an enumeration of search results
See Also:
SearchResult, NamingEnumeration

listLocations

public NamingEnumeration listLocations(String[] attrs)
                                throws NamingException
List all location entries in the collection.
Parameters:
attrs - names of attributes to return.
Returns:
an enumeration of search results
See Also:
SearchResult, NamingEnumeration

searchLocations

public NamingEnumeration searchLocations(String[] filenames)
                                  throws NamingException
Search for locations in the collection that contain all the given filenames.
Parameters:
filenames - filenames that must exist in a collection entry for it to be returned
Returns:
an enumeration of search results
See Also:
SearchResult, NamingEnumeration

searchLocations

public NamingEnumeration searchLocations(String[] filenames,
                                         String[] attrs)
                                  throws NamingException
Search for locations in the collection that contain all the given filenames.
Parameters:
filenames - filenames that must exist in a collection entry for it to be returned
attrs - names of attributes to return.
Returns:
an enumeration of search results
See Also:
SearchResult, NamingEnumeration

listCollections

public Vector listCollections()
                       throws NamingException
Lists all collections in the Catalog
Returns:
a vector or collections
See Also:
SearchResult, NamingEnumeration