Package org.apache.sling.testing.clients.osgi

Class OsgiConsoleClient

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, org.apache.http.client.HttpClient
    public class OsgiConsoleClient
extends SlingClient
    A client that wraps the Felix OSGi Web Console REST API calls.
    See Also:
    Web Console RESTful API

    • Constructor Detail

      • OsgiConsoleClient

        public OsgiConsoleClient​(java.net.URI serverUrl,
                         java.lang.String userName,
                         java.lang.String password)
                  throws ClientException
        Default constructor. Simply calls SlingClient(URI, String, String)
        Parameters:
        serverUrl - the URL to the server under test
        userName - the user name used for authentication
        password - the password for this user
        Throws:
        ClientException - if the client cannot be instantiated

      • OsgiConsoleClient

        public OsgiConsoleClient​(org.apache.http.impl.client.CloseableHttpClient http,
                         SlingClientConfig config)
                  throws ClientException
        Constructor used by adaptTo() and InternalBuilder classes. Should not be called directly in the code
        Parameters:
        http - http client to be used for requests
        config - sling specific configs
        Throws:
        ClientException - if the client cannot be instantiated

    • Method Detail

      • getBundlesInfo

        public BundlesInfo getBundlesInfo​(int... expectedStatus)
                           throws ClientException
        Returns the wrapper for the bundles info json
        Parameters:
        expectedStatus - list of accepted statuses of the response
        Returns:
        all the bundles info
        Throws:
        ClientException - if the response status does not match any of the expectedStatus

      • getBundleInfo

        public BundleInfo getBundleInfo​(java.lang.String id,
                                int... expectedStatus)
                         throws ClientException
        Returns the wrapper for the bundle info json
        Parameters:
        id - the id of the bundle
        expectedStatus - list of accepted statuses of the response
        Returns:
        the bundle info
        Throws:
        ClientException - if the response status does not match any of the expectedStatus

      • getComponentsInfo

        public ComponentsInfo getComponentsInfo​(int... expectedStatus)
                                 throws ClientException
        Returns the wrapper for the components info json
        Parameters:
        expectedStatus - list of accepted statuses of the response
        Returns:
        the components info
        Throws:
        ClientException - if the response status does not match any of the expectedStatus

      • getComponentInfo

        public ComponentInfo getComponentInfo​(java.lang.String id,
                                      int expectedStatus)
                               throws ClientException
        Returns the wrapper for the component info json
        Parameters:
        id - the id of the component
        expectedStatus - list of accepted statuses of the response
        Returns:
        the component info
        Throws:
        ClientException - if the response status does not match any of the expectedStatus

      • waitComponentRegistered

        public void waitComponentRegistered​(java.lang.String componentName,
                                    long timeout,
                                    long delay)
                             throws java.util.concurrent.TimeoutException,
                                    java.lang.InterruptedException
        Wait until the component with the given name is registered. This means the component must be either in state "Registered" or "Active". The state registered is called "satisfied" in the Felix DS Web Console
        Parameters:
        componentName - the component's name
        timeout - how long to wait for the component to become registered before throwing a TimeoutException in milliseconds
        delay - time to wait between checks of the state in milliseconds
        Throws:
        java.util.concurrent.TimeoutException - if the component did not become registered before timeout was reached
        java.lang.InterruptedException - if interrupted
        See Also:
        "OSGi Comp. R6, §112.5 Component Life Cycle"

      • waitServiceRegistered

        public void waitServiceRegistered​(java.lang.String type,
                                  java.lang.String bundleSymbolicName,
                                  long timeout,
                                  long delay)
                           throws java.util.concurrent.TimeoutException,
                                  java.lang.InterruptedException
        Wait until the service with the given name is registered. This means the component must be either in state "Registered" or "Active".
        Parameters:
        type - the type of the service (usually the name of a Java interface)
        bundleSymbolicName - the symbolic name of the bundle supposed to register that service. May be null in which case this method just waits for any service with the requested type being registered (independent of the registering bundle).
        timeout - how long to wait for the component to become registered before throwing a TimeoutException in milliseconds
        delay - time to wait between checks of the state in milliseconds
        Throws:
        java.util.concurrent.TimeoutException - if the component did not become registered before timeout was reached
        java.lang.InterruptedException - if interrupted

      • getConfiguration

        public java.util.Map<java.lang.String,​java.lang.Object> getConfiguration​(java.lang.String pid,
                                                                               int... expectedStatus)
                                                                        throws ClientException
        Returns a map of all properties set for the config referenced by the PID, where the map keys are the property names.
        Parameters:
        pid - the pid of the configuration
        expectedStatus - list of accepted statuses of the response
        Returns:
        the properties as a map
        Throws:
        ClientException - if the response status does not match any of the expectedStatus

      • getConfigurationWithWait

        @Deprecated
