org.jboss.forge.furnace.repositories

Interface AddonRepository

All Known Subinterfaces:

MutableAddonRepository

public interface AddonRepository

Used to perform Addon installation/registration operations.

Author:

Lincoln Baxter, III, Koen Aers, George Gastaldi

Method Summary

Methods

Modifier and Type	Method and Description
File	getAddonBaseDir(AddonId addon) Get the base installation directory of the given AddonId.
Set<AddonDependencyEntry>	getAddonDependencies(AddonId addon) Get the runtime Addon dependencies of the given AddonId.
File	getAddonDescriptor(AddonId addon) Get the addon descriptor file for the given AddonId.
List<File>	getAddonResources(AddonId addon) Get a list of all local resources for the given AddonId.
Date	getLastModified() Returns the last modified date of this AddonRepository.
File	getRootDirectory() Get the root directory of this AddonRepository.
int	getVersion() Returns the runtime change version of this AddonRepository.
boolean	isDeployed(AddonId addon) Returns true if the given AddonId is deployed in this AddonRepository; otherwise, returns false.
boolean	isEnabled(AddonId addon) Returns true if the given AddonId is enabled in this AddonRepository; otherwise, returns false.
List<AddonId>	listEnabled() Returns a List of AddonId instances for all enabled Addons in this repository.
List<AddonId>	listEnabledCompatibleWithVersion(Version version) Returns a List of AddonId instances for all enabled Addons in this repository that are API compatible with the given Version.

Method Detail

getAddonBaseDir

File getAddonBaseDir(AddonId addon)

Get the base installation directory of the given AddonId.

getAddonDependencies

Set<AddonDependencyEntry> getAddonDependencies(AddonId addon)

Get the runtime Addon dependencies of the given AddonId.

getAddonDescriptor

File getAddonDescriptor(AddonId addon)

Get the addon descriptor file for the given AddonId.

getAddonResources

List<File> getAddonResources(AddonId addon)

Get a list of all local resources for the given AddonId.

getRootDirectory

File getRootDirectory()

Get the root directory of this AddonRepository.

isDeployed

boolean isDeployed(AddonId addon)

Returns true if the given AddonId is deployed in this AddonRepository; otherwise, returns false.

isEnabled

boolean isEnabled(AddonId addon)

Returns true if the given AddonId is enabled in this AddonRepository; otherwise, returns false.

listEnabled

List<AddonId> listEnabled()

Returns a List of AddonId instances for all enabled Addons in this repository.

listEnabledCompatibleWithVersion

List<AddonId> listEnabledCompatibleWithVersion(Version version)

Returns a List of AddonId instances for all enabled Addons in this repository that are API compatible with the given Version.

getLastModified

Date getLastModified()

Returns the last modified date of this AddonRepository.

getVersion

int getVersion()

Returns the runtime change version of this AddonRepository.