src/share/jaxws_classes/com/sun/xml/internal/ws/developer/EPRRecipe.java

Thu, 31 Aug 2017 15:18:52 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:18:52 +0800
changeset 637
9c07ef4934dd
parent 368
0989ad8c0860
parent 0
373ffda63c9a
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.xml.internal.ws.developer;
aoqi@0 27
aoqi@0 28 import com.sun.istack.internal.NotNull;
aoqi@0 29 import com.sun.xml.internal.ws.api.message.Header;
aoqi@0 30 import com.sun.xml.internal.ws.api.message.Headers;
aoqi@0 31
aoqi@0 32 import javax.xml.transform.Source;
aoqi@0 33 import javax.xml.ws.EndpointReference;
aoqi@0 34 import javax.xml.ws.wsaddressing.W3CEndpointReference;
aoqi@0 35 import java.util.ArrayList;
aoqi@0 36 import java.util.List;
aoqi@0 37
aoqi@0 38 /**
aoqi@0 39 * Represents additional data to be added to EPRs
aoqi@0 40 * created from {@link StatefulWebServiceManager} (for advanced users).
aoqi@0 41 *
aoqi@0 42 * <p>
aoqi@0 43 * Occasionally it is convenient to be able to control the data to be
aoqi@0 44 * present on {@link EndpointReference}s created by {@link StatefulWebServiceManager}.
aoqi@0 45 * You can do so by using this class like this:
aoqi@0 46 *
aoqi@0 47 * <pre>
aoqi@0 48 * statefulWebServiceManager.export({@link W3CEndpointReference}.class,myObject,
aoqi@0 49 * new EPRRecipe().addReferenceParameter({@link Headers}.create(...))
aoqi@0 50 * .addReferenceParameter({@link Headers}.create(...)));
aoqi@0 51 * </pre>
aoqi@0 52 *
aoqi@0 53 * <p>
aoqi@0 54 * The methods on this class follows <a href="http://www.martinfowler.com/bliki/FluentInterface.html">
aoqi@0 55 * the fluent interface design</a> to allow construction without using a variable.
aoqi@0 56 *
aoqi@0 57 *
aoqi@0 58 * <p>
aoqi@0 59 * See <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/#eprinfomodel">
aoqi@0 60 * WS-Addressing EPR information model</a> for more details.
aoqi@0 61 *
aoqi@0 62 * @author Kohsuke Kawaguchi
aoqi@0 63 * @since 2.1.1
aoqi@0 64 * @see StatefulWebServiceManager
aoqi@0 65 * @see Headers
aoqi@0 66 */
aoqi@0 67 public final class EPRRecipe {
aoqi@0 68 private final List<Header> referenceParameters = new ArrayList<Header>();
aoqi@0 69 private final List<Source> metadata = new ArrayList<Source>();
aoqi@0 70
aoqi@0 71 /**
aoqi@0 72 * Gets all the reference parameters added so far.
aoqi@0 73 */
aoqi@0 74 public @NotNull List<Header> getReferenceParameters() {
aoqi@0 75 return referenceParameters;
aoqi@0 76 }
aoqi@0 77
aoqi@0 78 /**
aoqi@0 79 * Gets all the metadata added so far.
aoqi@0 80 */
aoqi@0 81 public @NotNull List<Source> getMetadata() {
aoqi@0 82 return metadata;
aoqi@0 83 }
aoqi@0 84
aoqi@0 85 /**
aoqi@0 86 * Adds a new reference parameter.
aoqi@0 87 */
aoqi@0 88 public EPRRecipe addReferenceParameter(Header h) {
aoqi@0 89 if(h==null) throw new IllegalArgumentException();
aoqi@0 90 referenceParameters.add(h);
aoqi@0 91 return this;
aoqi@0 92 }
aoqi@0 93
aoqi@0 94 /**
aoqi@0 95 * Adds all the headers as reference parameters.
aoqi@0 96 */
aoqi@0 97 public EPRRecipe addReferenceParameters(Header... headers) {
aoqi@0 98 for (Header h : headers)
aoqi@0 99 addReferenceParameter(h);
aoqi@0 100 return this;
aoqi@0 101 }
aoqi@0 102
aoqi@0 103 /**
aoqi@0 104 * Adds all the headers as reference parameters.
aoqi@0 105 */
aoqi@0 106 public EPRRecipe addReferenceParameters(Iterable<? extends Header> headers) {
aoqi@0 107 for (Header h : headers)
aoqi@0 108 addReferenceParameter(h);
aoqi@0 109 return this;
aoqi@0 110 }
aoqi@0 111
aoqi@0 112 /**
aoqi@0 113 * Adds a new metadata.
aoqi@0 114 */
aoqi@0 115 public EPRRecipe addMetadata(Source source) {
aoqi@0 116 if(source==null) throw new IllegalArgumentException();
aoqi@0 117 metadata.add(source);
aoqi@0 118 return this;
aoqi@0 119 }
aoqi@0 120
aoqi@0 121 public EPRRecipe addMetadata(Source... sources) {
aoqi@0 122 for (Source s : sources)
aoqi@0 123 addMetadata(s);
aoqi@0 124 return this;
aoqi@0 125 }
aoqi@0 126
aoqi@0 127 public EPRRecipe addMetadata(Iterable<? extends Source> sources) {
aoqi@0 128 for (Source s : sources)
aoqi@0 129 addMetadata(s);
aoqi@0 130 return this;
aoqi@0 131 }
aoqi@0 132 }

mercurial