Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## jet.server.api.rmi.admin
Interface RemoteClusterAdminService

All Superinterfaces:
  java.rmi.Remote

    public interface RemoteClusterAdminService

extends java.rmi.Remote

Config the properties that used for whole cluster(need security, active realm, JSP enabled, publisht temp result to version enabled, mail config), and shutdown specified sever in cluster if standalone server is used.

Method Summary
`java.lang.String` | `addPredefinedServer(java.lang.String name, java.lang.String host, java.lang.String port, int backupPriority, java.lang.String submitter)` Add a clustered server into predefined server list of cluster.
`java.lang.String` | `addPredefinedServer(java.lang.String name, java.lang.String host, java.lang.String port, java.lang.String submitter)` Add a clustered server into predefined server list of cluster.
`boolean` | `canEditPredefinedServers()` If can edit predefined server list of cluster.
`java.lang.String` | `getActiveRealm()` Get the active realm of server.
`int` | `getDefaultMailFormat()` Return the mail format send out.
`java.lang.String` | `getMailBox()` Return the mail form address.
`java.util.Vector` | `getMailFormats()` Return the all mail formats .
`int` | `getMailPort()` Return the smtp mail server 's port.
`java.lang.String` | `getMailServer()` Return the smtp mail server 's name.
`java.lang.String` | `getNotifyServerDownAddress()` Set the target address of mail for notification mail after a server in cluster down.
`Member[]` | `getPredefinedServers()` Get all server list that predefined.
`boolean` | `isEnableCompress()` Return true if compress mail, otherwise return false.
`boolean` | `isEnableJSP()` Return if use JSP.
`boolean` | `isEnableNotifyServerDown()` Get setting that whether send notification mail after a server in cluster down.
`boolean` | `isEnablePublishTempToVersion()` Check if enable publish temp result to version.
`boolean` | `isNeedSecurity()` Return if need security authentication
`java.util.Properties` | `loadClusterWeights()`
`java.lang.String` | `removePredefinedServer(java.lang.String name, java.lang.String submitter)` Remove a clustered server from predefined server list of cluster.
`long` | `runTestReport(java.lang.String name, java.util.Properties ht)` Return the time of running test report for in a indicated cluster member
`void` | `saveClusterWeights(java.util.Properties ep)`
`void` | `setActiveRealm(java.lang.String realmName, java.lang.String submmiter)` Set the active realm used in whole cluster.
`void` | `setDefaultMailFormat(int mailFormat, java.lang.String submitter)` Set the mail format send out.
`void` | `setEnableCompress(boolean isEnable, java.lang.String submitter)` Set if compress mail.
`void` | `setEnableJSP(boolean enable, java.lang.String submitter)` Set whether enable using JSP in whole cluster.
`void` | `setEnableNotifyServerDown(boolean enable)` Set option that specify whether send notification mail after a server in cluster down.
`void` | `setEnablePublishTempToVersion(boolean enable, java.lang.String submitter)` Set whether enable publish temp result to version in whole cluster.
`void` | `setMailBox(java.lang.String mailBox, java.lang.String submitter)` set the mail form address.
`void` | `setMailPort(int port, java.lang.String submitter)` set the smtp mail server 's port.
`void` | `setMailServer(java.lang.String smtpServerName, java.lang.String submitter)` set the smtp mail server 's name .
`void` | `setNeedSecurity(boolean need, java.lang.String submitter)` Set whether enable security authentication in whole cluster.
`void` | `setNotifyServerDownAddress(java.lang.String address)` Set the target address of mail for notification mail after a server in cluster down.
`java.lang.String` | `stopCluster(java.lang.String submitter)` Stop all servers in the cluste.
`java.lang.String` | `stopServer(java.lang.String name, java.lang.String submitter)` Stop a server in the cluster

Method Detail

### stopServer

    java.lang.String stopServer(java.lang.String name,
                                java.lang.String submitter)
                                throws ClusterException,
                                       java.rmi.RemoteException

  Stop a server in the cluster

  Parameters:
    `name` - server name of the specifed server.
    `submitter` - the user who requst this action.
  Returns:
    error message if any error occurs but does not throw exception, or null if success.
  Throws:
    `if` - error occurs when try to stop server.
    `java.rmi.RemoteException` - will be thrown if error occurs.
    `ClusterException`

