Package org.eclipse.equinox.p2.repository

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 final int
    ENABLED
    An option flag constant (value 1) indicating an enabled repository.
    static final int
    NONE
    General purpose zero-valued bit mask constant.
    static final String
    PREFERENCE_NODE
    The node identifier for repository secure preference store.
    static final String
    PROP_COMPRESSED
    The key for a boolean property indicating that repository metadata is stored in compressed form.
    static final String
    PROP_DESCRIPTION
    The key for a string property providing a human-readable description for the repository.
    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.
    static final String
    PROP_MIRRORS_URL
    The key for a string property providing a URL that can return mirrors of this repository.
    static final String
    PROP_NAME
    The key for a string property providing a human-readable name for the repository.
    static final String
    PROP_NICKNAME
    The key for a string property providing a user-defined name for the repository.
    static final String
    PROP_PASSWORD
    The key for a string property providing the password to an authenticated URL.
    static final String
    PROP_SYSTEM
    The key for a boolean property indicating that the repository is a system repository.
    static final String
    PROP_TIMESTAMP
    The key for a string property containing the time when the repository was last modified.
    static final String
    PROP_USERNAME
    The key for a string property providing the user name to an authenticated URL.
    static final int
    TYPE_ARTIFACT
    A repository type constant (value 1) representing an artifact repository.
    static final int
    TYPE_METADATA
    A repository type constant (value 0) representing a metadata repository.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    contains(T element)
    Returns true if this repository contains the given element.
    String
    getDescription()
    Returns a brief description of the repository.
    URI
    getLocation()
    Returns the location of this repository.
    String
    getName()
    Returns the name of the repository.
    Map<String,String>
    getProperties()
    Returns a read-only collection of the properties of the repository.
    String
    getProperty(String key)
    Returns the repository property with the given key, or null if no such property is defined
    String
    getProvider()
    Returns the name of the provider of the repository.
    IProvisioningAgent
    getProvisioningAgent()
    Returns the provisioning agent that manages this repository
    String
    getType()
    Returns a string representing the type of the repository.
    String
    getVersion()
    Returns a string representing the version for the repository type.
    boolean
    isModifiable()
    Returns true if this repository can be modified, and false otherwise.
    String
    setProperty(String key, String value)
    Sets the value of the property with the given key.
    String
    setProperty(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 Details

  • Method Details

    • 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, or null if 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()
      Returns true if this repository can be modified, and false otherwise. 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 of null will remove the corresponding key from the properties of this repository.
      Parameters:
      key - The property key
      value - The new property value, or null to remove the key
      Returns:
      The old property value, or null if 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 of null will remove the corresponding key from the properties of this repository.
      Parameters:
      key - The property key
      value - The new property value, or null to remove the key
      monitor - 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 null if there was no old value
      Since:
      2.1

    • contains

      default boolean contains(T element)
      Returns true if this repository contains the given element.
      Specified by:
      contains in interface IQueryable<T>
      Parameters:
      element - the element to query
      Returns:
      true if the given element is already in this repository
      Since:
      2.8