Java Doc for Job.java in » Groupware » hipergate » com » knowgate » scheduler » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Groupware » hipergate » com.knowgate.scheduler

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

com.knowgate.dataobjs .DBPersist

com.knowgate.scheduler .Job

All known Subclasses:   com.knowgate.scheduler.jobs .MimeSender,  com.knowgate.scheduler.jobs .FTPPublisher,  com.knowgate.scheduler.jobs .FileDumper,  com.knowgate.scheduler.jobs .FaxSender,  com.knowgate.scheduler.jobs .DummyJob,  com.knowgate.scheduler.jobs .EmailSender,
Job
abstract public class Job extends DBPersist (Code)

Abstract base class for Job Commands Implementations

author:
   Sergio Montoro Ten
version:
   2.2

Field Summary
final public static short STATUS_ABORTED

final public static short STATUS_FINISHED

final public static short STATUS_INTERRUPTED

final public static short STATUS_PENDING

final public static short STATUS_RUNNING

final public static short STATUS_SUSPENDED

protected int iPendingAtoms


Constructor Summary
public Job()


Method Summary
public void abort(JDCConnection oConn)

public boolean delete(JDCConnection oConn)

public static boolean delete(JDCConnection oConn, String sJobId)

abstract public void free()

public DBBind getDataBaseBind()

public String getParameter(String sParamName)

public Properties getParameters()

public Properties getProperties()

public String getProperty(String sPropertyName)

Get Environment Property
Environment properties are readed from hipergate.cnf.
public static synchronized Job instantiate(JDCConnection oConn, String sJobId, Properties oEnvironmentProps)

public static synchronized Job instantiate(JDCConnection oConn, String sJobId, String sProfileName)

public boolean load(JDCConnection oConn, Object[] PKVals)

public void log(String sStr)

public File logFile()

public static void main(String[] argv)

public int pending()

abstract public Object process(Atom oAtm)

Process an atom
Concrete atom processing implementation must be provided by each derived subclass.
public void resolveAtomsEMails(JDCConnection oConn)

public void setDataBaseBind(DBBind oDbb)

public void setStatus(JDCConnection oConn, int iStatus)

Set Job Status
If Status if set to Job.STATUS_FINISHED then dt_finished is set to current system date.
public boolean store(JDCConnection oConn)


Field Detail
STATUS_ABORTED
final public static short STATUS_ABORTED(Code)

STATUS_FINISHED
final public static short STATUS_FINISHED(Code)

STATUS_INTERRUPTED
final public static short STATUS_INTERRUPTED(Code)

STATUS_PENDING
final public static short STATUS_PENDING(Code)

STATUS_RUNNING
final public static short STATUS_RUNNING(Code)

STATUS_SUSPENDED
final public static short STATUS_SUSPENDED(Code)

iPendingAtoms
protected int iPendingAtoms(Code)

Constructor Detail
Job
public Job()(Code)

Method Detail
abort
public void abort(JDCConnection oConn) throws SQLException, IllegalStateException(Code)

delete
public boolean delete(JDCConnection oConn) throws SQLException(Code)

Delete Job

Parameters:
  oConn - Database Connection
throws:
  SQLException -

delete
public static boolean delete(JDCConnection oConn, String sJobId) throws SQLException(Code)

Delete Job
Call k_sp_del_job stored procedure
Parameters:
  oConn - Database Connection
Parameters:
  sJobId - GUID of Job to be deleted
throws:
  SQLException -

free
abstract public void free()(Code)

This method must free all the resource allocated by a Job

getDataBaseBind
public DBBind getDataBaseBind()(Code)
Get database binding for this Job DBBind

getParameter
public String getParameter(String sParamName)(Code)

Get parameter extracted from tx_parameter field

Parameters:
  sParamName - Parameter Name Parameter Value or null if not found

getParameters
public Properties getParameters()(Code)

Get parameters extracted from tx_parameter field
Parameters as a java.util.Properties object

