[gatein-commits] gatein SVN: r1312 - portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp.

Author: chris.laprun(a)jboss.com Date: 2010-01-15 06:42:30 -0500 (Fri, 15 Jan 2010) New Revision: 1312 Added: portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ActivatingFederatingPortletInvoker.java Modified: portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java Log: - Added ActivatingFederatingPortletInvoker to have a second-level federation for remote invokers so that we can activate them on demand instead of requiring ConsumerRegistry to push them to the top-level federating invoker (which would was currently done manually). Added: portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ActivatingFederatingPortletInvoker.java =================================================================== --- portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ActivatingFederatingPortletInvoker.java (rev 0) +++ portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ActivatingFederatingPortletInvoker.java 2010-01-15 11:42:30 UTC (rev 1312) @@ -0,0 +1,294 @@ +/* + * 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.portal.wsrp; + +import org.gatein.pc.api.InvokerUnavailableException; +import org.gatein.pc.api.NoSuchPortletException; +import org.gatein.pc.api.Portlet; +import org.gatein.pc.api.PortletContext; +import org.gatein.pc.api.PortletInvoker; +import org.gatein.pc.api.PortletInvokerException; +import org.gatein.pc.api.PortletStateType; +import org.gatein.pc.api.invocation.PortletInvocation; +import org.gatein.pc.api.invocation.response.PortletInvocationResponse; +import org.gatein.pc.api.state.DestroyCloneFailure; +import org.gatein.pc.api.state.PropertyChange; +import org.gatein.pc.api.state.PropertyMap; +import org.gatein.pc.federation.FederatedPortletInvoker; +import org.gatein.pc.federation.FederatingPortletInvoker; +import org.gatein.pc.federation.impl.FederatedPortletInvokerService; +import org.gatein.wsrp.WSRPConsumer; +import org.gatein.wsrp.consumer.registry.ConsumerRegistry; + +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * TODO: This is a fork of the FederatingPortletInvokerService in the PC module to avoid having to create a new release. + * Once PC 2.1.0.CR03 or above is release, revisit and clean up. The only thing that is really needed here is a + * different implementation of {@link #getFederatedPortletInvokerFor(org.gatein.pc.api.PortletContext)}. + * + * @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a> + * @version $Revision$ + */ +public class ActivatingFederatingPortletInvoker implements FederatingPortletInvoker /*extends FederatingPortletInvokerService*/ +{ + + /** The separator used in the id to route to the correct invoker. */ + static final String SEPARATOR = "."; + + /** The registred FederatedPortletInvokers. */ + private volatile Map<String, FederatedPortletInvoker> registry = new HashMap<String, FederatedPortletInvoker>(); + private transient ConsumerRegistry consumerRegistry; + + public synchronized FederatedPortletInvoker registerInvoker(String federatedId, PortletInvoker federatedInvoker) + { + if (federatedId == null) + { + throw new IllegalArgumentException("No null id"); + } + if (federatedInvoker == null) + { + throw new IllegalArgumentException("No null invoker"); + } + if (registry.containsKey(federatedId)) + { + throw new IllegalArgumentException("Attempting dual registration of " + federatedId); + } + Map<String, FederatedPortletInvoker> copy = new HashMap<String, FederatedPortletInvoker>(registry); + FederatedPortletInvokerService invoker = new FederatedPortletInvokerService(this, federatedId, federatedInvoker); + copy.put(federatedId, invoker); + registry = copy; + return invoker; + } + + public synchronized void unregisterInvoker(String federatedId) + { + if (federatedId == null) + { + throw new IllegalArgumentException("No null id accepted"); + } + if (!registry.containsKey(federatedId)) + { + throw new IllegalArgumentException("Attempting to unregister unknown invoker " + federatedId); + } + Map<String, FederatedPortletInvoker> copy = new HashMap<String, FederatedPortletInvoker>(registry); + copy.remove(federatedId); + registry = copy; + } + + public FederatedPortletInvoker getFederatedInvoker(String federatedId) throws IllegalArgumentException + { + if (federatedId == null) + { + throw new IllegalArgumentException("No null id provided"); + } + return registry.get(federatedId); + } + + public Collection<FederatedPortletInvoker> getFederatedInvokers() + { + return registry.values(); + } + + // PortletInvoker implementation ************************************************************************************ + + public Set<Portlet> getPortlets() throws PortletInvokerException + { + return getPortlets(false); + } + + private Set<Portlet> getPortlets(boolean remoteOnly) throws PortletInvokerException + { + LinkedHashSet<Portlet> portlets = new LinkedHashSet<Portlet>(); + for (FederatedPortletInvoker federated : registry.values()) + { + // if we're only interested in remote portlets, skip the local invoker. + if (remoteOnly && LOCAL_PORTLET_INVOKER_ID.equals(federated.getId())) + { + continue; + } + + try + { + Set<Portlet> offeredPortlets = federated.getPortlets(); + portlets.addAll(offeredPortlets); + } + catch (InvokerUnavailableException e) + { + e.printStackTrace(); + } + } + return portlets; + } + + public Set<Portlet> getLocalPortlets() throws PortletInvokerException + { + PortletInvoker local = registry.get(PortletInvoker.LOCAL_PORTLET_INVOKER_ID); + + return local.getPortlets(); + } + + public Set<Portlet> getRemotePortlets() throws PortletInvokerException + { + return getPortlets(true); + } + + public Portlet getPortlet(PortletContext compoundPortletContext) throws IllegalArgumentException, PortletInvokerException + { + FederatedPortletInvoker federated = getFederatedPortletInvokerFor(compoundPortletContext); + return federated.getPortlet(compoundPortletContext); + } + + public PortletInvocationResponse invoke(PortletInvocation invocation) throws PortletInvokerException + { + PortletContext compoundPortletContext = invocation.getTarget(); + FederatedPortletInvoker federated = getFederatedPortletInvokerFor(compoundPortletContext); + return federated.invoke(invocation); + } + + public PortletContext createClone(PortletStateType stateType, PortletContext compoundPortletContext) throws PortletInvokerException + { + FederatedPortletInvoker federated = getFederatedPortletInvokerFor(compoundPortletContext); + return federated.createClone(stateType, compoundPortletContext); + } + + public List<DestroyCloneFailure> destroyClones(List<PortletContext> portletContexts) throws IllegalArgumentException, PortletInvokerException, UnsupportedOperationException + { + if (portletContexts == null) + { + throw new IllegalArgumentException("No null list accepted"); + } + if (portletContexts.size() == 0) + { + return Collections.emptyList(); + } + + // Get the invoker and check that we address only one invoker (for now) + FederatedPortletInvoker invoker = null; + for (PortletContext compoundPortletContext : portletContexts) + { + FederatedPortletInvoker federated = getFederatedPortletInvokerFor(compoundPortletContext); + if (invoker == null) + { + invoker = federated; + } + else if (!invoker.equals(federated)) + { + throw new PortletInvokerException("Cannot destroy portlet lists that requires more than one federated invoker"); + } + } + + // + return invoker.destroyClones(portletContexts); + } + + public PropertyMap getProperties(PortletContext compoundPortletContext, Set<String> keys) throws PortletInvokerException + { + FederatedPortletInvoker federated = getFederatedPortletInvokerFor(compoundPortletContext); + return federated.getProperties(compoundPortletContext, keys); + } + + public PropertyMap getProperties(PortletContext compoundPortletContext) throws PortletInvokerException + { + FederatedPortletInvoker federated = getFederatedPortletInvokerFor(compoundPortletContext); + return federated.getProperties(compoundPortletContext); + } + + public PortletContext setProperties(PortletContext compoundPortletContext, PropertyChange[] changes) throws IllegalArgumentException, PortletInvokerException, UnsupportedOperationException + { + FederatedPortletInvoker federated = getFederatedPortletInvokerFor(compoundPortletContext); + return federated.setProperties(compoundPortletContext, changes); + } + + // Support methods ************************************************************************************************** + + /** + * Retrieves the portlet invoker associated with the specified compound portlet id or null if it is not found. + * + * @param compoundPortletContext the portlet context for which the invoker is to be retrieved + * @return the portlet invoker associated with the specified compound portlet id + * @throws IllegalArgumentException if the compound portlet id is not well formed or null + * @throws org.gatein.pc.api.NoSuchPortletException + * if not such portlet exist + */ + private FederatedPortletInvoker getFederatedPortletInvokerFor(PortletContext compoundPortletContext) throws IllegalArgumentException, NoSuchPortletException + { + if (compoundPortletContext == null) + { + throw new IllegalArgumentException("No null portlet id accepted"); + } + + // + String compoundPortletId = compoundPortletContext.getId(); + + // + int pos = compoundPortletId.indexOf(SEPARATOR); + if (pos == -1) + { + throw new IllegalArgumentException("Bad portlet id format " + compoundPortletId); + } + + // + String invokerId = compoundPortletId.substring(0, pos); + FederatedPortletInvoker federated = registry.get(invokerId); + + // if we didn't find the invoker, ask the ConsumerRegistry� + if (federated == null) + { + WSRPConsumer consumer = consumerRegistry.getConsumer(invokerId); + + // if there's no consumer with that invoker id, then there's nothing much we can do + if (consumer == null) + { + throw new NoSuchPortletException(compoundPortletId); + } + else + { + // activate the consumer which should register it with this FederatingPortletInvoker + consumerRegistry.activateConsumerWith(invokerId); + + federated = getFederatedInvoker(invokerId); + } + } + + // + return federated; + } + + public void setConsumerRegistry(ConsumerRegistry consumerRegistry) + { + if (consumerRegistry.getFederatingPortletInvoker() != this) + { + throw new IllegalArgumentException("Trying to use a ConsumerRegistry already linked to another FederatingPortletInvoker"); + } + + this.consumerRegistry = consumerRegistry; + } +} Modified: portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java =================================================================== --- portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java 2010-01-15 10:55:37 UTC (rev 1311) +++ portal/trunk/component/wsrp/src/main/java/org/gatein/portal/wsrp/ExoKernelIntegration.java 2010-01-15 11:42:30 UTC (rev 1312) @@ -1,6 +1,6 @@ /* * JBoss, a division of Red Hat - * Copyright 2009, Red Hat Middleware, LLC, and individual + * 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. @@ -74,6 +74,7 @@ private final String consumersConfigLocation; private ConsumerRegistry consumerRegistry; + private static final String REMOTE_INVOKERS_INVOKER_ID = "remote"; public ExoKernelIntegration(InitParams params, ConfigurationManager configurationManager, org.exoplatform.portal.pc.ExoKernelIntegration pc) throws Exception @@ -118,11 +119,10 @@ } container.registerComponentInstance(ProducerConfigurationService.class, producerConfigurationService); - RegistrationPersistenceManager registrationPersistenceManager = null; + RegistrationPersistenceManager registrationPersistenceManager; try { registrationPersistenceManager = new JCRRegistrationPersistenceManager(container); -// registrationPersistenceManager = new RegistrationPersistenceManagerImpl(); } catch (Exception e) { @@ -173,12 +173,19 @@ FederatingPortletInvoker federatingPortletInvoker = (FederatingPortletInvoker)container.getComponentInstanceOfType(PortletInvoker.class); + // set up a second level federating portlet invoker so that when a remote producer is queried, we can start it if needed + ActivatingFederatingPortletInvoker remoteInvokers = new ActivatingFederatingPortletInvoker(); + federatingPortletInvoker.registerInvoker(REMOTE_INVOKERS_INVOKER_ID, remoteInvokers); + try { consumerRegistry = new JCRConsumerRegistry(container); - consumerRegistry.setFederatingPortletInvoker(federatingPortletInvoker); + consumerRegistry.setFederatingPortletInvoker(remoteInvokers); consumerRegistry.setSessionEventBroadcaster(new SimpleSessionEventBroadcaster()); consumerRegistry.start(); + + // set the consumer registry on the second level federating invoker + remoteInvokers.setConsumerRegistry(consumerRegistry); } catch (Exception e) {