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

java.lang.Object
  extended by org.pentaho.di.job.entry.JobEntryBase
      extended by org.pentaho.di.job.entries.snmptrap.JobEntrySNMPTrap
All Implemented Interfaces:
Cloneable, CheckResultSourceInterface, LoggingObjectInterface, 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
static int DEFAULT_PORT
          Default port
static String[] target_type_Code
           
static String[] target_type_Desc
           
 
Constructor Summary
JobEntrySNMPTrap()
           
JobEntrySNMPTrap(String n)
           
 
Method Summary
 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 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, 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)
          This method is called by PDI whenever a job entry needs to read its settings from XML.
 void saveRep(Repository rep, 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
check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getRegistrationDate, getRepository, getRepositoryDirectory, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, setChanged, setChanged, setContainerObjectId, setDescription, setID, setLogLevel, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface
check, clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getRealFilename, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, isUnconditional, lookupRepositoryReferences, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository
 

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<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             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
Parameters:
entrynode - the top-level XML node
databases - the list of databases
slaveServers - the list of slave servers
rep - the repository object
Throws:
KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. For JobEntryBase, this method performs no operations.

Specified by:
loadRep in interface JobEntryInterface
Overrides:
loadRep in class JobEntryBase
Parameters:
rep - the repository object
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,
                    ObjectId id_job)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. For JobEntryBase, this method performs no operations

Specified by:
saveRep in interface JobEntryInterface
Overrides:
saveRep in class JobEntryBase
Parameters:
rep - the repository object
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.

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 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