jet.server.api.admin.cfg
Interface ConfigurationService

public interface ConfigurationService

This interface defines the methods to manage server configuration service.

Method Summary

java.lang.String	getActiveRealm() Returns the active realm in the server.
int	getAdminPort() Returns Administration Port.
int	getConnectionTimeout() Returns the Timeout property of the connection in milliseconds.
int	getDashboardPort() Returns the dashboard port of service configuration on the specified network address.
java.util.Vector	getHostAddresses() Returns the active host addresses.
java.lang.String	getHostName() Gets the active host name.
int	getMaxNumberOfConnection() Returns the maximum number of connections.
int	getMaxNumberOfHandler() Returns the maximum number of handlers.
int	getPort() Returns the service port of service configuration on the specified network address.
java.util.Vector	getRealms() Returns server realm names.
boolean	getServiceOnAll() Returns whether to provide service on all network addresses.
java.lang.String	getServletPropertyFileName() Returns the servlet property file name.
int	getSSLAdminPort() Returns http admin server secure port.
java.lang.String	getSSLAlgorithm() Returns keystore algorithm.
int	getSSLDashboardPort() Returns dashboard SSL port.
java.lang.String	getSSLKeystoreFile() Returns the keystore (database file) location.
java.lang.String	getSSLKeystorePassword() Returns password which is used to protect the integrity of the keystore.
java.lang.String	getSSLKeystoreType() Returns the qualifier which specifies the type of the keystore to be instantiated.
int	getSSLPort() Returns http server SSL port.
java.lang.String	getSSLProtocol() Returns the encryption/decryption protocol to be used on SSLSocket.
boolean	isEnableSSL() Returns whether to enable SSL.
void	loadProperties() Sets the properties of server.
void	setActiveRealm(java.lang.String activeRealm) Sets the active realm in the server.
void	setAdminPort(int adminPort) Sets Administration Port.
boolean	setConnectionTimeout(int connectionTimeout) Sets the Timeout property of the connection in milliseconds.
void	setDashboardPort(int port) Sets the dashboard port of service configuration on the specified network address.
void	setEnableSSL(boolean isEnable) Sets http server with SSL enabled.
void	setHostName(java.lang.String hostName) Sets active host name.
boolean	setMaxNumberOfConnection(int maxNumberOfConnection) Sets the maximum number of connections.
boolean	setMaxNumberOfHandler(int maxNumberOfHandler) Sets the maximum number of handlers.
boolean	setPort(int port) Sets the service port of service configuration on the specified network address.
void	setServiceOnAll(boolean allAddresses) Sets whether to provide service on all network addresses, return true if service is provided on all network addresses, else means network address at: *.
boolean	setServletPropertyFileName(java.lang.String servletPropertyFileName) Sets the servlet property file name.
void	setSSLAdminPort(int adminPort) Sets http admin server secure port.
void	setSSLAlgorithm(java.lang.String algorithm) Sets keystore algorithm.
void	setSSLDashboardPort(int port) Sets dashboard secure port.
void	setSSLKeystoreFile(java.lang.String keyStoreFile) Sets http server keystore file name.
void	setSSLKeystorePassword(java.lang.String keyStorePassword) Sets http server keystore file password.
void	setSSLKeystoreType(java.lang.String keyStoreType) Sets http server keystore type.
void	setSSLPort(int port) Sets http server secure port.
void	setSSLProtocol(java.lang.String protocol) Sets the encryption/decryption protocol to be used on SSLSocket.

Method Detail

setPort

boolean setPort(int port)

Sets the service port of service configuration on the specified network address.

Parameters:

port - the service port.

Returns:

whether the setting is successful.

getPort

int getPort()

Returns the service port of service configuration on the specified network address.

Returns:

the service port code.

setAdminPort

void setAdminPort(int adminPort)

Sets Administration Port.

Parameters:

adminPort - Administration Port.

getAdminPort

int getAdminPort()

Returns Administration Port.

Returns:

Administration Port.

setMaxNumberOfHandler

boolean setMaxNumberOfHandler(int maxNumberOfHandler)

Sets the maximum number of handlers.

Parameters:

maxNumberOfHandler - the maximum number of handlers.

Returns:

whether the setting is successful.

getMaxNumberOfHandler

int getMaxNumberOfHandler()

Returns the maximum number of handlers.

Returns:

the maximum number of handlers.

setMaxNumberOfConnection

boolean setMaxNumberOfConnection(int maxNumberOfConnection)

Sets the maximum number of connections.

Parameters:

maxNumberOfConnection - the maximum number of connections.

Returns:

whether the setting is successful.

getMaxNumberOfConnection

int getMaxNumberOfConnection()

Returns the maximum number of connections.

Returns:

the maximum number of connections.

setConnectionTimeout

boolean setConnectionTimeout(int connectionTimeout)

Sets the Timeout property of the connection in milliseconds.

Parameters:

connectionTimeout - the Timeout property of the connection in milliseconds.

Returns:

whether the setting is successful.

getConnectionTimeout

int getConnectionTimeout()

Returns the Timeout property of the connection in milliseconds.

Returns:

the Timeout property of the connection in milliseconds.

setServletPropertyFileName

boolean setServletPropertyFileName(java.lang.String servletPropertyFileName)

Sets the servlet property file name.

Parameters:

servletPropertyFileName - the servlet property file name.

Returns:

whether the setting is successful.

getServletPropertyFileName

java.lang.String getServletPropertyFileName()

Returns the servlet property file name.

Returns:

the servlet property file name.

setActiveRealm

void setActiveRealm(java.lang.String activeRealm)

Sets the active realm in the server.

Parameters:

activeRealm - the active realm in the server.

getActiveRealm

java.lang.String getActiveRealm()

Returns the active realm in the server.

Returns:

the active realm in the server.

getServiceOnAll

boolean getServiceOnAll()

Returns whether to provide service on all network addresses.

Returns:

true if service is provided on all network addresses, else means network address at: *.

getHostAddresses

java.util.Vector getHostAddresses()

Returns the active host addresses.

Returns:

the active host addresses.

getHostName

java.lang.String getHostName()

Gets the active host name.

Returns:

the host name in the server.

setHostName

void setHostName(java.lang.String hostName)

Sets active host name.

Parameters:

hostName - host name of the server.

setServiceOnAll

void setServiceOnAll(boolean allAddresses)

Sets whether to provide service on all network addresses, return true if service is provided on all network addresses, else means network address at: *.

Parameters:

allAddresses,whether - provide Service on All Network Addresses.

getRealms

java.util.Vector getRealms()

Returns server realm names.

Returns:

Vector which contains all realm names.

loadProperties

void loadProperties()

Sets the properties of server.

setEnableSSL

void setEnableSSL(boolean isEnable)

Sets http server with SSL enabled.

Parameters:

isEnable - if true, SSL is enabled; if false, disabled.

isEnableSSL

boolean isEnableSSL()

Returns whether to enable SSL.

Returns:

true when SSL is enabled, otherwise return false.

getSSLPort

int getSSLPort()

Returns http server SSL port.

Returns:

SSL port.

setSSLPort

void setSSLPort(int port)

Sets http server secure port.

Parameters:

port - http server secure port.

getSSLAdminPort

int getSSLAdminPort()

Returns http admin server secure port.

Returns:

http admin server secure port.

setSSLAdminPort

void setSSLAdminPort(int adminPort)

Sets http admin server secure port.

Parameters:

port - http admin server secure port.

getSSLKeystoreFile

java.lang.String getSSLKeystoreFile()

Returns the keystore (database file) location.

Returns:

the keystore location.

setSSLKeystoreFile

void setSSLKeystoreFile(java.lang.String keyStoreFile)

Sets http server keystore file name.

Parameters:

keyStoreFile - http server keystore file name.

getSSLKeystorePassword

java.lang.String getSSLKeystorePassword()

Returns password which is used to protect the integrity of the keystore.

Returns:

password which is used to protect the integrity of the keystore.

setSSLKeystorePassword

void setSSLKeystorePassword(java.lang.String keyStorePassword)

Sets http server keystore file password.

Parameters:

keyStorePassword - which is used to protect the integrity of the keystore.

getSSLKeystoreType

java.lang.String getSSLKeystoreType()

Returns the qualifier which specifies the type of the keystore to be instantiated.

Returns:

the qualifier which specifies the type of the keystore to be instantiated.

setSSLKeystoreType

void setSSLKeystoreType(java.lang.String keyStoreType)

Sets http server keystore type.

Parameters:

keyStoreType - which is used to specify the type of keystore. The valid values are JKS and PKCS12.

getSSLAlgorithm

java.lang.String getSSLAlgorithm()

Returns keystore algorithm.

Returns:

keystore algorithm.

setSSLAlgorithm

void setSSLAlgorithm(java.lang.String algorithm)

Sets keystore algorithm.

Parameters:

algorithm - By default, it is the Sun implementation (SunX509). For IBM JVMs you should use the value IbmX509.

getSSLProtocol

java.lang.String getSSLProtocol()

Returns the encryption/decryption protocol to be used on SSLSocket.

Returns:

the encryption/decryption protocol to be used on SSLSocket.

setSSLProtocol

void setSSLProtocol(java.lang.String protocol)

Sets the encryption/decryption protocol to be used on SSLSocket.

Parameters:

protocol - the valid values are SSL and TLS.

setDashboardPort

void setDashboardPort(int port)

Sets the dashboard port of service configuration on the specified network address.

Parameters:

port - the dashboard port.

getDashboardPort

int getDashboardPort()

Returns the dashboard port of service configuration on the specified network address.

Returns:

the board port.

getSSLDashboardPort

int getSSLDashboardPort()

Returns dashboard SSL port.

setSSLDashboardPort

void setSSLDashboardPort(int port)

Sets dashboard secure port.

Parameters:

port - dashbaord secure port.