org.xmlBlaster.engine.admin
Interface I_AdminNode

All Superinterfaces:

I_AdminUsage

All Known Subinterfaces:

RequestBrokerMBean

All Known Implementing Classes:

RequestBroker

public interface I_AdminNode
extends I_AdminUsage

Declares available methods of an xmlBlaster server instance for administration.

SNMP or telnet tools can access only the here declared properties.
This interface is implemented by RequestBroker.java, delivering the meat.

Since:

0.79f

Author:

xmlBlaster@marcelruff.info

Method Summary

java.lang.String	checkConsistency(java.lang.String fixIt, java.lang.String reportFileName) Do consistency check.
void	clearLastError() Clear the last exception text.
void	clearLastWarning() Clear the last warning text.
java.lang.String	displayClassInfo(java.lang.String clazzName) Check if the given java class is known and wherefrom it was loaded.
java.lang.String	dump() Dump the complete internal state of xmlBlaster.
java.lang.String	dumpAllStacks()
java.lang.String	dumpAllStacksToFile(java.lang.String file)
java.lang.String	dumpToFile(java.lang.String reportFileName)
void	exit() Shutdown xmlBlaster, exit value is '0'
java.lang.String[]	getAliveCallbackClients() Shows the clients which have a alive callback connection.
java.lang.String	getBuildJavaVendor() The java vendor of the compiler.
java.lang.String	getBuildJavaVersion() The compiler java version.
java.lang.String	getBuildTimestamp() Returns the date when xmlBlaster was compiled.
java.lang.String	getClientList() Deprecated. Please use getClients() instead
java.lang.String[]	getClients() Get the client names.
long	getFreeMem() Returns the current amount of free memory in the Java Virtual Machine.
java.lang.String	getFreeMemStr() Nicer to read for humans.
java.lang.String	getGc()
java.lang.String	getHostname() Access the bootstrap host name.
java.lang.String	getInstanceId() Unique id of the xmlBlaster server, changes on each restart.
java.lang.String	getLastError() Access the last logged error.
java.lang.String	getLastWarning() Access the last logged warning.
int	getMaxClients() Get the maximum allowed number of clients.
long	getMaxFreeMem() Returns the max.
java.lang.String	getMaxFreeMemStr() Nicer to read for humans.
long	getMaxMem() Returns the total amount of memory including what the Java virtual machine could additionally allocate.
java.lang.String	getMaxMemStr() Nicer to read for humans.
java.lang.String	getNodeId() Get my cluster node name.
java.lang.String	getNodeList() Deprecated. Please use getNodes() instead
java.lang.String[]	getNodes() Get the names of all known xmlBlaster cluster nodes.
int	getNumClients() How many clients instances are allocated.
long	getNumGet()
int	getNumNodes() Get the number of known cluster nodes.
long	getNumPublish()
int	getNumSubscriptions() Get the number of subscriptions.
int	getNumSysprop() Get the number of system properties.
int	getNumTopics() Get the number of topics.
long	getNumUpdate() The overall sent updates (callback to client)
int	getPort() Access the bootstrap port number.
java.lang.String	getRevisionNumber() Returns the xmlBlaster SVN version control revision number.
java.lang.String	getRunlevel() Access the current run level of xmlBlaster.
java.lang.String	getServerTimestamp() Access the current server time as a java.sql.Timestamp string.
long	getServerTimestampMillis() Returns the current server time in milliseconds.
java.lang.String	getStartupDate() Get date when xmlBlaster was started.
java.lang.String	getSubscriptionList() Deprecated. Please use getSubscriptions() instead
java.lang.String[]	getSubscriptions() Get the subscriptions ids.
java.lang.String	getSyspropList() Deprecated. Will be removed
java.lang.String	getTopicList() Deprecated. Please use getTopics() instead
java.lang.String[]	getTopics() Get the topics.
long	getTotalMem() Returns the current amount of memory in the Java virtual machine.
java.lang.String	getTotalMemStr() Nicer to read for humans.
long	getUptime() Get elapsed seconds since xmlBlaster started
long	getUsedMem()
java.lang.String	getUsedMemStr() Nicer to read for humans.
java.lang.String	getVersion() Get the xmlBlaster version number.
boolean	isAcceptWrongSenderAddress() Configure server with '-xmlBlaster/acceptWrongSenderAddress true' or "-xmlBlaster/acceptWrongSenderAddress/joe true".
java.lang.String	reportMemoryOverview()
java.lang.String	reportMemoryOverviewToFile(java.lang.String file)
void	setAcceptWrongSenderAddress(boolean acceptWrongSenderAddress)
void	setDump(java.lang.String fn) Dump the internal xmlBlaster state to the given file.
void	setExit(java.lang.String exitValue)
void	setGc(java.lang.String dummy)
void	setRunlevel(java.lang.String level) Change the run level of xmlBlaster.

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage

