summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/1.6.1-TUSCANY-3909/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessor.java
blob: f17f31edb1c481b2584e5595079c53c268cafd70 (plain)
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
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.    
 */
package org.apache.tuscany.sca.contribution.processor;

import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.util.List;

import org.apache.tuscany.sca.contribution.service.ContributionException;

/**
 * Interface for contribution package processors
 * 
 * Package processors understand the format of the contribution and how to get the
 * artifacts in the contribution.
 * 
 * @version $Rev$ $Date$
 */
public interface PackageProcessor {
    
    /**
     * Returns the type of package supported by this package processor.
     * 
     * @return the package type
     */
    String getPackageType();

    /**
     * Returns a list of artifacts in the contribution.
     * 
     * @param packageSourceURL Contribution package location URL
     * @param inputStream Optional content of the package
     * @return List of artifact URIs
     * @throws ContributionException
     * @throws IOException
     */
    List<URI> getArtifacts(URL packageSourceURL, InputStream inputStream) throws ContributionException, IOException;

    /**
     * Return the URL for an artifact in the package.
     * 
     * This is needed for archives such as jar files that have specific URL schemes
     * for the artifacts they contain.
     * 
     * @param packageSourceURL Contribution package location URL
     * @param artifact The relative URI for the artifact
     * @return The artifact URL
     */
    URL getArtifactURL(URL packageSourceURL, URI artifact) throws MalformedURLException;

}