org.wso2.carbon.server.admin.internal
Class ServerAdminCommandProvider

java.lang.Object
  org.wso2.carbon.server.admin.internal.ServerAdminCommandProvider

All Implemented Interfaces:

org.eclipse.osgi.framework.console.CommandProvider

public class ServerAdminCommandProvider
extends Object
implements org.eclipse.osgi.framework.console.CommandProvider

Equinox console commands for Server Administration

Constructor Summary

ServerAdminCommandProvider()

Method Summary

void	_dumpAdminServices(org.eclipse.osgi.framework.console.CommandInterpreter ci)
void	_ecbnm(org.eclipse.osgi.framework.console.CommandInterpreter ci) Method to change the state of a node from "maintenance" to "normal"
void	_endCarbonMaintenance(org.eclipse.osgi.framework.console.CommandInterpreter ci) Method to change the state of a node from "maintenance" to "normal"
void	_listAdminServices(org.eclipse.osgi.framework.console.CommandInterpreter ci) List Admin Services deployed on this server
void	_listHiddenServices(org.eclipse.osgi.framework.console.CommandInterpreter ci) List Hidden Services deployed on this server
void	_listSystemServicesInfo(org.eclipse.osgi.framework.console.CommandInterpreter ci)
void	_rcbn(org.eclipse.osgi.framework.console.CommandInterpreter ci) Forcefully restart this Carbon instance
void	_rcbng(org.eclipse.osgi.framework.console.CommandInterpreter ci) Gracefully restart this Carbon instance.
void	_restartCarbon(org.eclipse.osgi.framework.console.CommandInterpreter ci) Forcefully restart this Carbon instance
void	_restartCarbonGracefully(org.eclipse.osgi.framework.console.CommandInterpreter ci) Gracefully restart this Carbon instance.
void	_scbn(org.eclipse.osgi.framework.console.CommandInterpreter ci) Forcefully shutdown this Carbon instance
void	_scbng(org.eclipse.osgi.framework.console.CommandInterpreter ci) Gracefully shutdown this Carbon instance All client connections will be served before shutting down the server
void	_scbnm(org.eclipse.osgi.framework.console.CommandInterpreter ci) Method to switch a node to maintenance mode.
void	_shutdownCarbon(org.eclipse.osgi.framework.console.CommandInterpreter ci) Forcefully shutdown this Carbon instance
void	_shutdownCarbonGracefully(org.eclipse.osgi.framework.console.CommandInterpreter ci) Gracefully shutdown this Carbon instance All client connections will be served before shutting down the server
void	_startCarbonMaintenance(org.eclipse.osgi.framework.console.CommandInterpreter ci) Method to switch a node to maintenance mode.
String	getHelp()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerAdminCommandProvider

public ServerAdminCommandProvider()

Method Detail

_restartCarbon

public void _restartCarbon(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                    throws Exception

Forcefully restart this Carbon instance

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurs while restarting

_rcbn

public void _rcbn(org.eclipse.osgi.framework.console.CommandInterpreter ci)
           throws Exception

Forcefully restart this Carbon instance

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurs while restarting

_shutdownCarbon

public void _shutdownCarbon(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                     throws Exception

Forcefully shutdown this Carbon instance

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurs while shutting down

_scbn

public void _scbn(org.eclipse.osgi.framework.console.CommandInterpreter ci)
           throws Exception

Forcefully shutdown this Carbon instance

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurs while shutting down

_restartCarbonGracefully

public void _restartCarbonGracefully(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                              throws Exception

Gracefully restart this Carbon instance. All client connections will be served before restarting the server

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurs while restarting

_rcbng

public void _rcbng(org.eclipse.osgi.framework.console.CommandInterpreter ci)
            throws Exception

Gracefully restart this Carbon instance. All client connections will be served before restarting the server

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurs while restarting

_shutdownCarbonGracefully

public void _shutdownCarbonGracefully(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                               throws Exception

Gracefully shutdown this Carbon instance All client connections will be served before shutting down the server

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurs while shutting down

_scbng

public void _scbng(org.eclipse.osgi.framework.console.CommandInterpreter ci)
            throws Exception

Gracefully shutdown this Carbon instance All client connections will be served before shutting down the server

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurs while shutting down

_startCarbonMaintenance

public void _startCarbonMaintenance(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                             throws Exception

Method to switch a node to maintenance mode.

Here is the sequence of events:

Client calls this method

The server stops accepting new requests/connections, but continues to stay alive so that old requests & connections can be served

Once all requests have been processed, the method returns

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurred while switching to maintenace mode

_scbnm

public void _scbnm(org.eclipse.osgi.framework.console.CommandInterpreter ci)
            throws Exception

Method to switch a node to maintenance mode.

Here is the sequence of events:

Client calls this method

The server stops accepting new requests/connections, but continues to stay alive so that old requests & connections can be served

Once all requests have been processed, the method returns

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurred while switching to maintenace mode

_endCarbonMaintenance

public void _endCarbonMaintenance(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                           throws Exception

Method to change the state of a node from "maintenance" to "normal"

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurred while switching to normal mode

_ecbnm

public void _ecbnm(org.eclipse.osgi.framework.console.CommandInterpreter ci)
            throws Exception

Method to change the state of a node from "maintenance" to "normal"

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurred while switching to normal mode

_listAdminServices

public void _listAdminServices(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                        throws Exception

List Admin Services deployed on this server

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurred while listing admin services

_listSystemServicesInfo

public void _listSystemServicesInfo(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                             throws Exception

Throws:

Exception

_dumpAdminServices

public void _dumpAdminServices(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                        throws Exception

Throws:

Exception

_listHiddenServices

public void _listHiddenServices(org.eclipse.osgi.framework.console.CommandInterpreter ci)
                         throws Exception

List Hidden Services deployed on this server

Parameters:

ci - CommandInterpreter

Throws:

Exception - If an error occurred while listing hidden services

getHelp

public String getHelp()

Specified by:

getHelp in interface org.eclipse.osgi.framework.console.CommandProvider