getProperties
public Properties getProperties()(Code)
Get Environment Properties Collection

getProperty
public String getProperty(String sPropertyName)(Code)

Get Environment Property
Environment properties are readed from hipergate.cnf.
Parameters:
  sPropertyName -

instantiate
public static synchronized Job instantiate(JDCConnection oConn, String sJobId, Properties oEnvironmentProps) throws ClassNotFoundException, IllegalAccessException, SQLException, InstantiationException, FileNotFoundException(Code)

Create an instance of a Job subclass

The new object class name will be readed form k_jobs.nm_class field.

Parameters:
  oConn - Database Connection
Parameters:
  sJobId - GUID of Job to be deleted
Parameters:
  oEnvironmentProps - Environment properties taken from hipergate.cnf Reference to Instantiated Object
throws:
  FileNotFoundException - If any directory for Job log file could not be created
throws:
  ClassNotFoundException - If no class with name k_jobs.nm_class was found
throws:
  IllegalAccessException -
throws:
  InstantiationException -
throws:
  SQLException -

instantiate
public static synchronized Job instantiate(JDCConnection oConn, String sJobId, String sProfileName) throws ClassNotFoundException, IllegalAccessException, SQLException, InstantiationException, FileNotFoundException(Code)

Create an instance of a Job subclass

The new object class name will be readed form k_jobs.nm_class field.

Parameters:
  oConn - Database Connection
Parameters:
  sJobId - GUID of Job to be deleted
Parameters:
  sProfileName - Name without .cnf extension of the properties file to use Reference to Instantiated Object
throws:
  FileNotFoundException - If any directory for Job log file could not be created
throws:
  ClassNotFoundException - If no class with name k_jobs.nm_class was found
throws:
  IllegalAccessException -
throws:
  InstantiationException -
throws:
  SQLException -

load
public boolean load(JDCConnection oConn, Object[] PKVals) throws SQLException(Code)

Load Job

Parameters:
  oConn - Database Connection
Parameters:
  PKVals - An Array with a single element containing the Job GUID
throws:
  SQLException -

log
public void log(String sStr)(Code)

Write Line to Job Log File

Parameters:
  sStr - Line to be written

logFile
public File logFile()(Code)

Get reference to Job log file
Job log file is placed at /storage/jobs/gu_workarea/ Reference to Job Log File Object

main
public static void main(String[] argv) throws SQLException, org.xml.sax.SAXException, java.io.IOException, ClassNotFoundException, IllegalAccessException, InstantiationException(Code)

pending
public int pending()(Code)

Count of atoms pending of processing for this Job
This count is decremented upon each successfull call to process() method

process
abstract public Object process(Atom oAtm) throws SQLException, FileNotFoundException, IOException, MessagingException, NullPointerException(Code)

Process an atom
Concrete atom processing implementation must be provided by each derived subclass.
Parameters:
  oAtm - Atom to be processed Custom subclass defined Object
throws:
  SQLException -
throws:
  FileNotFoundException -
throws:
  IOException -
throws:
  MessagingException -
throws:
  NullPointerException -

resolveAtomsEMails
public void resolveAtomsEMails(JDCConnection oConn) throws SQLException(Code)

Fills atoms data from their e-mails
This method call k_sp_resolve_atoms stored procedure which takes each atom mail address and looks it up at k_member_address table for completing name surname and other personalization data embedded into each atom's record
Parameters:
  oConn - JDCConnection
throws:
  SQLException -

setDataBaseBind
public void setDataBaseBind(DBBind oDbb)(Code)
Assign a database binding to the Job
Parameters:
  oDbb - DBBind

setStatus
public void setStatus(JDCConnection oConn, int iStatus) throws SQLException(Code)

Set Job Status
If Status if set to Job.STATUS_FINISHED then dt_finished is set to current system date.
Parameters:
  oConn - Database Connection
