Package com.artisol.teneo.inquire.client.resources

Class AugmentersResourceImpl

  • All Implemented Interfaces:
    com.artisol.teneo.inquire.api.resources.AugmentersResource
    public class AugmentersResourceImpl
extends AbstractResource
implements com.artisol.teneo.inquire.api.resources.AugmentersResource

    • Field Summary

      • Fields inherited from interface com.artisol.teneo.inquire.api.resources.AugmentersResource

        DELETE_ACTION_PATH, DELETE_ACTION_SUMMARY, DELETE_ACTIONS_PATH, DELETE_ACTIONS_SUMMARY, DELETE_ADORNER_PATH, DELETE_ADORNER_SUMMARY, DELETE_AGGREGATOR_PATH, DELETE_AGGREGATOR_SUMMARY, GET_ACTION_PATH, GET_ACTION_SUMMARY, GET_ACTIONS_PATH, GET_ACTIONS_SUMMARY, GET_ADORNER_PATH, GET_ADORNER_SUMMARY, GET_ADORNERS_PATH, GET_ADORNERS_SUMMARY, GET_AGGREGATOR_PATH, GET_AGGREGATOR_SUMMARY, GET_AGGREGATORS_BUCKETS_PATH, GET_AGGREGATORS_BUCKETS_SUMMARY, GET_AGGREGATORS_PATH, GET_AGGREGATORS_SUMMARY, GET_EXPORT_PATH, GET_EXPORT_SUMMARY, GET_OVERVIEW_PATH, GET_OVERVIEW_SUMMARY, GET_SOLUTION_REVISIONS_PATH, GET_SOLUTION_REVISIONS_SUMMARY, PATH, POST_ACTION_CREATE_PATH, POST_ACTION_CREATE_SUMMARY, POST_ACTION_PERFORM_PATH, POST_ACTION_PERFORM_SUMMARY, POST_ACTIONS_PERFORM_PATH, POST_ACTIONS_PERFORM_SUMMARY, POST_ADORNER_CREATE_PATH, POST_ADORNER_CREATE_SUMMARY, POST_ADORNER_DISABLE_PATH, POST_ADORNER_DISABLE_SUMMARY, POST_ADORNER_ENABLE_PATH, POST_ADORNER_ENABLE_SUMMARY, POST_ADORNERS_TEST_GROOVY_PATH, POST_ADORNERS_TEST_GROOVY_SUMMARY, POST_ADORNERS_TEST_TQL_PATH, POST_ADORNERS_TEST_TQL_SUMMARY, POST_AGGREGATOR_CREATE_PATH, POST_AGGREGATOR_CREATE_SUMMARY, POST_AGGREGATOR_DISABLE_PATH, POST_AGGREGATOR_DISABLE_SUMMARY, POST_AGGREGATOR_ENABLE_PATH, POST_AGGREGATOR_ENABLE_SUMMARY, POST_AGGREGATORS_TEST_GROOVY_PATH, POST_AGGREGATORS_TEST_GROOVY_SUMMARY, POST_AGGREGATORS_TEST_TQL_PATH, POST_AGGREGATORS_TEST_TQL_SUMMARY, POST_IMPORT_PATH, POST_IMPORT_SUMMARY, PUT_ACTION_UPDATE_PATH, PUT_ACTION_UPDATE_SUMMARY, PUT_ADORNER_UPDATE_PATH, PUT_ADORNER_UPDATE_SUMMARY, PUT_AGGREGATOR_UPDATE_PATH, PUT_AGGREGATOR_UPDATE_SUMMARY

    • Constructor Summary

      Constructors 
      Constructor Description
      AugmentersResourceImpl​(javax.ws.rs.client.WebTarget webTarget)  

    • Constructor Detail

      • AugmentersResourceImpl

        public AugmentersResourceImpl​(javax.ws.rs.client.WebTarget webTarget)

    • Method Detail

      • createAdorner

        public String createAdorner​(String ldsName,
                            com.artisol.teneo.inquire.api.models.Adorner adorner)
                     throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action to add an adorner. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        adorner - the adorner model
        Returns:
        id of the created adorner action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • updateAdorner

        public String updateAdorner​(String ldsName,
                            String adornerId,
                            com.artisol.teneo.inquire.api.models.Adorner adorner)
                     throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action to update an adorner. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        adornerId - id of the adorner
        adorner - the adorner model
        Returns:
        id of the created adorner action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • createAggregator

        public String createAggregator​(String ldsName,
                               com.artisol.teneo.inquire.api.models.Aggregator aggregator)
                        throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action to add an aggregator. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        aggregator - the aggregator model
        Returns:
        id of the created aggregator action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • updateAggregator

        public String updateAggregator​(String ldsName,
                               String aggregatorId,
                               com.artisol.teneo.inquire.api.models.Aggregator aggregator)
                        throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action to update an aggregator. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        aggregatorId - id of the aggregator
        aggregator - the aggregator model
        Returns:
        id of the created aggregator action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • getAdorner

        public com.artisol.teneo.inquire.api.models.Adorner getAdorner​(String ldsName,
                                                               String adornerId)
                                                        throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Gets an adorner.
        Parameters:
        ldsName - Log Data Source name
        adornerId - id of the adorner to get
        Returns:
        the adorner model
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • getAggregator

        public com.artisol.teneo.inquire.api.models.Aggregator getAggregator​(String ldsName,
                                                                     String aggregatorId)
                                                              throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Gets an aggregator.
        Parameters:
        ldsName - Log Data Source name
        aggregatorId - id of the aggregator to get
        Returns:
        the aggregator model
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • getAdorners

        public List<com.artisol.teneo.inquire.api.models.Adorner> getAdorners​(String ldsName)
                                                               throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Gets the adorners present in the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        Returns:
        A list of adorner models
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • getAggregators

        public List<com.artisol.teneo.inquire.api.models.Aggregator> getAggregators​(String ldsName)
                                                                     throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Gets the aggregators present in the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        Returns:
        list of aggregator models
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • enableAdorner

        public String enableAdorner​(String ldsName,
                            String adornerId)
                     throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action that enables an adorner. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        adornerId - id of the adorner to enable
        Returns:
        id of the created adorner action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • disableAdorner

        public String disableAdorner​(String ldsName,
                             String adornerId)
                      throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action that disables an adorner. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        adornerId - id of the adorner to disable
        Returns:
        id of the created adorner action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • enableAggregator

        public String enableAggregator​(String ldsName,
                               String aggregatorId)
                        throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action that enables an aggregator. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        aggregatorId - id of the aggregator to enable
        Returns:
        id of the created aggregator action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • disableAggregator

        public String disableAggregator​(String ldsName,
                                String aggregatorId)
                         throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action that disables an aggregator. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        aggregatorId - id of the aggregator to disable
        Returns:
        id of the created aggregator action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • deleteAdorner

        public String deleteAdorner​(String ldsName,
                            String adornerId)
                     throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action to delete an adorner. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        adornerId - id of the adorner to delete
        Returns:
        id of the created adorner action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • deleteAggregator

        public String deleteAggregator​(String ldsName,
                               String aggregatorId)
                        throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Creates an action to delete an aggregator. The created action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        aggregatorId - id of the aggregator to delete
        Returns:
        id of the created aggregator action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • createAction

        public com.artisol.teneo.inquire.api.models.AugmenterAction createAction​(String ldsName,
                                                                         com.artisol.teneo.inquire.api.models.AugmenterAction action)
                                                                  throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Create an action. The action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        action - the action model
        Returns:
        the created action model
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • updateAction

        public com.artisol.teneo.inquire.api.models.AugmenterAction updateAction​(String ldsName,
                                                                         String actionId,
                                                                         com.artisol.teneo.inquire.api.models.AugmenterAction action)
                                                                  throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Updates an action. The action is queued for later execution.
        Parameters:
        ldsName - Log Data Source name
        actionId - id of the action
        action - the action model
        Returns:
        the updated action model
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • getAction

        public com.artisol.teneo.inquire.api.models.AugmenterAction getAction​(String ldsName,
                                                                      String actionId)
                                                               throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Gets an action.
        Parameters:
        ldsName - Log Data Source name
        actionId - id of the action
        Returns:
        the action model
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • getActions

        public List<com.artisol.teneo.inquire.api.models.AugmenterAction> getActions​(String ldsName)
                                                                      throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Returns a list of actions that are pending to be executed for a particular Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        Returns:
        list of AugmenterAction
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • deleteAction

        public void deleteAction​(String ldsName,
                         String actionId)
                  throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Deletes a action waiting for execution.
        Parameters:
        ldsName - Log Data Source name
        actionId - id of the action
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • deleteActions

        public void deleteActions​(String ldsName)
                   throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Deletes all actions waiting for execution.
        Parameters:
        ldsName - Log Data Source name
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • performAction

        public List<String> performAction​(String ldsName,
                                  String actionId)
                           throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Executes a waiting action.
        Parameters:
        ldsName - Log Data Source name
        actionId - id of the action
        Returns:
        a list of warning messages
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • performActions

        public List<String> performActions​(String ldsName)
                            throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Executes all waiting actions.
        Parameters:
        ldsName - Log Data Source name
        Returns:
        a list of warning messages
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • importAugmenters

        public List<com.artisol.teneo.inquire.api.models.AugmenterImportResult> importAugmenters​(String ldsName,
                                                                                         InputStream zipData)
                                                                                  throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Imports augmenters packaged as ZIP file into the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        zipData - an input stream containing the ZIP data
        Returns:
        a list of import results, one per augmenter
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • exportAugmenters

        public InputStream exportAugmenters​(String ldsName)
                             throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Returns all augmenters of the specified Log Data Source, packaged as ZIP file.
        Parameters:
        ldsName - Log Data Source name
        Returns:
        an input stream containing the ZIP data
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • getAugmentersOverview

        public com.artisol.teneo.inquire.api.models.AugmentersOverview getAugmentersOverview​(String ldsName)
                                                                              throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Returns the augmenters overview for the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        Returns:
        an AugmentersOverview object with overview data for all existing adorners and aggregators
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • getSolutionRevisions

        public SortedSet<Long> getSolutionRevisions​(String ldsName)
                                     throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Returns all available solution revisions for the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        Returns:
        the solution revisions
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • listAggregatorBuckets

        public List<com.artisol.teneo.inquire.api.models.AggregatorBucketInfo> listAggregatorBuckets​(String ldsName)
                                                                                      throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Lists all available aggregator buckets for the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        Returns:
        a list of bucket info objects
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • testTqlAdorner

        public com.artisol.teneo.inquire.api.models.TqlAdornerTestResult testTqlAdorner​(String ldsName,
                                                                                com.artisol.teneo.inquire.api.models.Adorner tqlAdorner)
                                                                         throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Tests a TQL adorner in the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        tqlAdorner - the TQL adorner model to test
        Returns:
        the test result data
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • testGroovyAdorner

        public com.artisol.teneo.inquire.api.models.GroovyAdornerTestResult testGroovyAdorner​(String ldsName,
                                                                                      com.artisol.teneo.inquire.api.models.Adorner groovyAdorner)
                                                                               throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Tests a Groovy adorner in the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        groovyAdorner - the Groovy adorner model to test
        Returns:
        the test result data
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • testTqlAggregator

        public com.artisol.teneo.inquire.api.models.TqlAggregatorTestResult testTqlAggregator​(String ldsName,
                                                                                      com.artisol.teneo.inquire.api.models.Aggregator tqlAggregator)
                                                                               throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Tests a TQL aggregator in the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        tqlAggregator - the TQL aggregator model to test
        Returns:
        the test result data
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution

      • testGroovyAggregator

        public com.artisol.teneo.inquire.api.models.GroovyAggregatorTestResult testGroovyAggregator​(String ldsName,
                                                                                            com.artisol.teneo.inquire.api.models.Aggregator groovyAggregator)
                                                                                     throws com.artisol.teneo.inquire.api.exceptions.InquireException
        Tests a Groovy aggregator in the specified Log Data Source.
        Parameters:
        ldsName - Log Data Source name
        groovyAggregator - the Groovy aggregator model to test
        Returns:
        the test result data
        Throws:
        com.artisol.teneo.inquire.api.exceptions.InquireException - if an unexpected error occurs during the method execution