src/share/jaxws_classes/com/sun/xml/internal/ws/developer/WSBindingProvider.java

Fri, 14 Feb 2014 11:13:45 +0100

author
mkos
date
Fri, 14 Feb 2014 11:13:45 +0100
changeset 515
6cd506508147
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8026188: Enhance envelope factory
Summary: Avoiding caching data initialized via TCCL in static context; fix also reviewed by Alexander Fomin
Reviewed-by: ahgross, mgrebac, skoivu

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.developer;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29 import com.sun.xml.internal.ws.api.ComponentRegistry;
ohair@286 30 import com.sun.xml.internal.ws.api.message.Header;
ohair@286 31 import com.sun.xml.internal.ws.api.message.Headers;
ohair@286 32 import com.sun.xml.internal.ws.api.addressing.WSEndpointReference;
ohair@286 33 import com.sun.xml.internal.ws.api.client.WSPortInfo;
ohair@286 34 import javax.xml.bind.JAXBContext;
ohair@286 35 import javax.xml.namespace.QName;
ohair@286 36 import javax.xml.ws.BindingProvider;
ohair@286 37 import javax.xml.ws.Dispatch;
ohair@286 38 import javax.xml.ws.Service;
ohair@286 39 import javax.xml.ws.Service.Mode;
ohair@286 40 import java.util.List;
ohair@286 41 import java.io.Closeable;
ohair@286 42 import com.sun.org.glassfish.gmbal.ManagedObjectManager;
ohair@286 43
ohair@286 44 /**
ohair@286 45 * {@link BindingProvider} with JAX-WS RI's extension methods.
ohair@286 46 *
ohair@286 47 * @author Kohsuke Kawaguchi
ohair@286 48 * @author Jitendra Kotamraju
ohair@286 49 * @since 2.1EA3
ohair@286 50 */
ohair@286 51 public interface WSBindingProvider extends BindingProvider, Closeable, ComponentRegistry {
ohair@286 52 /**
ohair@286 53 * Sets the out-bound headers to be added to messages sent from
ohair@286 54 * this {@link BindingProvider}.
ohair@286 55 *
ohair@286 56 * <p>
ohair@286 57 * Calling this method would discard any out-bound headers
ohair@286 58 * that were previously set.
ohair@286 59 *
ohair@286 60 * <p>
ohair@286 61 * A new {@link Header} object can be created by using
ohair@286 62 * one of the methods on {@link Headers}.
ohair@286 63 *
ohair@286 64 * @param headers
ohair@286 65 * The headers to be added to the future request messages.
ohair@286 66 * To clear the outbound headers, pass in either null
ohair@286 67 * or empty list.
ohair@286 68 * @throws IllegalArgumentException
ohair@286 69 * if the list contains null item.
ohair@286 70 */
ohair@286 71 void setOutboundHeaders(List<Header> headers);
ohair@286 72
ohair@286 73 /**
ohair@286 74 * Sets the out-bound headers to be added to messages sent from
ohair@286 75 * this {@link BindingProvider}.
ohair@286 76 *
ohair@286 77 * <p>
ohair@286 78 * Works like {@link #setOutboundHeaders(List)} except
ohair@286 79 * that it accepts a var arg array.
ohair@286 80 *
ohair@286 81 * @param headers
ohair@286 82 * Can be null or empty.
ohair@286 83 */
ohair@286 84 void setOutboundHeaders(Header... headers);
ohair@286 85
ohair@286 86 /**
ohair@286 87 * Sets the out-bound headers to be added to messages sent from
ohair@286 88 * this {@link BindingProvider}.
ohair@286 89 *
ohair@286 90 * <p>
ohair@286 91 * Each object must be a JAXB-bound object that is understood
ohair@286 92 * by the {@link JAXBContext} object known by this {@link WSBindingProvider}
ohair@286 93 * (that is, if this is a {@link Dispatch} with JAXB, then
ohair@286 94 * {@link JAXBContext} given to {@link Service#createDispatch(QName,JAXBContext,Mode)}
ohair@286 95 * and if this is a typed proxy, then {@link JAXBContext}
ohair@286 96 * implicitly created by the JAX-WS RI.)
ohair@286 97 *
ohair@286 98 * @param headers
ohair@286 99 * Can be null or empty.
ohair@286 100 * @throws UnsupportedOperationException
alanb@368 101 * If this {@link WSBindingProvider} is a {@link Dispatch}
ohair@286 102 * that does not use JAXB.
ohair@286 103 */
ohair@286 104 void setOutboundHeaders(Object... headers);
ohair@286 105
ohair@286 106 List<Header> getInboundHeaders();
ohair@286 107
ohair@286 108 /**
ohair@286 109 * Sets the endpoint address for all the invocations that happen
ohair@286 110 * from {@link BindingProvider}. Instead of doing the following
ohair@286 111 *
ohair@286 112 * <p>
ohair@286 113 * ((BindingProvider)proxy).getRequestContext().put(
ohair@286 114 * BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "...")
ohair@286 115 * <p>
ohair@286 116 * you could do this:
ohair@286 117 *
ohair@286 118 * <p>
ohair@286 119 * ((WSBindingProvider)proxy).setAddress("...");
ohair@286 120 *
ohair@286 121 * @param address Address of the service
ohair@286 122 */
ohair@286 123 void setAddress(String address);
ohair@286 124
ohair@286 125 /**
ohair@286 126 * Similar to {link BindingProvider#getEndpointReference(}, but returns WSEndpointReference that has more
ohair@286 127 * convenience methods
ohair@286 128 *
ohair@286 129 * @return WSEndpointReference of the target servcie endpoint
ohair@286 130 *
ohair@286 131 * @since JAX-WS 2.2
ohair@286 132 */
ohair@286 133 WSEndpointReference getWSEndpointReference();
ohair@286 134
ohair@286 135 /**
ohair@286 136 *
ohair@286 137 * @return WSPortInfo object that captures the port information for which the stub is created.
ohair@286 138 * @since JAX-WS 2.2
ohair@286 139 */
ohair@286 140 WSPortInfo getPortInfo();
ohair@286 141
ohair@286 142 /**
ohair@286 143 * Get the ManagedObjectManager for this provider.
ohair@286 144 */
ohair@286 145 public @NotNull ManagedObjectManager getManagedObjectManager();
ohair@286 146 }

mercurial