Package org.xwiki.extension

Interface InstalledExtension

    • Method Detail

      • getLocalExtension

        LocalExtension getLocalExtension()
        Returns:
        the actual extension

      • isInstalled

        boolean isInstalled()
        Returns:
        indicate if the extension is installed

      • isInstalled

        boolean isInstalled​(String namespace)
        Indicate if the extension is installed in the provided namespace.
        Parameters:
        namespace - the namespace to look at, if null it means the extension is installed on the root namespace
        Returns:
        true if the extension is installed in the provided namespace

      • isValid

        boolean isValid​(String namespace)
        Indicate if the extension is working.

        An installed extension can be invalid for example when one of the core extensions has been changed and is now incompatible with this installed extension.

        Parameters:
        namespace - the namespace to look at, if null it means the extension is installed on the root namespace
        Returns:
        true is valid
        Since:
        4.2M1

      • getNamespaces

        Collection<String> getNamespaces()
        Returns:
        the namespaces in which this extension is enabled. null means root namespace (i.e all namespaces).

      • isDependency

        boolean isDependency​(String namespace)
        Indicate if the extension as been installed as a dependency of another one.

        The idea is to be able to make the difference between extension specifically installed by a user so that it's possible to know which extension are not really required anymore.

        Parameters:
        namespace - the namespace to look at, null indicate the root namespace
        Returns:
        true if the the extension has been installed only because it was a dependency of another extension

      • getInstallDate

        Date getInstallDate​(String namespace)
        Parameters:
        namespace - the namespace to look at, null indicates the root namespace
        Returns:
        the date when this extension has been installed on the specified namespace, null if the install date is not available or if this extension is not installed on the specified namespace
        Since:
        7.0M2

      • getNamespaceProperty

        Object getNamespaceProperty​(String key,
                            String namespace)
        An installed extension can have different values for its properties depending on the namespace where it is installed. This method allows us to access the value of a specific extension property on a given namespace.
        Parameters:
        key - the name of the property to look for
        namespace - the namespace to look at, null indicates the root namespace
        Returns:
        the value of the specified extension property on the given namespace
        Since:
        7.0M2

      • isDependency

        @Deprecated
boolean isDependency()
        Deprecated.
        since 4.3M1 use isDependency(String) with null namespace instead
        Indicate if the extension as been installed as a dependency of another one.

        The idea is to be able to make the difference between extension specifically installed by a user so that it's possible to know which extension are not really required anymore.

        Returns:
        true if the the extension has been installed only because it was a dependency of another extension