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
|
/*******************************************************************************
* Copyright (c) 2007, 2008 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.internal.provisional.p2.artifact.repository;
import java.net.URL;
import java.util.Map;
import java.util.Properties;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.equinox.internal.provisional.p2.core.ProvisionException;
import org.eclipse.equinox.internal.provisional.p2.core.repository.IRepositoryManager;
import org.eclipse.equinox.internal.provisional.p2.metadata.IArtifactKey;
/**
* A metadata repository manager is used to create, access, and manipulate
* {@link IArtifactRepository} 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.
*/
public interface IArtifactRepositoryManager extends IRepositoryManager {
public static final IArtifactRequest[] NO_ARTIFACT_REQUEST = new IArtifactRequest[0];
/**
* 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.artifact.repository.simpleRepository"; //$NON-NLS-1$
/**
* Return a new request to mirror the given artifact into the destination repository.
* @param key the artifact to mirror
* @param destination the destination where the artifact will be mirrored
* @param destinationDescriptorProperties additional properties for use in creating the repository's ArtifactDescriptor,
* or <code>null</code> to indicate no additional properties are needed
* @param destinationRepositoryProperties additional repository specific properties for use in creating the repositor's ArtifactDescriptor,
* , or <code>null</code> to indicate no additional properties are needed
* @return the newly created request object
*/
public IArtifactRequest createMirrorRequest(IArtifactKey key, IArtifactRepository destination, Properties destinationDescriptorProperties, Properties destinationRepositoryProperties);
/**
* Creates and returns a new empty artifact 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(URL)}
* if they do not want the repository manager to remember the repository for subsequent
* load attempts.
* </p>
*
* @param location the 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>
*/
public IArtifactRepository createRepository(URL location, String name, String type, Map properties) throws ProvisionException;
/**
* Loads the repository at the given location. The location is expected to contain
* data that describes a valid artifact repository of a known type. If this manager
* already knows a repository at the given location then that repository is 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(URL)}
* if they do not want the repository manager to remember the repository for subsequent
* load attempts.
* </p>
*
* @param location the location in which to look for a repository description
* @param monitor a progress monitor, or <code>null</code> if progress
* reporting is not desired
* @return a repository object for the given location
* @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 IArtifactRepository loadRepository(URL location, IProgressMonitor monitor) throws ProvisionException;
/**
* 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 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 ProvisionException if the repository could not be created. 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 IArtifactRepository refreshRepository(URL location, IProgressMonitor monitor) throws ProvisionException;
}
|
