src/share/jaxws_classes/com/sun/xml/internal/ws/util/Pool.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, 2013, 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.util;
aoqi@0 27
aoqi@0 28 import com.sun.xml.internal.ws.api.pipe.Tube;
aoqi@0 29 import com.sun.xml.internal.ws.api.pipe.TubeCloner;
aoqi@0 30
aoqi@0 31 import javax.xml.bind.JAXBContext;
aoqi@0 32 import javax.xml.bind.JAXBException;
aoqi@0 33 import java.util.concurrent.ConcurrentLinkedQueue;
aoqi@0 34 import java.lang.ref.WeakReference;
aoqi@0 35
aoqi@0 36 /**
aoqi@0 37 * General-purpose object pool.
aoqi@0 38 *
aoqi@0 39 * <p>
aoqi@0 40 * In many parts of the runtime, we need to pool instances of objects that
aoqi@0 41 * are expensive to create (such as JAXB objects, StAX parsers, {@link Tube} instances.)
aoqi@0 42 *
aoqi@0 43 * <p>
aoqi@0 44 * This class provides a default implementation of such a pool.
aoqi@0 45 *
aoqi@0 46 * TODO: improve the implementation
aoqi@0 47 *
aoqi@0 48 * @author Kohsuke Kawaguchi
aoqi@0 49 */
aoqi@0 50 public abstract class Pool<T> {
aoqi@0 51
aoqi@0 52 // volatile since multiple threads may access queue reference
aoqi@0 53 private volatile WeakReference<ConcurrentLinkedQueue<T>> queue;
aoqi@0 54
aoqi@0 55 /**
aoqi@0 56 * Gets a new object from the pool.
aoqi@0 57 *
aoqi@0 58 * <p>
aoqi@0 59 * If no object is available in the pool, this method creates a new one.
aoqi@0 60 *
aoqi@0 61 * @return
aoqi@0 62 * always non-null.
aoqi@0 63 */
aoqi@0 64 public final T take() {
aoqi@0 65 T t = getQueue().poll();
aoqi@0 66 if(t==null)
aoqi@0 67 return create();
aoqi@0 68 return t;
aoqi@0 69 }
aoqi@0 70
aoqi@0 71 private ConcurrentLinkedQueue<T> getQueue() {
aoqi@0 72 WeakReference<ConcurrentLinkedQueue<T>> q = queue;
aoqi@0 73 if (q != null) {
aoqi@0 74 ConcurrentLinkedQueue<T> d = q.get();
aoqi@0 75 if (d != null)
aoqi@0 76 return d;
aoqi@0 77 }
aoqi@0 78
aoqi@0 79 // overwrite the queue
aoqi@0 80 ConcurrentLinkedQueue<T> d = new ConcurrentLinkedQueue<T>();
aoqi@0 81 queue = new WeakReference<ConcurrentLinkedQueue<T>>(d);
aoqi@0 82
aoqi@0 83 return d;
aoqi@0 84 }
aoqi@0 85
aoqi@0 86 /**
aoqi@0 87 * Returns an object back to the pool.
aoqi@0 88 */
aoqi@0 89 public final void recycle(T t) {
aoqi@0 90 getQueue().offer(t);
aoqi@0 91 }
aoqi@0 92
aoqi@0 93 /**
aoqi@0 94 * Creates a new instance of object.
aoqi@0 95 *
aoqi@0 96 * <p>
aoqi@0 97 * This method is used when someone wants to
aoqi@0 98 * {@link #take() take} an object from an empty pool.
aoqi@0 99 *
aoqi@0 100 * <p>
aoqi@0 101 * Also note that multiple threads may call this method
aoqi@0 102 * concurrently.
aoqi@0 103 */
aoqi@0 104 protected abstract T create();
aoqi@0 105
aoqi@0 106
aoqi@0 107 /**
aoqi@0 108 * JAXB {@link javax.xml.bind.Marshaller} pool.
aoqi@0 109 */
aoqi@0 110 public static final class Marshaller extends Pool<javax.xml.bind.Marshaller> {
aoqi@0 111 private final JAXBContext context;
aoqi@0 112
aoqi@0 113 public Marshaller(JAXBContext context) {
aoqi@0 114 this.context = context;
aoqi@0 115 }
aoqi@0 116
aoqi@0 117 @Override
aoqi@0 118 protected javax.xml.bind.Marshaller create() {
aoqi@0 119 try {
aoqi@0 120 return context.createMarshaller();
aoqi@0 121 } catch (JAXBException e) {
aoqi@0 122 // impossible
aoqi@0 123 throw new AssertionError(e);
aoqi@0 124 }
aoqi@0 125 }
aoqi@0 126 }
aoqi@0 127
aoqi@0 128 /**
aoqi@0 129 * JAXB {@link javax.xml.bind.Marshaller} pool.
aoqi@0 130 */
aoqi@0 131 public static final class Unmarshaller extends Pool<javax.xml.bind.Unmarshaller> {
aoqi@0 132 private final JAXBContext context;
aoqi@0 133
aoqi@0 134 public Unmarshaller(JAXBContext context) {
aoqi@0 135 this.context = context;
aoqi@0 136 }
aoqi@0 137
aoqi@0 138 @Override
aoqi@0 139 protected javax.xml.bind.Unmarshaller create() {
aoqi@0 140 try {
aoqi@0 141 return context.createUnmarshaller();
aoqi@0 142 } catch (JAXBException e) {
aoqi@0 143 // impossible
aoqi@0 144 throw new AssertionError(e);
aoqi@0 145 }
aoqi@0 146 }
aoqi@0 147 }
aoqi@0 148
aoqi@0 149 /**
aoqi@0 150 * {@link Tube} pool.
aoqi@0 151 */
aoqi@0 152 public static final class TubePool extends Pool<Tube> {
aoqi@0 153 private final Tube master;
aoqi@0 154
aoqi@0 155 public TubePool(Tube master) {
aoqi@0 156 this.master = master;
aoqi@0 157 recycle(master); // we'll use master as a part of the pool, too.
aoqi@0 158 }
aoqi@0 159
aoqi@0 160 @Override
aoqi@0 161 protected Tube create() {
aoqi@0 162 return TubeCloner.clone(master);
aoqi@0 163 }
aoqi@0 164
aoqi@0 165 /**
aoqi@0 166 *
aoqi@0 167 * @return master tubeline from pool
aoqi@0 168 * @deprecated Expected to be used in rare cases where access to master
aoqi@0 169 * tubeline is required and safe, such as Stub.close()."
aoqi@0 170 */
aoqi@0 171 @Deprecated()
aoqi@0 172 public final Tube takeMaster() {
aoqi@0 173 return master;
aoqi@0 174 }
aoqi@0 175
aoqi@0 176 }
aoqi@0 177 }

mercurial