Package org.rundeck.client.tool

Interface RdApp

  • public interface RdApp
    Access to config, output, and service client
    Since:
    1/11/17

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.rundeck.client.util.RdClientConfig getAppConfig()  
      org.rundeck.client.util.ServiceClient<org.rundeck.client.api.RundeckApi> getClient()
      return base api client
      org.rundeck.client.util.ServiceClient<org.rundeck.client.api.RundeckApi> getClient​(int version)  
      <T> org.rundeck.client.util.ServiceClient<T> getClient​(java.lang.Class<T> api)
      Return API client for specified API interface
      <T> org.rundeck.client.util.ServiceClient<T> getClient​(java.lang.Class<T> api, int version)
      Return API client for specified API interface
      CommandOutput getOutput()  
      void versionDowngradeWarning​(int requested, int supported)
      Issue warning about api version downgrade

    • Method Detail

      • getClient

        org.rundeck.client.util.ServiceClient<org.rundeck.client.api.RundeckApi> getClient()
                                                                            throws InputError
        return base api client
        Returns:
        current service client
        Throws:
        InputError - on error

      • getClient

        org.rundeck.client.util.ServiceClient<org.rundeck.client.api.RundeckApi> getClient​(int version)
                                                                            throws InputError
        Parameters:
        version - api version to use
        Returns:
        service client for particular api version
        Throws:
        InputError - on erro

      • getClient

        <T> org.rundeck.client.util.ServiceClient<T> getClient​(java.lang.Class<T> api)
                                                throws InputError
        Return API client for specified API interface
        Type Parameters:
        T - api interface type
        Parameters:
        api - api interface class
        Returns:
        new instance
        Throws:
        InputError - if configuration input error occurs

      • getClient

        <T> org.rundeck.client.util.ServiceClient<T> getClient​(java.lang.Class<T> api,
                                                       int version)
                                                throws InputError
        Return API client for specified API interface
        Type Parameters:
        T - api interface type
        Parameters:
        api - api interface class
        version - specified version
        Returns:
        new instance
        Throws:
        InputError - if configuration input error occurs

      • getAppConfig

        org.rundeck.client.util.RdClientConfig getAppConfig()
        Returns:
        app config

      • versionDowngradeWarning

        void versionDowngradeWarning​(int requested,
                             int supported)
        Issue warning about api version downgrade
        Parameters:
        requested - requested api version
        supported - supported api verson