/*
* JBoss, Home of Professional Open Source
* Copyright 2006, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This 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 software 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.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.kernel.plugins.dependency;
import java.util.Collection;
import java.util.Set;
import org.jboss.dependency.plugins.OwnerCallbackItem;
import org.jboss.dependency.spi.Cardinality;
import org.jboss.dependency.spi.Controller;
import org.jboss.dependency.spi.ControllerContext;
import org.jboss.dependency.spi.ControllerState;
import org.jboss.dependency.spi.DependencyItem;
import org.jboss.dependency.spi.dispatch.InvokeDispatchContext;
import org.jboss.kernel.spi.dependency.KernelController;
import org.jboss.kernel.spi.dependency.KernelControllerContext;
/**
* Collection callback item.
*
* @param <T> expected collection type
* @author <a href="mailto:ales.justin@jboss.com">Ales Justin</a>
*/
public abstract class CollectionCallbackItem<T extends Collection<Object>> extends OwnerCallbackItem<Class<?>, InvokeDispatchContext>
{
protected Cardinality cardinality;
protected AttributeInfo attribute;
public CollectionCallbackItem(Class<?> name, InvokeDispatchContext owner, AttributeInfo attribute)
{
this(name, null, null, null, owner, attribute);
}
public CollectionCallbackItem(Class<?> name, ControllerState whenRequired, ControllerState dependentState, Cardinality cardinality, InvokeDispatchContext context, AttributeInfo attribute)
{
super(name, whenRequired, dependentState, attribute != null ? attribute.getName() : null, context);
this.attribute = attribute;
this.cardinality = cardinality;
}
/**
* Create new collection impl instance - HashSet, ArrayList, ...
*
* @return new collection impl instance
*/
protected abstract T getCollectionParameterHolder();
/**
* Fill collection impl with existing context targets.
*
* @param controller the controller
* @return collection holder with target beans
* @throws Throwable for any error
*/
protected T fillHolder(Controller controller) throws Throwable
{
if (controller instanceof KernelController)
{
T holder = getCollectionParameterHolder();
if (holder == null)
throw new IllegalArgumentException("Illegal collection holder, equals null!");
KernelController kernelController = (KernelController)controller;
Set<KernelControllerContext> contexts = kernelController.getContexts(getIDependOn(), dependentState);
if (contexts != null && contexts.isEmpty() == false)
{
for(ControllerContext context : contexts)
{
holder.add(context.getTarget());
}
}
return holder;
}
else
throw new IllegalArgumentException("Cannot execute Collection call back - controller not KernelController instance.");
}
protected void execute(T holder) throws Throwable
{
if (attribute.isProperty())
owner.set(getAttributeName(), holder);
else
owner.invoke(getAttributeName(), new Object[]{holder}, new String[]{attribute.getType().getName()});
}
protected DependencyItem createDependencyItem(ControllerContext owner)
{
if (cardinality != null)
return new CallbackDependencyItem(owner.getName(), getIDependOn(), whenRequired, dependentState, cardinality);
else
return null;
}
public void ownerCallback(Controller controller, boolean isInstallPhase) throws Throwable
{
// fill or just push in empty
T holder = isInstallPhase ? fillHolder(controller) : getCollectionParameterHolder();
execute(holder);
}
public void changeCallback(Controller controller, ControllerContext context, boolean isInstallPhase) throws Throwable
{
T holder = fillHolder(controller);
if (isInstallPhase == false)
removeUninstallingContext(holder, context);
execute(holder);
addDependency(controller, context, isInstallPhase);
}
/**
* Remove the uninstalling context from holder.
* Since the context is about to change state -
* not part of callback watched targets.
*
* Can be overridden for different remove behaviour.
*
* @param holder collection holder
* @param context current context
*/
protected void removeUninstallingContext(T holder, ControllerContext context)
{
holder.remove(context.getTarget());
}
}