public interface PlugEngine
This interface represents an instance of Data Management Platform DataFlow engine that is
available to a plugin via PlugStep.getEngine()
.
IMPORTANT: This interface should never be used outside the context and lifecycle of the plugin to which it was provided. This means that an instance should not be passed as an argument to any method nor stored in a static location external to the plugin instance that obtained it.
Modifier and Type | Method and Description |
---|---|
void |
fatalError(java.lang.String message)
Notify the client application that a fatal error has occurred.
|
java.lang.String |
getKeyValue(java.lang.String key,
java.lang.String defaultValue)
Deprecated.
As of release DMP 2.3, replaced by configuration options and/or macros.
|
void |
logMessage(LogSeverity level,
java.lang.String message)
Log a message to the client application.
|
void |
setKeyValue(java.lang.String key,
java.lang.String value)
Deprecated.
As of release DMP 2.3, replaced by configuration options and/or macros.
|
@Deprecated void setKeyValue(java.lang.String key, java.lang.String value)
Values are substituted for macros in step parameters. They can also be used for other things like passing in machine specific data to jobs (things that shouldn't be stored in the job).
key
- The key to set.value
- The value to set.java.lang.NullPointerException
- If key or value is null.@Deprecated java.lang.String getKeyValue(java.lang.String key, java.lang.String defaultValue)
key
- The key to retrieve.defaultValue
- The value to return if the key does not exist.java.lang.NullPointerException
- If key or defaultValue is null.void logMessage(LogSeverity level, java.lang.String message)
This message should be used for informative purposes.
level
- The severity level of the message.message
- The text of the message.java.lang.NullPointerException
- if message is nullvoid fatalError(java.lang.String message)
The client application should probably terminate at this point.
message
- The text of the messagejava.lang.NullPointerException
- if message is nullCopyright © 2012 SAS Institute Inc. All Rights Reserved.