2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Copyright (C) 2017 Amdocs
8 * =============================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 * ============LICENSE_END=========================================================
27 package org.openecomp.appc.pool;
29 import java.io.Closeable;
30 import java.io.IOException;
31 import java.lang.reflect.InvocationHandler;
32 import java.lang.reflect.Method;
33 import java.lang.reflect.Proxy;
34 import java.util.concurrent.atomic.AtomicBoolean;
37 * This class is used as a "wrapper" for any closeable elements that are cached in a pool. It is implemented as a
38 * dynamic proxy, so that it appears to be the same class of object to the client as the interface being cached. The
39 * generic type being cached MUST be an interface.
41 * The generic type that we create a cached element for. This type is used to wrap instances of this type and
42 * expose access to the {@link java.io.Closeable} interface by using a dynamic proxy.
45 public class CachedElement<T extends Closeable> implements Closeable, InvocationHandler, CacheManagement {
48 * The pool that is managing this cached element
53 * The element that we are caching in the pool
58 * A thread-safe atomic indicator that tells us that the wrapped element has been released to the pool already, and
61 private AtomicBoolean released = new AtomicBoolean(false);
64 * Create a new instance of a cached element dynamic proxy for use in the pool.
66 * This returns an instance of the proxy to the caller that appears to be the same interface(s) as the object being
67 * cached. The dynamic proxy then intercepts all open and close semantics and directs that element to the pool.
70 * If the object being proxied does not implement the {@link CacheManagement} interface, then that interface is
71 * added to the dynamic proxy being created. This interface is actually implemented by the invocation handler (this
72 * object) for the proxy and allows direct access to the wrapped object inside the proxy.
76 * The pool that we are caching these elements within
78 * The element actually being cached
80 * The interface list of interfaces the element must implement (usually one)
81 * @return The dynamic proxy
83 @SuppressWarnings("unchecked")
84 public static <T extends Closeable> T newInstance(Pool<T> pool, T element, Class<?>[] interfaces) {
85 ClassLoader cl = element.getClass().getClassLoader();
86 CachedElement<T> ce = new CachedElement<>(pool, element);
87 boolean found = false;
88 for (Class<?> intf : interfaces) {
89 if (intf.getName().equals(CacheManagement.class.getName())) {
95 int length = found ? interfaces.length : interfaces.length + 1;
96 Class<?>[] proxyInterfaces = new Class[length];
97 System.arraycopy(interfaces, 0, proxyInterfaces, 0, interfaces.length);
100 proxyInterfaces[interfaces.length] = CacheManagement.class;
103 return (T) Proxy.newProxyInstance(cl, proxyInterfaces, ce);
107 * Construct a cached element and assign it to the pool as a free element
110 * The pool that the element will be managed within
112 * The element we are caching
114 @SuppressWarnings("unchecked")
115 public CachedElement(Pool<T> pool, T element) {
117 this.element = element;
120 pool.release((T) this);
121 } catch (PoolDrainedException e) {
127 * This method delegates the close call to the actual wrapped element.
129 * NOTE: This is not the same method that is called by the dynamic proxy. This method is in place to satisfy the
130 * signature of the {@link java.io.Closeable} interface. If it were to be called directly, then we will delegate the
131 * close to the underlying context. However, when the cached element is called as a synamic proxy, entry is in the
132 * {@link #invoke(Object, Method, Object[])} method.
135 * @see java.io.Closeable#close()
138 public void close() throws IOException {
143 * This method is the magic part of dynamic proxies. When the caller makes a method call based on the interface
144 * being proxied, this method is given control. This informs us of the method and arguments of the call. The object
145 * reference is that of the dynamic proxy itself, which is us.
147 * Here we will check to see if the user is trying to close the "element" (the dynamic proxy acts like the wrapped
148 * element). If he is, then we don't really close it, but instead release the element that we are wrapping back to
149 * the free pool. Once this has happened, we mark the element as "closed" (from the perspective of this dynamic
150 * proxy) so that we wont try to release it again.
153 * If the method is the <code>equals</code> method then we assume that we are comparing the cached element in one
154 * dynamic proxy to the cached element in another. We execute the comparison between the cached elements, and not
155 * the dynamic proxies themselves. This preserves the allusion to the caller that the dynamic proxy is the object
159 * For convenience, we also implement the <code>getWrappedObject</code> method so that the dynamic proxy can be
160 * called to obtain the actual wrapped object if desired. Note, to use this method, the caller would have to invoke
161 * it through reflection.
164 * If the method being invoked is not one that we intercept, then we simply delegate that method onto the wrapped
168 * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])
174 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
175 Object result = null;
177 if (method.getName().equals("close")) {
178 if (released.compareAndSet(false, true)) {
179 if (!pool.isDrained()) {
180 pool.release((T) proxy);
183 } else if (method.getName().equals("equals")) {
184 CacheManagement cm = (CacheManagement) proxy;
185 T other = (T) cm.getWrappedObject();
186 result = element.equals(other);
187 } else if (method.getName().equals("getWrappedObject")) {
190 result = method.invoke(element, args);
197 * This method is used to be able to access the wrapped object underneath the dynamic proxy
199 * @see org.openecomp.appc.pool.CacheManagement#getWrappedObject()
202 public T getWrappedObject() {
206 @SuppressWarnings("nls")
208 public String toString() {
209 return element == null ? "null" : element.toString();