Interface IRepository<T>
-
- Type Parameters:
T- The type of contents contained in this repository
- All Superinterfaces:
IAdaptable,IQueryable<T>
- All Known Subinterfaces:
IArtifactRepository,ICompositeRepository<T>,IFileArtifactRepository,IMetadataRepository
- All Known Implementing Classes:
AbstractArtifactRepository,AbstractMetadataRepository,AbstractRepository
public interface IRepository<T> extends IAdaptable, IQueryable<T>
A p2 repository contains either metadata or artifacts related to software provisioning. This base interface defines properties common to all types of repositories.- Since:
- 2.0
- Restriction:
- This interface is not intended to be implemented by clients. Instead the abstract classes implementing this interface should be used.
- Restriction:
- This interface is not intended to be extended by clients.
-
-
Field Summary
Fields Modifier and Type Field Description static intENABLEDAn option flag constant (value 1) indicating an enabled repository.static intNONEGeneral purpose zero-valued bit mask constant.static StringPREFERENCE_NODEThe node identifier for repository secure preference store.static StringPROP_COMPRESSEDThe key for a boolean property indicating that repository metadata is stored in compressed form.static StringPROP_DESCRIPTIONThe key for a string property providing a human-readable description for the repository.static StringPROP_MIRRORS_BASE_URLThe key for a string property providing the common base URL that should be replaced with the mirror URL.static StringPROP_MIRRORS_URLThe key for a string property providing a URL that can return mirrors of this repository.static StringPROP_NAMEThe key for a string property providing a human-readable name for the repository.static StringPROP_NICKNAMEThe key for a string property providing a user-defined name for the repository.static StringPROP_PASSWORDThe key for a string property providing the password to an authenticated URL.static StringPROP_SYSTEMThe key for a boolean property indicating that the repository is a system repository.static StringPROP_TIMESTAMPThe key for a string property containing the time when the repository was last modified.static StringPROP_USERNAMEThe key for a string property providing the user name to an authenticated URL.static intTYPE_ARTIFACTA repository type constant (value 1) representing an artifact repository.static intTYPE_METADATAA repository type constant (value 0) representing a metadata repository.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDescription()Returns a brief description of the repository.URIgetLocation()Returns the location of this repository.StringgetName()Returns the name of the repository.Map<String,String>getProperties()Returns a read-only collection of the properties of the repository.StringgetProperty(String key)Returns the repository property with the given key, ornullif no such property is definedStringgetProvider()Returns the name of the provider of the repository.IProvisioningAgentgetProvisioningAgent()Returns the provisioning agent that manages this repositoryStringgetType()Returns a string representing the type of the repository.StringgetVersion()Returns a string representing the version for the repository type.booleanisModifiable()Returnstrueif this repository can be modified, andfalseotherwise.StringsetProperty(String key, String value)Sets the value of the property with the given key.StringsetProperty(String key, String value, IProgressMonitor monitor)Sets the value of the property with the given key.-
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
-
Methods inherited from interface org.eclipse.equinox.p2.query.IQueryable
query
-
-
-
-
Field Detail
-
PROP_SYSTEM
static final String PROP_SYSTEM
The key for a boolean property indicating that the repository is a system repository. System repositories are implementation details that are not subject to general access, hidden from the typical user, etc. This property is never stored in the repository itself, but is instead tracked and managed by anIRepositoryManager.
-
PROP_COMPRESSED
static final String PROP_COMPRESSED
The key for a boolean property indicating that repository metadata is stored in compressed form. A compressed repository will have lower bandwidth cost to read when remote, but higher processing cost to uncompress when reading.- See Also:
getProperties(), Constant Field Values
-
PROP_NAME
static final String PROP_NAME
The key for a string property providing a human-readable name for the repository.
-
PROP_NICKNAME
static final String PROP_NICKNAME
The key for a string property providing a user-defined name for the repository. This property is never stored in the repository itself, but is instead tracked and managed by anIRepositoryManager.
-
PROP_DESCRIPTION
static final String PROP_DESCRIPTION
The key for a string property providing a human-readable description for the repository.
-
PROP_MIRRORS_BASE_URL
static final String PROP_MIRRORS_BASE_URL
The key for a string property providing the common base URL that should be replaced with the mirror URL.- See Also:
getProperties(), Constant Field Values
-
PROP_MIRRORS_URL
static final String PROP_MIRRORS_URL
The key for a string property providing a URL that can return mirrors of this repository.- See Also:
getProperties(), Constant Field Values
-
PROP_TIMESTAMP
static final String PROP_TIMESTAMP
The key for a string property containing the time when the repository was last modified.- See Also:
getProperties(), Constant Field Values
-
PROP_USERNAME
static final String PROP_USERNAME
The key for a string property providing the user name to an authenticated URL. This key is used in the secure preference store for repository data.- See Also:
PREFERENCE_NODE, Constant Field Values
-
PROP_PASSWORD
static final String PROP_PASSWORD
The key for a string property providing the password to an authenticated URL. This key is used in the secure preference store for repository data.- See Also:
PREFERENCE_NODE, Constant Field Values
-
PREFERENCE_NODE
static final String PREFERENCE_NODE
The node identifier for repository secure preference store.- See Also:
- Constant Field Values
-
TYPE_METADATA
static final int TYPE_METADATA
A repository type constant (value 0) representing a metadata repository.- See Also:
- Constant Field Values
-
TYPE_ARTIFACT
static final int TYPE_ARTIFACT
A repository type constant (value 1) representing an artifact repository.- See Also:
- Constant Field Values
-
NONE
static final int NONE
General purpose zero-valued bit mask constant. Useful whenever you need to supply a bit mask with no bits set.- See Also:
- Constant Field Values
-
ENABLED
static final int ENABLED
An option flag constant (value 1) indicating an enabled repository.- See Also:
- Constant Field Values
-
-
Method Detail
-
getLocation
URI getLocation()
Returns the location of this repository.- Returns:
- the URI representing the repository location.
-
getName
String getName()
Returns the name of the repository.- Returns:
- the name of the repository.
-
getType
String getType()
Returns a string representing the type of the repository. Note this method does not indicate the type of repository contents (metadata or artifacts), but instead the unique fully qualified id representing the repository implementation.- Returns:
- the type of the repository.
-
getVersion
String getVersion()
Returns a string representing the version for the repository type.- Returns:
- the version of the type of the repository.
-
getDescription
String getDescription()
Returns a brief description of the repository.- Returns:
- the description of the repository.
-
getProvider
String getProvider()
Returns the name of the provider of the repository.- Returns:
- the provider of this repository.
-
getProperties
Map<String,String> getProperties()
Returns a read-only collection of the properties of the repository.- Returns:
- the properties of this repository.
-
getProperty
String getProperty(String key)
Returns the repository property with the given key, ornullif no such property is defined- Parameters:
key- the property key- Returns:
- the property value, or
null
-
getProvisioningAgent
IProvisioningAgent getProvisioningAgent()
Returns the provisioning agent that manages this repository- Returns:
- A provisioning agent.
-
isModifiable
boolean isModifiable()
Returnstrueif this repository can be modified, andfalseotherwise. Attempts to change the contents of an unmodifiable repository will fail.- Returns:
- whether or not this repository can be modified
-
setProperty
String setProperty(String key, String value)
Sets the value of the property with the given key. Returns the old property associated with that key, if any. Setting a value ofnullwill remove the corresponding key from the properties of this repository.- Parameters:
key- The property keyvalue- The new property value, ornullto remove the key- Returns:
- The old property value, or
nullif there was no old value
-
setProperty
String setProperty(String key, String value, IProgressMonitor monitor)
Sets the value of the property with the given key. Returns the old property associated with that key, if any. Setting a value ofnullwill remove the corresponding key from the properties of this repository.- Parameters:
key- The property keyvalue- The new property value, ornullto remove the keymonitor- A progress monitor use to track progress and cancel the operation. This may be a long running operation if another process holds the lock on this location- Returns:
- The old property value, or
nullif there was no old value - Since:
- 2.1
-
-