01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api.server;
38:
39: import com.sun.istack.NotNull;
40: import com.sun.xml.ws.api.model.wsdl.WSDLModel;
41:
42: /**
43: * Root of the unparsed WSDL and other resources referenced from it.
44: * This object represents the description of the service
45: * that a {@link WSEndpoint} offers.
46: *
47: * <p>
48: * A description consists of a set of {@link SDDocument}, which
49: * each represents a single XML document that forms a part of the
50: * descriptor (for example, WSDL might refer to separate schema documents,
51: * or a WSDL might refer to another WSDL.)
52: *
53: * <p>
54: * {@link ServiceDefinition} and its descendants are immutable
55: * read-only objects. Once they are created, they always return
56: * the same value.
57: *
58: * <h2>Expected Usage</h2>
59: * <p>
60: * This object is intended to be used for serving the descriptors
61: * to remote clients (such as by MEX, or other protocol-specific
62: * metadata query, such as HTTP GET with "?wsdl" query string.)
63: *
64: * <p>
65: * This object is <b>NOT</b> intended to be used by other
66: * internal components to parse them. For that purpose, use
67: * {@link WSDLModel} instead.
68: *
69: * @author Kohsuke Kawaguchi
70: */
71: public interface ServiceDefinition extends Iterable<SDDocument> {
72: /**
73: * Gets the "primary" {@link SDDocument} that represents a WSDL.
74: *
75: * <p>
76: * This WSDL eventually refers to all the other {@link SDDocument}s.
77: *
78: * @return
79: * always non-null.
80: */
81: @NotNull
82: SDDocument getPrimary();
83:
84: /**
85: * Adds a filter that is called while writing {@link SDDocument}'s infoset. This
86: * filter is applied to the all the other reachable {@link SDDocument}s.
87: *
88: * @param filter that is called while writing the document
89: */
90: void addFilter(@NotNull
91: SDDocumentFilter filter);
92: }
|