public class Pegasus extends Namespace
Namespace.EmptyIterator
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
BUNDLE_KEY
The name of the key that if set, determines the number of super jobs
that are made corresponding to a logical transformation and an execution
pool.
|
static java.lang.String |
BUNDLE_LOCAL_STAGE_IN_KEY
The name of the key that determines the bundling parameter for the
local stagein transfer node.
|
static java.lang.String |
BUNDLE_LOCAL_STAGE_OUT_KEY
The name of the key that determines the bundling parameter for the
local stagein transfer node.
|
static java.lang.String |
BUNDLE_REMOTE_STAGE_IN_KEY
The name of the key that determines the bundling parameter for the
remote stagein transfer node.
|
static java.lang.String |
BUNDLE_REMOTE_STAGE_OUT_KEY
The name of the key that determines the bundling parameter for the
remote stagein transfer node.
|
static java.lang.String |
BUNDLE_STAGE_IN_KEY
The name of the key that determines the bundling parameter for the
stagein transfer node.
|
static java.lang.String |
BUNDLE_STAGE_OUT_KEY
The name of the key that determines the bundling parameter for the
stageout transfer node.
|
static java.lang.String |
CHAIN_STAGE_IN_KEY
The name of the key that determines the number of chains of stagein
nodes that are to be created per site.
|
static java.lang.String |
CHANGE_DIR_KEY
The name of the profile key that triggers the kickstart to change directory
before launching an executable instead of launching the executable from
the directory where kickstart is being run.
|
static java.lang.String |
CLUSTER_ARGUMENTS
Arguments that need to be passed to the clustering executable.
|
static java.lang.String |
CLUSTER_LOCAL_STAGE_IN_KEY
The name of the key that determines the cluster parameter for the
local stagein transfer node.
|
static java.lang.String |
CLUSTER_LOCAL_STAGE_OUT_KEY
The name of the key that determines the cluster parameter for the
local stagein transfer node.
|
static java.lang.String |
CLUSTER_REMOTE_STAGE_IN_KEY
The name of the key that determines the clustering parameter for the
stagein transfer node.
|
static java.lang.String |
CLUSTER_REMOTE_STAGE_OUT_KEY
The name of the key that determines the bundling parameter for the
remote stagein transfer node.
|
static java.lang.String |
CLUSTER_STAGE_IN_KEY
The name of the key that determines the clustering parameter for the
stagein transfer node.
|
static java.lang.String |
CLUSTER_STAGE_OUT_KEY
The name of the key that determines the clustering parameter for the
stageout transfer node.
|
static java.lang.String |
COLLAPSE_KEY
The name of the key that if set in the Pegasus namespace determines the
number of jobs that are collapsed into the super job.
|
static java.lang.String |
COLLAPSER_KEY
Deprecated.
|
static java.lang.String |
CONDOR_STYLE
The style indicating that the submit files are to be generated for
a vanilla condor execution.
|
static java.lang.String |
CONDORC_STYLE
The style indicating that the submit files are to be generated for
a CondorC submission to remote schedds.
|
static java.lang.String |
CORES_KEY
The number of cores that are associated with the job.
|
static java.lang.String |
CREAMCE_STYLE
The style indicating that the submit files are to be generated for
a creamce submission
|
static java.lang.String |
CREATE_AND_CHANGE_DIR_KEY
The name of the profile key that triggers the kickstart to create and
then the working directory to it before launching an executable.
|
static java.lang.String |
DEPRECATED_BUNDLE_STAGE_IN_KEY
The deprecated bundle stagein key.
|
static java.lang.String |
DEPRECATED_CHANGE_DIR_KEY
The deprecated change dir key.
|
private static Aggregator |
ERROR_MESSAGE_AGGREGATOR
Static Handle to the delimiter aggregator.
|
static java.lang.String |
EXITCODE_FAILURE_MESSAGE
The message to look for while detecting failures condor job's stdout/stderr
|
static java.lang.String |
EXITCODE_SUCCESS_MESSAGE
the message to look for while detecting success in condor job's stdout/stderr
|
static java.lang.String |
GLIDEIN_STYLE
The style indicating that the submit files are to be generated for a
glidein execution.
|
static java.lang.String |
GLIDEINWMS_STYLE
The style indicating that the submit files are to be generated for a
glideinwms execution.
|
static java.lang.String |
GLITE_STYLE
The style indicating that the submit files are to be generated for a
glite execution.
|
static java.lang.String |
GLOBUS_STYLE
The style indicating that the submit files are to be generated for
a CondorG execution.
|
static java.lang.String |
GRIDSTART_ARGUMENTS_KEY
The name of the profile key, that determines the arguments with which
the GridStart that is used to launch a job on the remote site is invoked
with.
|
static java.lang.String |
GRIDSTART_KEY
The name of the profile key that determines the launching executable
to be used to launch a job on the grid.
|
static java.lang.String |
GRIDSTART_PATH_KEY
The name of the profile key that designates the path to a gridstart.
|
static java.lang.String |
GROUP_KEY
The name of the profile key in vds namespace that does the grouping.
|
private static java.lang.String |
IRODSENVFILE |
static java.lang.String |
JOB_AGGREGATOR_KEY
The name of the key that determines the clusterig executable to be used
to run the merged/collapsed job.
|
static java.lang.String |
JOB_RUN_TIME
The name of the key that if set in the Pegasus namespace specifies the
approximate runtime of the job.
|
static java.lang.String |
LABEL_KEY
The name of the profile key in vds namespace that does the labelling
by default.
|
static java.lang.String |
MAX_RUN_TIME
The name of the key that if set in the Pegasus namespace specifies the
maximum amount of time for which a cluster should run.
|
protected static java.util.Map |
mDeprecatedTable
The table containing the mapping of the deprecated keys to the newer keys.
|
protected java.lang.String |
mNamespace
The name of the implementing namespace.
|
static java.lang.String |
NAMESPACE_NAME
The name of the namespace that this class implements.
|
static java.lang.String |
PMC_PRIORITY_KEY
A key to designate a priority to the jobs run by pegasus-mpi-cluster.
|
static java.lang.String |
PMC_REQUEST_CPUS_KEY
A key to designate the number of CPU's requested by pegasus-mpi-cluster.
|
static java.lang.String |
PMC_REQUEST_MEMORY_KEY
A key to designate the memory required by a job in MB by pegasus-mpi-cluster.
|
static java.lang.String |
PMC_TASK_ARGUMENTS
Arguments that need to be passed to the PMC clustering executable.
|
static java.lang.String |
REMOTE_INITIALDIR_KEY
The name of the key that sets a remote initial dir for a condor globus
job.
|
static java.lang.String |
RUNTIME_KEY
The name of the profile key when associated with a transformation in the
transformation catalog gives expected runtime in seconds.
|
private static java.lang.String |
S3CFG_FILE_VARIABLE |
private static java.lang.String |
SSH_PRIVATE_KEY_VARIABLE |
static java.lang.String |
SSH_STYLE
The style indicating that the submit files are to be generated for a
direct ssh submission
|
static java.lang.String |
STYLE_KEY
The name of the key, that denotes the style of the dag that is constructed.
|
private static Aggregator |
SUCCESS_MESSAGE_AGGREGATOR
Static Handle to the delimiter aggregator.
|
private static Aggregator |
SUM_AGGREGATOR
Static Handle to the sum aggregator.
|
static java.lang.String |
TRANSFER_ARGUMENTS_KEY
The name of the profile key, that when associated with transfer jobs
determines the arguments with which the transfer executable is invoked.
|
static java.lang.String |
TRANSFER_PROXY_KEY
The name of the profile key if associated with a job, results in an explicit
transfer of the proxy from the submit host to the remote site, instead of
banking upon CondorG to transfer the proxy.
|
static java.lang.String |
TRANSFER_SLS_ARGUMENTS_KEY
The name of the profile key, that when associated with transfer jobs
determines the arguments with which the transfer executable is invoked.
|
static java.lang.String |
TRANSFER_SLS_THREADS_KEY
The name of the profile key, that when associated with transfer jobs
determines the number of threads that pegasus-transfer uses to do the transfer
|
static java.lang.String |
TRANSFER_THREADS_KEY
The name of the profile key, that when associated with transfer jobs
determines the number of threads that pegasus-transfer uses to do the transfer
|
static java.lang.String |
TYPE_KEY
The name of the key that denotes the type of the job.
|
static java.lang.String |
WORKER_NODE_DIRECTORY_KEY
The directory in which job needs to execute on worker node tmp.
|
private static java.lang.String |
X509_USER_PROXY_KEY |
DEPRECATED_KEY, EMPTY_KEY, MALFORMED_KEY, mLogger, mProfileMap, NOT_PERMITTED_KEY, UNKNOWN_KEY, VALID_KEY, VERSION
Constructor and Description |
---|
Pegasus()
The default constructor.
|
Pegasus(java.util.Map mp)
The overloaded constructor.
|
Modifier and Type | Method and Description |
---|---|
int |
checkKey(java.lang.String key,
java.lang.String value)
This checks whether the key passed by the user is valid in the current
namespace or not.
|
void |
checkKeyInNS(PegasusProperties properties,
java.lang.String pool)
It puts in the namespace specific information specified in the properties
file into the namespace.
|
java.lang.Object |
clone()
Returns a copy of the current namespace object
|
void |
construct(java.lang.String key,
java.lang.String value)
Constructs a new element of the format (key=value).
|
boolean |
containsKey(java.lang.Object key)
Returns true if the namespace contains a mapping
for the specified key.
|
java.util.Map |
deprecatedTable()
Singleton access to the deprecated table that holds the deprecated keys,
and the keys that replace them.
|
java.lang.Object |
get(java.lang.Object key)
Returns the value to which this namespace maps the specified key.
|
boolean |
getBooleanValue(java.lang.Object key)
Returns a boolean value, that a particular key is mapped to in this
namespace.
|
java.lang.String |
getStringValue(java.lang.Object key)
Returns a String value, that a particular key is mapped to in this
namespace.
|
void |
merge(Namespace profiles)
UniqueMerge the profiles in the namespace in a controlled manner.
|
java.lang.String |
namespaceName()
Returns the name of the namespace associated with the profile implementations.
|
java.lang.String |
toCondor()
Converts the contents of the map into the string that can be put in the
Condor file for printing.
|
void |
unknownKey(java.lang.String key,
java.lang.String value)
Warns about an unknown profile key and constructs it anyway.
|
assimilate, checkKeyInNS, checkKeyInNS, checkKeyInNS, checkKeyInNS, checkKeyInNS, deprecatedKey, emptyKey, getProfileKeyIterator, isEmpty, isNamespaceValid, keySet, malformedKey, notPermitted, removeKey, toString
public static final java.lang.String NAMESPACE_NAME
public static final java.lang.String REMOTE_INITIALDIR_KEY
public static final java.lang.String BUNDLE_KEY
COLLAPSE_KEY
,
Constant Field Valuespublic static final java.lang.String COLLAPSE_KEY
public static final java.lang.String JOB_RUN_TIME
public static final java.lang.String MAX_RUN_TIME
public static final java.lang.String JOB_AGGREGATOR_KEY
public static final java.lang.String COLLAPSER_KEY
public static final java.lang.String GROUP_KEY
public static final java.lang.String LABEL_KEY
public static final java.lang.String GRIDSTART_KEY
public static final java.lang.String GRIDSTART_ARGUMENTS_KEY
public static final java.lang.String GRIDSTART_PATH_KEY
public static final java.lang.String EXITCODE_FAILURE_MESSAGE
public static final java.lang.String EXITCODE_SUCCESS_MESSAGE
public static final java.lang.String DEPRECATED_CHANGE_DIR_KEY
CHANGE_DIR_KEY
,
Constant Field Valuespublic static final java.lang.String CHANGE_DIR_KEY
public static final java.lang.String CREATE_AND_CHANGE_DIR_KEY
public static final java.lang.String CORES_KEY
public static final java.lang.String DEPRECATED_BUNDLE_STAGE_IN_KEY
CHANGE_DIR_KEY
,
Constant Field Valuespublic static final java.lang.String BUNDLE_STAGE_IN_KEY
public static final java.lang.String BUNDLE_REMOTE_STAGE_IN_KEY
public static final java.lang.String BUNDLE_LOCAL_STAGE_IN_KEY
public static final java.lang.String BUNDLE_REMOTE_STAGE_OUT_KEY
public static final java.lang.String BUNDLE_LOCAL_STAGE_OUT_KEY
public static final java.lang.String BUNDLE_STAGE_OUT_KEY
public static final java.lang.String CLUSTER_STAGE_IN_KEY
public static final java.lang.String CLUSTER_REMOTE_STAGE_IN_KEY
public static final java.lang.String CLUSTER_LOCAL_STAGE_IN_KEY
public static final java.lang.String CLUSTER_STAGE_OUT_KEY
public static final java.lang.String CLUSTER_REMOTE_STAGE_OUT_KEY
public static final java.lang.String CLUSTER_LOCAL_STAGE_OUT_KEY
public static final java.lang.String CHAIN_STAGE_IN_KEY
public static final java.lang.String TRANSFER_PROXY_KEY
public static final java.lang.String TRANSFER_ARGUMENTS_KEY
public static final java.lang.String TRANSFER_THREADS_KEY
public static final java.lang.String TRANSFER_SLS_ARGUMENTS_KEY
public static final java.lang.String TRANSFER_SLS_THREADS_KEY
public static final java.lang.String RUNTIME_KEY
public static final java.lang.String WORKER_NODE_DIRECTORY_KEY
public static final java.lang.String CLUSTER_ARGUMENTS
public static final java.lang.String STYLE_KEY
public static final java.lang.String TYPE_KEY
public static final java.lang.String CONDOR_STYLE
public static final java.lang.String CONDORC_STYLE
public static final java.lang.String CREAMCE_STYLE
public static final java.lang.String GLOBUS_STYLE
public static final java.lang.String GLIDEIN_STYLE
public static final java.lang.String GLIDEINWMS_STYLE
public static final java.lang.String GLITE_STYLE
public static final java.lang.String SSH_STYLE
public static final java.lang.String PMC_REQUEST_MEMORY_KEY
public static final java.lang.String PMC_REQUEST_CPUS_KEY
public static final java.lang.String PMC_PRIORITY_KEY
public static final java.lang.String PMC_TASK_ARGUMENTS
private static final java.lang.String S3CFG_FILE_VARIABLE
private static final java.lang.String SSH_PRIVATE_KEY_VARIABLE
private static final java.lang.String IRODSENVFILE
private static final java.lang.String X509_USER_PROXY_KEY
private static Aggregator SUM_AGGREGATOR
private static Aggregator ERROR_MESSAGE_AGGREGATOR
private static Aggregator SUCCESS_MESSAGE_AGGREGATOR
protected java.lang.String mNamespace
Namespace.isNamespaceValid(String)
protected static java.util.Map mDeprecatedTable
public Pegasus()
public Pegasus(java.util.Map mp)
mp
- the initial map.public java.lang.String namespaceName()
namespaceName
in class Namespace
NAMESPACE_NAME
public void construct(java.lang.String key, java.lang.String value)
public int checkKey(java.lang.String key, java.lang.String value)
public void checkKeyInNS(PegasusProperties properties, java.lang.String pool)
checkKeyInNS
in class Namespace
properties
- the PegasusProperties
object containing
all the properties that the user specified at various
places (like .chimerarc, properties file, command line).pool
- the pool name where the job is scheduled to run.COLLAPSER_KEY
,
TRANSFER_PROXY_KEY
public void merge(Namespace profiles)
public java.util.Map deprecatedTable()
deprecatedTable
in class Namespace
public java.lang.String toCondor()
public void unknownKey(java.lang.String key, java.lang.String value)
unknownKey
in class Namespace
key
- is the left-hand-sidevalue
- is the right hand sidepublic boolean containsKey(java.lang.Object key)
containsKey
in class Namespace
key
- The key that you want to search for
in the namespace.public java.lang.Object get(java.lang.Object key)
public boolean getBooleanValue(java.lang.Object key)
key
- The key whose boolean value you desire.public java.lang.String getStringValue(java.lang.Object key)
key
- The key whose boolean value you desire.