public java.util.Map<java.lang.String,​java.lang.Object> getConfigurationWithWait​(long waitCount,
                                                                                       java.lang.String pid,
                                                                                       int... expectedStatus)
                                                                                throws ClientException,
                                                                                       java.lang.InterruptedException
        Deprecated.
        use waitGetConfiguration(long, String, int...)
        Returns a map of all properties set for the config referenced by the PID, where the map keys are the property names. The method waits until the configuration has been set.
        Parameters:
        waitCount - The number of maximum wait intervals of 500ms. Between each wait interval, the method polls the backend to see if the configuration ahs been set.
        pid - pid
        expectedStatus - expected response status
        Returns:
        the config properties
        Throws:
        ClientException - if the response status does not match any of the expectedStatus
        java.lang.InterruptedException - to mark this operation as "waiting"

      • waitGetConfiguration

        public java.util.Map<java.lang.String,​java.lang.Object> waitGetConfiguration​(long timeout,
                                                                                   java.lang.String pid,
                                                                                   int... expectedStatus)
                                                                            throws ClientException,
                                                                                   java.lang.InterruptedException,
                                                                                   java.util.concurrent.TimeoutException
        Returns a map of all properties set for the config referenced by the PID, where the map keys are the property names. The method waits until the configuration has been set.
        Parameters:
        timeout - Maximum time to wait for the configuration to be available, in ms.
        pid - service pid
        expectedStatus - expected response status
        Returns:
        the config properties
        Throws:
        ClientException - if the response status does not match any of the expectedStatus
        java.lang.InterruptedException - to mark this operation as "waiting"
        java.util.concurrent.TimeoutException - if the timeout was reached

      • editConfiguration

        public java.lang.String editConfiguration​(java.lang.String PID,
                                          java.lang.String factoryPID,
                                          java.util.Map<java.lang.String,​java.lang.Object> configProperties,
                                          int... expectedStatus)
                                   throws ClientException
        Sets properties of a config referenced by its PID. the properties to be edited are passed as a map of property name,value pairs.
        Parameters:
        PID - Persistent identity string
        factoryPID - Factory persistent identity string or null
        configProperties - map of properties
        expectedStatus - expected response status
        Returns:
        the location of the config
        Throws:
        ClientException - if the response status does not match any of the expectedStatus

      • editConfigurationWithWait

        @Deprecated
