//
// ========================================================================
// Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under
// the terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0
//
// This Source Code may also be made available under the following
// Secondary Licenses when the conditions for such availability set
// forth in the Eclipse Public License, v. 2.0 are satisfied:
// the Apache License v2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.util;

import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

An ObjectFactory enhanced by Decorator instances.

Consistent single location for all Decorator behavior, with equal behavior in a ServletContext and also for a stand alone client.

Used by ServletContextHandler, WebAppContext, WebSocketServerFactory, and WebSocketClient.

Can be found in the ServletContext Attributes at the DecoratedObjectFactory.ATTR key.

/** * An ObjectFactory enhanced by {@link Decorator} instances. * <p> * Consistent single location for all Decorator behavior, with equal behavior in a ServletContext and also for a stand * alone client. * <p> * Used by ServletContextHandler, WebAppContext, WebSocketServerFactory, and WebSocketClient. * <p> * Can be found in the ServletContext Attributes at the {@link #ATTR DecoratedObjectFactory.ATTR} key. */
public class DecoratedObjectFactory implements Iterable<Decorator> { private static final Logger LOG = LoggerFactory.getLogger(DecoratedObjectFactory.class);
ServletContext attribute for the active DecoratedObjectFactory
/** * ServletContext attribute for the active DecoratedObjectFactory */
public static final String ATTR = DecoratedObjectFactory.class.getName(); private static final ThreadLocal<Object> decoratorInfo = new ThreadLocal<>(); private List<Decorator> decorators = new ArrayList<>(); public static void associateInfo(Object info) { decoratorInfo.set(info); } public static void disassociateInfo() { decoratorInfo.set(null); } public static Object getAssociatedInfo() { return decoratorInfo.get(); } public void addDecorator(Decorator decorator) { LOG.debug("Adding Decorator: {}", decorator); decorators.add(decorator); } public boolean removeDecorator(Decorator decorator) { LOG.debug("Remove Decorator: {}", decorator); return decorators.remove(decorator); } public void clear() { this.decorators.clear(); } public <T> T createInstance(Class<T> clazz) throws InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException { if (LOG.isDebugEnabled()) { LOG.debug("Creating Instance: {}", clazz); } T o = clazz.getDeclaredConstructor().newInstance(); return decorate(o); } public <T> T decorate(T obj) { T f = obj; // Decorate is always backwards for (int i = decorators.size() - 1; i >= 0; i--) { f = decorators.get(i).decorate(f); } return f; } public void destroy(Object obj) { for (Decorator decorator : this.decorators) { decorator.destroy(obj); } } public List<Decorator> getDecorators() { return Collections.unmodifiableList(decorators); } @Override public Iterator<Decorator> iterator() { return this.decorators.iterator(); } public void setDecorators(List<? extends Decorator> decorators) { this.decorators.clear(); if (decorators != null) { this.decorators.addAll(decorators); } } @Override public String toString() { StringBuilder str = new StringBuilder(); str.append(this.getClass().getName()).append("[decorators="); str.append(Integer.toString(decorators.size())); str.append("]"); return str.toString(); } }