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