Package org.pentaho.di.job.entries.snmptrap

Class JobEntrySNMPTrap

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.snmptrap.JobEntrySNMPTrap

All Implemented Interfaces:

Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.logging.LoggingObjectLifecycleInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntrySNMPTrap
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines an SNMPTrap job entry.

Since:

05-11-2003

Author:

Matt

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PORT	Default port
static String[]	target_type_Code
static String[]	target_type_Desc

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

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

Constructor Summary

Constructors

Constructor	Description
JobEntrySNMPTrap()
JobEntrySNMPTrap(String n)

Method Summary

Modifier and Type	Method	Description
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.
org.pentaho.di.core.Result	execute(org.pentaho.di.core.Result previousResult, int nr)	Execute the job entry.
String	getComString()
String	getEngineID()
String	getMessage()
String	getOID()
String	getPassPhrase()
String	getPort()
String	getRetry()
String	getServerName()
String	getTargetType()
String	getTargetTypeCode(String tt)
String	getTargetTypeDesc(String tt)
String	getTimeout()
String	getUser()
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, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.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<org.pentaho.di.core.database.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, org.pentaho.di.repository.ObjectId id_job)	This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
void	setComString(String comString)
void	setEngineID(String engineid)
void	setMessage(String message)
void	setOID(String oid)
void	setPassPhrase(String passphrase)
void	setPort(String port)
void	setRetry(String nrretry)
void	setServerName(String serverName)
void	setTargetType(String targettypein)
void	setTimeout(String timeout)
void	setUser(String user)

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

addDatetimeToFilename, check, 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, getResourceDependencies, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariables, hasChanged, hashCode, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isLoggingObjectInUse, 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, setLoggingObjectInUse, 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, check, clear, exportResources, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getParentJobMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getResourceDependencies, 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

Methods inherited from interface org.pentaho.di.core.logging.LoggingObjectLifecycleInterface

callAfterLog, callBeforeLog

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace

environmentSubstitute

Field Detail

DEFAULT_PORT

public static int DEFAULT_PORT

Default port

target_type_Desc

public static final String[] target_type_Desc

target_type_Code

public static final String[] target_type_Code

Constructor Detail

JobEntrySNMPTrap

public JobEntrySNMPTrap(String n)

JobEntrySNMPTrap

public JobEntrySNMPTrap()

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

getTargetTypeDesc

public String getTargetTypeDesc(String tt)

getTargetTypeCode

public String getTargetTypeCode(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<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.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.

getOID

public String getOID()

Returns:

Returns the OID.

setOID

public void setOID(String oid)

Parameters:

serverName - The oid to set.

getComString

public String getComString()

Returns:

Returns the comString.

setComString

public void setComString(String comString)

Parameters:

comString - The comString to set.

setUser

public void setUser(String user)

Parameters:

user - The user to set.

getUser

public String getUser()

Returns:

Returns the user.

setPassPhrase

public void setPassPhrase(String passphrase)

Parameters:

user - The passphrase to set.

getPassPhrase

public String getPassPhrase()

Returns:

Returns the passphrase.

setEngineID

public void setEngineID(String engineid)

Parameters:

user - The engineid to set.

getEngineID

public String getEngineID()

Returns:

Returns the engineid.

getTargetType

public String getTargetType()

setTargetType

public void setTargetType(String targettypein)

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.

setTimeout

public void setTimeout(String timeout)

Parameters:

timeout - The timeout to set.

getTimeout

public String getTimeout()

Returns:

Returns the timeout.

setRetry

public void setRetry(String nrretry)

Parameters:

nrretry - The nrretry to set.

getRetry

public String getRetry()

Returns:

Returns the nrretry.

execute

public org.pentaho.di.core.Result execute(org.pentaho.di.core.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