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

changeset 0
373ffda63c9a
child 637
9c07ef4934dd
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/transport/http/HttpMetadataPublisher.java	Wed Apr 27 01:27:09 2016 +0800
     1.3 @@ -0,0 +1,59 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.ws.transport.http;
    1.30 +
    1.31 +import com.sun.istack.internal.NotNull;
    1.32 +import com.sun.xml.internal.ws.api.Component;
    1.33 +import com.sun.xml.internal.ws.api.server.WSEndpoint;
    1.34 +
    1.35 +import java.io.IOException;
    1.36 +
    1.37 +/**
    1.38 + * Intercepts GET HTTP requests to process the requests.
    1.39 + *
    1.40 + * <p>
    1.41 + * {@link HttpAdapter} looks for this SPI in {@link WSEndpoint#getComponents()}
    1.42 + * to allow components to expose additional information through HTTP.
    1.43 + *
    1.44 + * @author Kohsuke Kawaguchi
    1.45 + * @see Component#getSPI(Class)
    1.46 + * @since 2.1.2
    1.47 + */
    1.48 +public abstract class HttpMetadataPublisher {
    1.49 +    /**
    1.50 +     * When {@link HttpAdapter} receives a GET request with a query string
    1.51 +     * (which is a convention for metadata requests, such as '?wsdl' or '?xsd=...'),
    1.52 +     * then this method is invoked to allow components to intercept the request.
    1.53 +     *
    1.54 +     * @param adapter
    1.55 +     *      Adapter that accepted the connection.
    1.56 +     * @param connection
    1.57 +     *      Represents the current connection.
    1.58 +     * @return
    1.59 +     *      true if the request is processed. If false is returned the default processing kicks in.
    1.60 +     */
    1.61 +    public abstract boolean handleMetadataRequest(@NotNull HttpAdapter adapter, @NotNull WSHTTPConnection connection) throws IOException;
    1.62 +}

mercurial