/*
* JBoss, a division of Red Hat
* Copyright 2009, Red Hat Middleware, LLC, 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.gatein.wsrp.consumer.registry;
import org.gatein.common.util.ParameterValidation;
import org.gatein.pc.api.PortletInvoker;
import org.gatein.pc.api.PortletInvokerException;
import org.gatein.pc.federation.FederatedPortletInvoker;
import org.gatein.pc.federation.FederatingPortletInvoker;
import org.gatein.wsrp.WSRPConsumer;
import org.gatein.wsrp.api.SessionEventBroadcaster;
import org.gatein.wsrp.consumer.ConsumerException;
import org.gatein.wsrp.consumer.ProducerInfo;
import org.gatein.wsrp.consumer.WSRPConsumerImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.SortedMap;
import java.util.TreeMap;
/**
* @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a>
* @version $Revision: 12693 $
* @since 2.6
*/
public abstract class AbstractConsumerRegistry implements ConsumerRegistry
{
/** Gives access to the Portal's portlet invokers */
private FederatingPortletInvoker federatingPortletInvoker;
protected SortedMap<String, WSRPConsumer> consumers;
private SessionEventBroadcaster sessionEventBroadcaster;
private static final String CONSUMER_WITH_ID = "Consumer with id '";
private static final String RELEASE_SESSIONS_LISTENER = "release_sessions_listener_";
private static final Logger log = LoggerFactory.getLogger(AbstractConsumerRegistry.class);
public FederatingPortletInvoker getFederatingPortletInvoker()
{
return federatingPortletInvoker;
}
public void setSessionEventBroadcaster(SessionEventBroadcaster sessionEventBroadcaster)
{
this.sessionEventBroadcaster = sessionEventBroadcaster;
}
public WSRPConsumer createConsumer(String id, Integer expirationCacheSeconds)
{
ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(id, "Consumer identifier", "Creating a Consumer");
if (getConsumer(id) != null)
{
throw new ConsumerException(CONSUMER_WITH_ID + id + "' already exists!");
}
ProducerInfo info = new ProducerInfo();
info.setId(id);
info.setRegistry(this);
info.setExpirationCacheSeconds(expirationCacheSeconds);
save(info, "Couldn't create Consumer '" + id + "'");
log.info(CONSUMER_WITH_ID + id + "' created");
return createConsumerFrom(info);
}
public void destroyConsumer(String id)
{
ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(id, "Consumer identifier", "Destroying a Consumer");
WSRPConsumer consumer = getConsumer(id);
if (consumer != null)
{
ProducerInfo info = consumer.getProducerInfo();
try
{
consumer.releaseSessions();
}
catch (PortletInvokerException e)
{
log.debug("releaseSessions failed when attempting to destroy " + CONSUMER_WITH_ID + id + "'");
}
// if the consumer is registered, deregister it
if (info.isRegistered())
{
registerOrDeregisterConsumerWith(id, false);
}
deactivateConsumerWith(id);
consumers.remove(id);
delete(info);
}
else
{
throw new ConsumerException(CONSUMER_WITH_ID + id + "' doesn't exist!");
}
log.info(CONSUMER_WITH_ID + id + "' destroyed");
}
public void persistConsumer(WSRPConsumer consumer)
{
ParameterValidation.throwIllegalArgExceptionIfNull(consumer, "Consumer");
ProducerInfo info = consumer.getProducerInfo();
save(info, CONSUMER_WITH_ID + info.getId() + "' couldn't be persisted!");
createConsumerFrom(info);
}
public void setFederatingPortletInvoker(FederatingPortletInvoker federatingPortletInvoker)
{
this.federatingPortletInvoker = federatingPortletInvoker;
}
private WSRPConsumer createConsumerFrom(ProducerInfo producerInfo)
{
WSRPConsumer consumer = new WSRPConsumerImpl(producerInfo);
consumers.put(producerInfo.getId(), consumer);
return consumer;
}
public void activateConsumerWith(String id) throws ConsumerException
{
ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(id, "Consumer identifier", "Activating a Consumer");
// if the consumer associated with the given id is already registered, don't do anything
if (federatingPortletInvoker.getFederatedInvoker(id) == null)
{
startOrStopConsumer(id, true);
}
else
{
// todo: fix-me federated portlet invoker gets desynchronized...
WSRPConsumer consumer = getConsumer(id);
if (consumer != null && !consumer.isActive())
{
federatingPortletInvoker.unregisterInvoker(id);
startOrStopConsumer(id, true);
}
}
}
public void deactivateConsumerWith(String id) throws ConsumerException
{
ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(id, "Consumer identifier", "Deactivating a Consumer");
// only process if there is a registered Consumer with the specified id
if (federatingPortletInvoker.getFederatedInvoker(id) != null)
{
startOrStopConsumer(id, false);
}
else
{
// todo: fix-me federated portlet invoker gets desynchronized...
WSRPConsumer consumer = getConsumer(id);
if (consumer != null && consumer.isActive())
{
federatingPortletInvoker.registerInvoker(id, consumer);
startOrStopConsumer(id, false);
}
}
}
public void updateProducerInfo(ProducerInfo producerInfo)
{
ParameterValidation.throwIllegalArgExceptionIfNull(producerInfo, "ProducerInfo");
String oldId = update(producerInfo);
// if we updated and oldId is not null, we need to update the local consumers map
if (oldId != null)
{
WSRPConsumer consumer = consumers.remove(oldId);
consumers.put(producerInfo.getId(), consumer);
}
}
public void start() throws Exception
{
reloadConsumers();
}
public void reloadConsumers()
{
// load the configured consumers
consumers = new TreeMap<String, WSRPConsumer>();
Iterator producerInfos = getAllProducerInfos();
// load the configured producers
ProducerInfo producerInfo;
while (producerInfos.hasNext())
{
producerInfo = (ProducerInfo)producerInfos.next();
// need to set the registry after loading from DB since registry is not persisted.
producerInfo.setRegistry(this);
createConsumerFrom(producerInfo);
try
{
// if the producer is marked as active, activate it fo' real! :)
if (producerInfo.isActive())
{
activateConsumerWith(producerInfo.getId());
}
}
catch (Exception e)
{
producerInfo.setActive(false);
updateProducerInfo(producerInfo);
}
}
}
public void stop() throws Exception
{
for (WSRPConsumer consumer : consumers.values())
{
// if producer is not active, it shouldn't be registered with the federating portlet invoker, hence do not
// unregister it.
if (consumer.getProducerInfo().isActive())
{
federatingPortletInvoker.unregisterInvoker(consumer.getProducerId());
}
try
{
consumer.stop();
}
catch (Exception e)
{
// ignore and continue
}
}
consumers.clear();
consumers = null;
}
public List<WSRPConsumer> getConfiguredConsumers()
{
return new ArrayList<WSRPConsumer>(consumers.values());
}
public WSRPConsumer getConsumer(String id)
{
ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(id, "consumer id", null);
return consumers.get(id);
}
public void registerOrDeregisterConsumerWith(String id, boolean register)
{
ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(id, "Consumer identifier", "Registering or deregistering a Consumer");
WSRPConsumer consumer = getConsumer(id);
if (consumer == null)
{
throw new ConsumerException(CONSUMER_WITH_ID + id + "' doesn't exist!");
}
try
{
if (register)
{
consumer.getProducerInfo().register();
}
else
{
consumer.getProducerInfo().deregister();
}
}
catch (Exception e)
{
// unexpected exception: deactivate the consumer
deactivateConsumerWith(id);
Throwable cause = e.getCause();
throw new ConsumerException("Couldn't " + (register ? "register" : "deregister") + CONSUMER_WITH_ID + id + "'",
cause != null ? cause : e);
}
}
private void startOrStopConsumer(String id, boolean start)
{
WSRPConsumer consumer;
try
{
if (start)
{
consumer = getConsumer(id);
if (consumer == null)
{
throw new IllegalArgumentException(CONSUMER_WITH_ID + id + "' doesn't exist!");
}
consumer.activate();
federatingPortletInvoker.registerInvoker(id, consumer);
sessionEventBroadcaster.registerListener(getListenerIdFrom(id), consumer);
}
else
{
FederatedPortletInvoker fedInvoker = federatingPortletInvoker.getFederatedInvoker(id);
if (fedInvoker != null)
{
PortletInvoker invoker = fedInvoker.getPortletInvoker();
if (invoker instanceof WSRPConsumer)
{
consumer = (WSRPConsumer)invoker;
consumer.deactivate();
federatingPortletInvoker.unregisterInvoker(id);
sessionEventBroadcaster.unregisterListener(getListenerIdFrom(id));
}
else
{
throw new IllegalArgumentException("PortletInvoker with id '" + id + "' is not a WSRPConsumer!");
}
}
else
{
throw new IllegalArgumentException("There is no registered PortletInvoker with id '" + id + "'");
}
}
}
catch (Exception e)
{
throw new ConsumerException("Couldn't " + (start ? "start" : "stop") + " Consumer service '" + id + "'", e);
}
// update ProducerInfo
updateProducerInfo(consumer.getProducerInfo());
}
private String getListenerIdFrom(String id)
{
return RELEASE_SESSIONS_LISTENER + id;
}
protected abstract void save(ProducerInfo info, String messageOnError);
protected abstract void delete(ProducerInfo info);
protected abstract String update(ProducerInfo producerInfo);
protected abstract Iterator getAllProducerInfos();
}