org.pentaho.di.job.entries.sendnagiospassivecheck

Class JobEntrySendNagiosPassiveCheck

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.sendnagiospassivecheck.JobEntrySendNagiosPassiveCheck

All Implemented Interfaces:

Cloneable, AttributesInterface, CheckResultSourceInterface, ExtensionDataInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntrySendNagiosPassiveCheck
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines an SendNagiosPassiveCheck job entry.

Since:

01-10-2011

Author:

Samatar

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECTION_TIME_OUT Default connection responseTimeOut to 5000 milliseconds
static int	DEFAULT_PORT Default port
static String[]	encryption_mode_Code
static String[]	encryption_mode_Desc
static int	ENCRYPTION_MODE_NONE
static int	ENCRYPTION_MODE_TRIPLEDES
static int	ENCRYPTION_MODE_XOR
static String[]	level_type_Code
static int	LEVEL_TYPE_CRITICAL
static String[]	level_type_Desc
static int	LEVEL_TYPE_OK
static int	LEVEL_TYPE_UNKNOWN
static int	LEVEL_TYPE_WARNING

Fields inherited from class org.pentaho.di.job.entry.JobEntryBase

attributesMap, containerObjectId, entryStepSetVariablesMap, extensionDataMap, log, metaStore, parentJob, parentJobMeta, rep, variables

Constructor Summary

Constructors

Constructor and Description
JobEntrySendNagiosPassiveCheck()
JobEntrySendNagiosPassiveCheck(String n)

Method Summary

Modifier and Type	Method and Description
void	check(List<CheckResultInterface> remarks, JobMeta jobMeta, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Allows JobEntry objects to check themselves for consistency
Object	clone() This method is called when a job entry is duplicated in Spoon.
boolean	evaluates() This method must return true if the job entry supports the true/false outgoing hops.
Result	execute(Result previousResult, int nr) Execute the job entry.
String	getConnectionTimeOut()
int	getEncryptionMode()
static int	getEncryptionModeByDesc(String tt)
static String	getEncryptionModeDesc(int i)
int	getLevel()
static int	getLevelByDesc(String tt)
static String	getLevelDesc(int i)
String	getMessage()
String	getPassword()
String	getPort()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Gets a list of all the resource dependencies that the step is depending on.
String	getResponseTimeOut()
String	getSenderServerName()
String	getSenderServiceName()
String	getServerName()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
void	loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers) This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.
void	loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore) This method is called by PDI whenever a job entry needs to read its settings from XML.
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_job) This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
void	setConnectionTimeOut(String connectionTimeOut)
void	setEncryptionMode(int encryptionModein)
void	setLevel(int levelMode)
void	setMessage(String message)
void	setPassword(String password)
void	setPort(String port)
void	setResponseTimeOut(String responseTimeOut)
void	setSenderServerName(String senderServerName)
void	setSenderServiceName(String senderServiceName)
void	setServerName(String serverName)

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getEntryStepSetVariable, getEntryStepSetVariablesMap, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentJobMeta, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariables, hasChanged, hashCode, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryStepSetVariable, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

check, clear, exportResources, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getParentJobMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getSQLStatements, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isReferencedObjectEnabled, isShell, isSpecial, isStart, isTransformation, isUnconditional, loadReferencedObject, loadReferencedObject, loadRep, loadXML, lookupRepositoryReferences, resetErrorsBeforeExecution, saveRep, setChanged, setChanged, setDescription, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setPluginId, setRepository

Field Detail

DEFAULT_CONNECTION_TIME_OUT

public static int DEFAULT_CONNECTION_TIME_OUT

Default connection responseTimeOut to 5000 milliseconds

DEFAULT_PORT

public static int DEFAULT_PORT

Default port

encryption_mode_Desc

public static final String[] encryption_mode_Desc

encryption_mode_Code

public static final String[] encryption_mode_Code

ENCRYPTION_MODE_NONE

public static final int ENCRYPTION_MODE_NONE

See Also:

Constant Field Values

ENCRYPTION_MODE_TRIPLEDES

public static final int ENCRYPTION_MODE_TRIPLEDES

See Also:

Constant Field Values

ENCRYPTION_MODE_XOR

public static final int ENCRYPTION_MODE_XOR

See Also:

Constant Field Values

level_type_Desc

public static final String[] level_type_Desc

level_type_Code

public static final String[] level_type_Code

LEVEL_TYPE_UNKNOWN

public static final int LEVEL_TYPE_UNKNOWN

See Also:

Constant Field Values

LEVEL_TYPE_OK

public static final int LEVEL_TYPE_OK

See Also:

Constant Field Values

LEVEL_TYPE_WARNING

public static final int LEVEL_TYPE_WARNING

