Package de.xima.fc.cluster

Class ClusterManager

java.lang.Object
de.xima.fc.cluster.ClusterManager
public class ClusterManager extends Object
Manager for the cluster that can be used to control the cluster in a way that is independent of the implementation used for the clustering.
Since:
3.1.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • restart

      public static void restart() throws ClusterOpenException
      Restarts the cluster (i.e. close()s it first, the startup()s it again}.
      Throws:
      ClusterOpenException - When the cluster could not be closed or started again.

    • startup

      public static void startup() throws ClusterOpenException
      Starts the cluster.
      Throws:
      ClusterOpenException - When the cluster could not be started.

    • open

      public static void open() throws ClusterOpenException
      Opens the cluster connection.
      Throws:
      ClusterOpenException - When the connection could not be opened.
      See Also:

    • close

      public static void close()
      Closes the cluster connection when previously opened via open().
      See Also:

    • disconnect

      public static void disconnect()
      Disconnect the getLocaleNode() from the cluster.
      See Also:

    • getConnection

      public static IClusterConnection getConnection()
      Returns:
      The current connection to the cluster, null when not connected.

    • registerOpenListener

      public static void registerOpenListener(IBaseNotificationListener listener)
      Registers a listener that is notified when the connection to the cluster is opened.
      Parameters:
      listener - Listener to register.

    • registerCloseListener

      public static void registerCloseListener(IBaseNotificationListener listener)
      Registers a listener that is notified when the connection to the cluster is closed.
      Parameters:
      listener - Listener to register.

    • isClusterActivated

      public static boolean isClusterActivated()
      Returns:
      Whether clustering is enabled. When clustering is disabled, startup() will not be possible.

    • isConnectionActive

      public static boolean isConnectionActive()
      Returns:
      Whether the connection to the cluster is active.

    • getLocaleNode

      public static NodeModel getLocaleNode()
      Returns:
      The local node, i.e. the node corresponding to the server running this code. null when no cluster connection is active.

    • isLocaleNodeActive

      public static boolean isLocaleNodeActive()
      Returns:
      Whether the the getLocaleNode() is active.