getUsageUrl, setUsageUrl, usage

Method Detail

getNumNodes

int getNumNodes()

Get the number of known cluster nodes.

Returns:

The number of xmlBlaster cluster nodes

getNodeList

java.lang.String getNodeList()

Deprecated. Please use getNodes() instead

Get the names of all known xmlBlaster cluster nodes.

Returns:

A comma separated list of cluster node names

getNodes

java.lang.String[] getNodes()

Get the names of all known xmlBlaster cluster nodes.

Returns:

A comma separated list of cluster node names

getNodeId

java.lang.String getNodeId()

Get my cluster node name.

Returns:

My cluster wide unique name

getInstanceId

java.lang.String getInstanceId()

Unique id of the xmlBlaster server, changes on each restart. If 'node/heron' is restarted, the instanceId changes.

Returns:

nodeId + timestamp, '/node/heron/instanceId/33470080380'

getVersion

java.lang.String getVersion()

Get the xmlBlaster version number.

Returns:

For example "1.0.4"

getRevisionNumber

java.lang.String getRevisionNumber()

Returns the xmlBlaster SVN version control revision number.

Returns:

The subversion revision number of the monitored instance, for example "13593"

getBuildTimestamp

java.lang.String getBuildTimestamp()

Returns the date when xmlBlaster was compiled.

Returns:

For example "07/28/2005 03:47 PM"

getBuildJavaVendor

java.lang.String getBuildJavaVendor()

The java vendor of the compiler.

Returns:

For example "Sun Microsystems Inc."

getBuildJavaVersion

java.lang.String getBuildJavaVersion()

The compiler java version.

Returns:

For example "1.5.0"

dump

java.lang.String dump()
                      throws XmlBlasterException

Dump the complete internal state of xmlBlaster. Is an operation to not do it automatically on JMX load

Throws:

XmlBlasterException

setDump

void setDump(java.lang.String fn)
             throws XmlBlasterException

Dump the internal xmlBlaster state to the given file.

deprecated, use #dumpToFile(String, String) which uses OutputStream

Parameters:

fn - The complete path and file name

Throws:

XmlBlasterException

dumpToFile

java.lang.String dumpToFile(java.lang.String reportFileName)

Parameters:

reportFileName - e.g. "/tmp/x.xml"

Returns:

getRunlevel

java.lang.String getRunlevel()

Access the current run level of xmlBlaster.

Returns:

0 is halted and 9 is fully operational

setRunlevel

void setRunlevel(java.lang.String level)
                 throws XmlBlasterException

Change the run level of xmlBlaster.

Parameters:

0 - is halted and 9 is fully operational

Throws:

XmlBlasterException

getServerTimestampMillis

long getServerTimestampMillis()

Returns the current server time in milliseconds. For an accuracy discussion please consult System.currentTimeMillis

Returns:

For example 1111400317333

getServerTimestamp

java.lang.String getServerTimestamp()

Access the current server time as a java.sql.Timestamp string.

Returns:

For example "2005-03-21 11:18:12.622"

getStartupDate

java.lang.String getStartupDate()

Get date when xmlBlaster was started.

Returns:

"2005-03-20 11:19:12.322"

getUptime

long getUptime()

Get elapsed seconds since xmlBlaster started

getLastError

java.lang.String getLastError()

Access the last logged error.

Returns:

The complete information about the last error logged, never null

clearLastError

void clearLastError()

Clear the last exception text.

getLastWarning

java.lang.String getLastWarning()

Access the last logged warning.

Returns:

The complete information about the last warning logged, never null

clearLastWarning

void clearLastWarning()

Clear the last warning text.

getMaxFreeMem

long getMaxFreeMem()

Returns the max. amount of free memory, including what the Java Virtual Machine could additionally allocate. Calling the gc method may result in increasing the value returned by freeMemory.

Returns:

an approximation to the total amount of memory available for future allocated objects, measured in bytes.

getMaxFreeMemStr

java.lang.String getMaxFreeMemStr()

Nicer to read for humans.

See Also:

getMaxFreeMem()

getFreeMem

long getFreeMem()

Returns the current amount of free memory in the Java Virtual Machine. Calling the gc method may result in increasing the value returned by freeMemory.

Returns:

an approximation to the total amount of memory currently available for future allocated objects, measured in bytes. Note that the JVM may allocate more memory and the free memory will grow.

getFreeMemStr

java.lang.String getFreeMemStr()

Nicer to read for humans.

See Also:

getFreeMem()

getTotalMem

long getTotalMem()

Returns the current amount of memory in the Java virtual machine. The value returned by this method may vary over time, depending on the host environment.

