org.xwiki.extension

Interface ExtensionManagerConfiguration

@Role
public interface ExtensionManagerConfiguration

Provide some general extension manager configuration.

Since:

4.0M1

Version:

$Id: bd00d5b54fead122497af4b9190dc53e4648474d $

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDEX_INTERVAL The default interval between two extension indexing.

Method Summary

Modifier and Type	Method and Description
Collection<ExtensionRepositoryDescriptor>	getExtensionRepositoryDescriptors()
default int	getIndexInterval()
File	getLocalRepository()
default VersionConstraint	getRecomendedVersionConstraint(String id)
default VersionConstraint	getRecomendedVersionConstraint(String id, VersionConstraint defaultVersion)
Collection<ExtensionRepositoryId>	getRepositories() Deprecated. since 4.3M1 use getExtensionRepositoryDescriptors() instead
String	getUserAgent()
default boolean	isIgnoredDependency(ExtensionDependency dependency)
default boolean	resolveCoreExtensions()

Field Detail

DEFAULT_INDEX_INTERVAL

static final int DEFAULT_INDEX_INTERVAL

The default interval between two extension indexing. The default is 1h.

See Also:

Constant Field Values

Method Detail

getLocalRepository

File getLocalRepository()

Returns:

the folder containing the local extensions

See Also:

LocalExtensionRepository

getRepositories

@Deprecated
Collection<ExtensionRepositoryId> getRepositories()

Deprecated. since 4.3M1 use getExtensionRepositoryDescriptors() instead

Returns:

the configured repositories

getExtensionRepositoryDescriptors

Collection<ExtensionRepositoryDescriptor> getExtensionRepositoryDescriptors()

Returns:

the configured repositories

Since:

4.3M1

getUserAgent

String getUserAgent()

Returns:

the user agent to declare when communication with external services (generally repositories)

resolveCoreExtensions

default boolean resolveCoreExtensions()

Returns:

true if XWiki should try to get more informations about the core extensions using the repositories

Since:

8.3RC1

getRecomendedVersionConstraint

default VersionConstraint getRecomendedVersionConstraint(String id,
                                                         VersionConstraint defaultVersion)

Parameters:

id - the identifier of the extension

defaultVersion - the version of the extension

Returns:

the recommended version or null if there is no specifically recommended version (including a recommended verison equals to the default one)

Since:

9.6

getRecomendedVersionConstraint

default VersionConstraint getRecomendedVersionConstraint(String id)

Parameters:

id - the identifier of the extension

Returns:

the recommended version or null if none could be found

Since:

9.8RC1

isIgnoredDependency

default boolean isIgnoredDependency(ExtensionDependency dependency)

Parameters:

dependency - the dependency

Returns:

true if the the extension dependency should be ignored (like those which are part of the JDK or known to cause problems while not being needed)

Since:

11.10.4, 12.2

getIndexInterval

@Unstable
default int getIndexInterval()

Returns:

the number of seconds between two extension indexing

Since:

12.10