Parameters:
  iStatus - Job Status
Status
STATUS_ABORTED (-1)
STATUS_FINISHED (0)
STATUS_PENDING (1)
STATUS_SUSPENDED (2)
STATUS_RUNNING (3)

throws:
  SQLException -

store
public boolean store(JDCConnection oConn) throws SQLException(Code)

Store Job
By default jobs are created with id_status=STATUS_PENDING
Parameters:
  oConn - Database Connection
throws:
  SQLException -

Fields inherited from com.knowgate.dataobjs.DBPersist
protected HashMap AllVals(Code)(Java Doc)
protected String sAuditCls(Code)(Java Doc)
protected String sAuditUsr(Code)(Java Doc)
protected String sTransactId(Code)(Java Doc)

Methods inherited from com.knowgate.dataobjs.DBPersist
public void allcaps(boolean bAllValuesUpperCase)(Code)(Java Doc)
public boolean allcaps()(Code)(Java Doc)
protected HashMap changelog(DBPersist oOldInstance)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public void clone(DBPersist oSource)(Code)(Java Doc)
public boolean containsKey(Object oKey) throws NullPointerException(Code)(Java Doc)
public boolean containsValue(Object oKey)(Code)(Java Doc)
public boolean delete(JDCConnection oConn) throws SQLException(Code)(Java Doc)
public Set entrySet()(Code)(Java Doc)
public boolean exists(JDCConnection oConn) throws SQLException(Code)(Java Doc)
public Object get(String sKey)(Code)(Java Doc)
public Object get(Object oKey) throws NullPointerException(Code)(Java Doc)
public String getAuditClassName()(Code)(Java Doc)
public Date getCreationDate(JDCConnection oConn) throws SQLException(Code)(Java Doc)
public java.util.Date getDate(String sKey) throws ClassCastException(Code)(Java Doc)
public String getDateFormated(String sKey, String sFormat) throws ClassCastException(Code)(Java Doc)
public String getDateShort(String sKey) throws ClassCastException(Code)(Java Doc)
public String getDateTime(String sKey)(Code)(Java Doc)
public String getDateTime24(String sKey)(Code)(Java Doc)
public BigDecimal getDecimal(String sKey) throws ClassCastException, NumberFormatException(Code)(Java Doc)
public String getDecimalFormated(String sKey, String sPattern) throws ClassCastException, NumberFormatException, NullPointerException, IllegalArgumentException(Code)(Java Doc)
public double getDouble(String sKey) throws NullPointerException, NumberFormatException(Code)(Java Doc)
public String getDoubleFormated(String sKey, String sPattern) throws ClassCastException, NumberFormatException, NullPointerException, IllegalArgumentException(Code)(Java Doc)
public float getFloat(String sKey) throws NullPointerException, NumberFormatException(Code)(Java Doc)
public String getFloatFormated(String sKey, String sPattern) throws ClassCastException, NumberFormatException, NullPointerException, IllegalArgumentException(Code)(Java Doc)
public int getInt(String sKey) throws NullPointerException, NumberFormatException(Code)(Java Doc)
public Integer getInteger(String sKey) throws NumberFormatException(Code)(Java Doc)
public int getIntervalPart(String sKey, String sPart) throws NullPointerException, NumberFormatException, IllegalArgumentException(Code)(Java Doc)
public HashMap getItemMap()(Code)(Java Doc)
public Set getItems()(Code)(Java Doc)
public Money getMoney(String sKey) throws NumberFormatException(Code)(Java Doc)
public java.sql.Date getSQLDate(String sKey) throws ClassCastException(Code)(Java Doc)
public Time getSQLTime(String sKey) throws ClassCastException(Code)(Java Doc)
public short getShort(String sKey) throws java.lang.NullPointerException(Code)(Java Doc)
public String getString(String sKey) throws NullPointerException(Code)(Java Doc)
public String getStringNull(String sKey, String sDefault)(Code)(Java Doc)
public DBTable getTable()(Code)(Java Doc)
public DBTable getTable(JDCConnection oConn) throws SQLException, IllegalStateException(Code)(Java Doc)
public String getTableName()(Code)(Java Doc)
public String getTime(String sKey) throws ClassCastException(Code)(Java Doc)
public Time getTimeOfDay(String sKey)(Code)(Java Doc)
public Timestamp getTimestamp(String sKey)(Code)(Java Doc)
protected static String getUIdFromName(JDCConnection oConn, Integer iDomainId, String sInstanceNm, String sStoredProc) throws SQLException(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
public boolean isNull(String sKey)(Code)(Java Doc)
public Iterator iterator()(Code)(Java Doc)
public Set keySet()(Code)(Java Doc)
public boolean load(JDCConnection oConn, Object[] PKVals) throws SQLException(Code)(Java Doc)
public boolean load(JDCConnection oConn, String sKey) throws SQLException(Code)(Java Doc)
public void parseXML(String sXMLFilePath) throws SAXException, SAXNotRecognizedException, SAXNotSupportedException, SAXParseException, IOException, ClassNotFoundException, IllegalAccessException, InstantiationException(Code)(Java Doc)
public void put(String sKey, String sVal) throws NullPointerException(Code)(Java Doc)
public void put(String sKey, Object oObj) throws NullPointerException(Code)(Java Doc)
public Object put(Object sKey, Object oObj) throws NullPointerException(Code)(Java Doc)
public void put(String sKey, int iVal)(Code)(Java Doc)
public void put(String sKey, short iVal)(Code)(Java Doc)
public void put(String sKey, Date dtVal)(Code)(Java Doc)
public void put(String sKey, Time tmVal)(Code)(Java Doc)
public void put(String sKey, String sDate, SimpleDateFormat oPattern) throws ParseException(Code)(Java Doc)
public void put(String sKey, double dVal)(Code)(Java Doc)
public void put(String sKey, BigDecimal oDecVal)(Code)(Java Doc)
public void put(String sKey, String sDecVal, DecimalFormat oPattern) throws ParseException(Code)(Java Doc)
public void put(String sKey, float fVal)(Code)(Java Doc)
public void put(String sKey, Money mVal)(Code)(Java Doc)
public void put(String sKey, File oFile) throws FileNotFoundException(Code)(Java Doc)
public void put(String sKey, byte[] aBytes)(Code)(Java Doc)
public void put(String sKey, char[] aChars)(Code)(Java Doc)
public void put(String sKey, String sData, int iSQLType) throws FileNotFoundException, IllegalArgumentException, NullPointerException(Code)(Java Doc)
public void putAll(Properties oPropsCollection) throws FileNotFoundException(Code)(Java Doc)
public void putAll(Map oMap)(Code)(Java Doc)
public void remove(String sKey)(Code)(Java Doc)
public Object remove(Object oKey)(Code)(Java Doc)
public void replace(String sKey, Object oObj)(Code)(Java Doc)
public void replace(String sKey, int iVal)(Code)(Java Doc)
public void replace(String sKey, short iVal)(Code)(Java Doc)
public void replace(String sKey, float fVal)(Code)(Java Doc)
public void setAuditTransact(String sAuditTransact)(Code)(Java Doc)
public void setAuditUser(String sAuditUser)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public boolean store(JDCConnection oConn) throws SQLException(Code)(Java Doc)
public void toLowerCase(String sKey)(Code)(Java Doc)
public void toUpperCase(String sKey)(Code)(Java Doc)
protected String toXML(String sIdent, String sDelim, HashMap oAttrs) throws IllegalStateException(Code)(Java Doc)
public String toXML(String sIdent, String sDelim) throws IllegalStateException(Code)(Java Doc)
public String toXML(String sIdent)(Code)(Java Doc)
public String toXML()(Code)(Java Doc)
public Collection values()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.