src/share/jaxws_classes/com/sun/xml/internal/ws/transport/http/HttpMetadataPublisher.java

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

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.transport.http;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29 import com.sun.xml.internal.ws.api.Component;
ohair@286 30 import com.sun.xml.internal.ws.api.server.WSEndpoint;
ohair@286 31
ohair@286 32 import java.io.IOException;
ohair@286 33
ohair@286 34 /**
ohair@286 35 * Intercepts GET HTTP requests to process the requests.
ohair@286 36 *
ohair@286 37 * <p>
ohair@286 38 * {@link HttpAdapter} looks for this SPI in {@link WSEndpoint#getComponents()}
ohair@286 39 * to allow components to expose additional information through HTTP.
ohair@286 40 *
ohair@286 41 * @author Kohsuke Kawaguchi
ohair@286 42 * @see Component#getSPI(Class)
ohair@286 43 * @since 2.1.2
ohair@286 44 */
ohair@286 45 public abstract class HttpMetadataPublisher {
ohair@286 46 /**
ohair@286 47 * When {@link HttpAdapter} receives a GET request with a query string
ohair@286 48 * (which is a convention for metadata requests, such as '?wsdl' or '?xsd=...'),
ohair@286 49 * then this method is invoked to allow components to intercept the request.
ohair@286 50 *
ohair@286 51 * @param adapter
ohair@286 52 * Adapter that accepted the connection.
ohair@286 53 * @param connection
ohair@286 54 * Represents the current connection.
ohair@286 55 * @return
ohair@286 56 * true if the request is processed. If false is returned the default processing kicks in.
ohair@286 57 */
ohair@286 58 public abstract boolean handleMetadataRequest(@NotNull HttpAdapter adapter, @NotNull WSHTTPConnection connection) throws IOException;
ohair@286 59 }

mercurial