[portal-commits] JBoss Portal SVN: r11823 - in branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core: impl/coordination and 1 other directory.
portal-commits at lists.jboss.org
portal-commits at lists.jboss.org
Sat Sep 6 05:50:22 EDT 2008
Author: chris.laprun at jboss.com
Date: 2008-09-06 05:50:22 -0400 (Sat, 06 Sep 2008)
New Revision: 11823
Modified:
branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core/controller/coordination/CoordinationConfigurator.java
branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core/impl/coordination/CoordinationService.java
Log:
- Re-organization and minor improvements.
- Javadoc of newly added methods.
Modified: branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core/controller/coordination/CoordinationConfigurator.java
===================================================================
--- branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core/controller/coordination/CoordinationConfigurator.java 2008-09-05 23:13:35 UTC (rev 11822)
+++ branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core/controller/coordination/CoordinationConfigurator.java 2008-09-06 09:50:22 UTC (rev 11823)
@@ -33,6 +33,7 @@
/**
* @author <a href="mailto:boleslaw dot dawidowicz at redhat anotherdot com">Boleslaw Dawidowicz</a>
+ * @author <a href="mailto:chris.laprun at jboss.com">Chris Laprun</a>
* @version : 0.1 $
*/
public interface CoordinationConfigurator
@@ -58,6 +59,14 @@
void removeEventWiring(EventWiringInfo eventWiringInfo) throws IllegalCoordinationException;
/**
+ * Removes the wiring found in the given page and identified with the given name
+ *
+ * @param page
+ * @param wiringName
+ */
+ void removeEventWiring(Page page, String wiringName);
+
+ /**
* Set event wiring implicit mode for a given page container. This will be inherited recursively by all children page
* containers
*
@@ -77,6 +86,16 @@
void renameEventWiring(EventWiringInfo eventWiring, String newName) throws IllegalCoordinationException;
/**
+ * Renames the named wiring in the given Page to the spefified new name.
+ *
+ * @param page the Page in which the wiring is supposed to be found
+ * @param wiringName the name of the wiring to be renamed
+ * @param newName the new name for the wiring
+ * @throws IllegalCoordinationException
+ */
+ void renameEventWiring(Page page, String wiringName, String newName) throws IllegalCoordinationException;
+
+ /**
* Checks if implicit event wiring is enabled for a given page container. May return null if no implicit mode is not
* set for this portal object
*
@@ -107,6 +126,16 @@
Collection<EventWiringInfo> getEventWirings(Page page);
/**
+ * Retrieves the event wiring found in the given page and identified with the specified name
+ *
+ * @param page
+ * @param name
+ * @return
+ * @throws IllegalCoordinationException
+ */
+ EventWiringInfo getEventWiring(Page page, String name) throws IllegalCoordinationException;
+
+ /**
* @param window
* @return all wirings where given window is a source
*/
@@ -222,10 +251,4 @@
* @return window bindings where given window is involved
*/
Collection<? extends WindowBindingInfo> getWindowBindings(Window window);
-
- void removeEventWiring(Page page, String wiringName);
-
- EventWiringInfo getEventWiring(Page page, String name) throws IllegalCoordinationException;
-
- void renameEventWiring(Page page, String wiringName, String newName) throws IllegalCoordinationException;
}
Modified: branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core/impl/coordination/CoordinationService.java
===================================================================
--- branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core/impl/coordination/CoordinationService.java 2008-09-05 23:13:35 UTC (rev 11822)
+++ branches/JBoss_Portal_Branch_2_7/core/src/main/org/jboss/portal/core/impl/coordination/CoordinationService.java 2008-09-06 09:50:22 UTC (rev 11823)
@@ -56,31 +56,33 @@
* @author <a href="mailto:chris.laprun at jboss.com">Chris Laprun</a>
* @version : 0.1 $
*/
-public class CoordinationService extends AbstractJBossService
- implements CoordinationManager, CoordinationConfigurator
+public class CoordinationService extends AbstractJBossService implements CoordinationManager, CoordinationConfigurator
{
private static final String EVENT_ROLE_SOURCE = "source";
- public static final String SOURCE = EVENT_ROLE_SOURCE;
private static final String EVENT_ROLE_DESTINATION = "destination";
- public static final String DESTINATION = EVENT_ROLE_DESTINATION;
public static final String BINDING = "binding";
public static final String PREFIX = "coordination";
public static final String QNAME_SEPARATOR = ";";
+
public static final String PREFIX_EVENT = PREFIX + ".event";
- public static final String PREFIX_PARAMETER = PREFIX + ".parameter";
- public static final String PREFIX_PARAMETER_ALIAS = PREFIX_PARAMETER + ".alias";
+ public static final String EVENT_IMPLICIT_MODE = PREFIX_EVENT + ".implicit_mode";
public static final String PREFIX_EVENT_NAME = PREFIX_EVENT + ".name.";
public static final String PREFIX_EVENT_WIRING = PREFIX_EVENT + ".wiring.";
- public static final String PREFIX_PARAMETER_NAME = PREFIX_PARAMETER + ".name";
- public static final String PREFIX_PARAMETER_BINDING = PREFIX_PARAMETER + ".binding";
- public static final String PREFIX_PARAMETER_ALIAS_NAME = PREFIX_PARAMETER_ALIAS + ".name";
- public static final String PREFIX_EVENT_IMPLICIT_MODE = PREFIX_EVENT + ".implicit_mode";
- public static final String PREFIX_PARAMETER_IMPLICIT_MODE = PREFIX_PARAMETER + ".implicit_mode";
- public static final Boolean DEFAULT_IMPLICIT_MODE = true;
+ private static final int PREFIX_EVENT_NAME_LENGTH = PREFIX_EVENT_NAME.length();
+ public static final String PREFIX_PARAMETER = PREFIX + ".parameter";
+ public static final String PARAMETER_IMPLICIT_MODE = PREFIX_PARAMETER + ".implicit_mode";
+ public static final String PREFIX_PARAMETER_NAME = PREFIX_PARAMETER + ".name.";
+ public static final String PREFIX_PARAMETER_BINDING = PREFIX_PARAMETER + ".binding.";
+ private static final int PREFIX_PARAMETER_BINDING_LENGTH = PREFIX_PARAMETER_BINDING.length();
+
+ public static final String PREFIX_PARAMETER_ALIAS = PREFIX_PARAMETER + ".alias";
+ public static final String PREFIX_PARAMETER_ALIAS_NAME = PREFIX_PARAMETER_ALIAS + ".name.";
+ private static final int PREFIX_PARAMETER_ALIAS_LENGTH = PREFIX_PARAMETER_ALIAS.length();
+
+ public static final Boolean DEFAULT_IMPLICIT_MODE = true;
protected EventConverter eventConverter = new SimpleEventConverter();
protected PortalObjectContainer portalObjectContainer;
- private static final int PREFIX_EVENT_NAME_LENGTH = PREFIX_EVENT_NAME.length();
protected void startService() throws Exception
{
@@ -259,7 +261,7 @@
for (Window window : sw)
{
- window.setDeclaredProperty(prop_name, SOURCE);
+ window.setDeclaredProperty(prop_name, EVENT_ROLE_SOURCE);
window.setDeclaredProperty(prop_wiring, sources.get(window).toString());
}
@@ -267,7 +269,7 @@
for (Window window : dw)
{
- window.setDeclaredProperty(prop_name, DESTINATION);
+ window.setDeclaredProperty(prop_name, EVENT_ROLE_DESTINATION);
window.setDeclaredProperty(prop_wiring, destinations.get(window).toString());
}
@@ -275,30 +277,13 @@
public void removeEventWiring(EventWiringInfo info) throws IllegalCoordinationException
{
- /*ParameterValidation.throwIllegalArgExceptionIfNull(info, "EventWiringInfo");
-
- // Remove all entries
-
- String prop_name = PREFIX_EVENT_NAME + "." + info.getName();
- String prop_wiring = PREFIX_EVENT_WIRING + "." + info.getName();
-
- Set<Window> all = new HashSet<Window>();
- all.addAll(info.getSources().keySet());
- all.addAll(info.getDestinations().keySet());
-
- for (Window window : all)
- {
- window.setDeclaredProperty(prop_name, null);
- window.setDeclaredProperty(prop_wiring, null);
- }*/
-
ParameterValidation.throwIllegalArgExceptionIfNull(info, "EventWiringInfo");
removeEventWiring(info.getPage(), info.getName());
}
public void removeEventWiring(Page page, String wiringName)
{
- ParameterValidation.throwIllegalArgExceptionIfNull(wiringName, "Event wiring name");
+ ParameterValidation.throwIllegalArgExceptionIfNull(wiringName, "event wiring name");
ParameterValidation.throwIllegalArgExceptionIfNull(page, "Page");
String prop_name = PREFIX_EVENT_NAME + wiringName;
@@ -330,25 +315,25 @@
public void setEventWiringImplicitMode(PageContainer pageContainer, boolean mode) throws IllegalCoordinationException
{
ParameterValidation.throwIllegalArgExceptionIfNull(pageContainer, "PageContainer");
- setImplicitMode(pageContainer, mode, PREFIX_EVENT_IMPLICIT_MODE);
+ setImplicitMode(pageContainer, mode, EVENT_IMPLICIT_MODE);
}
public void removeEventWiringImplicitMode(PageContainer pageContainer) throws IllegalCoordinationException
{
ParameterValidation.throwIllegalArgExceptionIfNull(pageContainer, "PageContainer");
- setImplicitMode(pageContainer, null, PREFIX_EVENT_IMPLICIT_MODE);
+ setImplicitMode(pageContainer, null, EVENT_IMPLICIT_MODE);
}
public Boolean isEventWiringImplicitModeEnabled(PageContainer pageContainer)
{
ParameterValidation.throwIllegalArgExceptionIfNull(pageContainer, "PageContainer");
- return decodeImplicitMode(pageContainer, PREFIX_EVENT_IMPLICIT_MODE);
+ return decodeImplicitMode(pageContainer, EVENT_IMPLICIT_MODE);
}
public Boolean resolveEventWiringImplicitModeEnabled(PageContainer page)
{
ParameterValidation.throwIllegalArgExceptionIfNull(page, "PageContainer");
- return resolveImplicitMode(page, PREFIX_EVENT_IMPLICIT_MODE);
+ return resolveImplicitMode(page, EVENT_IMPLICIT_MODE);
}
public Collection<EventWiringInfo> getEventWirings(Page page, QName eventQName)
@@ -538,7 +523,7 @@
}
// Set window properties
- String prop_wiring = PREFIX_PARAMETER_BINDING + "." + name;
+ String prop_wiring = PREFIX_PARAMETER_BINDING + name;
//
for (Window window : windows.keySet())
@@ -568,25 +553,25 @@
public Boolean isParameterBindingImplicitModeEnabled(PageContainer pageContainer)
{
ParameterValidation.throwIllegalArgExceptionIfNull(pageContainer, "PageContainer");
- return decodeImplicitMode(pageContainer, PREFIX_PARAMETER_IMPLICIT_MODE);
+ return decodeImplicitMode(pageContainer, PARAMETER_IMPLICIT_MODE);
}
public void setParameterBindingImplicitMode(PageContainer pageContainer, boolean mode) throws IllegalCoordinationException
{
ParameterValidation.throwIllegalArgExceptionIfNull(pageContainer, "PageContainer");
- setImplicitMode(pageContainer, mode, PREFIX_PARAMETER_IMPLICIT_MODE);
+ setImplicitMode(pageContainer, mode, PARAMETER_IMPLICIT_MODE);
}
public Boolean resolveParameterBindingImplicitModeEnabled(PageContainer pageContainer)
{
ParameterValidation.throwIllegalArgExceptionIfNull(pageContainer, "PageContainer");
- return resolveImplicitMode(pageContainer, PREFIX_PARAMETER_IMPLICIT_MODE);
+ return resolveImplicitMode(pageContainer, PARAMETER_IMPLICIT_MODE);
}
public void removeParameterBindingImplicitMode(PageContainer pageContainer) throws IllegalCoordinationException
{
ParameterValidation.throwIllegalArgExceptionIfNull(pageContainer, "PageContainer");
- setImplicitMode(pageContainer, null, PREFIX_PARAMETER_IMPLICIT_MODE);
+ setImplicitMode(pageContainer, null, PARAMETER_IMPLICIT_MODE);
}
public void setAliasBinding(Page page, String aliasName, Set<QName> qnames) throws IllegalCoordinationException
@@ -599,7 +584,7 @@
throw new IllegalArgumentException("Aliased QNames set is empty!");
}
- String propName = PREFIX_PARAMETER_ALIAS_NAME + "." + aliasName;
+ String propName = PREFIX_PARAMETER_ALIAS_NAME + aliasName;
// Check if qname consist separator string
for (QName qname : qnames)
@@ -629,7 +614,7 @@
ParameterValidation.throwIllegalArgExceptionIfNull(aliasInfo, "AliasBindingInfo");
AliasInfoPOJO alias = (AliasInfoPOJO)aliasInfo;
- String propName = PREFIX_PARAMETER_ALIAS_NAME + "." + aliasInfo.getName();
+ String propName = PREFIX_PARAMETER_ALIAS_NAME + aliasInfo.getName();
if (alias.getPage().getProperties().keySet().contains(propName))
{
alias.getPage().setDeclaredProperty(propName, null);
@@ -653,7 +638,7 @@
{
if (propertyName.startsWith(PREFIX_PARAMETER_ALIAS_NAME))
{
- String aliasName = propertyName.substring(PREFIX_PARAMETER_ALIAS_NAME.length() + 1);
+ String aliasName = propertyName.substring(PREFIX_PARAMETER_ALIAS_LENGTH);
AliasInfoPOJO info = new AliasInfoPOJO(aliasName, page);
String qnameList = page.getProperty(propertyName);
String[] qnames = qnameList.split(QNAME_SEPARATOR);
@@ -719,7 +704,7 @@
{
if (propName.startsWith(PREFIX_PARAMETER_BINDING))
{
- String pn = propName.substring(PREFIX_PARAMETER_BINDING.length() + 1);
+ String pn = propName.substring(PREFIX_PARAMETER_BINDING_LENGTH);
WindowInfoPOJO info;
if (!params.keySet().contains(pn))
{
More information about the portal-commits
mailing list