public java.lang.String editConfigurationWithWait​(int waitCount,
                                                  java.lang.String PID,
                                                  java.lang.String factoryPID,
                                                  java.util.Map<java.lang.String,​java.lang.Object> configProperties,
                                                  int... expectedStatus)
                                           throws ClientException,
                                                  java.lang.InterruptedException
        Deprecated.
        use waitEditConfiguration(long, String, String, Map, int...)
        Sets properties of a config referenced by its PID. the properties to be edited are passed as a map of property (name,value) pairs. The method waits until the configuration has been set.
        Parameters:
        waitCount - The number of maximum wait intervals of 500ms. Between each wait interval, the method polls the backend to see if the configuration ahs been set.
        PID - Persistent identity string
        factoryPID - Factory persistent identity string or null
        configProperties - map of properties
        expectedStatus - expected response status
        Returns:
        the pid
        Throws:
        ClientException - if the response status does not match any of the expectedStatus
        java.lang.InterruptedException - to mark this operation as "waiting"

      • waitEditConfiguration

        public java.lang.String waitEditConfiguration​(long timeout,
                                              java.lang.String PID,
                                              java.lang.String factoryPID,
                                              java.util.Map<java.lang.String,​java.lang.Object> configProperties,
                                              int... expectedStatus)
                                       throws ClientException,
                                              java.lang.InterruptedException,
                                              java.util.concurrent.TimeoutException
        Sets properties of a config referenced by its PID. the properties to be edited are passed as a map of property (name,value) pairs. The method waits until the configuration has been set.
        Parameters:
        timeout - Max time to wait for the configuration to be set, in ms
        PID - Persistent identity string
        factoryPID - Factory persistent identity string or null
        configProperties - map of properties
        expectedStatus - expected response status
        Returns:
        the pid
        Throws:
        ClientException - if the response status does not match any of the expectedStatus
        java.lang.InterruptedException - to mark this operation as "waiting"
        java.util.concurrent.TimeoutException - if the timeout was reached

      • deleteConfiguration

        public SlingHttpResponse deleteConfiguration​(java.lang.String pid,
                                             int... expectedStatus)
                                      throws ClientException
        Delete the config referenced by the PID
        Parameters:
        pid - pid
        expectedStatus - expected response status
        Returns:
        the sling response
        Throws:
        ClientException - if the response status does not match any of the expectedStatus

      • uninstallBundle

        public SlingHttpResponse uninstallBundle​(java.lang.String symbolicName)
                                  throws ClientException
        Uninstall a bundle
        Parameters:
        symbolicName - bundle symbolic name
        Returns:
        the sling response
        Throws:
        ClientException - if something went wrong with the request

      • installBundle

        public SlingHttpResponse installBundle​(java.io.File f,
                                       boolean startBundle)
                                throws ClientException
        Install a bundle using the Felix webconsole HTTP interface
        Parameters:
        f - the bundle file
        startBundle - whether to start the bundle or not
        Returns:
        the sling response
        Throws:
        ClientException - if the request failed

      • installBundle

        public SlingHttpResponse installBundle​(java.io.File f,
                                       boolean startBundle,
                                       int startLevel)
                                throws ClientException
        Install a bundle using the Felix webconsole HTTP interface, with a specific start level
        Parameters:
        f - bundle file
        startBundle - whether to start or just install the bundle
        startLevel - start level
        Returns:
        the sling response
        Throws:
        ClientException - if the request failed

      • checkBundleInstalled

        @Deprecated
public boolean checkBundleInstalled​(java.lang.String symbolicName,
                                    int waitTime,
                                    int retries)
                             throws java.lang.InterruptedException
        Deprecated.
        does not respect polling practices; use waitBundleInstalled(String, long, long) instead
        Check that specified bundle is installed and retries every {{waitTime}} milliseconds, until the bundle is installed or the number of retries was reached
        Parameters:
        symbolicName - the name of the bundle
        waitTime - How many milliseconds to wait between retries
        retries - the number of retries
        Returns:
        true if the bundle was installed until the retries stop, false otherwise
        Throws:
        java.lang.InterruptedException - if interrupted

      • installBundleWithRetry

        @Deprecated
