EmbeddorMBean


1   /*
2    * Copyright (C) The Apache Software Foundation. All rights reserved.
3    *
4    * This software is published under the terms of the Apache Software License
5    * version 1.1, a copy of which has been included with this distribution in
6    * the LICENSE.txt file.
7    */
8   package org.apache.avalon.phoenix.interfaces;
9   
10  import java.util.Date  ;
11  
12  /**
13   * This is the interface via which the Management interface interacts
14   * with the Embeddor.
15   *
16   * @phoenix:mx-topic name="Embeddor"
17   *
18   * @author <a HREF="peter at apache.org">Peter Donald</a>
19   */
20  public interface EmbeddorMBean
21  {
22      String   ROLE = EmbeddorMBean.class.getName();
23  
24      /**
25       * Get name by which the server is known.
26       * Usually this defaults to "Phoenix" but the admin
27       * may assign another name. This is useful when you
28       * are managing a cluster of Phoenix servers.
29       *
30       * @phoenix:mx-attribute
31       * @phoenix:mx-description Name by which this server is known.
32       *
33       * @return the name of server
34       */
35      String   getName();
36  
37      /**
38       * Get location of Phoenix installation
39       *
40       * @phoenix:mx-attribute
41       *
42       * @return the home directory of phoenix
43       */
44      String   getHomeDirectory();
45  
46      /**
47       * Get the date at which this server started.
48       *
49       * @phoenix:mx-attribute
50       *
51       * @return the date at which this server started
52       */
53      Date   getStartTime();
54  
55      /**
56       * Retrieve the number of millisecond
57       * the server has been up.
58       *
59       * @phoenix:mx-attribute
60       *
61       * @return the the number of millisecond the server has been up
62       */
63      long getUpTimeInMillis();
64  
65      /**
66       * Retrieve a string identifying version of server.
67       * Usually looks like "v4.0.1a".
68       *
69       * @phoenix:mx-attribute
70       * @phoenix:mx-description Retrieve a string identifying version of server.
71       *
72       * @return version string of server.
73       */
74      String   getVersion();
75  
76      /**
77       * Get a string defining the build.
78       * Possibly the date on which it was built, where it was built,
79       * with what features it was built and so forth.
80       *
81       * @phoenix:mx-attribute
82       *
83       * @return the string describing build
84       */
85      String   getBuild();
86  
87      /**
88       * Request the Embeddor shutsdown.
89       *
90       * @phoenix:mx-operation
91       */
92      void shutdown();
93  
94      /**
95       * Request the embeddor to restart.
96       *
97       * @phoenix:mx-operation
98       *
99       * @throws UnsupportedOperationException if restart not a supported operation
100      */
101     void restart()
102         throws UnsupportedOperationException  ;
103 }
104
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags