Package com.artisol.teneo.studio.client.sockets

Interface EventsHandler

  • public interface EventsHandler
    Provides methods to handle Teneo Studio backend events and connection status changes. Implementations of any on...Event methods should not implement long-lasting processes in order to not block the incoming messages from the backend.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void onConnected()
      Is called when connection has established successfully.
      void onConnecting()
      Is called when establishing a WebSockets connection.
      void onDisconnect​(javax.websocket.CloseReason reason)
      Is called when client is disconnected or connection is lost.
      void onEngineEvent​(com.artisol.teneo.studio.api.models.events.EngineEvent event)
      Is called when an EngineEvent occurred.
      void onInactivityUserEvent​(com.artisol.teneo.studio.api.models.events.InactivityUserEvent event)
      Is called when an InactivityUserEvent occurred.
      void onLocksExpiredEvent​(com.artisol.teneo.studio.api.models.events.LocksExpiredEvent event)
      Is called when an LocksExpiredEvent occurred.
      void onLogDataSourceEvent​(com.artisol.teneo.studio.api.models.events.LogDataSourceEvent event)
      Is called when a LogDataSourceEvent occurred.
      void onSentToBinEvent​(com.artisol.teneo.studio.api.models.events.SentToBinEvent event)
      Is called when an SentToBinEvent occurred.
      void onSessionReactivatedEvent​(com.artisol.teneo.studio.api.models.events.SessionReactivatedEvent event)
      Is called when an SessionReactivatedEvent occurred.
      void onSolutionEvent​(com.artisol.teneo.studio.api.models.events.SolutionEvent event)
      Is called when an SolutionEvent occurred.
      void onSolutionLogEvent​(com.artisol.teneo.studio.api.models.events.SolutionLogEvent event)
      Is called when an SolutionLogEvent occurred.
      void onTaskEvent​(com.artisol.teneo.studio.api.models.events.TaskEvent event)
      Is called when an TaskEvent occurred.

    • Method Detail

      • onConnecting

        void onConnecting()
        Is called when establishing a WebSockets connection.

      • onConnected

        void onConnected()
        Is called when connection has established successfully.

      • onDisconnect

        void onDisconnect​(javax.websocket.CloseReason reason)
        Is called when client is disconnected or connection is lost.
        Parameters:
        reason - Reason for disconnect.

      • onEngineEvent

        void onEngineEvent​(com.artisol.teneo.studio.api.models.events.EngineEvent event)
        Is called when an EngineEvent occurred.
        Parameters:
        event - the received EngineEvent

      • onInactivityUserEvent

        void onInactivityUserEvent​(com.artisol.teneo.studio.api.models.events.InactivityUserEvent event)
        Is called when an InactivityUserEvent occurred.
        Parameters:
        event - the received InactivityUserEvent

      • onLocksExpiredEvent

        void onLocksExpiredEvent​(com.artisol.teneo.studio.api.models.events.LocksExpiredEvent event)
        Is called when an LocksExpiredEvent occurred.
        Parameters:
        event - the received LocksExpiredEvent

      • onSentToBinEvent

        void onSentToBinEvent​(com.artisol.teneo.studio.api.models.events.SentToBinEvent event)
        Is called when an SentToBinEvent occurred.
        Parameters:
        event - the received SentToBinEvent

      • onSessionReactivatedEvent

        void onSessionReactivatedEvent​(com.artisol.teneo.studio.api.models.events.SessionReactivatedEvent event)
        Is called when an SessionReactivatedEvent occurred.
        Parameters:
        event - the received SessionReactivatedEvent

      • onSolutionEvent

        void onSolutionEvent​(com.artisol.teneo.studio.api.models.events.SolutionEvent event)
        Is called when an SolutionEvent occurred.
        Parameters:
        event - the received SolutionEvent

      • onSolutionLogEvent

        void onSolutionLogEvent​(com.artisol.teneo.studio.api.models.events.SolutionLogEvent event)
        Is called when an SolutionLogEvent occurred.
        Parameters:
        event - the received SolutionLogEvent

      • onTaskEvent

        void onTaskEvent​(com.artisol.teneo.studio.api.models.events.TaskEvent event)
        Is called when an TaskEvent occurred.
        Parameters:
        event - the received TaskEvent

      • onLogDataSourceEvent

        void onLogDataSourceEvent​(com.artisol.teneo.studio.api.models.events.LogDataSourceEvent event)
        Is called when a LogDataSourceEvent occurred.
        Parameters:
        event - the received LogDataSourceEvent