com.tibco.as.admin

Class Admin

java.lang.Object

com.tibco.as.admin.Admin

public abstract class Admin
extends java.lang.Object

Allows execution of ActiveSpaces Admin language commands on the Metaspace.

Constructor Summary

Constructors

Constructor and Description
Admin()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Invalidates this Admin reference.
abstract Metaspace	connect(java.lang.String command)
static Admin	create()
abstract void	disconnect(Metaspace metaspace) Command to execute to disconnect from a metaspace
abstract java.lang.String	execute(Metaspace metaspace, java.lang.String command) Executes ActiveSpaces Admin language commands on the Metasapce.
abstract java.lang.String	help() Returns all help strings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Admin

public Admin()

Method Detail

create

public static Admin create()

connect

public abstract Metaspace connect(java.lang.String command)
                           throws AdminException

Parameters:

command - Command to execute for Metaspace connection

Returns:

Metaspace object

Throws:

AdminException - if the command execution fails

disconnect

public abstract void disconnect(Metaspace metaspace)
                         throws AdminException

Command to execute to disconnect from a metaspace

Parameters:

metaspace - Metaspace object to disconnect

Throws:

AdminException - if the command fails

execute

public abstract java.lang.String execute(Metaspace metaspace,
                                         java.lang.String command)
                                  throws AdminException

Executes ActiveSpaces Admin language commands on the Metasapce. For commands such as "show space <space-name>", execute returns a String else it returns null.

Metaspace on which the commands will be executed must be passed in.

Parameters:

metaspace - Metaspace object that command will be executed on

command - Command to execute

Returns:

The output produced by the admin command being executed

Throws:

AdminException - if the command execution fails

close

public abstract void close()

Invalidates this Admin reference.

help

public abstract java.lang.String help()
                               throws AdminException

Returns all help strings

Returns:

help strings

Throws:

AdminException