|
| 1 | +/** |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + * or more contributor license agreements. See the NOTICE file |
| 4 | + * distributed with this work for additional information |
| 5 | + * regarding copyright ownership. The ASF licenses this file |
| 6 | + * to you under the Apache License, Version 2.0 (the |
| 7 | + * "License"); you may not use this file except in compliance |
| 8 | + * with the License. You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, |
| 13 | + * software distributed under the License is distributed on an |
| 14 | + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + * KIND, either express or implied. See the License for the |
| 16 | + * specific language governing permissions and limitations |
| 17 | + * under the License. |
| 18 | + */ |
| 19 | + |
| 20 | +package org.apache.cxf.io; |
| 21 | + |
| 22 | +import java.io.Closeable; |
| 23 | +import java.io.IOException; |
| 24 | +import java.util.ArrayList; |
| 25 | +import java.util.Collection; |
| 26 | +import java.util.Iterator; |
| 27 | +import java.util.Objects; |
| 28 | +import java.util.Timer; |
| 29 | +import java.util.TimerTask; |
| 30 | +import java.util.concurrent.DelayQueue; |
| 31 | +import java.util.concurrent.Delayed; |
| 32 | +import java.util.concurrent.TimeUnit; |
| 33 | +import java.util.logging.Logger; |
| 34 | + |
| 35 | +import jakarta.annotation.Resource; |
| 36 | +import org.apache.cxf.Bus; |
| 37 | +import org.apache.cxf.buslifecycle.BusLifeCycleListener; |
| 38 | +import org.apache.cxf.buslifecycle.BusLifeCycleManager; |
| 39 | +import org.apache.cxf.common.logging.LogUtils; |
| 40 | + |
| 41 | +public final class DelayedCachedOutputStreamCleaner implements CachedOutputStreamCleaner, BusLifeCycleListener { |
| 42 | + private static final Logger LOG = LogUtils.getL7dLogger(DelayedCachedOutputStreamCleaner.class); |
| 43 | + |
| 44 | + private long delay; /* default is 30 minutes, in milliseconds */ |
| 45 | + private final DelayQueue<DelayedCloseable> queue = new DelayQueue<>(); |
| 46 | + private Timer timer; |
| 47 | + |
| 48 | + private static final class DelayedCloseable implements Delayed { |
| 49 | + private final Closeable closeable; |
| 50 | + private final long expiredAt; |
| 51 | + |
| 52 | + DelayedCloseable(final Closeable closeable, final long delay) { |
| 53 | + this.closeable = closeable; |
| 54 | + this.expiredAt = System.nanoTime() + delay; |
| 55 | + } |
| 56 | + |
| 57 | + @Override |
| 58 | + public int compareTo(Delayed o) { |
| 59 | + return Long.compare(getDelay(TimeUnit.NANOSECONDS), o.getDelay(TimeUnit.NANOSECONDS)); |
| 60 | + } |
| 61 | + |
| 62 | + @Override |
| 63 | + public long getDelay(TimeUnit unit) { |
| 64 | + return unit.convert(expiredAt - System.nanoTime(), TimeUnit.NANOSECONDS); |
| 65 | + } |
| 66 | + |
| 67 | + @Override |
| 68 | + public int hashCode() { |
| 69 | + return Objects.hash(closeable); |
| 70 | + } |
| 71 | + |
| 72 | + @Override |
| 73 | + public boolean equals(Object obj) { |
| 74 | + if (this == obj) { |
| 75 | + return true; |
| 76 | + } |
| 77 | + |
| 78 | + if (obj == null) { |
| 79 | + return false; |
| 80 | + } |
| 81 | + |
| 82 | + if (getClass() != obj.getClass()) { |
| 83 | + return false; |
| 84 | + } |
| 85 | + |
| 86 | + final DelayedCloseable other = (DelayedCloseable) obj; |
| 87 | + return Objects.equals(closeable, other.closeable); |
| 88 | + } |
| 89 | + } |
| 90 | + |
| 91 | + @Resource |
| 92 | + public void setBus(Bus bus) { |
| 93 | + Number delayValue = null; |
| 94 | + BusLifeCycleManager busLifeCycleManager = null; |
| 95 | + |
| 96 | + if (bus != null) { |
| 97 | + delayValue = (Number) bus.getProperty(CachedConstants.CLEANER_DELAY_BUS_PROP); |
| 98 | + busLifeCycleManager = bus.getExtension(BusLifeCycleManager.class); |
| 99 | + } |
| 100 | + |
| 101 | + if (delayValue == null) { |
| 102 | + delay = TimeUnit.MILLISECONDS.convert(30, TimeUnit.MINUTES); |
| 103 | + } else { |
| 104 | + final long value = delayValue.longValue(); |
| 105 | + if (value > 0) { |
| 106 | + delay = value; /* already in milliseconds */ |
| 107 | + } |
| 108 | + } |
| 109 | + |
| 110 | + if (busLifeCycleManager != null) { |
| 111 | + busLifeCycleManager.registerLifeCycleListener(this); |
| 112 | + } |
| 113 | + |
| 114 | + if (timer != null) { |
| 115 | + timer.cancel(); |
| 116 | + timer = null; |
| 117 | + } |
| 118 | + |
| 119 | + if (delay > 0) { |
| 120 | + timer = new Timer("DelayedCachedOutputStreamCleaner", true); |
| 121 | + timer.scheduleAtFixedRate(new TimerTask() { |
| 122 | + @Override |
| 123 | + public void run() { |
| 124 | + clean(); |
| 125 | + } |
| 126 | + }, 0, Math.max(1, delay >> 1)); |
| 127 | + } |
| 128 | + |
| 129 | + } |
| 130 | + |
| 131 | + @Override |
| 132 | + public void register(Closeable closeable) { |
| 133 | + queue.put(new DelayedCloseable(closeable, delay)); |
| 134 | + } |
| 135 | + |
| 136 | + @Override |
| 137 | + public void unregister(Closeable closeable) { |
| 138 | + queue.remove(new DelayedCloseable(closeable, delay)); |
| 139 | + } |
| 140 | + |
| 141 | + @Override |
| 142 | + public void clean() { |
| 143 | + final Collection<DelayedCloseable> closeables = new ArrayList<>(); |
| 144 | + queue.drainTo(closeables); |
| 145 | + clean(closeables); |
| 146 | + } |
| 147 | + |
| 148 | + @Override |
| 149 | + public void initComplete() { |
| 150 | + } |
| 151 | + |
| 152 | + @Override |
| 153 | + public void postShutdown() { |
| 154 | + } |
| 155 | + |
| 156 | + @Override |
| 157 | + public void preShutdown() { |
| 158 | + if (timer != null) { |
| 159 | + timer.cancel(); |
| 160 | + } |
| 161 | + } |
| 162 | + |
| 163 | + public void forceClean() { |
| 164 | + clean(queue); |
| 165 | + } |
| 166 | + |
| 167 | + private void clean(Collection<DelayedCloseable> closeables) { |
| 168 | + final Iterator<DelayedCloseable> iterator = closeables.iterator(); |
| 169 | + while (iterator.hasNext()) { |
| 170 | + final DelayedCloseable next = iterator.next(); |
| 171 | + try { |
| 172 | + iterator.remove(); |
| 173 | + LOG.warning("Unclosed (leaked?) stream detected: " + next.closeable); |
| 174 | + next.closeable.close(); |
| 175 | + } catch (final IOException | RuntimeException ex) { |
| 176 | + LOG.warning("Unable to close (leaked?) stream: " + ex.getMessage()); |
| 177 | + } |
| 178 | + } |
| 179 | + } |
| 180 | +} |
0 commit comments