### stopCluster

    java.lang.String stopCluster(java.lang.String submitter)
                                 throws ClusterException,
                                        java.rmi.RemoteException

  Stop all servers in the cluste.

  Returns:
    error message if any error occurs but does not throw exception, or null if success.
  Throws:
    `if` - error occurs when try to stop whole cluster.
    `java.rmi.RemoteException` - will be thrown if error occurs.
    `ClusterException`

### canEditPredefinedServers

    boolean canEditPredefinedServers()
                                     throws java.rmi.RemoteException

  If can edit predefined server list of cluster. Only original admin serever of cluster can edit predefined server list, that is, if admin server is promoted from a backup server, edit is disable.

  Returns:
    true if can edit, otherwise false.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### addPredefinedServer

    java.lang.String addPredefinedServer(java.lang.String name,
                                         java.lang.String host,
                                         java.lang.String port,
                                         java.lang.String submitter)
                                         throws ClusterException,
                                                java.rmi.RemoteException

  Add a clustered server into predefined server list of cluster.

  Parameters:
    `name` - clustered server's name.
    `host` - clustered server's host.
    `port` - clustered server's rmi port.
    `submitter` - the user who requst this action.
  Returns:
    error message if any error occurs but does not throw exception, or null if success.
  Throws:
    `if` - any error occurs when try to add clustered server into predefined server list.
    `java.rmi.RemoteException` - will be thrown if error occurs.
    `ClusterException`

### addPredefinedServer

    java.lang.String addPredefinedServer(java.lang.String name,
                                         java.lang.String host,
                                         java.lang.String port,
                                         int backupPriority,
                                         java.lang.String submitter)
                                         throws ClusterException,
                                                java.rmi.RemoteException

  Add a clustered server into predefined server list of cluster.

  Parameters:
    `name` - clustered server's name.
    `host` - clustered server's host.
    `port` - clustered server's rmi port.
    `backupPriority` - specify backup server's priority when admin server was crashed. That is, if admin server was crashed, server that has highest priority in active backup servers will promote itself to admin server, priority value is a non-negative integer, "0" represent the highest priority, value "0" is reserved for admin server(if admin server was crashed, and before it restart, a backup server has promoted to admin server, original admin server has to start as backup server, it need a backup priority).
    `submitter` - the user who requst this action.
  Returns:
    error message if any error occurs but does not throw exception, or null if success.
  Throws:
    `if` - any error occurs when try to add clustered server into predefined server list.
    `java.rmi.RemoteException` - will be thrown if error occurs.
    `ClusterException`

### removePredefinedServer

    java.lang.String removePredefinedServer(java.lang.String name,
                                            java.lang.String submitter)
                                            throws ClusterException,
                                                   java.rmi.RemoteException

  Remove a clustered server from predefined server list of cluster.

  Parameters:
    `name` - name of clustered server which want to remove.
    `submitter` - the user who requst this action.
  Returns:
    error message if any error occurs but does not throw exception, or null if success.
  Throws:
    `if` - any error occurs when try to remove clustered server from predefined server list.
    `java.rmi.RemoteException` - will be thrown if error occurs.
    `ClusterException`

