DatabasePersistencePlugin


1   /*
2    * JBoss, Home of Professional Open Source
3    * Copyright 2005, JBoss Inc., and individual contributors as indicated
4    * by the @authors tag. See the copyright.txt in the distribution for a
5    * full listing of individual contributors.
6    *
7    * This is free software; you can redistribute it and/or modify it
8    * under the terms of the GNU Lesser General Public License as
9    * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22  package org.jboss.ejb.txtimer;
23  
24  // $Id: DatabasePersistencePlugin.java 38205 2005-11-17 22:16:37Z dimitris $
25  
26  import javax.management.MBeanServer  ;
27  import javax.management.ObjectName  ;
28  import java.io.Serializable  ;
29  import java.sql.SQLException  ;
30  import java.util.Date  ;
31  import java.util.List  ;
32  
33  /**
34   * An implementation of of this interface provides database specific JDBC access that is
35   * not portable accros RDBMS systems.
36   *
37   * @author Thomas.Diesler@jboss.org
38   * @version $Revision: 38205 $
39   * @since 23-Sep-2004
40   */
41  public interface DatabasePersistencePlugin
42  {
43     /** Initialize the plugin */
44     void init(MBeanServer   server, ObjectName   dataSource) throws SQLException  ;
45  
46     /** Create the timers table if it does not exist already */
47     void createTableIfNotExists() throws SQLException  ;
48  
49     /** Insert a timer object */
50     void insertTimer(String   timerId, TimedObjectId timedObjectId, Date   initialExpiration, long intervalDuration, Serializable   info) throws SQLException  ;
51  
52     /** Select a list of currently persisted timer handles
53      * @return List<TimerHandleImpl>
54      */
55     List   selectTimers(ObjectName   containerId) throws SQLException  ;
56  
57     /** Delete a timer. */
58     void deleteTimer(String   timerId, TimedObjectId timedObjectId) throws SQLException  ;
59  
60     /** Clear all persisted timers */
61     void clearTimers() throws SQLException  ;
62  
63     /** Get the timer table name */
64     String   getTableName();
65  
66     /** Get the timer ID column name */
67     String   getColumnTimerID();
68  
69     /** Get the target ID column name */
70     String   getColumnTargetID();
71  
72     /** Get the initial date column name */
73     String   getColumnInitialDate();
74  
75     /** Get the timer interval column name */
76     String   getColumnTimerInterval();
77  
78     /** Get the instance PK column name */
79     String   getColumnInstancePK();
80  
81     /** Get the info column name */
82     String   getColumnInfo();
83  }
84  
85
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags