jet.server.api.rmi.admin

Interface RemoteClusterAdminService

All Superinterfaces:

Remote

public interface RemoteClusterAdminService
extends Remote

Specifies the properties that are used for the whole cluster (such as need security, active realm, JSP enabled, publish temp result to version enabled, mail configuration), and shuts down the specified sever in the cluster if a stand alone server is used.

Method Summary

Modifier and Type	Method and Description
String	addPredefinedServer(String name, String host, String port, int backupPriority, String submitter) Deprecated. since version v10
String	addPredefinedServer(String name, String host, String port, String submitter) Deprecated. since version v10
boolean	canEditPredefinedServers() Deprecated. since version v10
String	getActiveRealm() Gets the active realm of the server.
int	getDefaultMailFormat() Returns the mail format sent out.
String	getLoadBalanceCustomClass() Returns the load balance custom class.
int	getLoadBalanceType() Returns the load balance type.
String	getMailBox() Returns the mail sender's address.
Vector	getMailFormats() Returns all the mail formats.
int	getMailPort() Returns the smtp mail server's port.
String	getMailServer() Returns the smtp mail server's name.
boolean	getMessageMode() Gets the internal message mode in JReport server.
String	getNotifyServerDownAddress() Sets the target address of the notification mail after a server in the cluster is down.
Member[]	getPredefinedServers() Deprecated. since version v10
boolean	isClusterSendConcurrentReport() Returns whether the cluster sends concurrent report.
boolean	isEnableCompress() Returns true if it enables to compress the mail, otherwise return false.
boolean	isEnableJSP() Returns whether to use JSP.
boolean	isEnableNotifyServerDown() Gets the setting about whether to send notification mail after a server in the cluster is down.
boolean	isEnablePublishTempToVersion() Checks whether to enable publishing temp result to version.
boolean	isNeedSecurity() Returns whether to need security authentication.
Properties	loadClusterWeights() Loads the cluster weights.
String	removePredefinedServer(String name, String submitter) Deprecated. since version v10
long	runTestReport(String name, Properties ht) Returns the time of running the test report in an indicated cluster member.
void	saveClusterWeights(Properties ep) Saves the cluster weights.
void	setActiveRealm(String realmName, String submmiter) Sets the active realm used in the whole cluster.
void	setClusterSendConcurrentReport(Boolean isSendReport) Sets whether the cluster sends concurrent report.
void	setDefaultMailFormat(int mailFormat, String submitter) Sets the mail format sent out.
void	setEnableCompress(boolean isEnable, String submitter) Sets whether to compress the mail.
void	setEnableJSP(boolean enable, String submitter) Sets whether to enable using JSP in the whole cluster.
void	setEnableNotifyServerDown(boolean enable) Sets the option that specifies whether to send notification mail after a server in the cluster is down.
void	setEnablePublishTempToVersion(boolean enable, String submitter) Sets whether to enable publishing temp result to version in the whole cluster.
void	setLoadBalanceCustomClass(String customClass) Sets the load balance custom class.
void	setLoadBalanceType(int type) Sets the load balance type.
void	setMailBox(String mailBox, String submitter) Sets the mail sender's address.
void	setMailPort(int port, String submitter) Sets the smtp mail server's port.
void	setMailServer(String smtpServerName, String submitter) sets the smtp mail server's name.
void	setMessageMode(boolean mode) Sets the internal message mode in JReport server.
void	setNeedSecurity(boolean need, String submitter) Sets whether to enable security authentication in the whole cluster.
void	setNotifyServerDownAddress(String address) Sets the target address of the notification mail after a server in the cluster is down.
String	stopCluster(String submitter) Stops all servers in the cluster.
String	stopServer(String name, String submitter) Stops a server in the cluster.

Method Detail

stopServer

String stopServer(String name,
                  String submitter)
           throws ClusterException,
                  RemoteException

Stops a server in the cluster.

Parameters:

name - the server name of the specified server.

submitter - the user who requested this action.

Returns:

error message if any error occurs but no exception is thrown, or null if successful.

Throws:

ClusterException - if error occurs when trying to stop the server.

RemoteException - if communication-related error occurs during RMI call execution.

stopCluster

String stopCluster(String submitter)
            throws ClusterException,
                   RemoteException

Stops all servers in the cluster.

Parameters:

submitter - the user who requested this action.

Returns:

error message if any error occurs but no exception is thrown, or null if successful.

Throws:

if - error occurs when trying to stop the whole cluster.

RemoteException - if communication-related error occurs during RMI call execution.

ClusterException

canEditPredefinedServers

