Package com.fifa.connectservicebus.sdk.api

Interface Messages

  • All Known Implementing Classes:
    MessagesImpl
    public interface Messages
    An instance of this class provides access to all the operations defined in Messages.

    • Method Detail

      • sendByRecipientAndActionAndProperties

        Object sendByRecipientAndActionAndProperties​(String recipient,
                                             byte[] body)
        Sends a message to a specified recipient via Message Bus.
        Parameters:
        recipient - Recipient, usually MA to receive the message.
        body - Message body
        Returns:
        the Object object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.rest.RestException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • sendByRecipientAndActionAndPropertiesAsync

        com.microsoft.rest.ServiceFuture<Object> sendByRecipientAndActionAndPropertiesAsync​(String recipient,
                                                                                    byte[] body,
                                                                                    com.microsoft.rest.ServiceCallback<Object> serviceCallback)
        Sends a message to a specified recipient via Message Bus.
        Parameters:
        recipient - Recipient, usually MA to receive the message.
        body - Message body
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • sendByRecipientAndActionAndPropertiesAsync

        rx.Observable<Object> sendByRecipientAndActionAndPropertiesAsync​(String recipient,
                                                                 byte[] body)
        Sends a message to a specified recipient via Message Bus.
        Parameters:
        recipient - Recipient, usually MA to receive the message.
        body - Message body
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • sendByRecipientAndActionAndPropertiesWithServiceResponseAsync

        rx.Observable<com.microsoft.rest.ServiceResponse<Object>> sendByRecipientAndActionAndPropertiesWithServiceResponseAsync​(String recipient,
                                                                                                                        byte[] body)
        Sends a message to a specified recipient via Message Bus.
        Parameters:
        recipient - Recipient, usually MA to receive the message.
        body - Message body
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • sendByRecipientAndActionAndProperties

        Object sendByRecipientAndActionAndProperties​(String recipient,
                                             byte[] body,
                                             String xAction,
                                             String xProperties)
        Sends a message to a specified recipient via Message Bus.
        Parameters:
        recipient - Recipient, usually MA to receive the message.
        body - Message body
        xAction - Name of the action represented by the message. Optional parameter
        xProperties - Unencrypted properties of the message. Optional parameter
        Returns:
        the Object object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.rest.RestException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • sendByRecipientAndActionAndPropertiesAsync

        com.microsoft.rest.ServiceFuture<Object> sendByRecipientAndActionAndPropertiesAsync​(String recipient,
                                                                                    byte[] body,
                                                                                    String xAction,
                                                                                    String xProperties,
                                                                                    com.microsoft.rest.ServiceCallback<Object> serviceCallback)
        Sends a message to a specified recipient via Message Bus.
        Parameters:
        recipient - Recipient, usually MA to receive the message.
        body - Message body
        xAction - Name of the action represented by the message. Optional parameter
        xProperties - Unencrypted properties of the message. Optional parameter
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • sendByRecipientAndActionAndPropertiesAsync

        rx.Observable<Object> sendByRecipientAndActionAndPropertiesAsync​(String recipient,
                                                                 byte[] body,
                                                                 String xAction,
                                                                 String xProperties)
        Sends a message to a specified recipient via Message Bus.
        Parameters:
        recipient - Recipient, usually MA to receive the message.
        body - Message body
        xAction - Name of the action represented by the message. Optional parameter
        xProperties - Unencrypted properties of the message. Optional parameter
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • sendByRecipientAndActionAndPropertiesWithServiceResponseAsync

        rx.Observable<com.microsoft.rest.ServiceResponse<Object>> sendByRecipientAndActionAndPropertiesWithServiceResponseAsync​(String recipient,
                                                                                                                        byte[] body,
                                                                                                                        String xAction,
                                                                                                                        String xProperties)
        Sends a message to a specified recipient via Message Bus.
        Parameters:
        recipient - Recipient, usually MA to receive the message.
        body - Message body
        xAction - Name of the action represented by the message. Optional parameter
        xProperties - Unencrypted properties of the message. Optional parameter
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • receiveByRequest

        Object receiveByRequest()
        Gets a message from the Message Bus. Message is deleted from the queue.
        Returns:
        the Object object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.rest.RestException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • receiveByRequestAsync

        com.microsoft.rest.ServiceFuture<Object> receiveByRequestAsync​(com.microsoft.rest.ServiceCallback<Object> serviceCallback)
        Gets a message from the Message Bus. Message is deleted from the queue.
        Parameters:
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • receiveByRequestAsync

        rx.Observable<Object> receiveByRequestAsync()
        Gets a message from the Message Bus. Message is deleted from the queue.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • receiveByRequestWithServiceResponseAsync

        rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Object,​MessageReceiveByRequestHeaders>> receiveByRequestWithServiceResponseAsync()
        Gets a message from the Message Bus. Message is deleted from the queue.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • receiveByRequest

        Object receiveByRequest​(Integer timeout)
        Gets a message from the Message Bus. Message is deleted from the queue.
        Parameters:
        timeout - The system will wait N number of seconds before returning "no messages available" message.
        Returns:
        the Object object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.rest.RestException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • receiveByRequestAsync

        com.microsoft.rest.ServiceFuture<Object> receiveByRequestAsync​(Integer timeout,
                                                               com.microsoft.rest.ServiceCallback<Object> serviceCallback)
        Gets a message from the Message Bus. Message is deleted from the queue.
        Parameters:
        timeout - The system will wait N number of seconds before returning "no messages available" message.
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • receiveByRequestAsync

        rx.Observable<Object> receiveByRequestAsync​(Integer timeout)
        Gets a message from the Message Bus. Message is deleted from the queue.
        Parameters:
        timeout - The system will wait N number of seconds before returning "no messages available" message.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • receiveByRequestWithServiceResponseAsync

        rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Object,​MessageReceiveByRequestHeaders>> receiveByRequestWithServiceResponseAsync​(Integer timeout)
        Gets a message from the Message Bus. Message is deleted from the queue.
        Parameters:
        timeout - The system will wait N number of seconds before returning "no messages available" message.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • peekLockByRequest

        Object peekLockByRequest()
        Gets and locks a message without deleting it from the queue. If message is not deleted within configured time it's automatically unlocked and visible for other recipients.
        Returns:
        the Object object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.rest.RestException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • peekLockByRequestAsync

        com.microsoft.rest.ServiceFuture<Object> peekLockByRequestAsync​(com.microsoft.rest.ServiceCallback<Object> serviceCallback)
        Gets and locks a message without deleting it from the queue. If message is not deleted within configured time it's automatically unlocked and visible for other recipients.
        Parameters:
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • peekLockByRequestAsync

        rx.Observable<Object> peekLockByRequestAsync()
        Gets and locks a message without deleting it from the queue. If message is not deleted within configured time it's automatically unlocked and visible for other recipients.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • peekLockByRequestWithServiceResponseAsync

        rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Object,​MessagePeekLockByRequestHeaders>> peekLockByRequestWithServiceResponseAsync()
        Gets and locks a message without deleting it from the queue. If message is not deleted within configured time it's automatically unlocked and visible for other recipients.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • peekLockByRequest

        Object peekLockByRequest​(Integer timeout)
        Gets and locks a message without deleting it from the queue. If message is not deleted within configured time it's automatically unlocked and visible for other recipients.
        Parameters:
        timeout - The system will wait N number of seconds before returning "no messages available" message.
        Returns:
        the Object object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.rest.RestException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • peekLockByRequestAsync

        com.microsoft.rest.ServiceFuture<Object> peekLockByRequestAsync​(Integer timeout,
                                                                com.microsoft.rest.ServiceCallback<Object> serviceCallback)
        Gets and locks a message without deleting it from the queue. If message is not deleted within configured time it's automatically unlocked and visible for other recipients.
        Parameters:
        timeout - The system will wait N number of seconds before returning "no messages available" message.
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • peekLockByRequestAsync

        rx.Observable<Object> peekLockByRequestAsync​(Integer timeout)
        Gets and locks a message without deleting it from the queue. If message is not deleted within configured time it's automatically unlocked and visible for other recipients.
        Parameters:
        timeout - The system will wait N number of seconds before returning "no messages available" message.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • peekLockByRequestWithServiceResponseAsync

        rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Object,​MessagePeekLockByRequestHeaders>> peekLockByRequestWithServiceResponseAsync​(Integer timeout)
        Gets and locks a message without deleting it from the queue. If message is not deleted within configured time it's automatically unlocked and visible for other recipients.
        Parameters:
        timeout - The system will wait N number of seconds before returning "no messages available" message.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deleteByRequest

        Object deleteByRequest​(String messageId,
                       String lockToken)
        Deletes a previously locked message (see PeekLock method).
        Parameters:
        messageId - Message identifier returned by a previously called "peeklock" method.
        lockToken - Lock token, returned by a previously called "peeklock" method.
        Returns:
        the Object object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.rest.RestException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deleteByRequestAsync

        com.microsoft.rest.ServiceFuture<Object> deleteByRequestAsync​(String messageId,
                                                              String lockToken,
                                                              com.microsoft.rest.ServiceCallback<Object> serviceCallback)
        Deletes a previously locked message (see PeekLock method).
        Parameters:
        messageId - Message identifier returned by a previously called "peeklock" method.
        lockToken - Lock token, returned by a previously called "peeklock" method.
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deleteByRequestAsync

        rx.Observable<Object> deleteByRequestAsync​(String messageId,
                                           String lockToken)
        Deletes a previously locked message (see PeekLock method).
        Parameters:
        messageId - Message identifier returned by a previously called "peeklock" method.
        lockToken - Lock token, returned by a previously called "peeklock" method.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deleteByRequestWithServiceResponseAsync

        rx.Observable<com.microsoft.rest.ServiceResponse<Object>> deleteByRequestWithServiceResponseAsync​(String messageId,
                                                                                                  String lockToken)
        Deletes a previously locked message (see PeekLock method).
        Parameters:
        messageId - Message identifier returned by a previously called "peeklock" method.
        lockToken - Lock token, returned by a previously called "peeklock" method.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • unlockByRequest

        Object unlockByRequest​(String messageId,
                       String lockToken)
        Unlocks a previously locked message. The message is returned to the queue and can be fetched using PeekLock method.
        Parameters:
        messageId - Message identifier returned by a previously called "peeklock" method.
        lockToken - Lock token, returned by a previously called "peeklock" method.
        Returns:
        the Object object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        com.microsoft.rest.RestException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • unlockByRequestAsync

        com.microsoft.rest.ServiceFuture<Object> unlockByRequestAsync​(String messageId,
                                                              String lockToken,
                                                              com.microsoft.rest.ServiceCallback<Object> serviceCallback)
        Unlocks a previously locked message. The message is returned to the queue and can be fetched using PeekLock method.
        Parameters:
        messageId - Message identifier returned by a previously called "peeklock" method.
        lockToken - Lock token, returned by a previously called "peeklock" method.
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • unlockByRequestAsync

        rx.Observable<Object> unlockByRequestAsync​(String messageId,
                                           String lockToken)
        Unlocks a previously locked message. The message is returned to the queue and can be fetched using PeekLock method.
        Parameters:
        messageId - Message identifier returned by a previously called "peeklock" method.
        lockToken - Lock token, returned by a previously called "peeklock" method.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • unlockByRequestWithServiceResponseAsync

        rx.Observable<com.microsoft.rest.ServiceResponse<Object>> unlockByRequestWithServiceResponseAsync​(String messageId,
                                                                                                  String lockToken)
        Unlocks a previously locked message. The message is returned to the queue and can be fetched using PeekLock method.
        Parameters:
        messageId - Message identifier returned by a previously called "peeklock" method.
        lockToken - Lock token, returned by a previously called "peeklock" method.
        Returns:
        the observable to the Object object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation