src/share/jaxws_classes/com/sun/xml/internal/ws/api/client/ServiceInterceptor.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

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.api.client;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29 import com.sun.istack.internal.Nullable;
ohair@286 30 import com.sun.xml.internal.ws.api.BindingID;
ohair@286 31 import com.sun.xml.internal.ws.api.WSBinding;
ohair@286 32 import com.sun.xml.internal.ws.api.WSFeatureList;
ohair@286 33 import com.sun.xml.internal.ws.api.WSService;
ohair@286 34 import com.sun.xml.internal.ws.developer.WSBindingProvider;
ohair@286 35
ohair@286 36 import javax.xml.ws.BindingProvider;
ohair@286 37 import javax.xml.ws.Dispatch;
ohair@286 38 import javax.xml.ws.WebServiceFeature;
ohair@286 39 import java.util.ArrayList;
ohair@286 40 import java.util.Collections;
ohair@286 41 import java.util.List;
ohair@286 42
ohair@286 43 /**
ohair@286 44 * Interception point for inner working of {@link WSService}.
ohair@286 45 *
ohair@286 46 * <p>
ohair@286 47 * System-level code could hook an implementation of this to
ohair@286 48 * {@link WSService} to augument its behavior.
ohair@286 49 *
ohair@286 50 * @author Kohsuke Kawaguchi
ohair@286 51 * @since 2.1 EA3
ohair@286 52 * @see ServiceInterceptorFactory
ohair@286 53 */
ohair@286 54 public abstract class ServiceInterceptor {
ohair@286 55 /**
ohair@286 56 * Called before {@link WSBinding} is created, to allow interceptors
ohair@286 57 * to add {@link WebServiceFeature}s to the created {@link WSBinding}.
ohair@286 58 *
ohair@286 59 * @param port
ohair@286 60 * Information about the port for which dispatch/proxy will be created.
ohair@286 61 * @param serviceEndpointInterface
ohair@286 62 * Null if the created binding is for {@link Dispatch}. Otheriwse
ohair@286 63 * it represents the port interface of the proxy to be created.
ohair@286 64 * @param defaultFeatures
ohair@286 65 * The list of features that are currently scheduled to be set for
ohair@286 66 * the newly created {@link WSBinding}.
ohair@286 67 *
ohair@286 68 * @return
ohair@286 69 * A set of features to be added to the newly created {@link WSBinding}.
ohair@286 70 * Can be empty but never null.
ohair@286 71 * <tt>defaultFeatures</tt> will take precedence over what this method
ohair@286 72 * would return (because it includes user-specified ones which will
ohair@286 73 * take the at-most priority), but features you return from this method
ohair@286 74 * will take precedence over {@link BindingID}'s
ohair@286 75 * {@link BindingID#createBuiltinFeatureList() implicit features}.
ohair@286 76 */
ohair@286 77 public List<WebServiceFeature> preCreateBinding(@NotNull WSPortInfo port, @Nullable Class<?> serviceEndpointInterface, @NotNull WSFeatureList defaultFeatures) {
ohair@286 78 return Collections.emptyList();
ohair@286 79 }
ohair@286 80
ohair@286 81 /**
ohair@286 82 * A callback to notify the event of creation of proxy object for SEI endpoint. The
ohair@286 83 * callback could set some properties on the {@link BindingProvider}.
ohair@286 84 *
ohair@286 85 * @param bp created proxy instance
ohair@286 86 * @param serviceEndpointInterface SEI of the endpoint
ohair@286 87 */
ohair@286 88 public void postCreateProxy(@NotNull WSBindingProvider bp,@NotNull Class<?> serviceEndpointInterface) {
ohair@286 89 }
ohair@286 90
ohair@286 91 /**
ohair@286 92 * A callback to notify that a {@link Dispatch} object is created. The callback
ohair@286 93 * could set some properties on the {@link BindingProvider}.
ohair@286 94 *
ohair@286 95 * @param bp BindingProvider of dispatch object
ohair@286 96 */
ohair@286 97 public void postCreateDispatch(@NotNull WSBindingProvider bp) {
ohair@286 98 }
ohair@286 99
ohair@286 100 /**
ohair@286 101 * Aggregates multiple interceptors into one facade.
ohair@286 102 */
ohair@286 103 public static ServiceInterceptor aggregate(final ServiceInterceptor... interceptors) {
ohair@286 104 if(interceptors.length==1)
ohair@286 105 return interceptors[0];
ohair@286 106 return new ServiceInterceptor() {
ohair@286 107 public List<WebServiceFeature> preCreateBinding(@NotNull WSPortInfo port, @Nullable Class<?> portInterface, @NotNull WSFeatureList defaultFeatures) {
ohair@286 108 List<WebServiceFeature> r = new ArrayList<WebServiceFeature>();
ohair@286 109 for (ServiceInterceptor si : interceptors)
ohair@286 110 r.addAll(si.preCreateBinding(port,portInterface,defaultFeatures));
ohair@286 111 return r;
ohair@286 112 }
ohair@286 113
ohair@286 114 public void postCreateProxy(@NotNull WSBindingProvider bp, @NotNull Class<?> serviceEndpointInterface) {
ohair@286 115 for (ServiceInterceptor si : interceptors)
ohair@286 116 si.postCreateProxy(bp,serviceEndpointInterface);
ohair@286 117 }
ohair@286 118
ohair@286 119 public void postCreateDispatch(@NotNull WSBindingProvider bp) {
ohair@286 120 for (ServiceInterceptor si : interceptors)
ohair@286 121 si.postCreateDispatch(bp);
ohair@286 122 }
ohair@286 123 };
ohair@286 124 }
ohair@286 125 }

mercurial