/* * Copyright (C) 2005-2008 Alfresco Software Limited. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * This program 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 General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * As a special exception to the terms and conditions of version 2.0 of * the GPL, you may redistribute this Program in connection with Free/Libre * and Open Source Software ("FLOSS") applications as described in Alfresco's * FLOSS exception. You should have recieved a copy of the text describing * the FLOSS exception, and it is also available here: * http://www.alfresco.com/legal/licensing" */ package org.alfresco.repo.policy; import java.lang.reflect.InvocationHandler; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.lang.reflect.Proxy; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.List; import org.alfresco.repo.policy.Behaviour.NotificationFrequency; import org.alfresco.repo.tenant.TenantService; import org.alfresco.service.cmr.repository.AssociationRef; import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.StoreRef; /** * A Policy Factory is responsible for creating Policy implementations. * * @author David Caruana * * @param the type of binding * @param
the policy interface */ /*package*/ class PolicyFactory { // Behaviour Index to query private BehaviourIndex index; // The policy interface class private Class
policyClass; // NOOP Invocation Handler private static InvocationHandler NOOPHandler = new NOOPHandler(); // Transaction Invocation Handler Factory private static TransactionInvocationHandlerFactory transactionHandlerFactory = null; // Tenant Service private static TenantService tenantService = null; /** * Construct. * * @param policyClass the policy class * @param index the behaviour index to query */ /*package*/ PolicyFactory(Class
policyClass, BehaviourIndex index) { this.policyClass = policyClass; this.index = index; } /** * Sets the Transaction Invocation Handler * * @param handlerFactory */ protected static void setTransactionInvocationHandlerFactory(TransactionInvocationHandlerFactory factory) { transactionHandlerFactory = factory; } /** * Sets the Tenant Service * * @param service */ protected static void setTenantService(TenantService service) { tenantService = service; } /** * Gets the Policy class created by this factory * * @return the policy class */ protected Class
getPolicyClass() { return policyClass; } /** * Construct a Policy implementation for the specified binding * * @param binding the binding * @return the policy implementation */ public P create(B binding) { Collection
policyInterfaces = createList(binding); return toPolicy(policyInterfaces); } /** * Construct a collection of Policy implementations for the specified binding * * @param binding the binding * @return the collection of policy implementations */ @SuppressWarnings("unchecked") public Collection
 createList(B binding)
    {
        Collection  policyInterfaces = new ArrayList (behaviourDefs.size());
        for (BehaviourDefinition behaviourDef : behaviourDefs)
        {
            Behaviour behaviour = behaviourDef.getBehaviour();
            P policyIF = behaviour.getInterface(policyClass);
            if (!(behaviour.getNotificationFrequency().equals(NotificationFrequency.EVERY_EVENT)))
            {
                // wrap behaviour in transaction proxy which deals with delaying invocation until necessary
                if (transactionHandlerFactory == null)
                {
                    throw new PolicyException("Transaction-level policies not supported as transaction support for the Policy Component has not been initialised.");
                }
                InvocationHandler trxHandler = transactionHandlerFactory.createHandler(behaviour, behaviourDef.getPolicyDefinition(), policyIF);
                policyIF = (P)Proxy.newProxyInstance(policyClass.getClassLoader(), new Class[]{policyClass}, trxHandler);
            }
            policyInterfaces.add(policyIF);
        }
        
        return policyInterfaces;
    }
    
    
    /**
     * Construct a single aggregate policy implementation for the specified 
     * collection of policy implementations.
     * 
     * @param policyList  the policy implementations to aggregate
     * @return  the aggregate policy implementation
     */
    @SuppressWarnings("unchecked")
    public P toPolicy(Collection  policyList)
    {
        if (policyList.size() == 1)
        {
            return policyList.iterator().next();
        }
        else if (policyList.size() == 0)
        {
            return (P)Proxy.newProxyInstance(policyClass.getClassLoader(), 
					new Class[]{policyClass}, NOOPHandler);
        }
        else
        {
            return (P)Proxy.newProxyInstance(policyClass.getClassLoader(), 
					new Class[]{policyClass, PolicyList.class}, new MultiHandler (policyList));
        }
    }
    
    /**
     * NOOP Invocation Handler.
     * 
     * @author David Caruana
     *
     */
    private static class NOOPHandler implements InvocationHandler
    {
        /* (non-Javadoc)
         * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])
         */
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
        {
            if (method.getName().equals("toString"))
            {
                return toString();
            }
            else if (method.getName().equals("hashCode"))
            {
                return hashCode();
            }
            else if (method.getName().equals("equals"))
            {
                return equals(args[0]);
            }
            return null;
        }
    }
    
    /**
     * Multi-policy Invocation Handler.
     * 
     * @author David Caruana
     *
     * @param    policy interface
     */
    private static class MultiHandler  implements InvocationHandler, PolicyList
    {
        private Collection  policyInterfaces;
       
        /**
         * Construct
         * 
         * @param policyInterfaces  the collection of policy implementations
         */
        public MultiHandler(Collection  policyInterfaces)
        {
            this.policyInterfaces = Collections.unmodifiableCollection(policyInterfaces);
        }
        
        /* (non-Javadoc)
         * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])
         */
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
        {
            if ((tenantService != null) && (tenantService.isEnabled()) && (args != null))
            {
                // Convert each of the arguments to the spoofed (no tenant prefix) reference
                for (int i = 0; i < args.length; i++)
                {
                    Object arg = args[i];
                    Object newArg = arg;
                    if (arg == null)
                    {
                        // No conversion possible
                    }
                    if (arg instanceof StoreRef)
                    {
                        StoreRef ref = (StoreRef) arg;
                        newArg = tenantService.getBaseName(ref);
                    }
                    else if (arg instanceof NodeRef)
                    {
                        NodeRef ref = (NodeRef) arg;
                        newArg = tenantService.getBaseName(ref);
                    }
                    else if (arg instanceof ChildAssociationRef)
                    {
                        ChildAssociationRef ref = (ChildAssociationRef) arg;
                        newArg = tenantService.getBaseName(ref);
                    }
                    else if (arg instanceof AssociationRef)
                    {
                        AssociationRef ref = (AssociationRef) arg;
                        newArg = tenantService.getBaseName(ref);
                    }
                    
                    // Substitute the new value
                    args[i] = newArg;
                }
            }
            
            // Handle PolicyList level methods
            if (method.getDeclaringClass().equals(PolicyList.class))
            {
                return method.invoke(this, args);
            }
            
            // Handle Object level methods
            if (method.getName().equals("toString"))
            {
                return toString() + ": wrapped " + policyInterfaces.size() + " policies";
            }
            else if (method.getName().equals("hashCode"))
            {
                return hashCode();
            }
            else if (method.getName().equals("equals"))
            {
                return equals(args[0]);
            }
            // Invoke each wrapped policy in turn
            try
            {
                Object result = null;
                for (P policyInterface : policyInterfaces)
                {
                    result = method.invoke(policyInterface, args);
                }
                return result;
            }
            catch (InvocationTargetException e)
            {
                throw e.getTargetException();
            }
        }
        /* (non-Javadoc)
         * @see org.alfresco.repo.policy.PolicyList#getPolicies()
         */
        public Collection getPolicies()
        {
            return policyInterfaces;
        }
    }
    
}