01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.transport.http;
38:
39: import com.sun.istack.NotNull;
40: import com.sun.xml.ws.api.server.EndpointComponent;
41: import com.sun.xml.ws.api.server.WSEndpoint;
42:
43: import java.io.IOException;
44:
45: /**
46: * Intercepts GET HTTP requests to process the requests.
47: *
48: * <p>
49: * {@link HttpAdapter} looks for this SPI in {@link WSEndpoint#getComponentRegistry()}
50: * to allow components to expose additional information through HTTP.
51: *
52: * @author Kohsuke Kawaguchi
53: * @see EndpointComponent#getSPI(Class)
54: * @since 2.1.2
55: */
56: public abstract class HttpMetadataPublisher {
57: /**
58: * When {@link HttpAdapter} receives a GET request with a query string
59: * (which is a convention for metadata requests, such as '?wsdl' or '?xsd=...'),
60: * then this method is invoked to allow components to intercept the request.
61: *
62: * @param adapter
63: * Adapter that accepted the connection.
64: * @param connection
65: * Represents the current connection.
66: * @return
67: * true if the request is processed. If false is returned the default processing kicks in.
68: */
69: public abstract boolean handleMetadataRequest(@NotNull
70: HttpAdapter adapter, @NotNull
71: WSHTTPConnection connection) throws IOException;
72: }
|