See Also:

Constant Field Values

LEVEL_TYPE_CRITICAL

public static final int LEVEL_TYPE_CRITICAL

See Also:

Constant Field Values

Constructor Detail

JobEntrySendNagiosPassiveCheck

public JobEntrySendNagiosPassiveCheck(String n)

JobEntrySendNagiosPassiveCheck

public JobEntrySendNagiosPassiveCheck()

Method Detail

clone

public Object clone()

Description copied from class: JobEntryBase

This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.

Specified by:

clone in interface JobEntryInterface

Overrides:

clone in class JobEntryBase

Returns:

a clone of the object

getEncryptionModeByDesc

public static int getEncryptionModeByDesc(String tt)

getEncryptionModeDesc

public static String getEncryptionModeDesc(int i)

getLevelDesc

public static String getLevelDesc(int i)

getLevelByDesc

public static int getLevelByDesc(String tt)

getXML

public String getXML()

Description copied from class: JobEntryBase

This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.

Specified by:

getXML in interface JobEntryInterface

Overrides:

getXML in class JobEntryBase

Returns:

the xml representation of the job entry

loadXML

public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws KettleXMLException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry's settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.

Specified by:

loadXML in interface JobEntryInterface

Overrides:

loadXML in class JobEntryBase

Parameters:

entrynode - the top-level XML node

databases - the list of databases

slaveServers - the list of slave servers

rep - the repository object

metaStore - The metaStore to optionally load from.

Throws:

KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Parameters:

rep - the repository object

metaStore - the MetaStore to use

id_jobentry - the id of the job entry

databases - the list of databases

slaveServers - the list of slave servers

Throws:

KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_job)
             throws KettleException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Parameters:

rep - the repository

metaStore - the MetaStore to use

id_job - the id_job

Throws:

KettleException - if any errors occur during the save

getServerName

public String getServerName()

Returns:

Returns the serverName.

setServerName

public void setServerName(String serverName)

Parameters:

serverName - The serverName to set.

getSenderServerName

public String getSenderServerName()

Returns:

Returns the senderServerName.

setSenderServerName

public void setSenderServerName(String senderServerName)

Parameters:

senderServerName - The senderServerName to set.

getSenderServiceName

public String getSenderServiceName()

Returns:

Returns the senderServiceName.

setSenderServiceName

public void setSenderServiceName(String senderServiceName)

Parameters:

senderServiceName - The senderServiceName to set.

setPassword

public void setPassword(String password)

Parameters:

password - The password to set.

getPassword

public String getPassword()

Returns:

Returns the password.

getEncryptionMode

public int getEncryptionMode()

setEncryptionMode

public void setEncryptionMode(int encryptionModein)

getLevel

public int getLevel()

setLevel

public void setLevel(int levelMode)

setMessage

public void setMessage(String message)

Parameters:

message - The message to set.

getMessage

public String getMessage()

Returns:

Returns the comString.

getPort

public String getPort()

Returns:

Returns the port.

setPort

public void setPort(String port)

Parameters:

port - The port to set.

setResponseTimeOut

public void setResponseTimeOut(String responseTimeOut)

Parameters:

responseTimeOut - The responseTimeOut to set.

getResponseTimeOut

public String getResponseTimeOut()

Returns:

Returns the responseTimeOut.

setConnectionTimeOut

public void setConnectionTimeOut(String connectionTimeOut)

Parameters:

connectionTimeOut - The connectionTimeOut to set.

getConnectionTimeOut

public String getConnectionTimeOut()

Returns:

Returns the connectionTimeOut.

execute

public Result execute(Result previousResult,
                      int nr)

Description copied from interface: JobEntryInterface

Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.

Specified by:

execute in interface JobEntryInterface

Parameters:

previousResult - the previous result

nr - the number of rows

Returns:

the Result object from execution of this job entry

evaluates

public boolean evaluates()

Description copied from class: JobEntryBase

This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

Specified by:

evaluates in interface JobEntryInterface

Overrides:

evaluates in class JobEntryBase

Returns:

false

getResourceDependencies

public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

Description copied from class: JobEntryBase

Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.

Specified by:

getResourceDependencies in interface JobEntryInterface

Overrides:

getResourceDependencies in class JobEntryBase

Returns:

an empty list of ResourceReferences

See Also:

ResourceReference

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

Description copied from class: JobEntryBase

Allows JobEntry objects to check themselves for consistency

Specified by:

check in interface JobEntryInterface

Overrides:

check in class JobEntryBase

Parameters:

remarks - List of CheckResult objects indicating consistency status

jobMeta - the metadata object for the job entry

space - the variable space to resolve string expressions with variables with

repository - the repository to load Kettle objects from

metaStore - the MetaStore to load common elements from