You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by hu...@apache.org on 2002/08/07 04:57:15 UTC
cvs commit: jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces EmbeddorMBean.java KernelMBean.java Kernel.java ApplicationMBean.java ExtensionManagerMBean.java DeployerMBean.java
huw 2002/08/06 19:57:15
Modified: src/java/org/apache/avalon/phoenix/interfaces
EmbeddorMBean.java KernelMBean.java Kernel.java
ApplicationMBean.java ExtensionManagerMBean.java
DeployerMBean.java
Log:
Added phoenix-mx tags to provide management metainfo.
Revision Changes Path
1.8 +18 -0 jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/EmbeddorMBean.java
Index: EmbeddorMBean.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/EmbeddorMBean.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- EmbeddorMBean.java 6 Aug 2002 11:57:41 -0000 1.7
+++ EmbeddorMBean.java 7 Aug 2002 02:57:15 -0000 1.8
@@ -13,6 +13,8 @@
* This is the interface via which the Management interface interacts
* with the Embeddor.
*
+ * @phoenix:mx-topic name="Embeddor"
+ *
* @author <a href="peter at apache.org">Peter Donald</a>
*/
public interface EmbeddorMBean
@@ -25,6 +27,8 @@
* may assign another name. This is useful when you
* are managing a cluster of Phoenix servers.
*
+ * @phoenix:mx-attribute
+ *
* @return the name of server
*/
String getName();
@@ -32,6 +36,8 @@
/**
* Get location of Phoenix installation
*
+ * @phoenix:mx-attribute
+ *
* @return the home directory of phoenix
*/
String getHomeDirectory();
@@ -39,6 +45,8 @@
/**
* Get the date at which this server started.
*
+ * @phoenix:mx-attribute
+ *
* @return the date at which this server started
*/
Date getStartTime();
@@ -47,6 +55,8 @@
* Retrieve the number of millisecond
* the server has been up.
*
+ * @phoenix:mx-attribute
+ *
* @return the the number of millisecond the server has been up
*/
long getUpTimeInMillis();
@@ -55,6 +65,8 @@
* Retrieve a string identifying version of server.
* Usually looks like "v4.0.1a".
*
+ * @phoenix:mx-attribute
+ *
* @return version string of server.
*/
String getVersion();
@@ -64,17 +76,23 @@
* Possibly the date on which it was built, where it was built,
* with what features it was built and so forth.
*
+ * @phoenix:mx-attribute
+ *
* @return the string describing build
*/
String getBuild();
/**
* Request the Embeddor shutsdown.
+ *
+ * @phoenix:mx-operation
*/
void shutdown();
/**
* Request the embeddor to restart.
+ *
+ * @phoenix:mx-operation
*
* @throws UnsupportedOperationException if restart not a supported operation
*/
1.5 +16 -0 jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/KernelMBean.java
Index: KernelMBean.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/KernelMBean.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- KernelMBean.java 6 Aug 2002 11:57:41 -0000 1.4
+++ KernelMBean.java 7 Aug 2002 02:57:15 -0000 1.5
@@ -11,14 +11,30 @@
* This is the interface via which you can manager
* the root container of Applications.
*
+ * @phoenix:mx-topic name="Kernel"
+ *
* @author <a href="mailto:peter at apache.org">Peter Donald</a>
*/
public interface KernelMBean
{
String ROLE = KernelMBean.class.getName();
+ /**
+ * Gets the list of applications running in the container
+ *
+ * @phoenix:mx-attribute
+ *
+ * @return applicationNames The array of application names
+ */
String[] getApplicationNames();
+ /**
+ * Removes the application from the container
+ *
+ * @phoenix:mx-operation
+ *
+ * @param name the name of application to remove
+ */
void removeApplication( String name )
throws Exception;
}
1.13 +19 -0 jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/Kernel.java
Index: Kernel.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/Kernel.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Kernel.java 6 Aug 2002 11:57:41 -0000 1.12
+++ Kernel.java 7 Aug 2002 02:57:15 -0000 1.13
@@ -18,16 +18,35 @@
{
String ROLE = Kernel.class.getName();
+ /**
+ * Adds an application to the container
+ */
void addApplication( SarMetaData metaData,
ClassLoader classLoader,
Logger hierarchy,
Configuration server )
throws Exception;
+ /**
+ * Removes the application from the container
+ *
+ * @param name the name of application to remove
+ */
void removeApplication( String name )
throws Exception;
+
+ /**
+ * Gets the named application
+ *
+ * @param name the name of application
+ */
Application getApplication( String name );
+ /**
+ * Gets the list of applications running in the container
+ *
+ * @return applicationNames The array of application names
+ */
String[] getApplicationNames();
}
1.8 +20 -0 jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/ApplicationMBean.java
Index: ApplicationMBean.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/ApplicationMBean.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ApplicationMBean.java 6 Aug 2002 11:57:41 -0000 1.7
+++ ApplicationMBean.java 7 Aug 2002 02:57:15 -0000 1.8
@@ -11,6 +11,8 @@
* This is the interface via which you can manager
* the root container of Applications.
*
+ * @phoenix:mx-topic name="Application"
+ *
* @author <a href="mailto:peter at apache.org">Peter Donald</a>
* @author <a href="mailto:leosimons@apache.org">Leo Simons</a>
*/
@@ -21,6 +23,8 @@
/**
* Get the name of the application.
*
+ * @phoenix:mx-attribute
+ *
* @return the name of the application
*/
String getName();
@@ -28,6 +32,8 @@
/**
* Get the name to display in Management UI.
*
+ * @phoenix:mx-attribute
+ *
* @return the name of the application to display in UI
*/
String getDisplayName();
@@ -35,6 +41,8 @@
/**
* Get the string used to describe the application in the UI.
*
+ * @phoenix:mx-attribute
+ *
* @return a short description of the application
*/
String getDescription();
@@ -42,6 +50,8 @@
/**
* Get location of Application installation
*
+ * @phoenix:mx-attribute
+ *
* @return the home directory of application
*/
String getHomeDirectory();
@@ -49,6 +59,8 @@
/**
* Get the names of the blocks that compose this Application
*
+ * @phoenix:mx-attribute
+ *
* @return list of block names
*/
String[] getBlockNames();
@@ -57,6 +69,8 @@
* Return true if the application is
* running or false otherwise.
*
+ * @phoenix:mx-attribute
+ *
* @return true if application is running, false otherwise
*/
boolean isRunning();
@@ -66,6 +80,8 @@
* This is only valid when isRunning() returns false,
* otherwise it will generate an IllegalStateException.
*
+ * @phoenix:mx-operation
+ *
* @throws IllegalStateException if application is already running
* @throws ApplicationException if the application failed to start.
* the message part of exception will contain more information
@@ -81,6 +97,8 @@
* This is equivelent to calling stop() and then start()
* in succession.
*
+ * @phoenix:mx-operation
+ *
* @throws IllegalStateException if application is not already running
* @throws ApplicationException if the application failed to stop or start.
* the message part of exception will contain more information
@@ -93,6 +111,8 @@
* Stop the application running.
* This is only valid when isRunning() returns true,
* otherwise it will generate an IllegalStateException.
+ *
+ * @phoenix:mx-operation
*
* @throws IllegalStateException if application is not already running
* @throws ApplicationException if the application failed to shutdown.
1.6 +6 -1 jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/ExtensionManagerMBean.java
Index: ExtensionManagerMBean.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/ExtensionManagerMBean.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ExtensionManagerMBean.java 6 Aug 2002 11:57:41 -0000 1.5
+++ ExtensionManagerMBean.java 7 Aug 2002 02:57:15 -0000 1.6
@@ -12,6 +12,8 @@
/**
* Management interface to ExtensionManager.
*
+ * @phoenix:mx-topic name="ExtensionManager"
+ *
* @author <a href="mailto:peter at apache.org">Peter Donald</a>
* @version $Revision$ $Date$
*/
@@ -25,6 +27,8 @@
* in which the ExtensionManager will look
* for Extensions.
*
+ * @phoenix:mx-attribute
+ *
* @return the list of paths to search in
*/
File[] getPaths();
@@ -34,6 +38,7 @@
* to discover new Extensions that have been added
* or remove old Extensions that have been removed.
*
+ * @phoenix:mx-operation
*/
void rescanPath();
1.2 +7 -1 jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/DeployerMBean.java
Index: DeployerMBean.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/DeployerMBean.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DeployerMBean.java 26 Mar 2002 11:03:18 -0000 1.1
+++ DeployerMBean.java 7 Aug 2002 02:57:15 -0000 1.2
@@ -13,6 +13,8 @@
* MBean Interface for the Deployer to use the deploy
* feature in the HmtlAdaptor
*
+ * @phoenix:mx-topic name="Deployer"
+ *
* @author <a href="mailto:bauer@denic.de">Joerg Bauer</a>
* @see Deployer
*/
@@ -22,6 +24,8 @@
/**
* Deploy an installation.
+
+ * @phoenix:mx-operation
*
* @param name the name of deployment
* @param sarURL the installation to deploy
@@ -45,7 +49,9 @@
throws DeploymentException;
/**
- * undeploy a resource from a location.
+ * Undeploy a resource from a location.
+ *
+ * @phoenix:mx-operation
*
* @param name the name of deployment
* @throws DeploymentException if an error occurs
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>