com.liferay.portal.aop.AopService.java Source code

Introduction

Here is the source code for com.liferay.portal.aop.AopService.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.aop;

/**
 * Declares implementations to be proxied and intercepted by advices. The
 * service is re-registered as interfaces it implements.
 *
 * <p>
 * <strong>Important:</strong> A service implementation should only register as
 * an <code>AopService</code> so that service listeners only see the service
 * proxy.
 * </p>
 *
 * @author Preston Crary
 */
public interface AopService {

    /**
     * Returns the services that the service proxy registers into OSGi for this
     * <code>AopService</code>.
     *
     * <p>
     * If the method is not overridden, all the services this
     * <code>AopService</code> directly implements, except
     * <code>AopService</code>, are returned and registered into OSGi by the
     * service proxy.
     * </p>
     *
     * <p>
     * Here are the restraints:
     * </p>
     *
     * <ul>
     * <li>
     * The services cannot include <code>AopService</code>
     * </li>
     * <li>
     * The service list must not change
     * </li>
     * <li>
     * The service list can only contain interfaces
     * </li>
     * <li>
     * This <code>AopService</code> implementation must implement each service
     * interface
     * </li>
     * <li>
     * This <code>AopService</code> implementation must implement something in
     * addition to <code>AopService</code>
     * </li>
     * </ul>
     */
    public default Class<?>[] getAopInterfaces() {
        return null;
    }

    /**
     * Sets this service's enclosing AOP proxy.
     *
     * @param aopProxy this service's enclosing AOP proxy
     */
    public default void setAopProxy(Object aopProxy) {
    }

}