Package org.gcube.event.publisher

Interface EventPublisher

All Known Implementing Classes:
AbstractEventPublisher
public interface EventPublisher

  • Method Details

    • publish

      void publish(Event event)
      Publish a new event and nothing more. The sender is not interested to the success/failure of the send. The results on the workflow engine, is the start of an instance of the workflow identified by the Event.getName() string.
      Parameters:
      event - the event to be published

    • publish

      String publish(Event event, boolean waitForResult)
      Publishes a new event and optionally wait for the result. If waitForResult parameter is false the behavior is the same of the publish(Event) method, if true, the workflow id is returned as string if the publish had success.
      Parameters:
      event - the vent to be published
      waitForResult - if the sender is interested or not to the resulting workflow id
      Returns:
      the resulting workflow id

    • isLastPublishOK

      boolean isLastPublishOK()
      Tells if the last publish was a success or not.
      Returns:
      true if the publish was OK, false otherwise

    • getLastPublishEventHTTPResponseCode

      int getLastPublishEventHTTPResponseCode()
      Returns the last returned HTTP response code of a publish. E.g. 200 if the send was OK or 404 if the event doesn't have a corresponding workflow definition.
      Returns:
      the HTTP response code of the last publish or -1 if an error occurred before the call (e.g. during the authorization or connection)

    • publishAndCheck

      EventStatus publishAndCheck(Event event)
      Publish an event and immediately checks for the results status. The behavior is the same of the publishAndCheck(Event, int) with delayMS argument less or equal to 0.
      Parameters:
      event - the event to be published
      Returns:
      an object with info about the event's running status

    • publishAndCheck

      EventStatus publishAndCheck(Event event, int delayMS)
      Publish an event and checks for the results status after a delay. The behavior is the same of the publishAndCheck(Event) if delayMS argument is less or equal to 0.
      Parameters:
      event - the event to be published
      delayMS - the delay betwen the publish and the query calls
      Returns:
      an object with info about the event's running status

    • check

      EventStatus check(String instanceId)
      Checks for the workflow results status.
      Parameters:
      instanceId - the workflow instance id, resulting of the publish(Event, boolean) with waitForResult as true.
      Returns:
      an object with info about the event's running status

    • refresh

      EventStatus refresh(EventStatus eventStatus)
      Refreshes an event status by checking for the status of the workflow execution represented by the EventStatus.getInstanceId() string.
      Parameters:
      eventStatus - a previously obtained event status.
      Returns:
      an object with new info about the event's running status

    • isLastCheckOK

      boolean isLastCheckOK()
      Tells if the last check was a success or not.
      Returns:
      true if the publish was OK, false otherwise

    • getLastCheckHTTPResponseCode

      int getLastCheckHTTPResponseCode()
      Returns the last returned HTTP response code of a check. E.g. 200 if the send was OK or 404 if the event doesn't have a corresponding workflow instance.
      Returns:
      the HTTP response code of the last publish or -1 if an error occurred before the call (e.g. during the authorization or connection)