325N/A/*
325N/A * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.xml.internal.ws.api.server;
325N/A
325N/Aimport com.sun.istack.internal.NotNull;
325N/Aimport com.sun.xml.internal.ws.api.model.wsdl.WSDLModel;
325N/A
325N/A/**
325N/A * Root of the unparsed WSDL and other resources referenced from it.
325N/A * This object represents the description of the service
325N/A * that a {@link WSEndpoint} offers.
325N/A *
325N/A * <p>
325N/A * A description consists of a set of {@link SDDocument}, which
325N/A * each represents a single XML document that forms a part of the
325N/A * descriptor (for example, WSDL might refer to separate schema documents,
325N/A * or a WSDL might refer to another WSDL.)
325N/A *
325N/A * <p>
325N/A * {@link ServiceDefinition} and its descendants are immutable
325N/A * read-only objects. Once they are created, they always return
325N/A * the same value.
325N/A *
325N/A * <h2>Expected Usage</h2>
325N/A * <p>
325N/A * This object is intended to be used for serving the descriptors
325N/A * to remote clients (such as by MEX, or other protocol-specific
325N/A * metadata query, such as HTTP GET with "?wsdl" query string.)
325N/A *
325N/A * <p>
325N/A * This object is <b>NOT</b> intended to be used by other
325N/A * internal components to parse them. For that purpose, use
325N/A * {@link WSDLModel} instead.
325N/A *
325N/A * @author Kohsuke Kawaguchi
325N/A */
325N/Apublic interface ServiceDefinition extends Iterable<SDDocument> {
325N/A /**
325N/A * Gets the "primary" {@link SDDocument} that represents a WSDL.
325N/A *
325N/A * <p>
325N/A * This WSDL eventually refers to all the other {@link SDDocument}s.
325N/A *
325N/A * @return
325N/A * always non-null.
325N/A */
325N/A @NotNull SDDocument getPrimary();
325N/A
325N/A /**
325N/A * Adds a filter that is called while writing {@link SDDocument}'s infoset. This
325N/A * filter is applied to the all the other reachable {@link SDDocument}s.
325N/A *
325N/A * @param filter that is called while writing the document
325N/A */
325N/A void addFilter(@NotNull SDDocumentFilter filter);
325N/A}