1/*
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.oracle.webservices.internal.api.databinding;
27
28import javax.xml.transform.Result;
29import javax.xml.ws.Holder;
30
31/**
32 * WSDLResolver is used by WSDLGenerator while generating WSDL and its associated
33 * documents. It is used to control what documents need to be generated and what
34 * documents need to be picked from metadata. If endpont's document metadata
35 * already contains some documents, their systemids may be used for wsdl:import,
36 * and schema:import. The suggested filenames are relative urls(for e.g: EchoSchema1.xsd)
37 * The Result object systemids are also relative urls(for e.g: AbsWsdl.wsdl).
38 *
39 * @author Jitendra Kotamraju
40 */
41public interface WSDLResolver {
42    /**
43     * Create a Result object into which concrete WSDL is to be generated.
44     *
45     * @return Result for the concrete WSDL
46     */
47    public Result getWSDL(String suggestedFilename);
48
49    /**
50     * Create a Result object into which abstract WSDL is to be generated. If the the
51     * abstract WSDL is already in metadata, it is not generated.
52     *
53     * Update filename if the suggested filename need to be changed in wsdl:import.
54     * This needs to be done if the metadata contains abstract WSDL, and that systemid
55     * needs to be reflected in concrete WSDL's wsdl:import
56     *
57     * @return null if abstract WSDL need not be generated
58     */
59    public Result getAbstractWSDL(Holder<String> filename);
60
61    /**
62     * Create a Result object into which schema doc is to be generated. Typically if
63     * there is a schema doc for namespace in metadata, then it is not generated.
64     *
65     * Update filename if the suggested filename need to be changed in xsd:import. This
66     * needs to be done if the metadata contains the document, and that systemid
67     * needs to be reflected in some other document's xsd:import
68     *
69     * @return null if schema need not be generated
70     */
71    public Result getSchemaOutput(String namespace, Holder<String> filename);
72
73}
74