boolean canEditPredefinedServers()
                          throws RemoteException

Deprecated. since version v10

Specifies whether the predefined server list of the cluster can be edited. Only original admin server of the cluster can edit the predefined server list, that is, if admin server is promoted from a backup server, the edition is disabled.

Returns:

true if the edition is allowed, otherwise false.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

addPredefinedServer

String addPredefinedServer(String name,
                           String host,
                           String port,
                           String submitter)
                    throws ClusterException,
                           RemoteException

Deprecated. since version v10

Adds a clustered server into the predefined server list of the cluster.

Parameters:

name - the clustered server's name.

host - the clustered server's host.

port - the clustered server's rmi port.

submitter - the user who requested this action.

Returns:

error message if any error occurs but no exception is thrown, or null if successful.

Throws:

if - any error occurs when trying to add the clustered server into the predefined server list.

RemoteException - if communication-related error occurs during RMI call execution.

ClusterException

addPredefinedServer

String addPredefinedServer(String name,
                           String host,
                           String port,
                           int backupPriority,
                           String submitter)
                    throws ClusterException,
                           RemoteException

Deprecated. since version v10

Adds a clustered server into the predefined server list of the cluster.

Parameters:

name - the clustered server's name.

host - the clustered server's host.

port - the clustered server's rmi port.

backupPriority - specifies backup server's priority when admin server is crashed. That is, if admin server is crashed, the server that has the highest priority among the active backup servers will promote itself to admin server. The priority value is a non-negative integer, "0" represents the highest priority, the value "0" is reserved for admin server. If admin server is crashed, and before it restarts, a backup server will be promoted to admin server, and the original admin server has to start as backup server, it needs a backup priority.

submitter - the user who requested this action.

Returns:

error message if any error occurs but no exception is thrown, or null if successful.

Throws:

if - any error occurs when trying to add the clustered server into the predefined server list.

RemoteException - if communication-related error occurs during RMI call execution.

ClusterException

removePredefinedServer

String removePredefinedServer(String name,
                              String submitter)
                       throws ClusterException,
                              RemoteException

Deprecated. since version v10

Removes a clustered server from the predefined server list of the cluster.

Parameters:

name - the name of clustered server which you want to remove.

submitter - the user who requested this action.

Returns:

error message if any error occurs but no exception is thrown, or null if successful.

Throws:

if - any error occurs when trying to remove the clustered server from the predefined server list.

RemoteException - if communication-related error occurs during RMI call execution.

ClusterException

getPredefinedServers

Member[] getPredefinedServers()
                       throws RemoteException

Deprecated. since version v10

Gets all servers list that are predefined.

Returns:

a member array that represents all servers in the predefined server list.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setEnableNotifyServerDown

void setEnableNotifyServerDown(boolean enable)
                        throws RemoteException

Sets the option that specifies whether to send notification mail after a server in the cluster is down.

Parameters:

enable - true if enabled to send notification mail.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

isEnableNotifyServerDown

boolean isEnableNotifyServerDown()
                          throws RemoteException

Gets the setting about whether to send notification mail after a server in the cluster is down.

Returns:

true if enabled to send notification mail.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setNotifyServerDownAddress

void setNotifyServerDownAddress(String address)
                         throws RemoteException

Sets the target address of the notification mail after a server in the cluster is down.

Parameters:

address - the target address of the mail

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getNotifyServerDownAddress

String getNotifyServerDownAddress()
                           throws RemoteException

Sets the target address of the notification mail after a server in the cluster is down.

Returns:

the target address of the mail, or "" if it is not set.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getActiveRealm

String getActiveRealm()
               throws RemoteException

Gets the active realm of the server.

Returns:

the active realm

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setActiveRealm

void setActiveRealm(String realmName,
                    String submmiter)
             throws RemoteException

Sets the active realm used in the whole cluster.

Parameters:

realmName - the realm name.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

isNeedSecurity

boolean isNeedSecurity()
                throws RemoteException

Returns whether to need security authentication.

Returns:

true if security authentication is needed, otherwise false.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setNeedSecurity

void setNeedSecurity(boolean need,
                     String submitter)
              throws RemoteException

Sets whether to enable security authentication in the whole cluster.

Parameters:

need - true if security authentication is enabled, false if disabled.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

isEnableJSP

boolean isEnableJSP()
             throws RemoteException

Returns whether to use JSP.

Returns:

true if JSP is used, otherwise false.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setEnableJSP

void setEnableJSP(boolean enable,
                  String submitter)
           throws RemoteException

Sets whether to enable using JSP in the whole cluster.

Parameters:

need - true if using JSP is enabled, false if disabled.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

isEnablePublishTempToVersion

boolean isEnablePublishTempToVersion()
                              throws RemoteException

Checks whether to enable publishing temp result to version.

Returns:

true if enabled, otherwise false.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setEnablePublishTempToVersion

void setEnablePublishTempToVersion(boolean enable,
                                   String submitter)
                            throws RemoteException

Sets whether to enable publishing temp result to version in the whole cluster.

Parameters:

enable - true if publishing temp result to version is enabled, false if disabled.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setMailServer

void setMailServer(String smtpServerName,
                   String submitter)
            throws RemoteException

sets the smtp mail server's name.

Parameters:

smtpServerName - the smtp mail server's name.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getMailServer

String getMailServer()
              throws RemoteException

Returns the smtp mail server's name.

Returns:

the smtp mail server's name.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setMailPort

void setMailPort(int port,
                 String submitter)
          throws RemoteException

Sets the smtp mail server's port.

Parameters:

port - the smtp mail server's port.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getMessageMode

boolean getMessageMode()
                throws RemoteException

Gets the internal message mode in JReport server. true---return message string. false---return message key.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setMessageMode

void setMessageMode(boolean mode)
             throws RemoteException

Sets the internal message mode in JReport server.

Parameters:

mode - the message mode.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getMailPort

int getMailPort()
         throws RemoteException

Returns the smtp mail server's port.

Returns:

the smtp mail server's port.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setMailBox

void setMailBox(String mailBox,
                String submitter)
         throws RemoteException

Sets the mail sender's address.

Parameters:

mailBox - the mail sender's address.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getMailBox

String getMailBox()
           throws RemoteException

Returns the mail sender's address.

Returns:

the mail sender's address.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setDefaultMailFormat

void setDefaultMailFormat(int mailFormat,
                          String submitter)
                   throws RemoteException

Sets the mail format sent out.

Parameters:

mailFormat - the mail format sent out.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getDefaultMailFormat

int getDefaultMailFormat()
                  throws RemoteException

Returns the mail format sent out.

Returns:

the mail format sent out.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getMailFormats

Vector getMailFormats()
               throws RemoteException

Returns all the mail formats.

Returns:

vector containing all the mail formats.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setEnableCompress

void setEnableCompress(boolean isEnable,
                       String submitter)
                throws RemoteException

Sets whether to compress the mail.

Parameters:

isEnable - whether to compress the mail.

submitter - the user who requested this action.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

isEnableCompress

boolean isEnableCompress()
                  throws RemoteException

Returns true if it enables to compress the mail, otherwise return false.

Returns:

whether to compress mail.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

runTestReport

long runTestReport(String name,
                   Properties ht)
            throws ClusterException,
                   RemoteException

Returns the time of running the test report in an indicated cluster member.

Parameters:

ht - the properties of the test report

name - the name of the test cluster member

Returns:

the time of running

Throws:

ClusterException - will be thrown if error occurs.

RemoteException - if communication-related error occurs during RMI call execution.

saveClusterWeights

void saveClusterWeights(Properties ep)
                 throws RemoteException

Saves the cluster weights.

Parameters:

ep - the properties of the cluster weights

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

loadClusterWeights

Properties loadClusterWeights()
                       throws IOException,
                              RemoteException

Loads the cluster weights.

Returns:

the properties of the cluster weights

Throws:

IOException - will be thrown if error occurs.

RemoteException - if communication-related error occurs during RMI call execution.

getLoadBalanceType

int getLoadBalanceType()
                throws RemoteException

Returns the load balance type.

Returns:

the load balance type

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getLoadBalanceCustomClass

String getLoadBalanceCustomClass()
                          throws RemoteException

Returns the load balance custom class.

Returns:

the load balance custom class

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setLoadBalanceType

void setLoadBalanceType(int type)
                 throws RemoteException

Sets the load balance type.

Parameters:

type - the load balance type

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setLoadBalanceCustomClass

void setLoadBalanceCustomClass(String customClass)
                        throws RemoteException

Sets the load balance custom class.

Parameters:

customClass - the load balance custom class

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setClusterSendConcurrentReport

void setClusterSendConcurrentReport(Boolean isSendReport)
                             throws RemoteException

Sets whether the cluster sends concurrent report.

Parameters:

isSendReport - true if the cluster sends concurrent report

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

isClusterSendConcurrentReport

boolean isClusterSendConcurrentReport()
                               throws RemoteException

Returns whether the cluster sends concurrent report.

Returns:

return true if the cluster sends concurrent report

Throws:

RemoteException - if communication-related error occurs during RMI call execution.