public class PegasusProperties
extends java.lang.Object
implements java.lang.Cloneable
org.griphyn.common.util.CommonProperties
Modifier and Type | Class and Description |
---|---|
static class |
PegasusProperties.CLEANUP_SCOPE
An enum defining The scope for cleanup algorithm
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ALL_TRANSFER_PRIORITY_PROPERTY_KEY
Default properties that applies priorities to all kinds of transfer
jobs.
|
static java.lang.String |
CONDOR_KICKSTART |
static java.lang.String |
DEFAULT_COMP_ERROR_PERCENTAGE |
static java.lang.String |
DEFAULT_COMP_MULTIPLICATION_FACTOR |
static java.lang.String |
DEFAULT_COMP_VARIANCE_PERCENTAGE |
static java.lang.String |
DEFAULT_CONDOR_BIN_DIR |
static java.lang.String |
DEFAULT_CONDOR_CONFIG_DIR |
static java.lang.String |
DEFAULT_DAGMAN_MAX_PRE_VALUE
The default value to be assigned for dagman.maxpre .
|
static java.lang.String |
DEFAULT_DATA_MULTIPLICATION_FACTOR |
private static java.lang.String |
DEFAULT_DAX_CALLBACK
The default DAXCallback that is loaded, if none is specified by the user.
|
static java.lang.String |
DEFAULT_EXEC_DIR |
static java.lang.String |
DEFAULT_GRIDSTART_MODE |
static java.lang.String |
DEFAULT_INVOKE_LENGTH |
static java.lang.String |
DEFAULT_JOB_AGGREGATOR |
static java.lang.String |
DEFAULT_LOGGING_FILE |
static java.lang.String |
DEFAULT_LRC_IGNORE_URL |
static java.lang.String |
DEFAULT_POOL_MODE |
static java.lang.String |
DEFAULT_RC_COLLECTION |
static java.lang.String |
DEFAULT_RLI_URL |
static java.lang.String |
DEFAULT_RLS_EXIT_MODE |
static java.lang.String |
DEFAULT_RLS_QUERY_ATTRIB |
static java.lang.String |
DEFAULT_RLS_QUERY_MODE |
static java.lang.String |
DEFAULT_RLS_TIMEOUT |
static java.lang.String |
DEFAULT_SITE_SELECTOR |
static java.lang.String |
DEFAULT_SITE_SELECTOR_KEEP |
static java.lang.String |
DEFAULT_SITE_SELECTOR_TIMEOUT |
static java.lang.String |
DEFAULT_STAGING_DELIMITER |
static java.lang.String |
DEFAULT_STORAGE_DIR |
static java.lang.String |
DEFAULT_TC_MAPPER_MODE |
static java.lang.String |
DEFAULT_TC_MODE |
static java.lang.String |
DEFAULT_TRANSFER_PROCESSES |
static java.lang.String |
DEFAULT_TRANSFER_STREAMS |
static java.lang.String |
DEFAULT_TX_SELECTOR_MODE |
static java.lang.String |
DISABLE_INVOKE_PROPERTY
the name of the property to disable invoke functionality
|
private java.lang.String |
mDefaultPoolFile
The default path to the pool file.
|
private java.lang.String |
mDefaultTC
The default path to the transformation catalog.
|
private java.lang.String |
mDefaultTransferPriority
The default transfer priority that needs to be applied to the transfer
jobs.
|
private java.util.Set |
mDeprecatedProperties
The set containing the deprecated properties specified by the user.
|
private static java.util.Map<Profiles.NAMESPACES,java.lang.String> |
mNamepsaceToPropertiesPrefix |
private java.lang.String |
mPegasusHome
The value of the PEGASUS_HOME environment variable.
|
private Profiles |
mProfiles
Profiles that are specified in the properties
|
private CommonProperties |
mProps
The object holding all the properties pertaining to the VDS system.
|
private java.lang.String |
mPropsInSubmitDir
The pointer to the properties file that is written out in the submit directory.
|
static java.lang.String |
PEGASUS_APP_METRICS_PREFIX |
static java.lang.String |
PEGASUS_REPLICA_CATALOG_FILE_PROPERTY |
static java.lang.String |
PEGASUS_REPLICA_CATALOG_PROPERTY |
static java.lang.String |
PEGASUS_SITE_CATALOG_FILE_PROPERTY |
static java.lang.String |
PEGASUS_SITE_CATALOG_PROPERTY |
static java.lang.String |
PEGASUS_TRANSFER_WORKER_PACKAGE_PROPERTY |
static java.lang.String |
PEGASUS_TRANSFORMATION_CATALOG_FILE_PROPERTY |
static java.lang.String |
PEGASUS_TRANSFORMATION_CATALOG_PROPERTY |
static java.lang.String |
PEGASUS_WORKER_NODE_EXECUTION_PROPERTY |
static java.lang.String |
ROOT_WORKFLOW_UUID_PROPERTY_KEY
The property key designated the root workflow uuid.
|
static java.lang.String |
SC_XML_FILE |
static java.lang.String |
SC_XML3_FILE |
static java.lang.String |
TC_DATA_FILE |
static java.lang.String |
TC_TEXT_FILE |
Modifier | Constructor and Description |
---|---|
private |
PegasusProperties(java.lang.String confProperties)
The constructor that constructs the default paths to the various
configuration files, and populates the singleton instance as required.
|
Modifier and Type | Method and Description |
---|---|
boolean |
abortOnFirstJobFailure()
Returns a boolean indicating whether seqexec trips on the first job failure.
|
boolean |
addDataDependencies()
Returns a boolean indicating whether to automatically
add edges as a result of underlying data dependecnies between jobs.
|
boolean |
assignDefaultJobPriorities()
Returns a boolean indicating whether we assign job priorities or not
to the jobs
Referred to by the "pegasus.job.priority.assign" property.
|
boolean |
bypassFirstLevelStagingForInputs()
Returns a boolean indicating whether to bypass first level staging of
inputs.
|
java.lang.Object |
clone()
Returns the clone of the object.
|
boolean |
createRegistrationJobs()
Returns a boolean indicating whether we create registration jobs or not.
|
boolean |
disableInvokeInGridStart()
Returns a boolean indicating whether to disable use of invoke or not.
|
boolean |
doStatWithKickstart()
Return a boolean indicating whether to turn the stat option for kickstart
on or not.
|
boolean |
executeOnWorkerNode()
Returns a boolean indicating whether to have jobs executing on worker
node tmp or not.
|
boolean |
generateKickstartExtraOptions()
Returns a boolean indicating whehter to pass extra options to kickstart
or not.
|
boolean |
generateLOFFiles()
Return a boolean indicating whether to generate the LOF files for the jobs
or not.
|
java.lang.String |
getAllIgnoredSites()
Returns a comma separated list of sites, from which to ignore data
transfers for all sites.
|
java.lang.String |
getAllPreferredSites()
Returns a comma separated list of sites, from which to prefer data
transfers for all sites.
|
java.lang.String |
getBaseSourceURLForSetupTransfers()
Returns the base source URL where pointing to the directory where the
worker package executables for pegasus releases are kept.
|
java.io.File |
getBinDir()
Accessor to the bin directory of the Pegasus install
|
java.lang.String |
getChmodDisabledSites()
Returns the list of sites for which the chmod job creation has to be
disabled for executable staging.
|
java.lang.String |
getCleanupImplementation()
Returns the name of the class that the user wants, to render the cleanup
jobs.
|
PegasusProperties.CLEANUP_SCOPE |
getCleanupScope()
Returns the scope for file cleanup.
|
java.lang.String |
getCleanupStrategy()
Returns the name of the Strategy class that the user wants, to insert the
cleanup jobs in the graph.
|
java.lang.String |
getClustererLabelKey()
Returns the key that is to be used as a label key, for labelled
clustering.
|
java.lang.String |
getClusterSizeCleanupJobsPerLevel()
Returns the fraction of cleanup jobs clustered into a single clustered
cleanup job.
|
java.lang.String |
getCollapseFactors()
Returns a comma separated list for the node collapsing criteria for the
execution pools.
|
java.lang.String |
getCreateDirClass()
Returns the name of the class that the user wants, to insert the
create directory jobs in the graph in case of creating random
directories.
|
java.lang.String |
getCreateDirImplementation()
Returns the name of the class that the user wants, to render the directory
creation jobs.
|
java.lang.String |
getCredName()
Returns the credential name to be used for the stork transfer jobs.
|
java.lang.String |
getDAXSchemaLocation()
Returns the location of the schema for the DAX.
|
java.lang.String |
getDAXSchemaLocation(java.lang.String defaultLocation)
Returns the location of the schema for the DAX.
|
java.lang.String |
getDefaultPathToCondorKickstart()
Returns the default path to the condor kickstart.
|
java.lang.String |
getDefaultPathToSC()
Returns the default path to the site catalog file.
|
java.lang.String |
getDefaultPathToTC()
Returns the default path to the transformation catalog.
|
private java.lang.String |
getDefaultThirdPartySites()
Returns the default list of third party sites.
|
private java.lang.String |
getDefaultTransferImplementation()
Returns the default transfer implementation to be picked up for
constructing transfer jobs.
|
private java.lang.String |
getDefaultTransferPriority()
Returns the default priority for the transfer jobs if specified in
the properties file.
|
java.lang.String |
getExecDirectory()
Returns the execution directory suffix or absolute specified
that is appended/replaced to the exec-mount-point specified in the
pool catalog for the various pools.
|
java.lang.String |
getGridFTPTimeout()
Returns the timeout value in seconds after which to timeout in case of
opening sockets to grid ftp server.
|
java.lang.String |
getGridStart()
Returns the GRIDSTART that is to be used to launch the jobs on the grid.
|
long |
getGridStartInvokeLength()
Returns the trigger value for invoking an application through kickstart
using kickstart.
|
java.lang.String |
getHorizontalClusterPreference()
Returns the users horizontal clustering preference.
|
java.lang.String |
getHorizontalPartitionerBundleValue(java.lang.String name)
Returns the bundle value for a particular transformation.
|
java.lang.String |
getHorizontalPartitionerCollapseValue(java.lang.String name)
Returns the collapse value for a particular transformation.
|
java.lang.String |
getHttpLog4jURL()
Returns the http url for log4j properties for windward project.
|
static PegasusProperties |
getInstance()
Returns an instance to this properties object.
|
static PegasusProperties |
getInstance(java.lang.String confProperties)
Returns an instance to this properties object.
|
java.lang.String |
getJobAggregator()
Returns what job aggregator is to be used to aggregate multiple
compute jobs into a single condor job.
|
java.lang.String |
getLog4JLogFile()
Returns the location of the local log file where you want the messages to
be logged.
|
java.lang.String |
getLogFormatter()
Returns the log formatter to use.
|
java.lang.String |
getLoggingFile()
Returns the file to which all the logging needs to be directed to.
|
java.lang.String |
getLogManager()
Returns the log manager to use.
|
java.util.List |
getMatchingProperties(java.lang.String prefix,
boolean system)
Returns the properties matching a particular prefix as a list of
sorted name value pairs, where name is the full name of the matching
property (including the prefix) and value is it's value in the properties
file.
|
java.lang.String |
getMaximumCleanupJobsPerLevel()
Returns the maximum number of clean up jobs created per level of the workflow
in case of InPlace cleanup.
|
java.lang.String |
getMetricsLogFile()
Returns the path to the file that is used to be logging metrics
Referred to by the "pegasus.log.metrics.file" property.
|
java.lang.String |
getNumOfTransferProcesses()
It returns the number of processes of g-u-c that the transfer script needs to
spawn to do the transfers.
|
java.lang.String |
getNumOfTransferStreams()
It returns the number of streams that each transfer process uses to do the
ftp transfer.
|
java.lang.String |
getPartitionerDAXCallback()
Returns the DAXCallback that is to be used while parsing the DAX.
|
java.lang.String |
getPartitionerLabelKey()
Returns the key that is to be used as a label key, for labelled
partitioning.
|
java.lang.String |
getPartitionParsingMode()
Returns the mode for parsing the dax while writing out the partitioned
daxes.
|
java.lang.String |
getPDAXSchemaLocation(java.lang.String defaultLocation)
Returns the location of the schema for the PDAX.
|
java.lang.String |
getPoolFile()
Returns the path to the pool file.
|
java.lang.String |
getPoolMode()
Returns the mode to be used for accessing the pool information.
|
java.lang.String |
getPoolSchemaLocation()
Returns the location of the schema for the DAX.
|
java.lang.String |
getPoolSchemaLocation(java.lang.String defaultLocation)
Returns the location of the schema for the site catalog file.
|
Namespace |
getProfiles(Profiles.NAMESPACES ns)
Returns all the profiles relevant to a particular namespace
|
java.lang.String |
getPropertiesInSubmitDirectory()
Returns the path to the property file that has been writting out in
the submit directory.
|
java.lang.String |
getProperty(java.lang.String key)
It allows you to get any property from the property file without going
through the corresponding accesor function in this class.
|
private java.lang.String |
getProperty(java.lang.String newProperty,
java.lang.String deprecatedProperty)
This function is used to check whether a deprecated property is used or
not.
|
private java.lang.String |
getProperty(java.lang.String newProperty,
java.lang.String deprecatedProperty,
java.lang.String defaultValue)
This function is used to check whether a deprecated property is used or
not.
|
java.lang.String |
getRefinementProvenanceStore()
Returns the provenance store to use to log the refiner actions.
|
java.lang.String |
getReplicaMode()
Returns the replica mode.
|
java.lang.String |
getReplicaSelector()
Returns the name of the selector to be used for selection amongst the
various replicas of a single lfn.
|
java.lang.String |
getRLIURL()
Returns the url to the RLI of the RLS.
|
int |
getRLSTimeout()
It returns the timeout value in seconds after which to timeout in case of
no activity from the RLS.
|
java.lang.String |
getRootWorkflowUUID()
Returns the root workflow UUID if defined in the properties, else null
Referred to by the "pegasus.workflow.root.uuid" property.
|
java.io.File |
getSchemaDir()
Accessor to the schema directory of the Pegasus install
|
java.io.File |
getSharedDir()
Accessor to the bin directory of the Pegasus install
|
java.lang.String |
getSiteSelectorKeep()
Returns a value designating whether we need to keep the temporary files
that are passed to the external site selectors.
|
java.lang.String |
getSiteSelectorMode()
Returns the class name of the site selector, that needs to be invoked to do
the site selection.
|
java.lang.String |
getSiteSelectorPath()
Returns the path to the external site selector that needs to be called
out to make the decision of site selection.
|
int |
getSiteSelectorTimeout()
It returns the timeout value in seconds after which to timeout in case of
no activity from the external site selector.
|
java.lang.String |
getSLSTransferArguments()
Returns the extra arguments with which the transfer executable used in
PegasusLite needs to be invoked.
|
java.lang.String |
getSLSTransferImplementation()
Returns the sls transfer implementation that is to be used for constructing
the transfer jobs.
|
java.lang.String |
getStagingDelimiter()
Returns the delimiter to be used for constructing the staged executable
name, during transfer of executables to remote sites.
|
java.lang.String |
getStorageDirectory()
Returns the storage directory suffix or absolute specified
that is appended/replaced to the storage-mount-point specified in the
pool catalog for the various pools.
|
java.lang.String |
getSubmitLogsDirectory()
Returns the the path to the logs directory on the submit host.
|
java.lang.String |
getSubmitMode()
Returns which submit mode to be used to submit the jobs on to the grid.
|
java.io.File |
getSysConfDir()
Accessor to $PEGASUS_HOME/etc.
|
java.lang.String |
getTCMapperMode()
Returns the mode for loading the transformation mapper that sits in
front of the transformation catalog.
|
java.lang.String |
getTCMode()
Returns the mode to be used for accessing the Transformation Catalog.
|
java.lang.String |
getTCPath()
Returns the location of the transformation catalog.
|
java.lang.String |
getThirdPartySites(java.lang.String property)
Returns the comma separated list of third party sites, specified in the
properties.
|
java.lang.String |
getThirdPartySitesRemote(java.lang.String property)
Returns the comma separated list of third party sites for which
the third party transfers are executed on the remote sites.
|
java.lang.String |
getTransferArguments()
Returns the arguments with which the transfer executable needs
to be invoked.
|
java.lang.String |
getTransferImplementation()
Returns the transfer implementation that is to be used for constructing
the transfer jobs.
|
java.lang.String |
getTransferImplementation(java.lang.String property)
Returns the transfer implementation.
|
java.lang.String |
getTransferInterPriority()
Returns the priority to be set for the interpool transfer job.
|
private java.lang.String |
getTransferPriority(java.lang.String property)
Returns the transfer priority.
|
java.lang.String |
getTransferRefiner()
Returns the transfer refiner that is to be used for adding in the
transfer jobs in the workflow
Referred to by the "pegasus.transfer.refiner" property.
|
java.lang.String |
getTransferStageInPriority()
Returns the priority to be set for the stage in transfer job.
|
java.lang.String |
getTransferStageOutPriority()
Returns the priority to be set for the stage out transfer job.
|
java.lang.String |
getTXSelectorMode()
Returns the mode for loading the transformation selector that selects
amongst the various candidate transformation catalog entry objects.
|
boolean |
getUseOfSymbolicLinks()
It returns whether the use of symbolic links in case where the source
and destination files happen to be on the same file system.
|
CommonProperties |
getVDSProperties()
Returns the CommonProperties that this object encapsulates.
|
java.lang.String |
getWingsPropertiesFile()
Returns the path to the wings properties file.
|
java.lang.String |
getWingsRequestID()
Returns the request id.
|
private void |
initializePropertyFile(java.lang.String confProperties)
Gets the handle to the properties file.
|
boolean |
labelBasedSubmitDirectoryForSubWorkflows()
Returns a boolean indicating whether the submit directory for the sub
workflows should include the label of the sub workflow or not.
|
private void |
logDeprecatedWarning(java.lang.String deprecatedProperty,
java.lang.String newProperty)
Logs a warning about the deprecated property.
|
boolean |
logJobAggregatorProgress()
Returns whether the seqexec job aggregator should log progress to a log or not.
|
boolean |
logJobAggregatorProgressToGlobal()
Returns whether the seqexec job aggregator should write to a global log or not.
|
boolean |
logMemoryUsage()
Returns a boolean indicating whether to log JVM memory usage or not.
|
java.util.Properties |
matchingSubset(java.lang.String prefix,
boolean keepPrefix)
Extracts a specific property key subset from the known properties.
|
java.util.Map<Profiles.NAMESPACES,java.lang.String> |
namespaceToPropertiesPrefix() |
static PegasusProperties |
nonSingletonInstance()
To get a reference to the the object.
|
protected static PegasusProperties |
nonSingletonInstance(java.lang.String confProperties)
To get a reference to the the object.
|
boolean |
preserveParserLineBreaks()
Returns a boolean indicating whether to preserver line breaks.
|
boolean |
quoteTransferURL()
Returns whether to introduce quotes around url's before handing to
g-u-c and condor.
|
Profiles |
retrieveProfilesFromProperties()
Retrieves profiles from the properties
|
protected Profiles |
retrieveProfilesFromProperties(CommonProperties properties)
Retrieves profiles from the properties
|
private void |
sanitizePathForProperty(java.util.Properties properties,
java.lang.String key)
Santizes the value in the properties .
|
protected static void |
sanityCheck(java.io.File dir)
Checks the destination location for existence, if it can
be created, if it is writable etc.
|
boolean |
setPostSCRIPTDebugON()
Returns a boolean indicating whether to turn debug on or not for exitcode.
|
java.lang.Object |
setProperty(java.lang.String key,
java.lang.String value)
Accessor: Overwrite any properties from within the program.
|
boolean |
setXBitWithKickstart()
Returns a boolean indicating whether kickstart should set x bit on
staged executables before launching them.
|
boolean |
stageSLSFilesViaFirstLevelStaging()
Returns a boolean indicating whether to stage sls files via Pegasus
First Level Staging or let Condor do it.
|
boolean |
symlinkCommonLog()
Completely disable placing a symlink for Condor common log (indiscriminately).
|
boolean |
transferWorkerPackage()
It specifies if the worker package needs to be staged to the remote site
or not.
|
boolean |
treatCacheAsRC()
Returns a boolean indicating whether to treat the entries in the cache
files as a replica catalog or not.
|
boolean |
useCondorQuotingForArguments()
Returns a boolean indicating whether we want to Condor Quote the
arguments of the job or not.
|
boolean |
useDeepStorageDirectoryStructure()
Returns a boolean indicating whether to have a deep storage directory
structure or not while staging out data to the output site.
|
boolean |
useExtendedTimeStamp()
It specifies whether to use the extended timestamp format for generation
of timestamps that are used to create the random directory name, and for
the classads generation.
|
boolean |
useForceInTransfer()
It specifies whether the underlying transfer mechanism being used should
use the force option if available to transfer the files.
|
boolean |
useInvokeInGridStart()
Returns a boolean indicating whether to use invoke in kickstart always
or not.
|
boolean |
useTimestampForDirectoryStructure()
Returns a boolean indicating whether to use timestamp for directory
name creation or not.
|
boolean |
writeOutMetrics()
Returns a boolean indicating whether to write out the planner metrics
or not.
|
java.lang.String |
writeOutProperties(java.lang.String directory)
Writes out the properties to a temporary file in the directory passed.
|
java.lang.String |
writeOutProperties(java.lang.String directory,
boolean sanitizePath)
Writes out the properties to a temporary file in the directory passed.
|
java.lang.String |
writeOutProperties(java.lang.String directory,
boolean sanitizePath,
boolean setInternalVariable)
Writes out the properties to a temporary file in the directory passed.
|
public static final java.lang.String DISABLE_INVOKE_PROPERTY
public static final java.lang.String PEGASUS_WORKER_NODE_EXECUTION_PROPERTY
public static final java.lang.String PEGASUS_TRANSFER_WORKER_PACKAGE_PROPERTY
public static final java.lang.String PEGASUS_TRANSFORMATION_CATALOG_PROPERTY
public static final java.lang.String PEGASUS_TRANSFORMATION_CATALOG_FILE_PROPERTY
public static final java.lang.String PEGASUS_REPLICA_CATALOG_PROPERTY
public static final java.lang.String PEGASUS_REPLICA_CATALOG_FILE_PROPERTY
public static final java.lang.String PEGASUS_SITE_CATALOG_PROPERTY
public static final java.lang.String PEGASUS_SITE_CATALOG_FILE_PROPERTY
public static final java.lang.String PEGASUS_APP_METRICS_PREFIX
public static final java.lang.String DEFAULT_RC_COLLECTION
public static final java.lang.String DEFAULT_RLI_URL
public static final java.lang.String DEFAULT_RLS_QUERY_MODE
public static final java.lang.String DEFAULT_RLS_EXIT_MODE
public static final java.lang.String DEFAULT_RLS_QUERY_ATTRIB
public static final java.lang.String DEFAULT_LRC_IGNORE_URL
public static final java.lang.String DEFAULT_RLS_TIMEOUT
public static final java.lang.String DEFAULT_EXEC_DIR
public static final java.lang.String DEFAULT_STORAGE_DIR
public static final java.lang.String DEFAULT_TC_MODE
public static final java.lang.String TC_TEXT_FILE
public static final java.lang.String TC_DATA_FILE
public static final java.lang.String DEFAULT_POOL_MODE
public static final java.lang.String DEFAULT_CONDOR_BIN_DIR
public static final java.lang.String DEFAULT_CONDOR_CONFIG_DIR
public static final java.lang.String SC_XML_FILE
public static final java.lang.String SC_XML3_FILE
public static final java.lang.String CONDOR_KICKSTART
public static final java.lang.String DEFAULT_STAGING_DELIMITER
public static final java.lang.String DEFAULT_TRANSFER_PROCESSES
public static final java.lang.String DEFAULT_TRANSFER_STREAMS
public static final java.lang.String DEFAULT_GRIDSTART_MODE
public static final java.lang.String DEFAULT_INVOKE_LENGTH
public static final java.lang.String DEFAULT_SITE_SELECTOR
public static final java.lang.String DEFAULT_SITE_SELECTOR_TIMEOUT
public static final java.lang.String DEFAULT_SITE_SELECTOR_KEEP
public static final java.lang.String DEFAULT_DATA_MULTIPLICATION_FACTOR
public static final java.lang.String DEFAULT_COMP_MULTIPLICATION_FACTOR
public static final java.lang.String DEFAULT_COMP_ERROR_PERCENTAGE
public static final java.lang.String DEFAULT_COMP_VARIANCE_PERCENTAGE
public static final java.lang.String DEFAULT_JOB_AGGREGATOR
public static final java.lang.String DEFAULT_TC_MAPPER_MODE
public static final java.lang.String DEFAULT_TX_SELECTOR_MODE
public static final java.lang.String DEFAULT_LOGGING_FILE
public static final java.lang.String ALL_TRANSFER_PRIORITY_PROPERTY_KEY
public static final java.lang.String ROOT_WORKFLOW_UUID_PROPERTY_KEY
public static final java.lang.String DEFAULT_DAGMAN_MAX_PRE_VALUE
private static final java.lang.String DEFAULT_DAX_CALLBACK
private java.lang.String mPegasusHome
private CommonProperties mProps
private java.lang.String mDefaultTC
private java.lang.String mDefaultPoolFile
private java.lang.String mDefaultTransferPriority
private java.util.Set mDeprecatedProperties
private java.lang.String mPropsInSubmitDir
private Profiles mProfiles
private static java.util.Map<Profiles.NAMESPACES,java.lang.String> mNamepsaceToPropertiesPrefix
private PegasusProperties(java.lang.String confProperties)
confProperties
- the path to conf properties, that supersede the
loading of properties from $PEGASUS_HOME/.pegasusrcpublic java.util.Map<Profiles.NAMESPACES,java.lang.String> namespaceToPropertiesPrefix()
public static PegasusProperties getInstance()
public static PegasusProperties getInstance(java.lang.String confProperties)
confProperties
- the path to conf properties, that supersede the
loading of properties from $PEGASUS_HOME/.pegasusrcprotected static PegasusProperties nonSingletonInstance(java.lang.String confProperties)
confProperties
- the path to conf properties, that supersede the
loading of properties from $PEGASUS_HOME/.pegasusrcpublic static PegasusProperties nonSingletonInstance()
public Profiles retrieveProfilesFromProperties()
properties
- the common properties so farprotected Profiles retrieveProfilesFromProperties(CommonProperties properties)
properties
- the common properties so farpublic java.lang.Object clone()
clone
in class java.lang.Object
public java.io.File getBinDir()
public java.io.File getSchemaDir()
public java.io.File getSharedDir()
public Namespace getProfiles(Profiles.NAMESPACES ns)
ns
- the namespace corresponding to which you need the profilespublic java.lang.String getDefaultPathToTC()
public java.lang.String getDefaultPathToSC()
getPoolMode()
public java.lang.String getDefaultPathToCondorKickstart()
private void initializePropertyFile(java.lang.String confProperties)
confProperties
- the path to conf properties, that supersede the
loading of properties from $PEGASUS_HOME/.pegasusrcpublic java.lang.String getProperty(java.lang.String key)
key
- the property whose value is desired.public CommonProperties getVDSProperties()
public java.lang.Object setProperty(java.lang.String key, java.lang.String value)
key
- is the key to look upvalue
- is the new property value to place in the system.public java.util.Properties matchingSubset(java.lang.String prefix, boolean keepPrefix)
prefix
- is the key prefix to filter the properties by.keepPrefix
- if true, the key prefix is kept in the resulting
dictionary. As side-effect, a key that matches the prefix exactly
will also be copied. If false, the resulting dictionary's keys are
shortened by the prefix. An exact prefix match will not be copied,
as it would result in an empty string key.is used to assemble matches
public java.util.List getMatchingProperties(java.lang.String prefix, boolean system)
prefix
- the prefix for the property names.system
- boolean indicating whether to match only System properties
or all including the ones in the property file.NameValue
objects corresponding to the matched
properties sorted by keys.
null if no matching property is found.public java.io.File getSysConfDir()
public java.lang.String getDAXSchemaLocation()
public java.lang.String getDAXSchemaLocation(java.lang.String defaultLocation)
defaultLocation
- the default location to the schema.public java.lang.String getPDAXSchemaLocation(java.lang.String defaultLocation)
defaultLocation
- the default location to the schema.public java.lang.String getCreateDirClass()
public java.lang.String getCreateDirImplementation()
public boolean useExtendedTimeStamp()
public boolean useTimestampForDirectoryStructure()
public java.lang.String getExecDirectory()
DEFAULT_EXEC_DIR
public java.lang.String getSubmitLogsDirectory()
public boolean labelBasedSubmitDirectoryForSubWorkflows()
public java.lang.String getStorageDirectory()
DEFAULT_STORAGE_DIR
public boolean useDeepStorageDirectoryStructure()
public java.lang.String getCleanupStrategy()
public java.lang.String getCleanupImplementation()
public java.lang.String getMaximumCleanupJobsPerLevel()
public java.lang.String getClusterSizeCleanupJobsPerLevel()
public PegasusProperties.CLEANUP_SCOPE getCleanupScope()
public java.lang.String getTCMode()
DEFAULT_TC_MODE
public java.lang.String getTCPath()
mDefaultTC
public java.lang.String getTCMapperMode()
DEFAULT_TC_MAPPER_MODE
public java.lang.String getReplicaMode()
public java.lang.String getRLIURL()
DEFAULT_RLI_URL
public int getRLSTimeout()
DEFAULT_RLS_TIMEOUT
public java.lang.String getPoolMode()
DEFAULT_POOL_MODE
public java.lang.String getPoolFile()
mDefaultPoolFile
public java.lang.String getPoolSchemaLocation()
public java.lang.String getPoolSchemaLocation(java.lang.String defaultLocation)
defaultLocation
- the default location where the schema should be
if no other location is specified.public java.lang.String getRefinementProvenanceStore()
public java.lang.String getTransferImplementation()
public java.lang.String getSLSTransferImplementation()
public java.lang.String getTransferImplementation(java.lang.String property)
property
- property name.public boolean stageSLSFilesViaFirstLevelStaging()
private java.lang.String getDefaultThirdPartySites()
private java.lang.String getDefaultTransferImplementation()
public boolean bypassFirstLevelStagingForInputs()
private java.lang.String getDefaultTransferPriority()
public java.lang.String getBaseSourceURLForSetupTransfers()
public java.lang.String getTransferRefiner()
public boolean quoteTransferURL()
public java.lang.String getNumOfTransferProcesses()
DEFAULT_TRANSFER_PROCESSES
public java.lang.String getNumOfTransferStreams()
DEFAULT_TRANSFER_STREAMS
public boolean useForceInTransfer()
public boolean getUseOfSymbolicLinks()
public java.lang.String getThirdPartySites(java.lang.String property)
property
- property name.public java.lang.String getThirdPartySitesRemote(java.lang.String property)
property
- property name.public java.lang.String getStagingDelimiter()
DEFAULT_STAGING_DELIMITER
public java.lang.String getChmodDisabledSites()
public boolean transferWorkerPackage()
public java.lang.String getTransferArguments()
public java.lang.String getSLSTransferArguments()
public java.lang.String getTransferStageInPriority()
public java.lang.String getTransferStageOutPriority()
public java.lang.String getTransferInterPriority()
private java.lang.String getTransferPriority(java.lang.String property)
property
- property name.public java.lang.String getTXSelectorMode()
DEFAULT_TC_MAPPER_MODE
public java.lang.String getReplicaSelector()
public java.lang.String getAllPreferredSites()
public java.lang.String getAllIgnoredSites()
public java.lang.String getSiteSelectorMode()
DEFAULT_SITE_SELECTOR
public java.lang.String getSiteSelectorPath()
public int getSiteSelectorTimeout()
DEFAULT_SITE_SELECTOR_TIMEOUT
public java.lang.String getSiteSelectorKeep()
DEFAULT_SITE_SELECTOR_KEEP
public java.lang.String getGridStart()
DEFAULT_GRIDSTART_MODE
public boolean setXBitWithKickstart()
public boolean doStatWithKickstart()
public boolean generateLOFFiles()
public boolean useInvokeInGridStart()
public boolean disableInvokeInGridStart()
public long getGridStartInvokeLength()
DEFAULT_INVOKE_LENGTH
public boolean generateKickstartExtraOptions()
public boolean setPostSCRIPTDebugON()
public boolean symlinkCommonLog()
public boolean useCondorQuotingForArguments()
public java.lang.String getCredName()
public java.lang.String getLogManager()
public java.lang.String getLogFormatter()
public java.lang.String getHttpLog4jURL()
public java.lang.String getLoggingFile()
public java.lang.String getLog4JLogFile()
public boolean writeOutMetrics()
public java.lang.String getMetricsLogFile()
public boolean logMemoryUsage()
public boolean assignDefaultJobPriorities()
public boolean createRegistrationJobs()
public boolean executeOnWorkerNode()
public boolean treatCacheAsRC()
public boolean preserveParserLineBreaks()
public boolean addDataDependencies()
public java.lang.String getWingsPropertiesFile()
public java.lang.String getWingsRequestID()
public java.lang.String getGridFTPTimeout()
DEFAULT_SITE_SELECTOR_TIMEOUT
public java.lang.String getSubmitMode()
public java.lang.String getPartitionParsingMode()
public java.lang.String getCollapseFactors()
public java.lang.String getHorizontalClusterPreference()
job.runtime
property. For all other cases the default horizontal clustering approach
will be used.public java.lang.String getJobAggregator()
DEFAULT_JOB_AGGREGATOR
public boolean logJobAggregatorProgress()
public boolean logJobAggregatorProgressToGlobal()
public boolean abortOnFirstJobFailure()
public java.lang.String getRootWorkflowUUID()
public java.lang.String getPartitionerDAXCallback()
DEFAULT_DAX_CALLBACK
public java.lang.String getPartitionerLabelKey()
public java.lang.String getHorizontalPartitionerBundleValue(java.lang.String name)
name
- the logical name of the transformation.public java.lang.String getHorizontalPartitionerCollapseValue(java.lang.String name)
name
- the logical name of the transformation.public java.lang.String getClustererLabelKey()
public java.lang.String getPropertiesInSubmitDirectory()
java.lang.RuntimeException
- in case of file not being generated.public java.lang.String writeOutProperties(java.lang.String directory) throws java.io.IOException
directory
- the directory in which the properties file needs to
be written to.java.io.IOException
- in case of error while writing out file.public java.lang.String writeOutProperties(java.lang.String directory, boolean sanitizePath) throws java.io.IOException
directory
- the directory in which the properties file needs to
be written to.sanitizePath
- boolean indicating whether to sanitize paths for
certain properties or not.java.io.IOException
- in case of error while writing out file.public java.lang.String writeOutProperties(java.lang.String directory, boolean sanitizePath, boolean setInternalVariable) throws java.io.IOException
directory
- the directory in which the properties file needs to
be written to.sanitizePath
- boolean indicating whether to sanitize paths for
certain properties or not.setInternalVariable
- whether to set the internal variable that stores
the path to the properties file.java.io.IOException
- in case of error while writing out file.private void sanitizePathForProperty(java.util.Properties properties, java.lang.String key)
properties
- the propertieskey
- the key whose value needs to be sanitizedprotected static void sanityCheck(java.io.File dir) throws java.io.IOException
dir
- is the new base directory to optionally create.java.io.IOException
- in case of error while writing out files.private java.lang.String getProperty(java.lang.String newProperty, java.lang.String deprecatedProperty)
newProperty
- the new property that should be used.deprecatedProperty
- the deprecated property that needs to be
replaced.private java.lang.String getProperty(java.lang.String newProperty, java.lang.String deprecatedProperty, java.lang.String defaultValue)
newProperty
- the new property that should be used.deprecatedProperty
- the deprecated property that needs to be
replaced.defaultValue
- the default value that should be returned.private void logDeprecatedWarning(java.lang.String deprecatedProperty, java.lang.String newProperty)
deprecatedProperty
- the deprecated property that needs to be
replaced.newProperty
- the new property that should be used.