Author: julien(a)jboss.com Date: 2008-06-02 16:16:56 -0400 (Mon, 02 Jun 2008) New Revision: 10906 Added: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PortalNode.java Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/PresentationServerImpl.java modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/content/portlet/controller/PresentationPortletControllerContext.java modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/ContextNode.java modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/NodeImporter.java modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PageNode.java modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PaneNode.java modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/StructuralStateContextImpl.java modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/WindowNode.java modules/presentation/trunk/portal/src/test/java/org/jboss/portal/presentation/portal/model/StructuralStateContextTestCase.java Log: rename structural node to portal node as it is more correct Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/PresentationServerImpl.java =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/PresentationServerImpl.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/PresentationServerImpl.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -23,7 +23,7 @@ package org.jboss.portal.presentation.portal; import org.jboss.portal.presentation.client.PresentationClient; -import org.jboss.portal.presentation.portal.model.StructuralNode; +import org.jboss.portal.presentation.portal.model.PortalNode; import org.jboss.portal.presentation.portal.model.StructuralStateContextImpl; import org.jboss.portal.presentation.portal.model.WindowNode; import org.jboss.portal.presentation.portal.model.PageNode; @@ -94,7 +94,7 @@ String targetId = objectAction.getTargetId(); // - StructuralNode targetNode = structuralStateContext.getNode(targetId); + PortalNode targetNode = structuralStateContext.getNode(targetId); // if (targetNode == null) Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/content/portlet/controller/PresentationPortletControllerContext.java =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/content/portlet/controller/PresentationPortletControllerContext.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/content/portlet/controller/PresentationPortletControllerContext.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -49,7 +49,7 @@ import org.jboss.portal.presentation.portal.content.portlet.spi.PresentationSecurityContext; import org.jboss.portal.presentation.portal.content.portlet.PortletContent; import org.jboss.portal.presentation.portal.model.PageNode; -import org.jboss.portal.presentation.portal.model.StructuralNode; +import org.jboss.portal.presentation.portal.model.PortalNode; import org.jboss.portal.presentation.portal.model.WindowNode; import org.jboss.portal.presentation.client.PresentationClient; @@ -96,7 +96,7 @@ Map<String, WindowNode> windows = new HashMap<String, WindowNode>(); // - for (StructuralNode child : page.getChildren()) + for (PortalNode child : page.getChildren()) { if (child instanceof WindowNode) { Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/ContextNode.java =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/ContextNode.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/ContextNode.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -29,7 +29,7 @@ * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> * @version $Revision: 630 $ */ -public class ContextNode extends StructuralNode +public class ContextNode extends PortalNode { public ContextNode(String name, StructuralStateContextImpl structuralStateContext) { Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/NodeImporter.java =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/NodeImporter.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/NodeImporter.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -73,9 +73,9 @@ } /** The root to import the children to. */ - private final StructuralNode root; + private final PortalNode root; - public NodeImporter(StructuralNode root) + public NodeImporter(PortalNode root) { this.root = root; } @@ -133,7 +133,7 @@ } } - private PageNode importPageDef(StructuralNode parentNode, Element pageDefElt) + private PageNode importPageDef(PortalNode parentNode, Element pageDefElt) { PageNode pageNode = createStructuralNode(parentNode, PageNode.class, pageDefElt); @@ -156,7 +156,7 @@ return pageNode; } - private void importLayout(StructuralNode paneNode, Element layoutElt) + private void importLayout(PortalNode paneNode, Element layoutElt) { if ("simple-layout".equals(layoutElt.getNodeName())) { @@ -179,7 +179,7 @@ } } - private WindowNode importWindowDef(StructuralNode parentNode, Element windowDefElt) + private WindowNode importWindowDef(PortalNode parentNode, Element windowDefElt) { WindowNode windowNode = createStructuralNode(parentNode, WindowNode.class, windowDefElt); @@ -208,7 +208,7 @@ return windowNode; } - private <T extends StructuralNode> T createStructuralNode(StructuralNode parent, Class<T> type, Element nodeDefElt) + private <T extends PortalNode> T createStructuralNode(PortalNode parent, Class<T> type, Element nodeDefElt) { String nodeName = nodeDefElt.getAttribute("name"); Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PageNode.java =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PageNode.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PageNode.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -33,7 +33,7 @@ * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> * @version $Revision: 630 $ */ -public class PageNode extends StructuralNode +public class PageNode extends PortalNode { public PageNode(String name, StructuralStateContextImpl structuralStateContext) { @@ -56,7 +56,7 @@ return windows; } - private void collectWindows(StructuralNode node, List<WindowNode> windows) + private void collectWindows(PortalNode node, List<WindowNode> windows) { if (node instanceof WindowNode) { @@ -64,7 +64,7 @@ } else if (node instanceof PaneNode) { - for (StructuralNode child : node.getChildren()) + for (PortalNode child : node.getChildren()) { collectWindows(child, windows); } Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PaneNode.java =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PaneNode.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PaneNode.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -29,7 +29,7 @@ * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> * @version $Revision: 630 $ */ -public class PaneNode extends StructuralNode +public class PaneNode extends PortalNode { public PaneNode(String name, StructuralStateContextImpl structuralStateContext) Copied: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PortalNode.java (from rev 10905, modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/StructuralNode.java) =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PortalNode.java (rev 0) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/PortalNode.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -0,0 +1,353 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2008, 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.jboss.portal.presentation.portal.model; + +import org.jboss.portal.presentation.model.ui.UIObject; +import org.jboss.portal.presentation.state.StaleStateException; +import org.jboss.portal.presentation.state.structural.StructuralObject; + +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import java.io.Serializable; + +/** + * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> + * @version $Revision: 630 $ + */ +public abstract class PortalNode +{ + + /** . */ + private final Set<String> EMPTY_STRING_SET = Collections.emptySet(); + + /** . */ + private PortalNode parent; + + /** . */ + private final Map<String, PortalNode> children = new HashMap<String, PortalNode>(); + + /** . */ + private final StructuralStateContextImpl structuralStateContext; + + /** . */ + private final String id; + + /** . */ + private final String name; + + /** . */ + private boolean valid; + + /** . */ + private final Map<String, Serializable> properties; + + protected PortalNode(String name, StructuralStateContextImpl structuralStateContext) + { + this.name = name; + this.id = structuralStateContext.nextId(); + this.structuralStateContext = structuralStateContext; + this.properties = new HashMap<String, Serializable>(); + this.valid = true; + } + + public abstract Class<? extends UIObject> getType(); + + Collection<StructuralObject> takeChildrenSnapshot(StructuralObject structuralObject) + { + synchronized (this) + { + if (!takeSnapshot().equals(structuralObject)) + { + throw new StaleStateException(); + } + + // + Set<StructuralObject> structuralChildren = new HashSet<StructuralObject>(); + for (PortalNode child : children.values()) + { + structuralChildren.add(child.takeSnapshot()); + } + + // + return structuralChildren; + } + } + + StructuralObject takeParentSnapshot(StructuralObject structuralObject) + { + synchronized (this) + { + if (!takeSnapshot().equals(structuralObject)) + { + throw new StaleStateException(); + } + + // + return parent != null ? parent.takeSnapshot() : null; + } + } + + StructuralObject takeSnapshot() + { + synchronized (this) + { + StructuralStateImpl state = new StructuralStateImpl( + getType(), + name, + Collections.unmodifiableMap(new HashMap<String, Serializable>(properties))); + + // + Set<String> childrenIds = new HashSet<String>(); + for (PortalNode child : children.values()) + { + childrenIds.add(child.id); + } + + // + String parentId = parent != null ? parent.id : null; + + // + return new StructuralObjectImpl(id, parentId, Collections.unmodifiableSet(childrenIds), state); + } + } + + StructuralObject.Refresh refresh(StructuralObjectImpl structuralObject) + { + synchronized (this) + { + Map<String, PortalNode> childrenMap = new HashMap<String, PortalNode>(); + for (PortalNode child : children.values()) + { + childrenMap.put(child.getId(), child); + } + + // + Map<String, PortalNode> addedChildrenMap = new HashMap<String, PortalNode>(childrenMap); + addedChildrenMap.keySet().removeAll(structuralObject.getChildrenIds()); + + // + Map<String, PortalNode> staleChildren = new HashMap<String, PortalNode>(childrenMap); + staleChildren.keySet().retainAll(structuralObject.getChildrenIds()); + + // + Set<String> removedChildrenIds = new HashSet<String>(structuralObject.getChildrenIds()); + removedChildrenIds.removeAll(staleChildren.keySet()); + + // + Set<StructuralObject> addedStructuralChildren = new HashSet<StructuralObject>(); + for (PortalNode addedChild : addedChildrenMap.values()) + { + addedStructuralChildren.add(addedChild.takeSnapshot()); + } + + // + Map<String, StructuralObject> staleStructuralChildren = new HashMap<String, StructuralObject>(); + for (PortalNode stateChild : staleChildren.values()) + { + staleStructuralChildren.put(stateChild.getId(), stateChild.takeSnapshot()); + } + + // + return new StructuralObject.Refresh( + parent != null ? parent.takeSnapshot() : null, + takeSnapshot(), + addedStructuralChildren, + removedChildrenIds, + staleStructuralChildren, + EMPTY_STRING_SET); + } + } + + public boolean isValid() + { + return valid; + } + + public String getId() + { + return id; + } + + public String getName() + { + return name; + } + + public PortalNode getParent() + { + return parent; + } + + public Set<String> getPropertyNames() + { + return Collections.unmodifiableSet(properties.keySet()); + } + + public Serializable getProperty(String propertyName) + { + if (propertyName == null) + { + throw new IllegalArgumentException("No null property name"); + } + + // + synchronized (this) + { + return properties.get(propertyName); + } + } + + public void setProperty(String propertyName, Serializable propertyValue) + { + if (propertyName == null) + { + throw new IllegalArgumentException("No null property name"); + } + + // + synchronized (this) + { + if (propertyValue != null) + { + properties.put(propertyName, propertyValue); + } + else + { + properties.remove(propertyName); + } + } + } + + public Collection<? extends PortalNode> getChildren() + { + return Collections.unmodifiableCollection(children.values()); + } + + public <T extends PortalNode> T addChild(String name, Class<T> type) + { + if (name == null) + { + throw new IllegalArgumentException(); + } + if (type == null) + { + throw new IllegalArgumentException(); + } + + // + T child; + try + { + Constructor<T> ctor = type.getConstructor(String.class, StructuralStateContextImpl.class); + child = ctor.newInstance(name, structuralStateContext); + } + catch (InstantiationException e) + { + throw new AssertionError(e); + } + catch (IllegalAccessException e) + { + throw new AssertionError(e); + } + catch (NoSuchMethodException e) + { + throw new AssertionError(e); + } + catch (InvocationTargetException e) + { + throw new AssertionError(e); + } + + // + synchronized (this) + { + if (children.containsKey(name)) + { + throw new IllegalArgumentException("Child already exist"); + } + children.put(name, child); + child.parent = this; + } + + // + structuralStateContext.nodes.put(child.id, child); + + // + return child; + } + + public void destroyChild(String name) + { + if (name == null) + { + throw new IllegalArgumentException(); + } + + // + PortalNode child; + synchronized (this) + { + if (!children.containsKey(name)) + { + throw new IllegalArgumentException("No such child " + name); + } + + child = children.get(name); + + // + for (String blah : new ArrayList<String>(child.children.keySet())) + { + child.destroyChild(blah); + } + + // + children.remove(name); + structuralStateContext.nodes.remove(child.id); + + // + child.valid = false; + child.parent = null; + } + } + + public PortalNode getChild(String name) + { + if (name == null) + { + throw new IllegalArgumentException(); + } + + // + synchronized (this) + { + return children.get(name); + } + } +} Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/StructuralStateContextImpl.java =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/StructuralStateContextImpl.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/StructuralStateContextImpl.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -44,7 +44,7 @@ private final AtomicLong sequence = new AtomicLong(); /** . */ - final ConcurrentMap<String, StructuralNode> nodes = new ConcurrentHashMap<String, StructuralNode>(); + final ConcurrentMap<String, PortalNode> nodes = new ConcurrentHashMap<String, PortalNode>(); /** . */ private final ContextNode root = new ContextNode("", this); @@ -59,7 +59,7 @@ return Long.toString(sequence.getAndIncrement()); } - public StructuralNode getNode(String nodeId) + public PortalNode getNode(String nodeId) { if (nodeId == null) { @@ -83,10 +83,10 @@ } // - StructuralNode node = nodes.get(objectId); + PortalNode node = nodes.get(objectId); // - StructuralNode parent = node.getParent(); + PortalNode parent = node.getParent(); // if (parent == null) @@ -106,7 +106,7 @@ } // - StructuralNode node = nodes.get(objectId); + PortalNode node = nodes.get(objectId); // return node != null ? node.takeSnapshot() : null; @@ -120,7 +120,7 @@ } // - StructuralNode parentNode = nodes.get(structuralParent.getId()); + PortalNode parentNode = nodes.get(structuralParent.getId()); // if (parentNode == null) @@ -140,7 +140,7 @@ } // - StructuralNode childNode = nodes.get(structuralChild.getId()); + PortalNode childNode = nodes.get(structuralChild.getId()); // if (childNode == null) @@ -165,16 +165,16 @@ } // - StructuralNode structuralNode = nodes.get(structuralObject.getId()); + PortalNode portalNode = nodes.get(structuralObject.getId()); // - if (structuralNode == null) + if (portalNode == null) { throw new NoSuchStateException(); } // - if (!structuralNode.takeSnapshot().equals(structuralObject)) + if (!portalNode.takeSnapshot().equals(structuralObject)) { throw new StaleStateException(); } @@ -188,15 +188,15 @@ } // - StructuralNode structuralNode = nodes.get(structuralObject.getId()); + PortalNode portalNode = nodes.get(structuralObject.getId()); // - if (structuralNode == null) + if (portalNode == null) { throw new NoSuchStateException(); } // - return structuralNode.refresh((StructuralObjectImpl)structuralObject); + return portalNode.refresh((StructuralObjectImpl)structuralObject); } } Modified: modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/WindowNode.java =================================================================== --- modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/WindowNode.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/main/java/org/jboss/portal/presentation/portal/model/WindowNode.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -33,7 +33,7 @@ * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> * @version $Revision: 630 $ */ -public class WindowNode extends StructuralNode +public class WindowNode extends PortalNode { /** . */ @@ -51,7 +51,7 @@ public PageNode getPage() { - for (StructuralNode current = getParent();current != null;current = current.getParent()) + for (PortalNode current = getParent();current != null;current = current.getParent()) { if (current instanceof PageNode) { Modified: modules/presentation/trunk/portal/src/test/java/org/jboss/portal/presentation/portal/model/StructuralStateContextTestCase.java =================================================================== --- modules/presentation/trunk/portal/src/test/java/org/jboss/portal/presentation/portal/model/StructuralStateContextTestCase.java 2008-06-02 19:08:03 UTC (rev 10905) +++ modules/presentation/trunk/portal/src/test/java/org/jboss/portal/presentation/portal/model/StructuralStateContextTestCase.java 2008-06-02 20:16:56 UTC (rev 10906) @@ -38,7 +38,7 @@ * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> * @version $Revision: 630 $ */ -public class StructuralStateContextTestCase extends AbstractModelTestCase<StructuralNode> +public class StructuralStateContextTestCase extends AbstractModelTestCase<PortalNode> { /** . */ @@ -49,49 +49,49 @@ return structuralStateContext; } - protected StructuralNode getRoot() + protected PortalNode getRoot() { return structuralStateContext.getRoot(); } - protected Set<String> getPropertyNames(StructuralNode structuralNode) + protected Set<String> getPropertyNames(PortalNode portalNode) { - return structuralNode.getPropertyNames(); + return portalNode.getPropertyNames(); } - protected StructuralNode getParent(StructuralNode structuralNode) + protected PortalNode getParent(PortalNode portalNode) { - return structuralNode.getParent(); + return portalNode.getParent(); } - protected List<? extends StructuralNode> getChildren(StructuralNode structuralNode) + protected List<? extends PortalNode> getChildren(PortalNode portalNode) { - return new ArrayList<StructuralNode>(structuralNode.getChildren()); + return new ArrayList<PortalNode>(portalNode.getChildren()); } - protected String getName(StructuralNode structuralNode) + protected String getName(PortalNode portalNode) { - return structuralNode.getName(); + return portalNode.getName(); } - protected boolean isValid(StructuralNode structuralNode) + protected boolean isValid(PortalNode portalNode) { - return structuralNode.isValid(); + return portalNode.isValid(); } - protected Class<? extends UIObject> getType(StructuralNode structuralNode) + protected Class<? extends UIObject> getType(PortalNode portalNode) { - return structuralNode.getType(); + return portalNode.getType(); } - protected String getId(StructuralNode structuralNode) + protected String getId(PortalNode portalNode) { - return structuralNode.getId(); + return portalNode.getId(); } - protected StructuralNode addChild(StructuralNode structuralNode, String name, Class<? extends UIObject> modelType) + protected PortalNode addChild(PortalNode portalNode, String name, Class<? extends UIObject> modelType) { - Class<? extends StructuralNode> structuralNodeType; + Class<? extends PortalNode> structuralNodeType; // if (modelType == UIContext.class) @@ -112,22 +112,22 @@ } // - return structuralNode.addChild(name, structuralNodeType); + return portalNode.addChild(name, structuralNodeType); } - protected void setProperty(StructuralNode structuralNode, String propertyName, String propertyValue) + protected void setProperty(PortalNode portalNode, String propertyName, String propertyValue) { - structuralNode.setProperty(propertyName, propertyValue); + portalNode.setProperty(propertyName, propertyValue); } - protected Serializable getProperty(StructuralNode structuralNode, String name) + protected Serializable getProperty(PortalNode portalNode, String name) { - return structuralNode.getProperty(name); + return portalNode.getProperty(name); } - protected void destroy(StructuralNode structuralNode) + protected void destroy(PortalNode portalNode) { - structuralStateContext.destroy(structuralNode.getId()); + structuralStateContext.destroy(portalNode.getId()); } protected void setUp() throws Exception