com.palantir.common.proxy.MultiDelegateProxy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-commons Show documentation
Palantir open source project
There is a newer version: 0.1152.0
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.palantir.common.proxy;

import com.google.common.base.Suppliers;
import com.google.common.collect.ImmutableList;
import com.google.common.reflect.AbstractInvocationHandler;
import com.palantir.logsafe.Preconditions;
import com.palantir.logsafe.logger.SafeLogger;
import com.palantir.logsafe.logger.SafeLoggerFactory;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.Arrays;
import java.util.function.Supplier;

/**
 * This class will delegate functionality and return the value (or throw the exception) of
 * one of the delegates.
 * 
 * It will simply call the other delegates and ignore their return values and log any exceptions
 * that are thrown at the error level.  These are logged as errors because these classes shoudln't be throwing.
 * 

 * This class is useful if you have a Mock and you want to ensure certain methods
 * are/aren't called, but you want to use a Fake to do the work.
 * 
 */
@SuppressWarnings("ProxyNonConstantType")
public final class MultiDelegateProxy extends AbstractInvocationHandler {
    private static final SafeLogger log = SafeLoggerFactory.get(MultiDelegateProxy.class);

    @SafeVarargs
    public static  T newProxyInstance(Class interfaceClass, T mainDelegate, T... delegatesToCall) {
        return newProxyInstance(interfaceClass, mainDelegate, Arrays.asList(delegatesToCall));
    }

    /**
     * This will copy off all the objects in delegatesToCall.
     */
    public static  T newProxyInstance(
            Class interfaceClass, T mainDelegate, Iterable delegatesToCall) {
        return newProxyInstance(
                interfaceClass, mainDelegate, Suppliers.ofInstance(ImmutableList.copyOf(delegatesToCall)));
    }

    /**
     * For each method invoked on the returned object, {@link Supplier#get()} will be called
     * and iterated over.
     */
    @SuppressWarnings("unchecked")
    public static  T newProxyInstance(
            Class interfaceClass, T mainDelegate, Supplier> dynamicDelegatesToCall) {
        return (T) Proxy.newProxyInstance(
                interfaceClass.getClassLoader(),
                new Class[] {interfaceClass},
                new MultiDelegateProxy(mainDelegate, dynamicDelegatesToCall));
    }

    final T delegate;
    final Supplier> othersToCall;

    private MultiDelegateProxy(T delegate, Supplier> toCall) {
        this.delegate = Preconditions.checkNotNull(delegate);
        this.othersToCall = toCall;
    }

    @Override
    protected Object handleInvocation(Object proxy, Method method, Object[] args) throws Throwable {
        try {
            for (T t : othersToCall.get()) {
                try {
                    method.invoke(t, args);
                } catch (InvocationTargetException e) {
                    log.error("Failed when calling within proxy. This isn't allowed.", e);
                    if (e.getCause() instanceof Error) {
                        throw e;
                    }
                }
            }
            return method.invoke(delegate, args);
        } catch (InvocationTargetException e) {
            throw e.getCause();
        }
    }
}