org.quickserver.util.xmlreader
Class QSAdminServerConfig

java.lang.Object
  org.quickserver.util.xmlreader.BasicServerConfig
      org.quickserver.util.xmlreader.QSAdminServerConfig

public class QSAdminServerConfig

extends BasicServerConfig

This class encapsulate the configuration of QSAdminServer. This class is used by QuickServer.configQuickServer(org.quickserver.util.xmlreader.QuickServerConfig) and QuickServer.initService(java.lang.Object[]) method to initialise QSAdminServer.

Since:

1.2

Author:

Akshathkumar Shetty

Constructor Summary

QSAdminServerConfig()

Method Summary

java.lang.String	getAuthenticator() Returns the Authenticator class that handles the authentication of the client.
java.lang.String	getBindAddr() Returns the Ip address binding to.
java.lang.String	getClientCommandHandler() Returns the ClientCommandHandler class that interacts with client sockets.
java.lang.String	getCommandPlugin() Gets the CommandPlugin for QSAdminServer class which plugsin into CommandHandler of QsAdminServer,it will be null if not set.
java.lang.String	getCommandShellEnable() Gets the CommandShellEnable flag for QSAdminServer
java.lang.String	getCommandShellPromptName() Gets the PromptName for QSAdminShell
long	getMaxConnection() Returns the maximum number of client connection allowed.
java.lang.String	getName() Returns the name of the QSAdminServer
int	getPort() Returns the port for the QSAdminServer
java.lang.String	getServerAuthenticator() Deprecated. As of 1.3 use getAuthenticator()
void	setAuthenticator(java.lang.String authenticator) Sets the Authenticator class that handles the authentication of the client.
void	setBindAddr(java.lang.String bindAddr) Sets the Ip address to bind to.
void	setClientCommandHandler(java.lang.String handler) Sets the ClientCommandHandler class that interacts with client sockets.
void	setCommandPlugin(java.lang.String plugin) Set the CommandPlugin for QSAdminServer class which plugs in into CommandHandler of QsAdminServer,it will be null if not set.
void	setCommandShellEnable(java.lang.String enable) Set the CommandShellEnable flag for QSAdminServer XML Tag: <command-shell><enable>true</enable></command-shell> Allowed values = true | false
void	setCommandShellPromptName(java.lang.String commandShellPromptName) Set the PromptName for QSAdminShell XML Tag: <command-shell><prompt-name>true</prompt-name></command-shell> Default values = QSAdmin
void	setMaxConnection(long maxConnection) Sets the maximum number of client connection allowed.
void	setName(java.lang.String name) Sets the name for the QSAdminServer.
void	setPort(int port) Sets the port for the QSAdminServer to listen on.
void	setServerAuthenticator(java.lang.String authenticator) Deprecated. As of 1.3 use setAuthenticator(java.lang.String)
java.lang.String	toXML(java.lang.String pad) Returns XML config of this class.

Methods inherited from class org.quickserver.util.xmlreader.BasicServerConfig

getAccessConstraintConfig, getAdvancedSettings, getClientBinaryHandler, getClientData, getClientObjectHandler, getClientWriteHandler, getCommunicationLogging, getConsoleLoggingFormatter, getConsoleLoggingLevel, getMaxAuthTry, getMaxAuthTryMsg, getMaxConnectionMsg, getObjectPoolConfig, getSecure, getServerBanner, getServerHooks, getServerMode, getTimeout, getTimeoutMsg, setAccessConstraintConfig, setAdvancedSettings, setClientBinaryHandler, setClientData, setClientObjectHandler, setClientWriteHandler, setCommunicationLogging, setConsoleLoggingFormatter, setConsoleLoggingLevel, setMaxAuthTry, setMaxAuthTryMsg, setMaxConnectionMsg, setObjectPoolConfig, setSecure, setServerBanner, setServerHooks, setServerMode, setTimeout, setTimeoutMsg

Methods inherited from class java.lang.Object

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

Constructor Detail

QSAdminServerConfig

public QSAdminServerConfig()

Method Detail

getName

public java.lang.String getName()

Returns the name of the QSAdminServer

Overrides:

getName in class BasicServerConfig

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String name)

Sets the name for the QSAdminServer. XML Tag: <name></name>

Overrides:

setName in class BasicServerConfig

Parameters:

name - for the QSAdminServer

See Also:

getName()

setPort

public void setPort(int port)

Sets the port for the QSAdminServer to listen on. If not set, it will run on Port 9877 XML Tag: <port></port>

Overrides:

setPort in class BasicServerConfig

Parameters:

port - to listen on.

See Also:

getPort()

getPort

