Package org.jboss.jbossts.star.client

Interface SRAClientAPI

  • All Known Implementing Classes:
    SRAClient
    public interface SRAClientAPI

    • Method Detail

      • startSRA

        URL startSRA​(URL parentSRA,
             String clientID,
             Long timeout,
             TimeUnit unit)
      throws GenericSRAException
        Parameters:
        parentSRA - the parent SRA if this new SRA is nested
        clientID - Each client is expected to have a unique identity (which can be a URL). (optional)
        timeout - Specifies the maximum time in seconds that the SRA will exist for. If the SRA is terminated because of a timeout, the SRA URL is deleted. All further invocations on the URL will return 404. The invoker can assume this was equivalent to a compensate operation. (optional, default to 0)
        unit -
        Returns:
        the id of the new SRA
        Throws:
        GenericSRAException

      • cancelSRA

        String cancelSRA​(URL sraId)
          throws GenericSRAException
        Attempt to cancel an SRA Trigger the compensation of the SRA. All compensators will be triggered by the coordinator (ie the compensate message will be sent to each compensators). Upon termination, the URL is implicitly deleted. The invoker cannot know for sure whether the sra completed or compensated without enlisting a io.narayana.sra.
        Parameters:
        sraId - The unique identifier of the SRA (required)
        Returns:
        compensator sepcific data provided by the application for nested SRA the API implementation will combine compensator data into a JSON encoded array. This means that compensators MUST not return any data that starts with the JSON array start token (ie a '[' character)
        Throws:
        GenericSRAException - Comms error

      • commitSRA

        String commitSRA​(URL sraId)
          throws GenericSRAException
        Attempt to close an SRA Trigger the successful completion of the SRA. All compensators will be dropped by the coordinator. The complete message will be sent to the compensators. Upon termination, the URL is implicitly deleted. The invoker cannot know for sure whether the sra completed or compensated without enlisting a io.narayana.sra.
        Parameters:
        sraId - The unique identifier of the SRA (required)
        Returns:
        compensator sepcific data provided by the application for nested SRA the API implementation will combine compensator data into a JSON encoded array. This means that compensators MUST not return any data that starts with the JSON array start token (ie a '[' character)
        Throws:
        GenericSRAException - Comms error

      • joinSRA

        void joinSRA​(URL sraId,
             Long timelimit,
             String body)
      throws GenericSRAException
        A SRAParticipant can join with the SRA at any time prior to the completion of an activity
        Parameters:
        sraId - The unique identifier of the SRA (required)
        timelimit - The time limit (in seconds) that the SRAParticipant can guarantee that it can compensate the work performed by the io.narayana.sra.demo.service. After this time period has elapsed, it may no longer be possible to undo the work within the scope of this (or any enclosing) SRA. It may therefore be necessary for the application or io.narayana.sra.demo.service to start other activities to explicitly try to compensate this work. The application or coordinator may use this information to control the lifecycle of a SRA. (required)
        body - The resource path that the SRA coordinator will use to drive the compensator. Performing a GET on the compensator URL will return the current status of the compensator, or 404 if the compensator is no longer present. The following types must be returned by Compensators to indicate their current status: - Compensating: the SRAParticipant is currently compensating for the SRA; - Compensated: the SRAParticipant has successfully compensated for the SRA. - FailedToCompensate: the SRAParticipant was not able to compensate for the SRA. It must maintain information about the work it was to compensate until the coordinator sends it a forget message. - Completing: the SRAParticipant is tidying up after being told to complete. - Completed: the coordinator/io.narayana.sra has confirmed. - FailedToComplete: the SRAParticipant was unable to tidy-up. Performing a POST on URL/compensate will cause the compensator to compensate the work that was done within the scope of the SRA. Performing a POST on URL/complete will cause the compensator to tidy up and it can forget this SRA. (optional)
        Throws:
        GenericSRAException - Comms error

      • joinSRA

        String joinSRA​(URL sraId,
               Long timelimit,
               String compensateUrl,
               String completeUrl,
               String leaveUrl,
               String statusUrl)
        throws GenericSRAException
        Similar to joinSRA(URL, Long, String) but the various compensator urls are passed in explicitly
        Parameters:
        sraId - The unique identifier of the SRA (required)
        timelimit - The time limit (in seconds) that the SRAParticipant can guarantee that it can compensate the work performed by the io.narayana.sra.demo.service
        compensateUrl - Performing a POST onthis URL will cause the io.narayana.sra to compensate the work that was done within the scope of the SRA.
        completeUrl - Performing a POST on this URL will cause the io.narayana.sra to tidy up and it can forget this transaction.
        leaveUrl - Performing a PUT on this URL with cause the compensator to leave the SRA
        statusUrl - Performing a GET on this URL will return the status of the compensator {@see joinSRA}
        Throws:
        GenericSRAException

      • getCurrent

        URL getCurrent()
        checks whether there is an SRA associated with the calling thread
        Returns: