jdk8-mips64-public/jaxws: src/share/jaxws_classes/com/sun/xml/internal/ws/transport/http/HttpMetadataPublisher.java@9c07ef4934dd

     1 /*

     2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.xml.internal.ws.transport.http;

    28 import com.sun.istack.internal.NotNull;

    29 import com.sun.xml.internal.ws.api.Component;

    30 import com.sun.xml.internal.ws.api.server.WSEndpoint;

    32 import java.io.IOException;

    34 /**

    35  * Intercepts GET HTTP requests to process the requests.

    36  *

    37  * <p>

    38  * {@link HttpAdapter} looks for this SPI in {@link WSEndpoint#getComponents()}

    39  * to allow components to expose additional information through HTTP.

    40  *

    41  * @author Kohsuke Kawaguchi

    42  * @see Component#getSPI(Class)

    43  * @since 2.1.2

    44  */

    45 public abstract class HttpMetadataPublisher {

    46     /**

    47      * When {@link HttpAdapter} receives a GET request with a query string

    48      * (which is a convention for metadata requests, such as '?wsdl' or '?xsd=...'),

    49      * then this method is invoked to allow components to intercept the request.

    50      *

    51      * @param adapter

    52      *      Adapter that accepted the connection.

    53      * @param connection

    54      *      Represents the current connection.

    55      * @return

    56      *      true if the request is processed. If false is returned the default processing kicks in.

    57      */

    58     public abstract boolean handleMetadataRequest(@NotNull HttpAdapter adapter, @NotNull WSHTTPConnection connection) throws IOException;

    59 }

Mercurial > jdk8-mips64-public > jaxws / file revision