public int getPort()

Returns the port for the QSAdminServer

Overrides:

getPort in class BasicServerConfig

See Also:

setPort(int)

setClientCommandHandler

public void setClientCommandHandler(java.lang.String handler)

Sets the ClientCommandHandler class that interacts with client sockets. XML Tag: <client-command-handler></client-command-handler>

Overrides:

setClientCommandHandler in class BasicServerConfig

Parameters:

handler - the fully qualified name of the class that implements ClientCommandHandler

See Also:

getClientCommandHandler()

getClientCommandHandler

public java.lang.String getClientCommandHandler()

Returns the ClientCommandHandler class that interacts with client sockets.

Overrides:

getClientCommandHandler in class BasicServerConfig

See Also:

setClientCommandHandler(java.lang.String)

setServerAuthenticator

public void setServerAuthenticator(java.lang.String authenticator)

Deprecated. As of 1.3 use setAuthenticator(java.lang.String)

Sets the Authenticator class that handles the authentication of the client. XML Tag: <server-authenticator></server-authenticator>

Overrides:

setServerAuthenticator in class BasicServerConfig

Parameters:

authenticator - the fully qualified name of the class that implements Authenticator.

See Also:

getServerAuthenticator()

setAuthenticator

public void setAuthenticator(java.lang.String authenticator)

Sets the Authenticator class that handles the authentication of the client. XML Tag: <authenticator></authenticator>

Overrides:

setAuthenticator in class BasicServerConfig

Parameters:

authenticator - the fully qualified name of the class that implements Authenticator.

Since:

1.3

See Also:

getServerAuthenticator()

getServerAuthenticator

public java.lang.String getServerAuthenticator()

Deprecated. As of 1.3 use getAuthenticator()

Returns the Authenticator class that handles the authentication of the client.

Overrides:

getServerAuthenticator in class BasicServerConfig

See Also:

setServerAuthenticator(java.lang.String)

getAuthenticator

public java.lang.String getAuthenticator()

Returns the Authenticator class that handles the authentication of the client.

Overrides:

getAuthenticator in class BasicServerConfig

Since:

1.3

See Also:

setAuthenticator(java.lang.String)

setBindAddr

public void setBindAddr(java.lang.String bindAddr)

Sets the Ip address to bind to. XML Tag: <bind-address></bind-address>

Overrides:

setBindAddr in class BasicServerConfig

Parameters:

bindAddr - argument can be used on a multi-homed host for a QuickServer that will only accept connect requests to one of its addresses. If not set, it will default accepting connections on any/all local addresses.

See Also:

getBindAddr()

getBindAddr

public java.lang.String getBindAddr()

Returns the Ip address binding to.

Overrides:

getBindAddr in class BasicServerConfig

See Also:

setBindAddr(java.lang.String)

setCommandPlugin

public void setCommandPlugin(java.lang.String plugin)

Set the CommandPlugin for QSAdminServer class which plugs in into CommandHandler of QsAdminServer,it will be null if not set. XML Tag: <command-plugin></command-plugin>

getCommandPlugin

public java.lang.String getCommandPlugin()

Gets the CommandPlugin for QSAdminServer class which plugsin into CommandHandler of QsAdminServer,it will be null if not set.

setCommandShellEnable

public void setCommandShellEnable(java.lang.String enable)

Set the CommandShellEnable flag for QSAdminServer XML Tag: <command-shell><enable>true</enable></command-shell> Allowed values = true | false

Since:

1.3.2

getCommandShellEnable

public java.lang.String getCommandShellEnable()

Gets the CommandShellEnable flag for QSAdminServer

Since:

1.3.2

setCommandShellPromptName

public void setCommandShellPromptName(java.lang.String commandShellPromptName)

Set the PromptName for QSAdminShell XML Tag: <command-shell><prompt-name>true</prompt-name></command-shell> Default values = QSAdmin

Since:

1.3.2

getCommandShellPromptName

public java.lang.String getCommandShellPromptName()

Gets the PromptName for QSAdminShell

Since:

1.3.2

setMaxConnection

public void setMaxConnection(long maxConnection)

Sets the maximum number of client connection allowed. Default value is 1 XML Tag: <max-connection></max-connection>

Overrides:

setMaxConnection in class BasicServerConfig

Since:

1.4

See Also:

getMaxConnection()

getMaxConnection

public long getMaxConnection()

Returns the maximum number of client connection allowed.

Overrides:

getMaxConnection in class BasicServerConfig

See Also:

setMaxConnection(long)

toXML

public java.lang.String toXML(java.lang.String pad)

Returns XML config of this class.

Since:

1.3