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 String

ROLE

Method Summary

String	getBuild() Get a string defining the build.
String	getHomeDirectory() Get location of Phoenix installation
String	getName() Get name by which the server is known.
Date	getStartTime() Get the date at which this server started.
long	getUpTimeInMillis() Retrieve the number of millisecond the server has been up.
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 String ROLE

Method Detail

getName

public 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 String getHomeDirectory()

Get location of Phoenix installation

Returns:

the home directory of phoenix

getStartTime

public 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 String getVersion()

Retrieve a string identifying version of server. Usually looks like "v4.0.1a".

Returns:

version string of server.

getBuild

public 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 UnsupportedOperationException

Request the embeddor to restart.

Throws:

UnsupportedOperationException - if restart not a supported operation