com.oracle.webservices.api.message.DistributedPropertySet Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.oracle.webservices.api.message;
import java.util.Map;
import com.sun.istack.Nullable;
/**
* {@link PropertySet} that combines properties exposed from multiple
* {@link PropertySet}s into one.
*
*
* 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.)
*
*
* 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.
*
*
* 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.
*
*
* A similar benefit applies on the server-side, for a transport to expose
* a bunch of properties to {@link WebServiceContext}.
*
*
* 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.api.message.PropertySet {
public @Nullable T getSatellite(Class satelliteClass);
public Map, com.oracle.webservices.api.message.PropertySet> getSatellites();
public void addSatellite(com.oracle.webservices.api.message.PropertySet satellite);
public void addSatellite(Class keyClass, com.oracle.webservices.api.message.PropertySet satellite);
public void removeSatellite(com.oracle.webservices.api.message.PropertySet satellite);
public void copySatelliteInto(com.oracle.webservices.api.message.MessageContext r);
}