Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/org/jvnet/ws/message/DistributedPropertySet.java@c46e0b6e3f98 (annotated)
src/share/jaxws_classes/com/sun/xml/internal/org/jvnet/ws/message/DistributedPropertySet.java
Thu, 08 Mar 2012 18:20:15 -0800
- author
- ohair
- date
- Thu, 08 Mar 2012 18:20:15 -0800
- changeset 292
- c46e0b6e3f98
- parent 286
- f50545b5e2f1
- permissions
- -rw-r--r--
7152425: Fix copyright notices on 12 files in jaxws
Reviewed-by: mbykov
| ohair@286 | 1 | /* |
| ohair@292 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
| ohair@292 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| ohair@286 | 4 | * |
| ohair@292 | 5 | * This code is free software; you can redistribute it and/or modify it |
| ohair@292 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@292 | 7 | * published by the Free Software Foundation. Oracle designates this |
| ohair@292 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@292 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| ohair@286 | 10 | * |
| ohair@292 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| ohair@292 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| ohair@292 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| ohair@292 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| ohair@292 | 15 | * accompanied this code). |
| ohair@286 | 16 | * |
| ohair@292 | 17 | * You should have received a copy of the GNU General Public License version |
| ohair@292 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| ohair@292 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| ohair@286 | 20 | * |
| ohair@292 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@292 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@292 | 23 | * questions. |
| ohair@286 | 24 | */ |
| ohair@286 | 25 | |
| ohair@286 | 26 | package com.sun.xml.internal.org.jvnet.ws.message; |
| ohair@286 | 27 | |
| ohair@286 | 28 | import com.sun.istack.internal.Nullable; |
| ohair@286 | 29 | |
| ohair@286 | 30 | /** |
| ohair@286 | 31 | * {@link PropertySet} that combines properties exposed from multiple |
| ohair@286 | 32 | * {@link PropertySet}s into one. |
| ohair@286 | 33 | * |
| ohair@286 | 34 | * <p> |
| ohair@286 | 35 | * This implementation allows one {@link PropertySet} to assemble |
| ohair@286 | 36 | * all properties exposed from other "satellite" {@link PropertySet}s. |
| ohair@286 | 37 | * (A satellite may itself be a {@link DistributedPropertySet}, so |
| ohair@286 | 38 | * in general this can form a tree.) |
| ohair@286 | 39 | * |
| ohair@286 | 40 | * <p> |
| ohair@286 | 41 | * This is useful for JAX-WS because the properties we expose to the application |
| ohair@286 | 42 | * are contributed by different pieces, and therefore we'd like each of them |
| ohair@286 | 43 | * to have a separate {@link PropertySet} implementation that backs up |
| ohair@286 | 44 | * the properties. For example, this allows FastInfoset to expose its |
| ohair@286 | 45 | * set of properties to {@link RequestContext} by using a strongly-typed fields. |
| ohair@286 | 46 | * |
| ohair@286 | 47 | * <p> |
| ohair@286 | 48 | * This is also useful for a client-side transport to expose a bunch of properties |
| ohair@286 | 49 | * into {@link ResponseContext}. It simply needs to create a {@link PropertySet} |
| ohair@286 | 50 | * object with methods for each property it wants to expose, and then add that |
| ohair@286 | 51 | * {@link PropertySet} to {@link Packet}. This allows property values to be |
| ohair@286 | 52 | * lazily computed (when actually asked by users), thus improving the performance |
| ohair@286 | 53 | * of the typical case where property values are not asked. |
| ohair@286 | 54 | * |
| ohair@286 | 55 | * <p> |
| ohair@286 | 56 | * A similar benefit applies on the server-side, for a transport to expose |
| ohair@286 | 57 | * a bunch of properties to {@link WebServiceContext}. |
| ohair@286 | 58 | * |
| ohair@286 | 59 | * <p> |
| ohair@286 | 60 | * To achieve these benefits, access to {@link DistributedPropertySet} is slower |
| ohair@286 | 61 | * compared to {@link PropertySet} (such as get/set), while adding a satellite |
| ohair@286 | 62 | * object is relatively fast. |
| ohair@286 | 63 | * |
| ohair@286 | 64 | * @author Kohsuke Kawaguchi |
| ohair@286 | 65 | */ |
| ohair@286 | 66 | public interface DistributedPropertySet extends com.sun.xml.internal.org.jvnet.ws.message.PropertySet { |
| ohair@286 | 67 | |
| ohair@286 | 68 | public @Nullable <T extends com.sun.xml.internal.org.jvnet.ws.message.PropertySet> T getSatellite(Class<T> satelliteClass); |
| ohair@286 | 69 | |
| ohair@286 | 70 | public void addSatellite(com.sun.xml.internal.org.jvnet.ws.message.PropertySet satellite); |
| ohair@286 | 71 | |
| ohair@286 | 72 | public void addSatellite(Class keyClass, com.sun.xml.internal.org.jvnet.ws.message.PropertySet satellite); |
| ohair@286 | 73 | |
| ohair@286 | 74 | public void removeSatellite(com.sun.xml.internal.org.jvnet.ws.message.PropertySet satellite); |
| ohair@286 | 75 | |
| ohair@286 | 76 | public void copySatelliteInto(com.sun.xml.internal.org.jvnet.ws.message.MessageContext r); |
| ohair@286 | 77 | } |
