Package com.artisol.teneo.studio.client

Class TeneoStudioClient

  • public class TeneoStudioClient
extends Object
    Teneo Studio Client. It conveniently wraps the REST calls to Teneo Studio Server API. Before using any resource, user must be logged in.

    • Constructor Detail

      • TeneoStudioClient

        public TeneoStudioClient​(String host,
                         boolean isSecureConnection)
        Creates a new client instance.
        Parameters:
        host - base host address of the Studio back-end to connect to (e.g. "host:8080/teneo-studio")
        isSecureConnection - indicates whether to use a secure connection

      • TeneoStudioClient

        public TeneoStudioClient​(String host,
                         boolean isSecureConnection,
                         String accessToken)
        Creates a new client instance.
        Parameters:
        host - base host address of the Studio back-end to connect to (e.g. "host:8080/teneo-studio")
        isSecureConnection - indicates whether to use a secure connection
        accessToken - a valid access token to be used

    • Method Detail

      • getAdmin

        public com.artisol.teneo.studio.api.resources.AdminResource getAdmin()
        Returns:
        A callable resource implementing AdminResource interface

      • getAuth

        public com.artisol.teneo.studio.api.resources.AuthResource getAuth()
        Returns:
        A callable resource implementing AuthResource interface

      • getAutoTests

        public com.artisol.teneo.studio.api.resources.AutoTestsResource getAutoTests()
        Returns:
        A callable resource implementing AutoTestsResource interface

      • getBatchRequests

        public com.artisol.teneo.studio.api.resources.BatchRequestsResource getBatchRequests()
        Returns:
        A callable resource implementing BatchRequestsResource interface

      • getClasses

        public com.artisol.teneo.studio.api.resources.ClassesResource getClasses()
        Returns:
        A callable resource implementing ClassesResource interface

      • getCLU

        public com.artisol.teneo.studio.api.resources.CLUResource getCLU()
        Returns:
        A callable resource implementing CLUResource interface

      • getCopilot

        public com.artisol.teneo.studio.api.resources.CopilotResource getCopilot()
        Returns:
        A callable resource implementing CopilotResource interface

      • getCustomers

        public com.artisol.teneo.studio.api.resources.CustomersResource getCustomers()
        Returns:
        A callable resource implementing CustomersResource interface

      • getDocuments

        public com.artisol.teneo.studio.api.resources.DocumentsResource getDocuments()
        Returns:
        A callable resource implementing DocumentsResource interface

      • getEmotions

        public com.artisol.teneo.studio.api.resources.EmotionsResource getEmotions()
        Returns:
        A callable resource implementing EmotionsResource interface

      • getEngines

        public com.artisol.teneo.studio.api.resources.EnginesResource getEngines()
        Returns:
        A callable resource implementing EnginesResource interface

      • getEntities

        public com.artisol.teneo.studio.api.resources.EntitiesResource getEntities()
        Returns:
        A callable resource implementing EntitiesResource interface

      • getFileResources

        public com.artisol.teneo.studio.api.resources.FileResourcesResource getFileResources()
        Returns:
        A callable resource implementing FileResourcesResource interface

      • getFlows

        public com.artisol.teneo.studio.api.resources.FlowsResource getFlows()
        Returns:
        A callable resource implementing FlowsResource interface

      • getFolders

        public com.artisol.teneo.studio.api.resources.FoldersResource getFolders()
        Returns:
        A callable resource implementing FoldersResource interface

      • getGlobalListeners

        public com.artisol.teneo.studio.api.resources.GlobalListenersResource getGlobalListeners()
        Returns:
        A callable resource implementing GlobalListenersResource interface

      • getGlobalScripts

        public com.artisol.teneo.studio.api.resources.GlobalScriptsResource getGlobalScripts()
        Returns:
        A callable resource implementing GlobalScriptsResource interface

      • getGlobalVariables

        public com.artisol.teneo.studio.api.resources.GlobalVariablesResource getGlobalVariables()
        Returns:
        A callable resource implementing GlobalVariablesResource interface

      • getInputProcessors

        public com.artisol.teneo.studio.api.resources.InputProcessorsResource getInputProcessors()
        Returns:
        A callable resource implementing InputProcessorsResource interface

      • getIntegrations

        public com.artisol.teneo.studio.api.resources.IntegrationsResource getIntegrations()
        Returns:
        A callable resource implementing IntegrationsResource interface

      • getIntentModels

        public com.artisol.teneo.studio.api.resources.IntentModelsResource getIntentModels()
        Returns:
        A callable resource implementing IntentModelsResource interface

      • getIntentTriggerOrdering

        public com.artisol.teneo.studio.api.resources.IntentTriggersResource getIntentTriggerOrdering()
        Returns:
        A callable resource implementing IntentTriggersResource interface

      • getLanguageObjects

        public com.artisol.teneo.studio.api.resources.LanguageObjectsResource getLanguageObjects()
        Returns:
        A callable resource implementing LanguageObjectsResource interface

      • getLibraries

        public com.artisol.teneo.studio.api.resources.LibrariesResource getLibraries()
        Returns:
        A callable resource implementing LibrariesResource interface

      • getLibraryConflicts

        public com.artisol.teneo.studio.api.resources.LibraryConflictsResource getLibraryConflicts()
        Returns:
        A callable resource implementing LibraryConflictsResource interface

      • getLocks

        public com.artisol.teneo.studio.api.resources.LocksResource getLocks()
        Returns:
        A callable resource implementing LocksResource interface

      • getLogArchives

        public com.artisol.teneo.studio.api.resources.LogArchivesResource getLogArchives()
        Returns:
        A callable resource implementing LogArchivesResource interface

      • getLogDataSources

        public com.artisol.teneo.studio.api.resources.LogDataSourcesResource getLogDataSources()
        Returns:
        A callable resource implementing LogDataSourcesResource interface

      • getMasterLocal

        public com.artisol.teneo.studio.api.resources.MasterLocalResource getMasterLocal()
        Returns:
        A callable resource implementing MasterLocalResource interface

      • getMetadataDefinitions

        public com.artisol.teneo.studio.api.resources.MetadataDefinitionsResource getMetadataDefinitions()
        Returns:
        A callable resource implementing MetadataDefinitionsResource interface

      • getOptimization

        public com.artisol.teneo.studio.api.resources.OptimizationResource getOptimization()
        Returns:
        A callable resource implementing OptimizationResource interface

      • getScriptedContexts

        public com.artisol.teneo.studio.api.resources.ScriptedContextsResource getScriptedContexts()
        Returns:
        A callable resource implementing ScriptedContextsResource interface

      • getStableVersions

        public com.artisol.teneo.studio.api.resources.StableVersionsResource getStableVersions()
        Returns:
        A callable resource implementing StableVersionsResource interface

      • getPromptTriggerOrdering

        public com.artisol.teneo.studio.api.resources.PromptTriggersResource getPromptTriggerOrdering()
        Returns:
        A callable resource implementing PromptTriggersResource interface

      • getPublishEnvironments

        public com.artisol.teneo.studio.api.resources.PublishEnvironmentsResource getPublishEnvironments()
        Returns:
        A callable resource implementing PublishEnvironmentsResource interface

      • getTasks

        public com.artisol.teneo.studio.api.resources.TasksResource getTasks()
        Returns:
        A callable resource implementing TasksResource interface

      • getTemplates

        public com.artisol.teneo.studio.api.resources.TemplatesResource getTemplates()
        Returns:
        A callable resource implementing TemplatesResource interface

      • getUsers

        public com.artisol.teneo.studio.api.resources.UsersResource getUsers()
        Returns:
        A callable resource implementing UsersResource interface

      • getVersions

        public com.artisol.teneo.studio.api.resources.VersionsResource getVersions()
        Returns:
        A callable resource implementing VersionsResource interface

      • getSolutionLogs

        public com.artisol.teneo.studio.api.resources.SolutionLogsResource getSolutionLogs()
        Returns:
        A callable resource implementing SolutionLogsResource interface

      • getSolutions

        public com.artisol.teneo.studio.api.resources.SolutionsResource getSolutions()
        Returns:
        A callable resource implementing SolutionsResource interface

      • getWebsockets

        public com.artisol.teneo.studio.api.resources.WebSocketsResource getWebsockets()
        Returns:
        A callable resource implementing WebSocketsResource interface

      • addLockTokens

        public void addLockTokens​(String... lockTokens)
        Adds lock tokens so that they are used in the following up requests.
        Parameters:
        lockTokens - the lock tokens

      • removeLockTokens

        public void removeLockTokens​(String... lockTokens)
        Removes lock tokens.
        Parameters:
        lockTokens - the lock tokens

      • clearLockTokens

        public void clearLockTokens()
        Removes all lock tokens.

      • setComment

        public void setComment​(String comment)
        Adds a one-time user comment to be send along with the next request. After the request the comment will be cleared.
        Parameters:
        comment - the user comment; its length should not exceed 1000 characters

      • getEventsSocketClient

        public EventsSocketClient getEventsSocketClient()
        Returns:
        The events websocket client