Package org.mycore.webtools.processing.socket

Interface MCRProcessableWebsocketSender

All Known Implementing Classes:
MCRProcessableWebsocketSenderImpl
public interface MCRProcessableWebsocketSender
Base interface to send processables, collections and the registry over the wire.
Author:
Matthias Eichner

  • Method Details

    • sendError

      void sendError(jakarta.websocket.Session session, Integer errorCode)
      Sends an error code.
      Parameters:
      session - the websocket session
      errorCode - the error code

    • sendRegistry

      void sendRegistry(jakarta.websocket.Session session, MCRProcessableRegistry registry)
      Sends the whole registry.
      Parameters:
      session - the websocket session
      registry - the registry to send

    • addCollection

      void addCollection(jakarta.websocket.Session session, MCRProcessableRegistry registry, MCRProcessableCollection collection)
      Appends the given collection to the registry.
      Parameters:
      session - the websocket session
      registry - where to add the collection
      collection - the collection to add

    • removeCollection

      void removeCollection(jakarta.websocket.Session session, MCRProcessableCollection collection)
      Removes the given collection.
      Parameters:
      session - the websocket session
      collection - the collection to remove

    • addProcessable

      void addProcessable(jakarta.websocket.Session session, MCRProcessableCollection collection, MCRProcessable processable)
      Appends the given processable to the collection.
      Parameters:
      session - the websocket session
      collection - where to add the processable
      processable - the processable to add

    • removeProcessable

      void removeProcessable(jakarta.websocket.Session session, MCRProcessable processable)
      Removes the given processable.
      Parameters:
      session - the websocket session
      processable - the processable to remove

    • updateProcessable

      void updateProcessable(jakarta.websocket.Session session, MCRProcessable processable)
      Updates the content of the given processable.
      Parameters:
      session - the websocket session
      processable - the processable to update

    • updateProperty

      void updateProperty(jakarta.websocket.Session session, MCRProcessableCollection collection, String name, Object value)
      Updates a property of the given processable collection.
      Parameters:
      session - the websocket session
      collection - the collection to update
      name - name of the property
      value - value of the property