org.apache.avalon.phoenix.interfaces
Interface EmbeddorMBean

All Known Implementing Classes:
DefaultEmbeddor

public interface EmbeddorMBean

This is the interface via which the Management interface interacts with the Embeddor.

Author:
Peter Donald

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 java.lang.String getBuild()
          Get a string defining the build.
 java.lang.String getHomeDirectory()
          Get location of Phoenix installation
 java.lang.String getName()
          Get name by which the server is known.
 java.util.Date getStartTime()
          Get the date at which this server started.
 long getUpTimeInMillis()
          Retrieve the number of millisecond the server has been up.
 java.lang.String getVersion()
          Retrieve a string identifying version of server.
 void restart()
          Request the embeddor to restart.
 void shutdown()
          Request the Embeddor shutsdown.
 

Field Detail

ROLE

public static final java.lang.String ROLE
Method Detail

getName

public java.lang.String getName()
Get name by which the server is known. Usually this defaults to "Phoenix" but the admin may assign another name. This is useful when you are managing a cluster of Phoenix servers.

Returns:
the name of server

getHomeDirectory

public java.lang.String getHomeDirectory()
Get location of Phoenix installation

Returns:
the home directory of phoenix

getStartTime

public java.util.Date getStartTime()
Get the date at which this server started.

Returns:
the date at which this server started

getUpTimeInMillis

public long getUpTimeInMillis()
Retrieve the number of millisecond the server has been up.

Returns:
the the number of millisecond the server has been up

getVersion

public java.lang.String getVersion()
Retrieve a string identifying version of server. Usually looks like "v4.0.1a".

Returns:
version string of server.

getBuild

public java.lang.String getBuild()
Get a string defining the build. Possibly the date on which it was built, where it was built, with what features it was built and so forth.

Returns:
the string describing build

shutdown

public void shutdown()
Request the Embeddor shutsdown.


restart

public void restart()
             throws java.lang.UnsupportedOperationException
Request the embeddor to restart.

Throws:
java.lang.UnsupportedOperationException - if restart not a supported operation


Copyright © 2001 Apache Jakarta Project. All Rights Reserved.