public boolean installBundleWithRetry​(java.io.File f,
                                      boolean startBundle,
                                      int startLevel,
                                      int waitTime,
                                      int retries)
                               throws ClientException,
                                      java.lang.InterruptedException
        Deprecated.
        waitInstallBundle(File, boolean, int, long, long)
        Install a bundle using the Felix webconsole HTTP interface and wait for it to be installed
        Parameters:
        f - the bundle file
        startBundle - whether to start the bundle or not
        startLevel - the start level of the bundle. negative values mean default start level
        waitTime - how long to wait between retries of checking the bundle
        retries - how many times to check for the bundle to be installed, until giving up
        Returns:
        true if the bundle was successfully installed, false otherwise
        Throws:
        ClientException - if the request failed
        java.lang.InterruptedException - if interrupted

      • waitInstallBundle

        public void waitInstallBundle​(java.io.File f,
                              boolean startBundle,
                              int startLevel,
                              long timeout,
                              long delay)
                       throws ClientException,
                              java.lang.InterruptedException,
                              java.util.concurrent.TimeoutException
        Install a bundle using the Felix webconsole HTTP interface and wait for it to be installed.
        Parameters:
        f - the bundle file
        startBundle - whether to start the bundle or not
        startLevel - the start level of the bundle. negative values mean default start level
        timeout - how long to wait for the bundle to be installed before throwing a TimeoutException in milliseconds
        delay - time to wait between checks of the state in milliseconds
        Throws:
        ClientException - if the request failed
        java.util.concurrent.TimeoutException - if the bundle did not install before timeout was reached
        java.lang.InterruptedException - if interrupted

      • waitBundleInstalled

        public void waitBundleInstalled​(java.lang.String symbolicName,
                                long timeout,
                                long delay)
                         throws java.util.concurrent.TimeoutException,
                                java.lang.InterruptedException
        Wait until the bundle is installed.
        Parameters:
        symbolicName - symbolic name of bundle
        timeout - how long to wait for the bundle to be installed before throwing a TimeoutException in milliseconds
        delay - time to wait between checks of the state in milliseconds
        Throws:
        java.util.concurrent.TimeoutException - if the bundle did not install before timeout was reached
        java.lang.InterruptedException - if interrupted
        See Also:
        "OSGi Core R6, §4.4.2 Bundle State"

      • waitBundleStarted

        public void waitBundleStarted​(java.lang.String symbolicName,
                              long timeout,
                              long delay)
                       throws java.util.concurrent.TimeoutException,
                              java.lang.InterruptedException
        Wait until the bundle is started
        Parameters:
        symbolicName - symbolic name of bundle
        timeout - how long to wait for the bundle to be installed before throwing a TimeoutException in milliseconds.
        delay - time to wait between checks of the state in milliseconds.
        Throws:
        java.util.concurrent.TimeoutException - if the bundle did not install before timeout was reached
        java.lang.InterruptedException - if interrupted
        See Also:
        "OSGi Core R6, §4.4.2 Bundle State"

      • getBundleId

        public long getBundleId​(java.lang.String symbolicName)
                 throws ClientException
        Get the id of the bundle
        Parameters:
        symbolicName - bundle symbolic name
        Returns:
        the id
        Throws:
        ClientException - if the id cannot be retrieved

      • getBundleVersion

        public java.lang.String getBundleVersion​(java.lang.String symbolicName)
                                  throws ClientException
        Get the version of the bundle
        Parameters:
        symbolicName - bundle symbolic name
        Returns:
        bundle version
        Throws:
        ClientException - if the version is not retrieved

      • getBundleState

        public java.lang.String getBundleState​(java.lang.String symbolicName)
                                throws ClientException
        Get the state of the bundle
        Parameters:
        symbolicName - bundle symbolic name
        Returns:
        the state of the bundle
        Throws:
        ClientException - if the state cannot be retrieved

      • startBundle

        public void startBundle​(java.lang.String symbolicName)
                 throws ClientException
        Starts a bundle
        Parameters:
        symbolicName - the name of the bundle
        Throws:
        ClientException - if the request failed

      • stopBundle

        public void stopBundle​(java.lang.String symbolicName)
                throws ClientException
        Stop a bundle
        Parameters:
        symbolicName - the name of the bundle
        Throws:
        ClientException - if the request failed

      • startBundlewithWait

        @Deprecated
public void startBundlewithWait​(java.lang.String symbolicName,
                                int waitTime,
                                int retries)
                         throws ClientException,
                                java.lang.InterruptedException
        Deprecated.
        use waitStartBundle(String, long, long)
        Starts a bundle and waits for it to be started
        Parameters:
        symbolicName - the name of the bundle
        waitTime - How many milliseconds to wait between retries
        retries - the number of retries
        Throws:
        ClientException - if the request failed
        java.lang.InterruptedException - if interrupted

      • waitStartBundle

        public void waitStartBundle​(java.lang.String symbolicName,
                            long timeout,
                            long delay)
                     throws ClientException,
                            java.lang.InterruptedException,
                            java.util.concurrent.TimeoutException
        Starts a bundle and waits for it to be started
        Parameters:
        symbolicName - the name of the bundle
        timeout - max time to wait for the bundle to start, in ms
        delay - time to wait between status checks, in ms
        Throws:
        ClientException - if the request failed
        java.lang.InterruptedException - if interrupted
        java.util.concurrent.TimeoutException - if starting timed out

      • refreshPackages

        public void refreshPackages()
                     throws ClientException
        Calls PackageAdmin.refreshPackages to force re-wiring of all the bundles.
        Throws:
        ClientException - if the request failed

      • getBundleSymbolicName

        public static java.lang.String getBundleSymbolicName​(java.io.File bundleFile)
                                              throws java.io.IOException
        Get the symbolic name from a bundle file by looking at the manifest
        Parameters:
        bundleFile - bundle file
        Returns:
        the name extracted from the manifest
        Throws:
        java.io.IOException - if reading the jar failed

      • getBundleVersionFromFile

        public static java.lang.String getBundleVersionFromFile​(java.io.File bundleFile)
                                                 throws java.io.IOException
        Get the version form a bundle file by looking at the manifest
        Parameters:
        bundleFile - bundle file
        Returns:
        the version
        Throws:
        java.io.IOException - if reading the bundle jar failed