Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.ws.transport.http; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import com.sun.istack.internal.NotNull; |
aoqi@0 | 29 | import com.sun.xml.internal.ws.api.Component; |
aoqi@0 | 30 | import com.sun.xml.internal.ws.api.server.WSEndpoint; |
aoqi@0 | 31 | |
aoqi@0 | 32 | import java.io.IOException; |
aoqi@0 | 33 | |
aoqi@0 | 34 | /** |
aoqi@0 | 35 | * Intercepts GET HTTP requests to process the requests. |
aoqi@0 | 36 | * |
aoqi@0 | 37 | * <p> |
aoqi@0 | 38 | * {@link HttpAdapter} looks for this SPI in {@link WSEndpoint#getComponents()} |
aoqi@0 | 39 | * to allow components to expose additional information through HTTP. |
aoqi@0 | 40 | * |
aoqi@0 | 41 | * @author Kohsuke Kawaguchi |
aoqi@0 | 42 | * @see Component#getSPI(Class) |
aoqi@0 | 43 | * @since 2.1.2 |
aoqi@0 | 44 | */ |
aoqi@0 | 45 | public abstract class HttpMetadataPublisher { |
aoqi@0 | 46 | /** |
aoqi@0 | 47 | * When {@link HttpAdapter} receives a GET request with a query string |
aoqi@0 | 48 | * (which is a convention for metadata requests, such as '?wsdl' or '?xsd=...'), |
aoqi@0 | 49 | * then this method is invoked to allow components to intercept the request. |
aoqi@0 | 50 | * |
aoqi@0 | 51 | * @param adapter |
aoqi@0 | 52 | * Adapter that accepted the connection. |
aoqi@0 | 53 | * @param connection |
aoqi@0 | 54 | * Represents the current connection. |
aoqi@0 | 55 | * @return |
aoqi@0 | 56 | * true if the request is processed. If false is returned the default processing kicks in. |
aoqi@0 | 57 | */ |
aoqi@0 | 58 | public abstract boolean handleMetadataRequest(@NotNull HttpAdapter adapter, @NotNull WSHTTPConnection connection) throws IOException; |
aoqi@0 | 59 | } |