1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*******************************************************************************
* Copyright (c) 2007, 2010 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.equinox.p2.repository.metadata;
import java.net.URI;
import java.util.Map;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.equinox.p2.core.ProvisionException;
import org.eclipse.equinox.p2.metadata.IInstallableUnit;
import org.eclipse.equinox.p2.repository.IRepositoryManager;
/**
* A metadata repository manager is used to create, access, and manipulate
* {@link IMetadataRepository} instances. See {@link IRepositoryManager}
* for a general description of the characteristics of repository managers.
*
* @noimplement This interface is not intended to be implemented by clients.
* @noextend This interface is not intended to be extended by clients.
* @since 2.0
*/
public interface IMetadataRepositoryManager extends IRepositoryManager<IInstallableUnit> {
/**
* The name used for obtaining a reference to the metadata repository manager service
*/
public static final String SERVICE_NAME = IMetadataRepositoryManager.class.getName();
/**
* Repository type for a simple repository based on a URL or local file system location.
*/
public static final String TYPE_SIMPLE_REPOSITORY = "org.eclipse.equinox.p2.metadata.repository.simpleRepository"; //$NON-NLS-1$
/**
* Repository type for a composite repository based on a URL or local file system location.
*/
public static final String TYPE_COMPOSITE_REPOSITORY = "org.eclipse.equinox.p2.metadata.repository.compositeRepository"; //$NON-NLS-1$
/**
* Creates and returns a new empty metadata repository of the given type at
* the given location.
* <p>
* The resulting repository is added to the list of repositories tracked by
* the repository manager. Clients must make a subsequent call to {@link #removeRepository(URI)}
* if they do not want the repository manager to remember the repository for subsequent
* load attempts.
* </p>
*
* @param location the absolute location for the new repository
* @param name the name of the new repository
* @param type the kind of repository to create
* @param properties the properties to set on the repository
* @return the newly created repository
* @throws ProvisionException if the repository could not be created. Reasons include:
* <ul>
* <li>The repository type is unknown.</li>
* <li>There was an error writing to the given repository location.</li>
* <li>A repository already exists at that location.</li>
* </ul>
* @throws OperationCanceledException if this operation has been canceled
*/
public IMetadataRepository createRepository(URI location, String name, String type, Map<String, String> properties) throws ProvisionException, OperationCanceledException;
/**
* Loads a repository corresponding to the given URL. If a repository has
* previously been loaded at the given location, the same cached repository
* may be returned.
* <p>
* The resulting repository is added to the list of repositories tracked by
* the repository manager. Clients must make a subsequent call to {@link #removeRepository(URI)}
* if they do not want the repository manager to remember the repository for subsequent
* load attempts.
* </p>
*
* @param location The absolute location of the repository to load
* @param monitor a progress monitor, or <code>null</code> if progress
* reporting is not desired
* @return The loaded metadata repository
* @throws OperationCanceledException if this operation has been canceled
* @throws ProvisionException if the repository could not be created. Reasons include:
* <ul>
* <li>There is no existing repository at that location.</li>
* <li>The repository at that location could not be read.</li>
* </ul>
*/
public IMetadataRepository loadRepository(URI location, IProgressMonitor monitor) throws ProvisionException, OperationCanceledException;
/**
* Loads a repository corresponding to the given URL. If a repository has
* previously been loaded at the given location, the same cached repository
* may be returned.
* <p>
* The resulting repository is added to the list of repositories tracked by
* the repository manager. Clients must make a subsequent call to {@link #removeRepository(URI)}
* if they do not want the repository manager to remember the repository for subsequent
* load attempts.
* </p>
* <p>
* The flags passed in should be taken as a hint for the type of repository to load. If
* the manager cannot load a repository that satisfies these hints, it can fail fast.
* </p>
* @param location The absolute location of the repository to load
* @param flags - bit-wise or of flags to consider when loading the repository
* (currently only {@link IRepositoryManager#REPOSITORY_HINT_MODIFIABLE} is supported)
* @param monitor a progress monitor, or <code>null</code> if progress
* reporting is not desired
* @return The loaded metadata repository
* @throws OperationCanceledException if this operation has been canceled
* @throws ProvisionException if the repository could not be created. Reasons include:
* <ul>
* <li>There is no existing repository at that location.</li>
* <li>The repository at that location could not be read.</li>
* </ul>
* @see IRepositoryManager#REPOSITORY_HINT_MODIFIABLE
*/
public IMetadataRepository loadRepository(URI location, int flags, IProgressMonitor monitor) throws ProvisionException, OperationCanceledException;
/**
* Refreshes the repository corresponding to the given URL. This method discards
* any cached state held by the repository manager and reloads the repository
* contents. The provided repository location must already be known to the repository
* manager.
*
* @param location The absolute location of the repository to refresh
* @param monitor a progress monitor, or <code>null</code> if progress
* reporting is not desired
* @return The refreshed metadata repository
* @throws OperationCanceledException if this operation has been canceled
* @throws ProvisionException if the repository could not be refreshed. Reasons include:
* <ul>
* <li>The location is not known to the repository manager.</li>
* <li>There is no existing repository at that location.</li>
* <li>The repository at that location could not be read.</li>
* </ul>
*/
public IMetadataRepository refreshRepository(URI location, IProgressMonitor monitor) throws ProvisionException, OperationCanceledException;
}
|
