/*
* JBoss, a division of Red Hat
* Copyright 2010, 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.session.SessionEventBroadcaster;
import org.gatein.wsrp.consumer.ConsumerException;
import org.gatein.wsrp.consumer.ProducerInfo;
import org.gatein.wsrp.consumer.WSRPConsumerImpl;
import org.gatein.wsrp.consumer.migration.MigrationService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
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;
private SortedMap<String, WSRPConsumer> consumers;
private Map<String, String> keysToIds;
private SessionEventBroadcaster sessionEventBroadcaster = SessionEventBroadcaster.NO_OP_BROADCASTER;
private MigrationService migrationService;
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);
protected AbstractConsumerRegistry()
{
initConsumers(null);
}
public FederatingPortletInvoker getFederatingPortletInvoker()
{
return federatingPortletInvoker;
}
public void setSessionEventBroadcaster(SessionEventBroadcaster sessionEventBroadcaster)
{
this.sessionEventBroadcaster = sessionEventBroadcaster;
}
public MigrationService getMigrationService()
{
return migrationService;
}
public void setMigrationService(MigrationService migrationService)
{
this.migrationService = migrationService;
}
public WSRPConsumer createConsumer(String id, Integer expirationCacheSeconds, String wsdlURL)
{
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);
info.getEndpointConfigurationInfo().setWsdlDefinitionURL(wsdlURL);
save(info, "Couldn't create Consumer '" + id + "'");
log.debug(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);
}
deactivateConsumer(consumer);
remove(consumer);
delete(info);
}
else
{
throw new ConsumerException(CONSUMER_WITH_ID + id + "' doesn't exist!");
}
log.debug(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;
}
public ProducerInfo getProducerInfoByKey(String key)
{
String id = keysToIds.get(key);
if (id != null)
{
return getConsumer(id).getProducerInfo();
}
else
{
return null;
}
}
private WSRPConsumer createConsumerFrom(ProducerInfo producerInfo)
{
WSRPConsumer consumer = newConsumer(producerInfo);
add(consumer);
return consumer;
}
/**
* Extracted for testing purposes...
*
* @param producerInfo
* @return
*/
protected WSRPConsumer newConsumer(ProducerInfo producerInfo)
{
return new WSRPConsumerImpl(producerInfo, migrationService);
}
public void activateConsumerWith(String id) throws ConsumerException
{
ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(id, "Consumer identifier", "Activating a Consumer");
activateConsumer(getConsumer(id));
}
protected void activateConsumer(WSRPConsumer consumer)
{
ParameterValidation.throwIllegalArgExceptionIfNull(consumer, "WSRPConsumer");
String id = consumer.getProducerId();
if (federatingPortletInvoker.getFederatedInvoker(id) == null)
{
startOrStopConsumer(consumer, true);
}
else
{
// todo: fix-me federated portlet invoker gets desynchronized...
if (!consumer.isActive())
{
federatingPortletInvoker.unregisterInvoker(id);
startOrStopConsumer(consumer, true);
}
}
}
public void deactivateConsumerWith(String id) throws ConsumerException
{
ParameterValidation.throwIllegalArgExceptionIfNullOrEmpty(id, "Consumer identifier", "Deactivating a Consumer");
deactivateConsumer(getConsumer(id));
}
protected void deactivateConsumer(WSRPConsumer consumer)
{
ParameterValidation.throwIllegalArgExceptionIfNull(consumer, "Consumer");
String id = consumer.getProducerId();
// only process if there is a registered Consumer with the specified id
if (federatingPortletInvoker.getFederatedInvoker(id) != null)
{
startOrStopConsumer(consumer, false);
}
else
{
// todo: fix-me federated portlet invoker gets desynchronized...
if (consumer.isActive())
{
federatingPortletInvoker.registerInvoker(id, consumer);
startOrStopConsumer(consumer, 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 information
if (oldId != null)
{
remove(getConsumer(oldId));
WSRPConsumer consumer = createConsumerFrom(producerInfo);
// update the federating portlet invoker:
FederatedPortletInvoker invoker = federatingPortletInvoker.getFederatedInvoker(oldId);
if (invoker != null)
{
federatingPortletInvoker.unregisterInvoker(oldId);
federatingPortletInvoker.registerInvoker(producerInfo.getId(), consumer);
}
}
}
public void start() throws Exception
{
reloadConsumers();
}
public void reloadConsumers()
{
// load the configured consumers
initConsumers(null);
Iterator<ProducerInfo> producerInfos = getProducerInfosFromStorage();
// load the configured producers
ProducerInfo producerInfo;
while (producerInfos.hasNext())
{
producerInfo = producerInfos.next();
// need to set the registry after loading from DB since registry is not persisted.
producerInfo.setRegistry(this);
createConsumerFrom(producerInfo);
}
}
public void stop() throws Exception
{
for (WSRPConsumer consumer : getConsumers(false))
{
// if producer is not active, it shouldn't be registered with the federating portlet invoker, hence do not
// unregister it. We have changed how consumers are registered (active consumers are not automatically
// registered anymore), we also need to check if the consumer is known by the federating portlet invoker...
String producerId = consumer.getProducerId();
if (consumer.getProducerInfo().isActive() && federatingPortletInvoker.getFederatedInvoker(producerId) != null)
{
federatingPortletInvoker.unregisterInvoker(producerId);
}
try
{
consumer.stop();
}
catch (Exception e)
{
// ignore and continue
}
}
clearConsumers();
}
public List<WSRPConsumer> getConfiguredConsumers()
{
return new ArrayList<WSRPConsumer>(getConsumers());
}
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
deactivateConsumer(consumer);
Throwable cause = e.getCause();
throw new ConsumerException("Couldn't " + (register ? "register" : "deregister") + CONSUMER_WITH_ID + id + "'",
cause != null ? cause : e);
}
}
private void startOrStopConsumer(WSRPConsumer consumer, boolean start)
{
try
{
String id = consumer.getProducerId();
if (start)
{
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 '" + consumer.getProducerId() + "'", e);
}
// update ProducerInfo
updateProducerInfo(consumer.getProducerInfo());
}
private String getListenerIdFrom(String id)
{
return RELEASE_SESSIONS_LISTENER + id;
}
protected abstract void save(ProducerInfo info, String messageOnError) throws ConsumerException;
protected abstract void delete(ProducerInfo info) throws ConsumerException;
/**
* Persists the changes made to ProducerInfo.
*
* @param producerInfo
* @return the previous value of the ProducerInfo's id if it has changed, <code>null</code> otherwise
*/
protected abstract String update(ProducerInfo producerInfo);
protected abstract Iterator<ProducerInfo> getProducerInfosFromStorage();
// internal management methods
protected void add(WSRPConsumer consumer)
{
String id = consumer.getProducerId();
consumers.put(id, consumer);
ProducerInfo info = consumer.getProducerInfo();
keysToIds.put(info.getKey(), id);
}
protected WSRPConsumer remove(WSRPConsumer consumer)
{
String id = keysToIds.remove(consumer.getProducerInfo().getKey());
return consumers.remove(id);
}
protected Collection<WSRPConsumer> getConsumers()
{
return getConsumers(true);
}
protected Collection<WSRPConsumer> getConsumers(boolean startConsumers)
{
Collection<WSRPConsumer> consumerz = consumers.values();
if (startConsumers)
{
for (WSRPConsumer consumer : consumerz)
{
if (consumer.getProducerInfo().isActive() && !consumer.isActive())
{
try
{
consumer.refresh(false);
}
catch (Exception e)
{
log.info("Couldn't activate consumer " + consumer.getProducerId());
consumer.getProducerInfo().setActiveAndSave(false);
}
}
}
}
return consumerz;
}
protected Map<String, String> getKeyMappings()
{
return Collections.unmodifiableMap(keysToIds);
}
protected void initConsumers(SortedMap<String, WSRPConsumer> consumers)
{
if (!ParameterValidation.existsAndIsNotEmpty(consumers))
{
consumers = new TreeMap<String, WSRPConsumer>();
}
this.consumers = consumers;
int size = consumers.size();
keysToIds = size == 0 ? new HashMap<String, String>() : new HashMap<String, String>(size);
}
private void clearConsumers()
{
consumers.clear();
keysToIds.clear();
consumers = null;
keysToIds = null;
}
protected class ProducerInfoIterator implements Iterator<ProducerInfo>
{
private Iterator<WSRPConsumer> consumers;
public ProducerInfoIterator(Iterator<WSRPConsumer> consumers)
{
this.consumers = consumers;
}
public boolean hasNext()
{
return consumers.hasNext();
}
public ProducerInfo next()
{
return consumers.next().getProducerInfo();
}
public void remove()
{
throw new UnsupportedOperationException("remove not supported on this iterator implementation");
}
}
}