src/share/jaxws_classes/com/sun/xml/internal/ws/developer/EPRRecipe.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.message.Header;
ohair@286 30 import com.sun.xml.internal.ws.api.message.Headers;
ohair@286 31
ohair@286 32 import javax.xml.transform.Source;
ohair@286 33 import javax.xml.ws.EndpointReference;
ohair@286 34 import javax.xml.ws.wsaddressing.W3CEndpointReference;
ohair@286 35 import java.util.ArrayList;
ohair@286 36 import java.util.List;
ohair@286 37
ohair@286 38 /**
ohair@286 39 * Represents additional data to be added to EPRs
ohair@286 40 * created from {@link StatefulWebServiceManager} (for advanced users).
ohair@286 41 *
ohair@286 42 * <p>
ohair@286 43 * Occasionally it is convenient to be able to control the data to be
ohair@286 44 * present on {@link EndpointReference}s created by {@link StatefulWebServiceManager}.
ohair@286 45 * You can do so by using this class like this:
ohair@286 46 *
ohair@286 47 * <pre>
ohair@286 48 * statefulWebServiceManager.export({@link W3CEndpointReference}.class,myObject,
ohair@286 49 * new EPRRecipe().addReferenceParameter({@link Headers}.create(...))
ohair@286 50 * .addReferenceParameter({@link Headers}.create(...)));
ohair@286 51 * </pre>
ohair@286 52 *
ohair@286 53 * <p>
ohair@286 54 * The methods on this class follows <a href="http://www.martinfowler.com/bliki/FluentInterface.html">
ohair@286 55 * the fluent interface design</a> to allow construction without using a variable.
ohair@286 56 *
ohair@286 57 *
ohair@286 58 * <p>
ohair@286 59 * See <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/#eprinfomodel">
ohair@286 60 * WS-Addressing EPR information model</a> for more details.
ohair@286 61 *
ohair@286 62 * @author Kohsuke Kawaguchi
ohair@286 63 * @since 2.1.1
ohair@286 64 * @see StatefulWebServiceManager
ohair@286 65 * @see Headers
ohair@286 66 */
ohair@286 67 public final class EPRRecipe {
ohair@286 68 private final List<Header> referenceParameters = new ArrayList<Header>();
ohair@286 69 private final List<Source> metadata = new ArrayList<Source>();
ohair@286 70
ohair@286 71 /**
ohair@286 72 * Gets all the reference parameters added so far.
ohair@286 73 */
ohair@286 74 public @NotNull List<Header> getReferenceParameters() {
ohair@286 75 return referenceParameters;
ohair@286 76 }
ohair@286 77
ohair@286 78 /**
ohair@286 79 * Gets all the metadata added so far.
ohair@286 80 */
ohair@286 81 public @NotNull List<Source> getMetadata() {
ohair@286 82 return metadata;
ohair@286 83 }
ohair@286 84
ohair@286 85 /**
ohair@286 86 * Adds a new reference parameter.
ohair@286 87 */
ohair@286 88 public EPRRecipe addReferenceParameter(Header h) {
ohair@286 89 if(h==null) throw new IllegalArgumentException();
ohair@286 90 referenceParameters.add(h);
ohair@286 91 return this;
ohair@286 92 }
ohair@286 93
ohair@286 94 /**
ohair@286 95 * Adds all the headers as reference parameters.
ohair@286 96 */
ohair@286 97 public EPRRecipe addReferenceParameters(Header... headers) {
ohair@286 98 for (Header h : headers)
ohair@286 99 addReferenceParameter(h);
ohair@286 100 return this;
ohair@286 101 }
ohair@286 102
ohair@286 103 /**
ohair@286 104 * Adds all the headers as reference parameters.
ohair@286 105 */
ohair@286 106 public EPRRecipe addReferenceParameters(Iterable<? extends Header> headers) {
ohair@286 107 for (Header h : headers)
ohair@286 108 addReferenceParameter(h);
ohair@286 109 return this;
ohair@286 110 }
ohair@286 111
ohair@286 112 /**
ohair@286 113 * Adds a new metadata.
ohair@286 114 */
ohair@286 115 public EPRRecipe addMetadata(Source source) {
ohair@286 116 if(source==null) throw new IllegalArgumentException();
ohair@286 117 metadata.add(source);
ohair@286 118 return this;
ohair@286 119 }
ohair@286 120
ohair@286 121 public EPRRecipe addMetadata(Source... sources) {
ohair@286 122 for (Source s : sources)
ohair@286 123 addMetadata(s);
ohair@286 124 return this;
ohair@286 125 }
ohair@286 126
ohair@286 127 public EPRRecipe addMetadata(Iterable<? extends Source> sources) {
ohair@286 128 for (Source s : sources)
ohair@286 129 addMetadata(s);
ohair@286 130 return this;
ohair@286 131 }
ohair@286 132 }

mercurial