| /* |
| * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package com.oracle.webservices.internal.api.message; |
| |
| import java.util.Map; |
| |
| import com.sun.istack.internal.Nullable; |
| |
| /** |
| * {@link PropertySet} that combines properties exposed from multiple |
| * {@link PropertySet}s into one. |
| * |
| * <p> |
| * This implementation allows one {@link PropertySet} to assemble |
| * all properties exposed from other "satellite" {@link PropertySet}s. |
| * (A satellite may itself be a {@link DistributedPropertySet}, so |
| * in general this can form a tree.) |
| * |
| * <p> |
| * This is useful for JAX-WS because the properties we expose to the application |
| * are contributed by different pieces, and therefore we'd like each of them |
| * to have a separate {@link PropertySet} implementation that backs up |
| * the properties. For example, this allows FastInfoset to expose its |
| * set of properties to {@link RequestContext} by using a strongly-typed fields. |
| * |
| * <p> |
| * This is also useful for a client-side transport to expose a bunch of properties |
| * into {@link ResponseContext}. It simply needs to create a {@link PropertySet} |
| * object with methods for each property it wants to expose, and then add that |
| * {@link PropertySet} to {@link Packet}. This allows property values to be |
| * lazily computed (when actually asked by users), thus improving the performance |
| * of the typical case where property values are not asked. |
| * |
| * <p> |
| * A similar benefit applies on the server-side, for a transport to expose |
| * a bunch of properties to {@link WebServiceContext}. |
| * |
| * <p> |
| * To achieve these benefits, access to {@link DistributedPropertySet} is slower |
| * compared to {@link PropertySet} (such as get/set), while adding a satellite |
| * object is relatively fast. |
| * |
| * @author Kohsuke Kawaguchi |
| */ |
| public interface DistributedPropertySet extends com.oracle.webservices.internal.api.message.PropertySet { |
| |
| public @Nullable <T extends com.oracle.webservices.internal.api.message.PropertySet> T getSatellite(Class<T> satelliteClass); |
| |
| public Map<Class<? extends com.oracle.webservices.internal.api.message.PropertySet>, com.oracle.webservices.internal.api.message.PropertySet> getSatellites(); |
| |
| public void addSatellite(com.oracle.webservices.internal.api.message.PropertySet satellite); |
| |
| public void addSatellite(Class<? extends com.oracle.webservices.internal.api.message.PropertySet> keyClass, com.oracle.webservices.internal.api.message.PropertySet satellite); |
| |
| public void removeSatellite(com.oracle.webservices.internal.api.message.PropertySet satellite); |
| |
| public void copySatelliteInto(com.oracle.webservices.internal.api.message.MessageContext r); |
| } |