Note that the amount of memory required to hold an object of any given type may be implementation-dependent.

Returns:

the total amount of memory currently available for current and future objects, measured in bytes.

getTotalMemStr

java.lang.String getTotalMemStr()

Nicer to read for humans.

See Also:

getTotalMem()

getMaxMem

long getMaxMem()

Returns the total amount of memory including what the Java virtual machine could additionally allocate. The value returned by this method does not change (see java -Xmx...).

Increase with for example java -Xmx512M on startup.

Returns:

the total amount of memory currently available for current and future objects, measured in bytes.

getMaxMemStr

java.lang.String getMaxMemStr()

Nicer to read for humans.

See Also:

getMaxMem()

getUsedMem

long getUsedMem()

Returns:

getTotalMem() - getFreeMem()

getUsedMemStr

java.lang.String getUsedMemStr()

Nicer to read for humans.

See Also:

getUsedMem()

getGc

java.lang.String getGc()

setGc

void setGc(java.lang.String dummy)

exit

void exit()
          throws XmlBlasterException

Shutdown xmlBlaster, exit value is '0'

Throws:

XmlBlasterException

setExit

void setExit(java.lang.String exitValue)
             throws XmlBlasterException

Throws:

XmlBlasterException

getHostname

java.lang.String getHostname()

Access the bootstrap host name. This IP or DNS hostname is used for IOR download (CORBA) and for our internal tiny http server.

Returns:

The hostname where xmlBlaster listens on

getPort

int getPort()

Access the bootstrap port number. This port is used for IOR download (CORBA) and for our internal tiny http server.

Returns:

The port number, for example 3412

getNumClients

int getNumClients()

How many clients instances are allocated.

getMaxClients

int getMaxClients()

Get the maximum allowed number of clients.

getClientList

java.lang.String getClientList()

Deprecated. Please use getClients() instead

Get the client names.

Returns:

A comma separated list

getClients

java.lang.String[] getClients()

Get the client names.

Returns:

An array with all client names

getAliveCallbackClients

java.lang.String[] getAliveCallbackClients()

Shows the clients which have a alive callback connection.

Returns:

The client session names

getNumSysprop

int getNumSysprop()

Get the number of system properties.

getSyspropList

java.lang.String getSyspropList()

Deprecated. Will be removed

Get the system properties.

Returns:

A comma separated list

getNumTopics

int getNumTopics()

Get the number of topics.

getTopicList

java.lang.String getTopicList()

Deprecated. Please use getTopics() instead

Get the topics.

Returns:

A comma separated list

getTopics

java.lang.String[] getTopics()

Get the topics.

Returns:

An array of all topic names

getNumSubscriptions

int getNumSubscriptions()

Get the number of subscriptions.

Returns:

A comma separated list

getSubscriptionList

java.lang.String getSubscriptionList()

Deprecated. Please use getSubscriptions() instead

Get the subscriptions.

Returns:

A comma separated list

getSubscriptions

java.lang.String[] getSubscriptions()

Get the subscriptions ids.

Returns:

An array of all subscription ids

displayClassInfo

java.lang.String displayClassInfo(java.lang.String clazzName)

Check if the given java class is known and wherefrom it was loaded.

Parameters:

className - for example "com.microsoft.sqlserver.jdbc.SQLServerDriver"

Returns:

The info

getNumGet

long getNumGet()

Returns:

Returns the number of get() invocations

getNumPublish

long getNumPublish()

Returns:

Returns the number if publish() invocations

getNumUpdate

long getNumUpdate()

The overall sent updates (callback to client)

checkConsistency

java.lang.String checkConsistency(java.lang.String fixIt,
                                  java.lang.String reportFileName)

Do consistency check.

Parameters:

fixIt - If "true" (ignoring case) there will be attempts to fix problems, defaults to "false"

reportFileName - The file to dump the report

Returns:

A short status report

dumpAllStacks

java.lang.String dumpAllStacks()

dumpAllStacksToFile

java.lang.String dumpAllStacksToFile(java.lang.String file)

reportMemoryOverview

java.lang.String reportMemoryOverview()

reportMemoryOverviewToFile

java.lang.String reportMemoryOverviewToFile(java.lang.String file)

isAcceptWrongSenderAddress

boolean isAcceptWrongSenderAddress()

Configure server with '-xmlBlaster/acceptWrongSenderAddress true' or "-xmlBlaster/acceptWrongSenderAddress/joe true".

Returns:

true: We accept wrong sender address in PublishQos.getSender() (not myself)

setAcceptWrongSenderAddress

void setAcceptWrongSenderAddress(boolean acceptWrongSenderAddress)

Parameters:

acceptWrongSenderAddress - the acceptWrongSenderAddress to set