src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/ServiceDefinition.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.server;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29 import com.sun.xml.internal.ws.api.model.wsdl.WSDLModel;
ohair@286 30
ohair@286 31 /**
ohair@286 32 * Root of the unparsed WSDL and other resources referenced from it.
ohair@286 33 * This object represents the description of the service
ohair@286 34 * that a {@link WSEndpoint} offers.
ohair@286 35 *
ohair@286 36 * <p>
ohair@286 37 * A description consists of a set of {@link SDDocument}, which
ohair@286 38 * each represents a single XML document that forms a part of the
ohair@286 39 * descriptor (for example, WSDL might refer to separate schema documents,
ohair@286 40 * or a WSDL might refer to another WSDL.)
ohair@286 41 *
ohair@286 42 * <p>
ohair@286 43 * {@link ServiceDefinition} and its descendants are immutable
ohair@286 44 * read-only objects. Once they are created, they always return
ohair@286 45 * the same value.
ohair@286 46 *
ohair@286 47 * <h2>Expected Usage</h2>
ohair@286 48 * <p>
ohair@286 49 * This object is intended to be used for serving the descriptors
ohair@286 50 * to remote clients (such as by MEX, or other protocol-specific
ohair@286 51 * metadata query, such as HTTP GET with "?wsdl" query string.)
ohair@286 52 *
ohair@286 53 * <p>
ohair@286 54 * This object is <b>NOT</b> intended to be used by other
ohair@286 55 * internal components to parse them. For that purpose, use
ohair@286 56 * {@link WSDLModel} instead.
ohair@286 57 *
ohair@286 58 * @author Kohsuke Kawaguchi
ohair@286 59 */
ohair@286 60 public interface ServiceDefinition extends Iterable<SDDocument> {
ohair@286 61 /**
ohair@286 62 * Gets the "primary" {@link SDDocument} that represents a WSDL.
ohair@286 63 *
ohair@286 64 * <p>
ohair@286 65 * This WSDL eventually refers to all the other {@link SDDocument}s.
ohair@286 66 *
ohair@286 67 * @return
ohair@286 68 * always non-null.
ohair@286 69 */
ohair@286 70 @NotNull SDDocument getPrimary();
ohair@286 71
ohair@286 72 /**
ohair@286 73 * Adds a filter that is called while writing {@link SDDocument}'s infoset. This
ohair@286 74 * filter is applied to the all the other reachable {@link SDDocument}s.
ohair@286 75 *
ohair@286 76 * @param filter that is called while writing the document
ohair@286 77 */
ohair@286 78 void addFilter(@NotNull SDDocumentFilter filter);
ohair@286 79 }

mercurial