Interface MessageStore

    • Method Detail

      • setParameters

        void setParameters​(Map<String,​Object> parameters)
        set the implementation specific parameters
        Parameters:
        parameters - A map of parameters or null
      • getParameters

        Map<String,​Object> getParameters()
        get the implementation specific parameters of the Message store
        Returns:
        a properties map
      • addParameter

        void addParameter​(String name,
                          String key)
        Adds message store specific parameters
        Parameters:
        name - parameter name
        key - parameter key value
      • addParameterKey

        void addParameterKey​(String name,
                             String key)
        Adds message store parameter registry keys
        Parameters:
        name - parameter name
        key - parameter registry key value
      • getParameterKey

        String getParameterKey​(String name)
        Gets parameter registry key from the parameter name
        Parameters:
        name - parameter name
        Returns:
        registry key of parameter value
      • getParameterKeyMap

        Map<String,​String> getParameterKeyMap()
        Gets registry key mappings for the parameters
        Returns:
        registry key maps for parameter values
      • setFileName

        void setFileName​(String filename)
        Set the name of the file that the Message store is configured
        Parameters:
        filename - Name of the file where this artifact is defined
      • getFileName

        String getFileName()
        get the file name that the message store is configured
        Returns:
        Name of the file where this artifact is defined
      • clear

        void clear()
        Delete all the Messages in the Message Store
      • remove

        MessageContext remove​(String messageID)
        Delete and return the MessageContext with given Message id
        Parameters:
        messageID - message id of the Message
        Returns:
        MessageContext instance
      • size

        int size()
        Returns the number of Messages in this store.
        Returns:
        the number of Messages in this Store
      • get

        MessageContext get​(int index)
        Return the Message in given index position (this may depend on the implementation)
        Parameters:
        index - position of the message
        Returns:
        Message in given index position
      • getAll

        List<MessageContext> getAll()
        Get the All messages in the Message store without removing them from the queue
        Returns:
        List of all Messages
      • get

        MessageContext get​(String messageId)
        Get the Message with the given ID from the Message store without removing it
        Parameters:
        messageId - A message ID string
        Returns:
        Message with given ID
      • isEdited

        boolean isEdited()
        Whether the message store edited through the management console
        Returns:
        true if Message Store config is locally edited
      • setIsEdited

        void setIsEdited​(boolean isEdited)
        Set whether the message store edited through the management console
        Parameters:
        isEdited - true if Message Store config is locally edited
      • getArtifactContainerName

        String getArtifactContainerName()
        Get the name of the artifact container from which the message store deployed
        Returns:
        Name of artifact container
      • setArtifactContainerName

        void setArtifactContainerName​(String artifactContainerName)
        Set the name of the artifact container from which the message store deployed
        Parameters:
        artifactContainerName - name of artifact container