### getPredefinedServers

    Member[] getPredefinedServers()
                                  throws java.rmi.RemoteException

  Get all server list that predefined.

  Returns:
    a member array that represent all servers in predefined server list.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setEnableNotifyServerDown

    void setEnableNotifyServerDown(boolean enable)
                                   throws java.rmi.RemoteException

  Set option that specify whether send notification mail after a server in cluster down.

  Parameters:
    `enable` - true if enable send notification mail.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### isEnableNotifyServerDown

    boolean isEnableNotifyServerDown()
                                     throws java.rmi.RemoteException

  Get setting that whether send notification mail after a server in cluster down.

  Returns:
    ture if enable send notification mail.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setNotifyServerDownAddress

    void setNotifyServerDownAddress(java.lang.String address)
                                    throws java.rmi.RemoteException

  Set the target address of mail for notification mail after a server in cluster down.

  Parameters:
    `address` - target address of mail
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### getNotifyServerDownAddress

    java.lang.String getNotifyServerDownAddress()
                                                throws java.rmi.RemoteException

  Set the target address of mail for notification mail after a server in cluster down.

  Returns:
    target address of mail, or "" if it is not set.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### getActiveRealm

    java.lang.String getActiveRealm()
                                    throws java.rmi.RemoteException

  Get the active realm of server.

  Returns:
    active realm
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setActiveRealm

    void setActiveRealm(java.lang.String realmName,
                        java.lang.String submmiter)
                        throws java.rmi.RemoteException

  Set the active realm used in whole cluster.

  Parameters:
    `realmName` - the realm name.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### isNeedSecurity

    boolean isNeedSecurity()
                           throws java.rmi.RemoteException

  Return if need security authentication

  Returns:
    true if need security authentication, otherwise false.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setNeedSecurity

    void setNeedSecurity(boolean need,
                         java.lang.String submitter)
                         throws java.rmi.RemoteException

  Set whether enable security authentication in whole cluster.

  Parameters:
    `need` - true if enable security authentication, false disable.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### isEnableJSP

    boolean isEnableJSP()
                        throws java.rmi.RemoteException

  Return if use JSP.

  Returns:
    true if use JSP, otherwise false.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setEnableJSP

    void setEnableJSP(boolean enable,
                      java.lang.String submitter)
                      throws java.rmi.RemoteException

  Set whether enable using JSP in whole cluster.

  Parameters:
    `need` - true if enable using JSP, false disable.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### isEnablePublishTempToVersion

    boolean isEnablePublishTempToVersion()
                                         throws java.rmi.RemoteException

  Check if enable publish temp result to version.

  Returns:
    true if enable, otherwise false.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setEnablePublishTempToVersion

    void setEnablePublishTempToVersion(boolean enable,
                                       java.lang.String submitter)
                                       throws java.rmi.RemoteException

  Set whether enable publish temp result to version in whole cluster.

  Parameters:
    `enable` - true if enable publish temp result to version, false disable.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setMailServer

    void setMailServer(java.lang.String smtpServerName,
                       java.lang.String submitter)
                       throws java.rmi.RemoteException

  set the smtp mail server 's name .

  Parameters:
    `smtpServerName` - the smtp mail server 's name.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### getMailServer

    java.lang.String getMailServer()
                                   throws java.rmi.RemoteException

  Return the smtp mail server 's name.

  Returns:
    the smtp mail server 's name.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setMailPort

    void setMailPort(int port,
                     java.lang.String submitter)
                     throws java.rmi.RemoteException

  set the smtp mail server 's port.

  Parameters:
    `port` - the smtp mail server 's port.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### getMailPort

    int getMailPort()
                    throws java.rmi.RemoteException

  Return the smtp mail server 's port.

  Returns:
    the smtp mail server 's port.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setMailBox

    void setMailBox(java.lang.String mailBox,
                    java.lang.String submitter)
                    throws java.rmi.RemoteException

  set the mail form address.

  Parameters:
    `mailBox` - the mail form address.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### getMailBox

    java.lang.String getMailBox()
                                throws java.rmi.RemoteException

  Return the mail form address.

  Returns:
    the mail form address.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setDefaultMailFormat

    void setDefaultMailFormat(int mailFormat,
                              java.lang.String submitter)
                              throws java.rmi.RemoteException

  Set the mail format send out.

  Parameters:
    `mailFormat` - the mail format send out.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### getDefaultMailFormat

    int getDefaultMailFormat()
                             throws java.rmi.RemoteException

  Return the mail format send out.

  Returns:
    the mail format send out.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### getMailFormats

    java.util.Vector getMailFormats()
                                    throws java.rmi.RemoteException

  Return the all mail formats .

  Returns:
    vector which all the mail format .
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### setEnableCompress

    void setEnableCompress(boolean isEnable,
                           java.lang.String submitter)
                           throws java.rmi.RemoteException

  Set if compress mail.

  Parameters:
    `isEnable` - if compress mail.
    `submitter` - the user who requst this action.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### isEnableCompress

    boolean isEnableCompress()
                             throws java.rmi.RemoteException

  Return true if compress mail, otherwise return false.

  Returns:
    if compress mail.
  Throws:
    `java.rmi.RemoteException` - will be thrown if error occurs.

### runTestReport

    long runTestReport(java.lang.String name,
                       java.util.Properties ht)
                       throws ClusterException,
                              java.rmi.RemoteException

  Return the time of running test report for in a 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:
    `java.rmi.RemoteException` - will be thrown if error occurs.
    `ClusterException`

### saveClusterWeights

    void saveClusterWeights(java.util.Properties ep)
                            throws java.rmi.RemoteException

  Throws:
    `java.rmi.RemoteException`

### loadClusterWeights

    java.util.Properties loadClusterWeights()
                                            throws java.io.IOException,
                                                   java.rmi.RemoteException

  Throws:
    `java.io.IOException`
    `java.rmi.RemoteException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD