Method Detail

• getDisplayName

  String getDisplayName()

  The display name of the ClientApp, used in user interfaces. The app must translate.

  Returns:

  non-null

• getName

  String getName()

  The generic name of the ClientApp, used for registration, e.g. "console". Do not translate.

  Returns:

  non-null

• getState

  ClientAppState getState()

  The current state of the ClientApp.

  Returns:

  non-null

• shutdown

  void shutdown(String[] args)
         throws Throwable

  Do not take a long time. Do not block. Use a thread if necessary. If previously running, client must call ClientAppManager.notify() at least once within this method to change the state to STOPPING or STOPPED. May be called multiple times on the same object, in any state.

  Parameters:

  args - generally null but could be stopArgs from clients.config

  Throws:

  Throwable - on shutdown failure

• startup

  void startup()
        throws Throwable

  Do not take a long time. Do not block. Start threads here if necessary. Client must call ClientAppManager.notify() at least once within this method to change the state from INITIALIZED to something else. Will not be called multiple times on the same object.

  Throws:

  Throwable - on startup failure