Interface IServerTimeOutManager

All Superinterfaces:
ICCConfigurationObjectWithInitialize
All Known Implementing Classes:
ServerTimeOutManager

public interface IServerTimeOutManager extends ICCConfigurationObjectWithInitialize
Management of server timeouts in order to support server shut down with "latency". Via the server time out manager a server can be informed that it will be shut down at a certain point of time.

The task of the server time out manager is to keep and distribute this information so that other mechanisms can react - in order to support the user to close his/her current sessions and to re-logon to another node.

The taks is NOT to actually shut down the server!

The default implementation is ServerTimeOutManager. You can set your own implementation by corresponding configuration of system.xml.
  • Method Details

    • initialize

      void initialize(javax.servlet.ServletContext servletContext)
      Is called by CaptainCasa environment after the instance is created.
      Specified by:
      initialize in interface ICCConfigurationObjectWithInitialize
    • triggerServerTimeout

      void triggerServerTimeout(ServerTimeOutInfo sti)
      Tell the server node that it will be timed out at a certain point of time.
    • removeCurrentServerTimeOut

      void removeCurrentServerTimeOut()
      Remove current server timeout definition - no time out is defined anymore afterwards.
    • addTimeOutListener

      void addTimeOutListener(IServerTimeOutListener listener)
    • removeTimeOutListener

      void removeTimeOutListener(IServerTimeOutListener listener)
    • findCurrentDurationUntilServerTimeOut

      long findCurrentDurationUntilServerTimeOut()
      Returns:
      negative: no timeout defined; 0: timeout already in past; >0: timeout is scheduled