public class File extends Abstract implements TransformationCatalog
Modifier and Type | Field and Description |
---|---|
private boolean |
mFlushOnClose
Boolean indicating whether to flush the contents back to the file on
close.
|
protected LogManager |
mLogger
The LogManager object which is used to log all the messages.
|
private boolean |
modifyFileURL
Boolean indicating whether to modify the file URL or not
|
private PegasusProperties |
mProps
The handle to the properties object.
|
private String |
mTCFile
The path to the file based TC.
|
private static File |
mTCFileHandle
The singleton handler to the contents of the transformation catalog.
|
private Map |
mTreeMap
The Tree Map which stores the contents of the file.
|
protected List |
mvExecPools
The List containing the user specified list of pools on which he wants
the dag to run.
|
FILE_URL_SCHEME, MODIFY_FOR_FILE_URLS_KEY, VERSION
DB_ALL_PREFIX
Constructor and Description |
---|
File() |
Modifier and Type | Method and Description |
---|---|
int |
addLFNProfile(String namespace,
String name,
String version,
List profiles)
Add additional profile to a logical transformation .
|
int |
addPFNProfile(String pfn,
TCType type,
String resourcename,
List profiles)
Add additional profile to a physical transformation.
|
protected boolean |
addTCEntry(String namespace,
String name,
String version,
String physicalname,
TCType type,
String resourceid,
List pfnprofiles,
List lfnprofiles,
SysInfo system,
Notifications invokes,
boolean write)
Add an single entry into the transformation catalog.
|
int |
clear()
Deletes the entire transformation catalog.
|
void |
close()
Explicitely free resources before the garbage collection hits.
|
boolean |
connect(Properties props)
Establishes a link between the implementation and the thing the
implementation is build upon.
|
int |
deleteLFNProfiles(String namespace,
String name,
String version,
List profiles)
Delete a list of profiles or all the profiles associated with a logical
transformation.
|
int |
deletePFNProfiles(String physicalname,
TCType type,
String resourceid,
List profiles)
Delete a list of profiles or all the profiles associated with a pfn on a
resource and of a type.
|
void |
File()
The default constructor.
|
List<TransformationCatalogEntry> |
getContents()
List all the contents of the TC
|
String |
getDescription()
Returns a textual description of the transformation mode.
|
static TransformationCatalog |
getInstance()
Deprecated.
|
List<String[]> |
getTCLogicalNames(String resourceid,
TCType type)
Get the list of LogicalNames available on a particular resource.
|
void |
initialize(PegasusBag bag)
Initialize the implementation, and return an instance of the implementation.
|
int |
insert(List<TransformationCatalogEntry> entries)
Add multiple TCEntries to the Catalog.
|
int |
insert(String namespace,
String name,
String version,
String physicalname,
TCType type,
String resourceid,
List pfnprofiles,
List lfnprofiles,
SysInfo system)
Add an single entry into the transformation catalog.
|
int |
insert(TransformationCatalogEntry entry)
Add single TCEntry to the Catalog.
|
int |
insert(TransformationCatalogEntry entry,
boolean write)
Add single TCEntry object temporarily to the in memory Catalog.
|
boolean |
isClosed()
Predicate to check, if the connection with the catalog's
implementation is still active.
|
protected void |
logMessage(String msg)
Logs the message to a logging stream.
|
List<TransformationCatalogEntry> |
lookup(String namespace,
String name,
String version,
List resourceids,
TCType type)
Returns TC entries for a particular logical transformation and/or on a
number of resources and/or of a particular type.
|
List<TransformationCatalogEntry> |
lookup(String namespace,
String name,
String version,
String resourceid,
TCType type)
Returns TC entries for a particular logical transformation and/or on a
particular resource and/or of a particular type.
|
List<Profile> |
lookupLFNProfiles(String namespace,
String name,
String version)
Get the list of Profiles associated with a particular logical transformation.
|
List<TransformationCatalogEntry> |
lookupNoProfiles(String namespace,
String name,
String version,
String resourceid,
TCType type)
Get the list of PhysicalNames for a particular transformation on a site/sites
for a particular type/types;
|
List<Profile> |
lookupPFNProfiles(String pfn,
String resourceid,
TCType type)
Get the list of Profiles associated with a particular physical transformation.
|
List<String> |
lookupSites(String namespace,
String name,
String version,
TCType type)
Get the list of Resource ID's where a particular transformation may reside.
|
private boolean |
populateTC()
Populates the internal copy of the transformation catalog from the file
containing the transformation catalog in the 6 column format.
|
private boolean |
populateTC(InputStream reader)
Populates the internal copy of the transformation catalog from a byte
stream (input stream).
|
private boolean |
populateTC(Reader reader)
Adds multiple entries into the TC.
|
int |
removeByLFN(String namespace,
String name,
String version,
String resourceid,
TCType type)
Delete all entries in the transformation catalog for a give logical tranformation and/or on a resource and/or of
a particular type
|
int |
removeByPFN(String physicalname,
String namespace,
String name,
String version,
String resourceid,
TCType type)
Delete all entries in the transformation catalog for pair of logical and physical transformation.
|
int |
removeBySiteID(String resourceid)
Delete all entries on a particular resource from the transformation catalog.
|
int |
removeBySysInfo(SysInfo sysinfo)
Deletes entries from the catalog which have a particular system information.
|
int |
removeByType(TCType type,
String resourceid)
Delete a particular type of transformation, and/or on a particular resource
|
private void |
writeTC() |
modifyForFileURLS, modifyForFileURLS
private static File mTCFileHandle
protected LogManager mLogger
protected List mvExecPools
private Map mTreeMap
private String mTCFile
private PegasusProperties mProps
private boolean mFlushOnClose
private boolean modifyFileURL
public static TransformationCatalog getInstance()
public void File()
public void initialize(PegasusBag bag)
initialize
in interface TransformationCatalog
bag
- the bag of Pegasus initialization objects.public String getDescription()
getDescription
in interface TransformationCatalog
public List<TransformationCatalogEntry> lookup(String namespace, String name, String version, List resourceids, TCType type) throws Exception
lookup
in interface TransformationCatalog
namespace
- String The namespace of the logical transformation.name
- String the name of the logical transformation.version
- String The version of the logical transformation.resourceids
- List The List resourceid where the transformation is located.
If NULL it returns all resources.type
- TCType The type of the transformation to search for.
If NULL it returns all types.Exception
TCType
,
edu.isi.pegasus.planner.catalog.TransformationCatalogEntry
public List<TransformationCatalogEntry> lookup(String namespace, String name, String version, String resourceid, TCType type) throws Exception
lookup
in interface TransformationCatalog
namespace
- String The namespace of the logical transformation.name
- String the name of the logical transformation.version
- String The version of the logical transformation.resourceid
- String The resourceid where the transformation is located.
If NULL it returns all resources.type
- TCType The type of the transformation to search for.
If NULL it returns all types.Exception
TCType
,
edu.isi.pegasus.planner.catalog.TransformationCatalogEntry
public List<String> lookupSites(String namespace, String name, String version, TCType type) throws Exception
lookupSites
in interface TransformationCatalog
namespace
- String The namespace of the transformation to search for.name
- String The name of the transformation to search for.version
- String The version of the transformation to search for.type
- TCType The type of the transformation to search for.Exception
- NotImplementedException if not implementedTCType
public List<TransformationCatalogEntry> lookupNoProfiles(String namespace, String name, String version, String resourceid, TCType type) throws Exception
lookupNoProfiles
in interface TransformationCatalog
namespace
- String The namespace of the transformation to search for.name
- String The name of the transformation to search for.version
- String The version of the transformation to search for.resourceid
- String The id of the resource on which you want to search. type
- TCType The type of the transformation to search for. Exception
- NotImplementedException if not implemented.TCType
public List<String[]> getTCLogicalNames(String resourceid, TCType type) throws Exception
getTCLogicalNames
in interface TransformationCatalog
resourceid
- String The id of the resource on which you want to searchtype
- TCType The type of the transformation to search for. Exception
- NotImplementedException if not implemented.public List<Profile> lookupLFNProfiles(String namespace, String name, String version) throws Exception
lookupLFNProfiles
in interface TransformationCatalog
namespace
- String The namespace of the transformation to search for.name
- String The name of the transformation to search for.version
- String The version of the transformation to search for.Exception
- NotImplementedException if not implemented.org.griphyn.cPlanner.classes.Profile
public List<Profile> lookupPFNProfiles(String pfn, String resourceid, TCType type) throws Exception
lookupPFNProfiles
in interface TransformationCatalog
pfn
- The physical file name to search the transformation by.resourceid
- String The id of the resource on which you want to search.type
- TCType The type of the transformation to search for. Exception
- NotImplementedException if not implemented.org.griphyn.cPlanner.classes.Profile
public List<TransformationCatalogEntry> getContents() throws Exception
getContents
in interface TransformationCatalog
Exception
public int insert(List<TransformationCatalogEntry> entries) throws Exception
insert
in interface TransformationCatalog
tcentry
- List Takes a list of TransformationCatalogEntry objects as inputException
edu.isi.pegasus.planner.catalog.TransformationCatalogEntry
public int insert(TransformationCatalogEntry entry) throws Exception
insert
in interface TransformationCatalog
tcentry
- Takes a single TransformationCatalogEntry object as inputException
edu.isi.pegasus.planner.catalog.TransformationCatalogEntry
public int insert(TransformationCatalogEntry entry, boolean write) throws Exception
insert
in interface TransformationCatalog
tcentry
- Takes a single TransformationCatalogEntry object as inputwrite
- boolean enable write commits to backed catalog or not.Exception
edu.isi.pegasus.planner.catalog.TransformationCatalogEntry
public int insert(String namespace, String name, String version, String physicalname, TCType type, String resourceid, List pfnprofiles, List lfnprofiles, SysInfo system) throws Exception
insert
in interface TransformationCatalog
namespace
- String The namespace of the transformation to be added (Can be null)name
- String The name of the transformation to be added.version
- String The version of the transformation to be added. (Can be null)physicalname
- String The physical name/location of the transformation to be added.type
- TCType The type of the physical transformation.resourceid
- String The resource location id where the transformation is located.lfnprofiles
- List The List of Profile objects associated with a Logical Transformation. (can be null)pfnprofiles
- List The List of Profile objects associated with a Physical Transformation. (can be null)sysinfo
- SysInfo The System information associated with a physical transformation.Exception
edu.isi.pegasus.planner.catalog.TransformationCatalogEntry
,
SysInfo
,
org.griphyn.cPlanner.classes.Profile
protected boolean addTCEntry(String namespace, String name, String version, String physicalname, TCType type, String resourceid, List pfnprofiles, List lfnprofiles, SysInfo system, Notifications invokes, boolean write) throws Exception
namespace
- the namespace of the transformation to be added (Can be null)name
- the name of the transformation to be added.version
- the version of the transformation to be added. (Can be null)physicalname
- the physical name/location of the transformation to be added.type
- the type of the physical transformation.resourceid
- the resource location id where the transformation is located.lfnprofiles
- the List of Profile
objects associated
with a Logical Transformation. (can be null)pfnprofiles
- the list of Profile
objects associated
with a Physical Transformation. (can be null)system
- the System information associated with a physical
transformation.invokes
- the Notifications associated with the
transformation.write
- boolean to commit changes to backend catalogException
org.griphyn.common.catalog.TransformationCatalogEntry
,
SysInfo
,
org.griphyn.cPlanner.classes.Profile
public int addLFNProfile(String namespace, String name, String version, List profiles) throws Exception
addLFNProfile
in interface TransformationCatalog
namespace
- String The namespace of the transformation to be added. (can be null)name
- String The name of the transformation to be added.version
- String The version of the transformation to be added. (can be null)profiles
- List The List of Profile objects that are to be added
to the transformation.Exception
org.griphyn.cPlanner.classes.Profile
public int addPFNProfile(String pfn, TCType type, String resourcename, List profiles) throws Exception
addPFNProfile
in interface TransformationCatalog
pfn
- String The physical name of the transformationtype
- TCType The type of transformation that the profile is
associated with.resourcename
- String The resource on which the physical transformation existsprofiles
- The List of Profile objects that are to be added
to the transformation.Exception
org.griphyn.cPlanner.classes.Profile
public int removeByLFN(String namespace, String name, String version, String resourceid, TCType type) throws Exception
removeByLFN
in interface TransformationCatalog
namespace
- String The namespace of the transformation to be deleted. (can be null)name
- String The name of the transformation to be deleted.version
- String The version of the transformation to be deleted. ( can be null)resourceid
- String The resource id for which the transformation is to be deleted.
If NULL then transformation on all resource are deletedtype
- TCType The type of the transformation. If NULL then all types are deleted for the transformation.Exception
TCType
public int removeByPFN(String physicalname, String namespace, String name, String version, String resourceid, TCType type) throws Exception
removeByPFN
in interface TransformationCatalog
physicalname
- String The physical name of the transformationnamespace
- String The namespace assocaited in the logical name of the transformation.name
- String The name of the logical transformation.version
- String The version number of the logical transformation.resourceid
- String The resource on which the transformation is to be deleted.
If NULL then it searches all the resource id.type
- TCType The type of transformation. If NULL then it search and deletes entries for all types.Exception
TCType
public int removeByType(TCType type, String resourceid) throws Exception
removeByType
in interface TransformationCatalog
type
- TCType The type of the transformationresourceid
- String The resource on which the transformation exists.
If NULL then that type of transformation is deleted from all the resources.Exception
TCType
public int removeBySysInfo(SysInfo sysinfo) throws Exception
removeBySysInfo
in interface TransformationCatalog
sysinfo
- SysInfo The System Information by which you want to deleteException
SysInfo
public int removeBySiteID(String resourceid) throws Exception
removeBySiteID
in interface TransformationCatalog
resourceid
- String The resource which you want to remove.Exception
public int clear() throws Exception
clear
in interface TransformationCatalog
Exception
public int deletePFNProfiles(String physicalname, TCType type, String resourceid, List profiles) throws Exception
deletePFNProfiles
in interface TransformationCatalog
physicalname
- String The physical name of the transformation.type
- TCType The type of the transformation.resourceid
- String The resource of the transformation.profiles
- List The list of profiles to be deleted. If NULL then all profiles for that pfn+resource+type are deleted.Exception
org.griphyn.cPlanner.classes.Profile
public int deleteLFNProfiles(String namespace, String name, String version, List profiles) throws Exception
deleteLFNProfiles
in interface TransformationCatalog
namespace
- String The namespace of the logical transformation.name
- String The name of the logical transformation.version
- String The version of the logical transformation.profiles
- List The List of profiles to be deleted. If NULL
then all profiles for the logical transformation are deleted.Exception
org.griphyn.cPlanner.classes.Profile
public boolean connect(Properties props)
Catalog
FIXME: The cause for failure is lost without exceptions.
public boolean isClosed()
Catalog
close()
.isClosed
in interface Catalog
Catalog.close()
public void close()
Catalog
private void writeTC()
private boolean populateTC(InputStream reader)
reader
- the InputStrean
containing the bytes to be
read.private boolean populateTC()
private boolean populateTC(Reader reader)
reader
- the input stream from where to read the contents of the
transformation catalog.protected void logMessage(String msg)
msg
- the message to be logged.Copyright © 2011 The University of Southern California. All Rights Reserved.