JmxEtlManagerMBean


1   /*
2    * Copyright 2006-2007 The Scriptella Project Team.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package scriptella.execution;
17  
18  import java.util.Date  ;
19  
20  /**
21   * JMX MBean interface for ETL task.
22   * <p>This interface specifies attributes and operations available via JMX.
23   * <p>The ETL mbeans have the following naming convention:
24   * <code>
25   * <pre>
26   * scriptella:type=etl,url=&lt;ETL_XML_FILE_URL&gt;[,n=&lt;COLLISION_ID&gt;]
27   * </pre>
28   * The collision ID is appended only if the same file is executed simultaneously.
29   * </code>
30   *
31   *
32   * @author Fyodor Kupolov
33   * @version 1.0
34   */
35  public interface JmxEtlManagerMBean {
36      /**
37       * Returns the number of executed statements by all connections of the ETL task.
38       * @return non-negative number of executed statements.
39       */
40      long getExecutedStatementsCount();
41  
42      /**
43       * Returns the date/time when ETL was started.
44       * @return date/time.
45       */
46      Date   getStartDate();
47  
48      /**
49       * Returns the throughput of the managed ETL task.
50       * @return statements/sec throughput or 0 if undefined.
51       */
52      double getThroughput();
53  
54      /**
55       * Cancels the managed ETL task.
56       */
57      void cancel();
58  }
59
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags