rhq-commits September 2012

rhq-commits@lists.fedorahosted.org

10 participants
178 discussions

[rhq] Branch 'rhq-on-as7' - modules/enterprise
by mazz 13 Sep '12

13 Sep '12

modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/inventory/resource/ResourceLineageRenderer.java | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) New commits: commit 5f2a82eca40df0a3bc024ac9aef097fe02313ebd Author: John Mazzitelli <mazz(a)redhat.com> Date: Thu Sep 13 13:28:35 2012 -0400 this was blowing up startup. not even sure if this renderer is used anymore, but lazily look up this slsb to avoid the startup error diff --git a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/inventory/resource/ResourceLineageRenderer.java b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/inventory/resource/ResourceLineageRenderer.java index 73903a5..8ce1424 100644 --- a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/inventory/resource/ResourceLineageRenderer.java +++ b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/inventory/resource/ResourceLineageRenderer.java @@ -40,8 +40,6 @@ import org.rhq.enterprise.server.util.LookupUtil; public class ResourceLineageRenderer extends Renderer { private static final String SEPARATOR = " > "; - private ResourceManagerLocal resourceManager = LookupUtil.getResourceManager(); - /** * Encode the beginning of the given {@link ResourceLineageComponent}. * @@ -53,7 +51,8 @@ public class ResourceLineageRenderer extends Renderer { ResourceLineageComponent resourceLineage = (ResourceLineageComponent) component; ResponseWriter writer = facesContext.getResponseWriter(); long monitorId = HibernatePerformanceMonitor.get().start(); - List<Resource> ancestorResources = this.resourceManager.getResourceLineage(resourceLineage.getResourceId()); + ResourceManagerLocal resourceManager = LookupUtil.getResourceManager(); + List<Resource> ancestorResources = resourceManager.getResourceLineage(resourceLineage.getResourceId()); HibernatePerformanceMonitor.get().stop(monitorId, "ResourceLineage renderer"); if (ancestorResources.isEmpty()) { throw new IllegalStateException(

1 0

[rhq] Branch 'rhq-on-as7' - modules/enterprise
by mazz 13 Sep '12

13 Sep '12

modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SubjectGWTServiceImpl.java | 11 modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/authentication/LogoutAction.java | 3 modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/SessionCacheListener.java | 22 + modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesBase.java | 13 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCache.java | 139 -------- modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCacheBean.java | 171 ++++++++++ modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCacheLocal.java | 38 ++ modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java | 36 +- modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java | 31 - modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java | 8 10 files changed, 287 insertions(+), 185 deletions(-) New commits: commit b19c778b7fae320ed14a155602556d083af782c0 Author: John Mazzitelli <mazz(a)redhat.com> Date: Thu Sep 13 12:03:20 2012 -0400 fix subject preference cache - making it a ejb singleton also made ShutdownListener a ejb singleton with PreDestroy method diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SubjectGWTServiceImpl.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SubjectGWTServiceImpl.java index bbdd102..52cae1d 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SubjectGWTServiceImpl.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SubjectGWTServiceImpl.java @@ -28,7 +28,7 @@ import org.rhq.core.domain.util.PageList; import org.rhq.enterprise.gui.coregui.client.gwt.SubjectGWTService; import org.rhq.enterprise.gui.coregui.server.util.SerialUtility; import org.rhq.enterprise.server.auth.SubjectManagerLocal; -import org.rhq.enterprise.server.auth.prefs.SubjectPreferencesCache; +import org.rhq.enterprise.server.auth.prefs.SubjectPreferencesCacheLocal; import org.rhq.enterprise.server.exception.LoginException; import org.rhq.enterprise.server.util.LookupUtil; @@ -40,6 +40,7 @@ public class SubjectGWTServiceImpl extends AbstractGWTServiceImpl implements Sub private static final long serialVersionUID = 1L; private SubjectManagerLocal subjectManager = LookupUtil.getSubjectManager(); + private SubjectPreferencesCacheLocal prefsCache = LookupUtil.getSubjectPreferencesCache(); private Object subjectLock = new Object(); // used to lock out concurrent subject updates public void createPrincipal(String username, String password) throws RuntimeException { @@ -106,7 +107,7 @@ public class SubjectGWTServiceImpl extends AbstractGWTServiceImpl implements Sub Subject subject = SerialUtility.prepare(modifiedSubject, "SubjectManager.updateSubjectPW"); // Clear the prefs for this subject from the user prefs cache that portal-war uses, in case we just // changed any prefs; otherwise the cache would contain stale prefs. - SubjectPreferencesCache.getInstance().clearConfiguration(subject.getId()); + LookupUtil.getSubjectPreferencesCache().clearConfiguration(subject.getId()); return subject; } catch (Throwable t) { throw getExceptionToThrowToClient(t); @@ -170,8 +171,8 @@ public class SubjectGWTServiceImpl extends AbstractGWTServiceImpl implements Sub subjectToModify = subjectManager.getSubjectById(subjectToModify.getId()); subjectToModify.setUserConfiguration(prefs); } - - Configuration persistedPrefs = SubjectPreferencesCache.getInstance().getPreferences(subjectToModify.getId()); + + Configuration persistedPrefs = prefsCache.getPreferences(subjectToModify.getId()); if (updatePrefs && changedPrefs != null) { Configuration userPrefs = subjectToModify.getUserConfiguration(); @@ -191,7 +192,7 @@ public class SubjectGWTServiceImpl extends AbstractGWTServiceImpl implements Sub if (updatePrefs) { //clear the prefs cache so that JSF UI refreshes it - SubjectPreferencesCache.getInstance().clearConfiguration(subjectToModify.getId()); + prefsCache.clearConfiguration(subjectToModify.getId()); } } diff --git a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/authentication/LogoutAction.java b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/authentication/LogoutAction.java index b86acae..1a0cfd5 100644 --- a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/authentication/LogoutAction.java +++ b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/authentication/LogoutAction.java @@ -37,7 +37,6 @@ import org.rhq.enterprise.gui.legacy.WebUser; import org.rhq.enterprise.gui.legacy.util.RequestUtils; import org.rhq.enterprise.gui.legacy.util.SessionUtils; import org.rhq.enterprise.server.auth.SubjectManagerLocal; -import org.rhq.enterprise.server.auth.prefs.SubjectPreferencesCache; import org.rhq.enterprise.server.util.LookupUtil; public class LogoutAction extends Action { @@ -72,7 +71,7 @@ public class LogoutAction extends Action { if (webUser != null) { Subject subject = webUser.getSubject(); if (subject != null) { - SubjectPreferencesCache.getInstance().clearConfiguration(subject.getId()); + LookupUtil.getSubjectPreferencesCache().clearConfiguration(subject.getId()); } } } diff --git a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/SessionCacheListener.java b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/SessionCacheListener.java index faa8873..caa58b5 100644 --- a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/SessionCacheListener.java +++ b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/SessionCacheListener.java @@ -1,3 +1,21 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ package org.rhq.enterprise.gui.startup; import javax.servlet.http.HttpSessionEvent; @@ -6,7 +24,7 @@ import javax.servlet.http.HttpSessionListener; import org.rhq.core.domain.auth.Subject; import org.rhq.enterprise.gui.legacy.WebUser; import org.rhq.enterprise.gui.legacy.util.SessionUtils; -import org.rhq.enterprise.server.auth.prefs.SubjectPreferencesCache; +import org.rhq.enterprise.server.util.LookupUtil; public class SessionCacheListener implements HttpSessionListener { @@ -19,7 +37,7 @@ public class SessionCacheListener implements HttpSessionListener { if (webUser != null) { Subject subject = webUser.getSubject(); if (subject != null) { - SubjectPreferencesCache.getInstance().clearConfiguration(subject.getId()); + LookupUtil.getSubjectPreferencesCache().clearConfiguration(subject.getId()); } } } diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesBase.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesBase.java index 5b1b980..e8ef7c3 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesBase.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesBase.java @@ -1,6 +1,6 @@ /* * RHQ Management Platform - * Copyright (C) 2005-2008 Red Hat, Inc. + * Copyright (C) 2005-2012 Red Hat, Inc. * All rights reserved. * * This program is free software; you can redistribute it and/or modify @@ -20,9 +20,7 @@ package org.rhq.enterprise.server.auth.prefs; import java.lang.reflect.Method; import java.util.ArrayList; -import java.util.HashSet; import java.util.List; -import java.util.Set; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; @@ -30,6 +28,7 @@ import org.apache.commons.logging.LogFactory; import org.rhq.core.domain.auth.Subject; import org.rhq.core.domain.configuration.PropertySimple; import org.rhq.core.util.StringUtil; +import org.rhq.enterprise.server.util.LookupUtil; public abstract class SubjectPreferencesBase { @@ -41,11 +40,9 @@ public abstract class SubjectPreferencesBase { protected static final String PREF_ITEM_DELIM_REGEX = "\\|"; private int subjectId; - private Set<String> changed; public SubjectPreferencesBase(Subject subject) { this.subjectId = subject.getId(); - this.changed = new HashSet<String>(); } /** @@ -117,7 +114,7 @@ public abstract class SubjectPreferencesBase { } protected String getPreference(String key) throws IllegalArgumentException { - PropertySimple prop = SubjectPreferencesCache.getInstance().getUserProperty(subjectId, key); + PropertySimple prop = LookupUtil.getSubjectPreferencesCache().getUserProperty(subjectId, key); if (prop == null) { if (this.subjectId == 0) { @@ -239,10 +236,10 @@ public abstract class SubjectPreferencesBase { val = value.toString(); } - SubjectPreferencesCache.getInstance().setUserProperty(subjectId, key, val); + LookupUtil.getSubjectPreferencesCache().setUserProperty(subjectId, key, val); } protected void unsetPreference(String key) { - SubjectPreferencesCache.getInstance().unsetUserProperty(subjectId, key); + LookupUtil.getSubjectPreferencesCache().unsetUserProperty(subjectId, key); } } diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCache.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCache.java deleted file mode 100644 index d88bd85..0000000 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCache.java +++ /dev/null @@ -1,139 +0,0 @@ -package org.rhq.enterprise.server.auth.prefs; - -import java.util.HashMap; -import java.util.Map; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -import org.rhq.core.domain.auth.Subject; -import org.rhq.core.domain.configuration.Configuration; -import org.rhq.core.domain.configuration.Property; -import org.rhq.core.domain.configuration.PropertySimple; -import org.rhq.enterprise.server.auth.SubjectManagerLocal; -import org.rhq.enterprise.server.common.EntityManagerFacadeLocal; -import org.rhq.enterprise.server.configuration.ConfigurationManagerLocal; -import org.rhq.enterprise.server.util.LookupUtil; - -public class SubjectPreferencesCache { - - protected final Log log = LogFactory.getLog(SubjectPreferencesCache.class); - - private Map<Integer, Configuration> subjectPreferences; - - private static final SubjectPreferencesCache instance = new SubjectPreferencesCache(); - - private SubjectManagerLocal subjectManager; - private EntityManagerFacadeLocal entityManagerFacade; - private ConfigurationManagerLocal configurationManager; - - private SubjectPreferencesCache() { - subjectPreferences = new HashMap<Integer, Configuration>(); - subjectManager = LookupUtil.getSubjectManager(); - entityManagerFacade = LookupUtil.getEntityManagerFacade(); - configurationManager = LookupUtil.getConfigurationManager(); - } - - public static SubjectPreferencesCache getInstance() { - return instance; - } - - private void load(int subjectId) { - // if subject ID is 0, it probably means this is a new LDAP user that needs to be registered - if (subjectId != 0 && !subjectPreferences.containsKey(subjectId)) { - try { - Subject subject = subjectManager.loadUserConfiguration(subjectId); - Configuration configuration = subject.getUserConfiguration(); - subjectPreferences.put(subjectId, configuration); - } catch (Throwable t) { - log.warn("Can not get preferences for subject[id=" + subjectId + "], subject does not exist yet"); - } - } - } - - public synchronized PropertySimple getUserProperty(int subjectId, String propertyName) { - load(subjectId); - - Configuration config = subjectPreferences.get(subjectId); - if (config == null) { - return null; - } - - PropertySimple prop = config.getSimple(propertyName); - if (prop == null) { - return null; - } - - return new PropertySimple(propertyName, prop.getStringValue()); - } - - public synchronized void setUserProperty(int subjectId, String propertyName, String value) { - load(subjectId); - - Configuration config = subjectPreferences.get(subjectId); - if (config == null) { - return; - } - - PropertySimple prop = config.getSimple(propertyName); - if (prop == null) { - prop = new PropertySimple(propertyName, value); - config.put(prop); // add new to collection - mergeProperty(prop); - } else if (prop.getStringValue() == null || !prop.getStringValue().equals(value)) { - prop.setStringValue(value); - mergeProperty(prop); - } - } - - private void mergeProperty(PropertySimple prop) { - // merge will persist if property doesn't exist (i.e., id = 0) - PropertySimple mergedProperty = entityManagerFacade.merge(prop); // only merge changes - if (prop.getId() == 0) { - // so subsequent merges do not continue re-persisting property as new - prop.setId(mergedProperty.getId()); - } - } - - public synchronized void unsetUserProperty(int subjectId, String propertyName) { - load(subjectId); - - Configuration config = subjectPreferences.get(subjectId); - if (config == null) { - return; - } - - Property property = config.remove(propertyName); - // it's possible property was already removed, and thus this operation becomes a no-op to the backing store - if (property != null && property.getId() != 0) { - try { - configurationManager.deleteProperties(new int[] { property.getId() }); - } catch (Throwable t) { - log.error("Could not remove " + property, t); - } - } - } - - /** - * @param subjectId the subject to get preferences of - * @return the COPY of the configuration object - changes done to that instance will not be reflected in the persisted - * preferences - */ - public synchronized Configuration getPreferences(int subjectId) { - load(subjectId); - - Configuration config = subjectPreferences.get(subjectId); - if (config == null) { - return new Configuration(); - } else { - return config.deepCopy(); - } - } - - public synchronized void clearConfiguration(int subjectId) { - if (log.isTraceEnabled()) { - log.trace("Removing PreferencesCache For " + subjectId); - } - subjectPreferences.remove(subjectId); - } -} diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCacheBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCacheBean.java new file mode 100644 index 0000000..d196d07 --- /dev/null +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCacheBean.java @@ -0,0 +1,171 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ +package org.rhq.enterprise.server.auth.prefs; + +import java.util.HashMap; +import java.util.Map; + +import javax.ejb.ConcurrencyManagement; +import javax.ejb.ConcurrencyManagementType; +import javax.ejb.EJB; +import javax.ejb.Lock; +import javax.ejb.LockType; +import javax.ejb.Singleton; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import org.rhq.core.domain.auth.Subject; +import org.rhq.core.domain.configuration.Configuration; +import org.rhq.core.domain.configuration.Property; +import org.rhq.core.domain.configuration.PropertySimple; +import org.rhq.enterprise.server.auth.SubjectManagerLocal; +import org.rhq.enterprise.server.common.EntityManagerFacadeLocal; +import org.rhq.enterprise.server.configuration.ConfigurationManagerLocal; + +(a)ConcurrencyManagement(ConcurrencyManagementType.CONTAINER) +@Singleton +public class SubjectPreferencesCacheBean implements SubjectPreferencesCacheLocal { + + protected final Log log = LogFactory.getLog(SubjectPreferencesCacheBean.class); + + private Map<Integer, Configuration> subjectPreferences; + + @EJB + private SubjectManagerLocal subjectManager; + + @EJB + private EntityManagerFacadeLocal entityManagerFacade; + + @EJB + private ConfigurationManagerLocal configurationManager; + + private SubjectPreferencesCacheBean() { + subjectPreferences = new HashMap<Integer, Configuration>(); + } + + private void load(int subjectId) { + // if subject ID is 0, it probably means this is a new LDAP user that needs to be registered + if (subjectId != 0 && !subjectPreferences.containsKey(subjectId)) { + try { + Subject subject = subjectManager.loadUserConfiguration(subjectId); + Configuration configuration = subject.getUserConfiguration(); + subjectPreferences.put(subjectId, configuration); + } catch (Throwable t) { + log.warn("Can not get preferences for subject[id=" + subjectId + "], subject does not exist yet"); + } + } + } + + @Override + @Lock(LockType.READ) + public PropertySimple getUserProperty(int subjectId, String propertyName) { + load(subjectId); + + Configuration config = subjectPreferences.get(subjectId); + if (config == null) { + return null; + } + + PropertySimple prop = config.getSimple(propertyName); + if (prop == null) { + return null; + } + + return new PropertySimple(propertyName, prop.getStringValue()); + } + + @Override + @Lock(LockType.WRITE) + public void setUserProperty(int subjectId, String propertyName, String value) { + load(subjectId); + + Configuration config = subjectPreferences.get(subjectId); + if (config == null) { + return; + } + + PropertySimple prop = config.getSimple(propertyName); + if (prop == null) { + prop = new PropertySimple(propertyName, value); + config.put(prop); // add new to collection + mergeProperty(prop); + } else if (prop.getStringValue() == null || !prop.getStringValue().equals(value)) { + prop.setStringValue(value); + mergeProperty(prop); + } + } + + private void mergeProperty(PropertySimple prop) { + // merge will persist if property doesn't exist (i.e., id = 0) + PropertySimple mergedProperty = entityManagerFacade.merge(prop); // only merge changes + if (prop.getId() == 0) { + // so subsequent merges do not continue re-persisting property as new + prop.setId(mergedProperty.getId()); + } + } + + @Override + @Lock(LockType.WRITE) + public void unsetUserProperty(int subjectId, String propertyName) { + load(subjectId); + + Configuration config = subjectPreferences.get(subjectId); + if (config == null) { + return; + } + + Property property = config.remove(propertyName); + // it's possible property was already removed, and thus this operation becomes a no-op to the backing store + if (property != null && property.getId() != 0) { + try { + configurationManager.deleteProperties(new int[] { property.getId() }); + } catch (Throwable t) { + log.error("Could not remove " + property, t); + } + } + } + + /** + * @param subjectId the subject to get preferences of + * @return the COPY of the configuration object - changes done to that instance will not be reflected in the persisted + * preferences + */ + @Override + @Lock(LockType.READ) + public Configuration getPreferences(int subjectId) { + load(subjectId); + + Configuration config = subjectPreferences.get(subjectId); + if (config == null) { + return new Configuration(); + } else { + return config.deepCopy(); + } + } + + @Override + @Lock(LockType.WRITE) + public void clearConfiguration(int subjectId) { + if (log.isTraceEnabled()) { + log.trace("Removing PreferencesCache For " + subjectId); + } + subjectPreferences.remove(subjectId); + } +} diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCacheLocal.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCacheLocal.java new file mode 100644 index 0000000..73e82e7 --- /dev/null +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/auth/prefs/SubjectPreferencesCacheLocal.java @@ -0,0 +1,38 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ +package org.rhq.enterprise.server.auth.prefs; + +import javax.ejb.Local; + +import org.rhq.core.domain.configuration.Configuration; +import org.rhq.core.domain.configuration.PropertySimple; + +@Local +public interface SubjectPreferencesCacheLocal { + + PropertySimple getUserProperty(int subjectId, String propertyName); + + void setUserProperty(int subjectId, String propertyName, String value); + + void unsetUserProperty(int subjectId, String propertyName); + + Configuration getPreferences(int subjectId); + + void clearConfiguration(int subjectId); +} \ No newline at end of file diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java index 5194fb6..f8dca66 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java @@ -23,9 +23,10 @@ import java.sql.SQLException; import java.sql.Statement; import javax.annotation.PreDestroy; +import javax.annotation.Resource; +import javax.ejb.EJB; import javax.ejb.Singleton; import javax.ejb.Startup; -import javax.management.Notification; import javax.sql.DataSource; import org.apache.commons.logging.Log; @@ -34,7 +35,10 @@ import org.apache.commons.logging.LogFactory; import org.rhq.core.domain.cloud.Server; import org.rhq.core.domain.cloud.Server.OperationMode; import org.rhq.core.util.jdbc.JDBCUtil; -import org.rhq.enterprise.server.util.LookupUtil; +import org.rhq.enterprise.server.RHQConstants; +import org.rhq.enterprise.server.cloud.CloudManagerLocal; +import org.rhq.enterprise.server.cloud.instance.ServerManagerLocal; +import org.rhq.enterprise.server.scheduler.SchedulerLocal; /** * This listens for the RHQ server's shutdown notification and when it hears it, will start shutting down RHQ components @@ -47,13 +51,22 @@ import org.rhq.enterprise.server.util.LookupUtil; @Singleton @Startup public class ShutdownListener { - /** - * Logger - */ private final Log log = LogFactory.getLog(ShutdownListener.class); private final String RHQ_DB_TYPE_MAPPING_PROPERTY = "rhq.server.database.type-mapping"; + @EJB + private SchedulerLocal schedulerBean; + + @EJB + private ServerManagerLocal serverManager; + + @EJB + private CloudManagerLocal cloudManager; + + @Resource(name = "RHQ_DS", mappedName = RHQConstants.DATASOURCE_JNDI_NAME) + private DataSource dataSource; + /** * This is called when the shutdown notification is received from the JBoss server. This gives a chance for us to * cleanly shutdown our application in an orderly fashion. @@ -61,12 +74,14 @@ public class ShutdownListener { * @see javax.management.NotificationListener#handleNotification(Notification, Object) */ @PreDestroy - public void handleNotification(Notification notification, Object handback) { + public void handleNotification() { // JBossAS 4.2.3 used to send us this JMX notification on shutdown - AS7 does not have shutdown notifications. // So we are using the @PreDestroy mechanism on a singleton EJB to attempt to clean up the application before it is shutdown + log.info("Shutdown listener has been told we are shutting down - starting to clean up now..."); stopScheduler(); updateServerOperationMode(); stopEmbeddedDatabase(); + log.info("Shutdown listener completed its shutdown tasks. It is safe to shutdown now."); } /** @@ -75,7 +90,7 @@ public class ShutdownListener { private void stopScheduler() { try { log.info("Shutting down the scheduler gracefully - currently running jobs will be allowed to finish..."); - LookupUtil.getSchedulerBean().shutdown(true); + schedulerBean.shutdown(true); log.info("The scheduler has been shutdown and all jobs are done."); } catch (Throwable t) { // only show ugly stack traces if the user runs the server in debug mode @@ -90,9 +105,9 @@ public class ShutdownListener { private void updateServerOperationMode() { try { // Set the server operation mode to DOWN unless in MM - Server server = LookupUtil.getServerManager().getServer(); + Server server = serverManager.getServer(); if (Server.OperationMode.MAINTENANCE != server.getOperationMode()) { - LookupUtil.getCloudManager().updateServerMode(new Integer[] { server.getId() }, OperationMode.DOWN); + cloudManager.updateServerMode(new Integer[] { server.getId() }, OperationMode.DOWN); } } catch (Throwable t) { // only show ugly stack traces if the user runs the server in debug mode @@ -113,8 +128,7 @@ public class ShutdownListener { Connection connection = null; Statement statement = null; try { - DataSource ds = LookupUtil.getDataSource(); - connection = ds.getConnection(); + connection = dataSource.getConnection(); statement = connection.createStatement(); statement.execute("shutdown"); log.info("Embedded database closed cleanly"); diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java index c5b0823..e1ef4a8 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java @@ -27,6 +27,7 @@ import java.util.List; import java.util.Properties; import javax.annotation.PostConstruct; +import javax.annotation.Resource; import javax.ejb.EJB; import javax.ejb.Singleton; import javax.ejb.Startup; @@ -49,10 +50,10 @@ import org.rhq.core.domain.resource.Agent; import org.rhq.core.util.ObjectNameFactory; import org.rhq.enterprise.communications.ServiceContainerConfigurationConstants; import org.rhq.enterprise.communications.util.SecurityUtil; +import org.rhq.enterprise.server.RHQConstants; import org.rhq.enterprise.server.alert.engine.internal.AlertConditionCacheCoordinator; import org.rhq.enterprise.server.auth.SessionManager; import org.rhq.enterprise.server.auth.SubjectManagerLocal; -import org.rhq.enterprise.server.auth.prefs.SubjectPreferencesCache; import org.rhq.enterprise.server.cloud.CloudManagerLocal; import org.rhq.enterprise.server.cloud.instance.CacheConsistencyManagerLocal; import org.rhq.enterprise.server.cloud.instance.ServerManagerLocal; @@ -84,6 +85,8 @@ import org.rhq.enterprise.server.util.concurrent.AvailabilityReportSerializer; * This startup singleton EJB performs the rest of the RHQ Server startup initialization. * In order for it to do its work properly, we must ensure everything has been deployed and started; * specifically, all EJBs must have been deployed and available. + * + * This bean is not meant for client consumption - it is only for startup initialization. */ @Singleton @Startup @@ -116,6 +119,9 @@ public class StartupBean { @EJB private SubjectManagerLocal subjectManager; + @Resource(name = "RHQ_DS", mappedName = RHQConstants.DATASOURCE_JNDI_NAME) + private DataSource dataSource; + /** * Performs the final RHQ Server initialization work that needs to talk place. EJBs are available in this method. * @@ -133,7 +139,6 @@ public class StartupBean { // get singletons right now so we load the classes immediately into our classloader AlertConditionCacheCoordinator.getInstance(); SessionManager.getInstance(); - SubjectPreferencesCache.getInstance(); AlertSerializer.getSingleton(); AvailabilityReportSerializer.getSingleton(); @@ -179,8 +184,7 @@ public class StartupBean { // Ensure the class is loaded and the dbType is set for our current db Connection conn = null; try { - DataSource ds = LookupUtil.getDataSource(); - conn = ds.getConnection(); + conn = dataSource.getConnection(); DatabaseTypeFactory.setDefaultDatabaseType(DatabaseTypeFactory.getDatabaseType(conn)); } catch (Exception e) { log.error("Could not initialize server.", e); @@ -683,24 +687,17 @@ public class StartupBean { } /** - * Registers a listener to the JBoss server's shutdown notification so some components can be cleaned up in an + * Registers a listener to the system shutdown notification so some components can be cleaned up in an * orderly fashion when the server is shutdown. * - * @throws RuntimeException if cannot register this service as a shutdown listener + * @throws RuntimeException if cannot register a shutdown listener */ private void registerShutdownListener() throws RuntimeException { // as of JBossAS 4.0.5, this is the known MBean name of the service that notifies when the server is shutting down - // TODO: find out how AS7 can notify us when its going down - right now, this code won't work on AS7 - /* - try { - ObjectName jbossServerName = new ObjectName("jboss.system:type=Server"); - MBeanServer jbossServer = ManagementFactory.getPlatformMBeanServer(); - jbossServer.addNotificationListener(jbossServerName, new ShutdownListener(), null, null); - } catch (Exception e) { - throw new RuntimeException("Failed to register the Server Shutdown Listener", e); - } - */ - log.warn("!!! TODO: REGISTER OUR SHUTDOWN LISTENER!!!"); + // AS7 today does not have notifications like this. So we have a new EJB singleton ShutdownListener with a PreDestroy method. + // If that doesn't work, we can try to create a system shutdown hook in here. Thus I'm leaving this method in here in case + // we need it later. Just add a Runtime.addShutdownHook call in here that calls our ShutdownListener. + return; } /** diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java index 313f295..183fc3e 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java @@ -53,6 +53,8 @@ import org.rhq.enterprise.server.alert.engine.jms.CachedConditionProducerBean; import org.rhq.enterprise.server.alert.engine.jms.CachedConditionProducerLocal; import org.rhq.enterprise.server.auth.SubjectManagerBean; import org.rhq.enterprise.server.auth.SubjectManagerLocal; +import org.rhq.enterprise.server.auth.prefs.SubjectPreferencesCacheBean; +import org.rhq.enterprise.server.auth.prefs.SubjectPreferencesCacheLocal; import org.rhq.enterprise.server.authz.AuthorizationManagerBean; import org.rhq.enterprise.server.authz.AuthorizationManagerLocal; import org.rhq.enterprise.server.authz.RoleManagerBean; @@ -604,7 +606,11 @@ public final class LookupUtil { public static PlatformUtilizationManagerLocal getPlatformUtilizationManager() { return lookupLocal(PlatformUtilizationManagerBean.class); } - + + public static SubjectPreferencesCacheLocal getSubjectPreferencesCache() { + return lookupLocal(SubjectPreferencesCacheBean.class); + } + public static CoreServerMBean getCoreServer() { CoreServerMBean rhqServer; try {

1 0

[rhq] Branch 'rhq-on-as7' - modules/enterprise
by mazz 13 Sep '12

13 Sep '12

1 0

[rhq] 2 commits - modules/core modules/enterprise modules/plugins pom.xml
by lkrejci 13 Sep '12

13 Sep '12

modules/core/domain/pom.xml | 1 modules/core/native-system/pom.xml | 4 modules/core/plugin-api/pom.xml | 4 modules/core/util/pom.xml | 5 + modules/enterprise/scripting/api/pom.xml | 4 modules/enterprise/server/jar/pom.xml | 26 ++++++ modules/plugins/augeas/pom.xml | 2 modules/plugins/database/pom.xml | 5 + modules/plugins/jboss-as-5/pom.xml | 3 modules/plugins/jboss-as-7/pom.xml | 2 modules/plugins/jboss-as/pom.xml | 5 + modules/plugins/jmx/pom.xml | 8 + pom.xml | 129 +++++++++++++++++++++++++++---- 13 files changed, 179 insertions(+), 19 deletions(-) New commits: commit d30f869055c15e1f5539d91dddc4b14d224cf490 Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Thu Aug 16 14:41:27 2012 +0200 [BZ 803737] - adding the core/native-system module to the API checks. diff --git a/modules/core/native-system/pom.xml b/modules/core/native-system/pom.xml index 82cd33a..934b13f 100644 --- a/modules/core/native-system/pom.xml +++ b/modules/core/native-system/pom.xml @@ -17,6 +17,10 @@ <description> Java API that wraps the native library used to access low-level system resources natively. </description> + + <properties> + <rhq.internal>false</rhq.internal> + </properties> <dependencies> commit cc51a3cb86e68c5ef4e56bf1a2972c6f5c1a70db Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Mon Aug 13 17:29:47 2012 +0200 [BZ 803737] - API checks based on clirr plugin diff --git a/modules/core/domain/pom.xml b/modules/core/domain/pom.xml index 64ffe1c..8061224 100644 --- a/modules/core/domain/pom.xml +++ b/modules/core/domain/pom.xml @@ -17,6 +17,7 @@ <properties>  <jboss-embeddable-ejb3.version>1.0.0.Alpha9</jboss-embeddable-ejb3.version> + <rhq.internal>false</rhq.internal> </properties> diff --git a/modules/core/plugin-api/pom.xml b/modules/core/plugin-api/pom.xml index 5ba5465..556a182 100644 --- a/modules/core/plugin-api/pom.xml +++ b/modules/core/plugin-api/pom.xml @@ -15,6 +15,10 @@ <name>RHQ Plugin API</name> <description>RHQ Plugin API used to write custom plugins</description> + <properties> + <rhq.internal>false</rhq.internal> + </properties> + <dependencies>  diff --git a/modules/core/util/pom.xml b/modules/core/util/pom.xml index 2737ce3..9045533 100644 --- a/modules/core/util/pom.xml +++ b/modules/core/util/pom.xml @@ -14,6 +14,10 @@ <name>RHQ Utilities</name> <description>generic utility classes for use by any RHQ module</description> + <properties> + <rhq.internal>false</rhq.internal> + </properties> + <dependencies>  @@ -130,6 +134,7 @@ </plugins> </build> </profile> + <profile> <id>cobertura</id> <activation> diff --git a/modules/enterprise/scripting/api/pom.xml b/modules/enterprise/scripting/api/pom.xml index b3d036b..0bdc28b 100644 --- a/modules/enterprise/scripting/api/pom.xml +++ b/modules/enterprise/scripting/api/pom.xml @@ -10,6 +10,10 @@ <name>RHQ Scripting API</name> <description>Provides API for adding scripting support to RHQ using different javax.scripting - based interpreters</description> + <properties> + <rhq.internal>false</rhq.internal> + </properties> + <build> <plugins> <plugin> diff --git a/modules/enterprise/server/jar/pom.xml b/modules/enterprise/server/jar/pom.xml index aa0aad3..c567be7 100644 --- a/modules/enterprise/server/jar/pom.xml +++ b/modules/enterprise/server/jar/pom.xml @@ -24,6 +24,8 @@ <jboss-embeddable-ejb3.version>1.0.0.Alpha9</jboss-embeddable-ejb3.version> <clean.db>true</clean.db> + + <rhq.internal>false</rhq.internal> </properties> <dependencies> @@ -903,6 +905,16 @@ </configuration> </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>clirr-maven-plugin</artifactId> + <configuration> + <includes> + <include>**/*Remote</include> + <include>**/ServerVersion</include> + </includes> + </configuration> + </plugin> </plugins> </build> @@ -1210,4 +1222,18 @@ </profile> </profiles> + <reporting> + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>clirr-maven-plugin</artifactId> + <configuration> + <includes> + <include>**/*Remote</include> + <include>**/ServerVersion</include> + </includes> + </configuration> + </plugin> + </plugins> + </reporting> </project> diff --git a/modules/plugins/augeas/pom.xml b/modules/plugins/augeas/pom.xml index b770b07..ce670b8 100644 --- a/modules/plugins/augeas/pom.xml +++ b/modules/plugins/augeas/pom.xml @@ -19,6 +19,7 @@ <properties> <augeas-bindings.version>0.0.2</augeas-bindings.version> + <rhq.internal>false</rhq.internal> </properties> <dependencies> @@ -208,7 +209,6 @@ </build> </profile> - <profile> <id>cobertura-plugins</id> <activation> diff --git a/modules/plugins/database/pom.xml b/modules/plugins/database/pom.xml index 24d0e1c..7305db5 100644 --- a/modules/plugins/database/pom.xml +++ b/modules/plugins/database/pom.xml @@ -15,6 +15,10 @@ <name>RHQ Database Plugin</name> <description>An abstract plugin for managing databases via JDBC</description> + <properties> + <rhq.internal>false</rhq.internal> + </properties> + <dependencies> <dependency> <groupId>com.h2database</groupId> @@ -98,6 +102,7 @@ </plugins> </build> </profile> + <profile> <id>cobertura-plugins</id> <activation> diff --git a/modules/plugins/jboss-as-5/pom.xml b/modules/plugins/jboss-as-5/pom.xml index 8ca5f8a..5cc08b5 100644 --- a/modules/plugins/jboss-as-5/pom.xml +++ b/modules/plugins/jboss-as-5/pom.xml @@ -23,6 +23,7 @@ <jbossas.version>6.0.0.M1</jbossas.version> <as5.version>6.1.0.Final</as5.version> <as5.url>http://download.jboss.org/jbossas/6.1/jboss-as-distribution-6.1.0.Final.zip</as5.url> + <rhq.internal>false</rhq.internal> </properties> <dependencyManagement> @@ -659,7 +660,7 @@ </plugins> </build> </profile> - + <profile> <id>cobertura-plugins</id> <activation> diff --git a/modules/plugins/jboss-as-7/pom.xml b/modules/plugins/jboss-as-7/pom.xml index ecd2295..a02c9f3 100644 --- a/modules/plugins/jboss-as-7/pom.xml +++ b/modules/plugins/jboss-as-7/pom.xml @@ -27,6 +27,7 @@ <jboss-as-arquillian-container-managed.version>7.1.1.Final</jboss-as-arquillian-container-managed.version> <java.tieredCompilation>-Dxxx</java.tieredCompilation> <java.useCompressedOOPS>-Dxxx</java.useCompressedOOPS> + <rhq.internal>false</rhq.internal> </properties> @@ -611,6 +612,7 @@ </build> </profile> + </profiles> </project> diff --git a/modules/plugins/jboss-as/pom.xml b/modules/plugins/jboss-as/pom.xml index 866838e..13ea4ad 100644 --- a/modules/plugins/jboss-as/pom.xml +++ b/modules/plugins/jboss-as/pom.xml @@ -15,6 +15,10 @@ <name>RHQ JBossAS 3.2.x/4.x Plugin</name> <description>A plugin for managing JBoss Application Server 3.2.x/4.x</description> + <properties> + <rhq.internal>false</rhq.internal> + </properties> + <dependencies>   @@ -354,6 +358,7 @@ </plugins> </build> </profile> + <profile> <id>cobertura-plugins</id> <activation> diff --git a/modules/plugins/jmx/pom.xml b/modules/plugins/jmx/pom.xml index c38a4d0..eba28da 100644 --- a/modules/plugins/jmx/pom.xml +++ b/modules/plugins/jmx/pom.xml @@ -15,7 +15,11 @@ <name>RHQ JMX Plugin</name> <description>a plugin for managing a generic JMX-enabled application</description> - <dependencies> + <properties> + <rhq.internal>false</rhq.internal> + </properties> + + <dependencies> <dependency> <groupId>mc4j</groupId> @@ -257,7 +261,7 @@ </plugins> </build> </profile> - + <profile> <id>cobertura-plugins</id> <activation> diff --git a/pom.xml b/pom.xml index f6bd80d..7c1451e 100644 --- a/pom.xml +++ b/pom.xml @@ -111,7 +111,6 @@ <freemarker.version>2.3.18</freemarker.version> <powermock.version>1.4.11</powermock.version> <arquillian.version>1.0.1.Final</arquillian.version> - <animal.sniffer.version>1.7</animal.sniffer.version> <xercesImpl.version>2.9.1-jbossas-2</xercesImpl.version>  <rhq.db.admin.username>rhqadmin</rhq.db.admin.username> @@ -181,6 +180,17 @@ <localRepository>${user.home}/.m2/repository</localRepository> <project.json.version>20080701</project.json.version> + +  + <animal.sniffer.version>1.8</animal.sniffer.version> + <animal.sniffer.java.signature.groupId>org.codehaus.mojo.signature</animal.sniffer.java.signature.groupId> + <animal.sniffer.java.signature.artifactId>java16</animal.sniffer.java.signature.artifactId> + <animal.sniffer.java.signature.version>1.0</animal.sniffer.java.signature.version> +  + <clirr.version>2.4</clirr.version> +  + <rhq.internal>true</rhq.internal> </properties> @@ -741,7 +751,13 @@ </exclusions> </configuration> </plugin> - </plugins> + + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>clirr-maven-plugin</artifactId> + <version>${clirr.version}</version> + </plugin> + </plugins> </pluginManagement> @@ -1036,7 +1052,9 @@ <target> <property name="apidocs.dir" value="target/apidocs" /> - <copy dir="modules/core/domain/target/site/apidocs" todir="${apidocs.dir}/domain"/> + <copy todir="${apidocs.dir}/domain"> + <fileset dir="modules/core/domain/target/site/apidocs" erroronmissingdir="false"/> + </copy> </target> </configuration> <goals> @@ -1074,9 +1092,9 @@ <id>java-api-check</id> <configuration> <signature> - <groupId>org.codehaus.mojo.signature</groupId> - <artifactId>java16</artifactId> - <version>1.0</version> + <groupId>${animal.sniffer.java.signature.groupId}</groupId> + <artifactId>${animal.sniffer.java.signature.artifactId}</artifactId> + <version>${animal.sniffer.java.signature.version}</version> </signature> </configuration> <phase>process-classes</phase> @@ -1088,8 +1106,7 @@ </plugin> </plugins> - </build> - + </build> <repositories> @@ -1328,17 +1345,99 @@ </build> </profile> - </profiles> + <profile> + <id>signature-check</id> + <activation> + <property> + <name>signature-check-base-version</name> + </property> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>clirr-maven-plugin</artifactId> + <executions> + <execution> + <id>signature-check</id> + <goals> + <goal>check</goal> + </goals> + <configuration> + <comparisonArtifacts> + <comparisonArtifact> + <groupId>${project.groupId}</groupId> + <artifactId>${project.artifactId}</artifactId> + <version>${signature-check-base-version}</version> + </comparisonArtifact> + </comparisonArtifacts> + <logResults>true</logResults> + <xmlOutputFile>${project.build.directory}/${project.build.finalName}.signature-check.xml</xmlOutputFile> + <failOnError>false</failOnError> + <skip>${rhq.internal}</skip> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> + + <reporting> + <plugins> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>clirr-maven-plugin</artifactId> + <configuration> + <comparisonVersion>${signature-check-base-version}</comparisonVersion> + <comparisonArtifacts> + <comparisonArtifact> + <groupId>${project.groupId}</groupId> + <artifactId>${project.artifactId}</artifactId> + <version>${signature-check-base-version}</version> + </comparisonArtifact> + </comparisonArtifacts> + <skip>${rhq.internal}</skip> + <minSeverity>info</minSeverity> + </configuration> + </plugin> + </plugins> + </reporting> + </profile> + + <profile> + <activation> + <property> + <name>generate-dependency-graph</name> + <value>true</value> + </property> + </activation> + + <reporting> + <plugins> + <plugin> + <groupId>com.googlecode.maven-overview-plugin</groupId> + <artifactId>maven-overview-plugin</artifactId> + <configuration> + <skip>${skip.overview}</skip> + </configuration> + </plugin> + </plugins> + </reporting> + </profile> +</profiles> <reporting> <plugins> - <plugin> - <groupId>com.googlecode.maven-overview-plugin</groupId> - <artifactId>maven-overview-plugin</artifactId> - <version>RELEASE</version> - </plugin> - + <plugin> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>2.0.1</version> + <reportSets> + <reportSet> + </reportSet> + </reportSets> + </plugin> + <!-- <plugin> <artifactId>maven-javadoc-plugin</artifactId>

1 0

[rhq] 6 commits - modules/enterprise
by lkrejci 13 Sep '12

13 Sep '12

modules/enterprise/binding/src/main/java/org/rhq/bindings/script/BaseRhqSchemeScriptSourceProvider.java | 13 modules/enterprise/binding/src/main/java/org/rhq/bindings/script/RepoScriptSourceProvider.java | 14 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/admin/DownloadsView.java | 57 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/gwt/SystemGWTService.java | 10 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SystemGWTServiceImpl.java | 29 modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages.properties | 4 modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_cs.properties | 4 modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_de.properties | 4 modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ja.properties | 4 modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_pt.properties | 4 modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ru.properties | 4 modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_zh.properties | 4 modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/FileSystemScriptSourceProvider.java | 28 modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/ModulesDirectoryScriptSourceProvider.java | 49 modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/SamplesScriptSourceProvider.java | 16 modules/enterprise/remoting/cli/src/main/resources/META-INF/services/org.rhq.scripting.ScriptSourceProvider | 1 modules/enterprise/remoting/cli/src/main/samples/README.txt | 31 modules/enterprise/remoting/cli/src/main/samples/modules/bundles.js | 150 + modules/enterprise/remoting/cli/src/main/samples/modules/drift.js | 240 ++ modules/enterprise/remoting/cli/src/main/samples/modules/jbossas.js | 811 ++++++++++ modules/enterprise/remoting/cli/src/main/samples/modules/util.js | 280 +++ modules/enterprise/remoting/cli/src/main/scripts/rhq-client.build.xml | 2 modules/enterprise/remoting/client-api/pom.xml | 14 modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RemoteClient.java | 14 modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java | 31 modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java | 121 + modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/JsEngineProvider.java | 4 modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapter.java | 32 modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/EngineTest.java | 19 modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/InitializerTest.java | 4 modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapterTest.java | 117 + modules/enterprise/scripting/javascript/src/test/resources/nest.js | 9 modules/enterprise/scripting/javascript/src/test/resources/nested/deep-nest.js | 8 modules/enterprise/server/client-api/pom.xml | 17 modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java | 26 modules/enterprise/server/client-api/src/test/java/org/rhq/enterprise/client/test/RhqDownloadsScriptSourceProviderTest.java | 102 + modules/enterprise/server/container/src/main/downloadable-resources/cli-alert-scripts/fix-bundle-deployment.js | 417 ----- modules/enterprise/server/container/src/main/downloadable-resources/script-modules/bundles.js | 150 + modules/enterprise/server/container/src/main/downloadable-resources/script-modules/drift.js | 240 ++ modules/enterprise/server/container/src/main/downloadable-resources/script-modules/jbossas.js | 811 ++++++++++ modules/enterprise/server/container/src/main/downloadable-resources/script-modules/util.js | 280 +++ 41 files changed, 3683 insertions(+), 492 deletions(-) New commits: commit 96ea0adc66c658fa94ccb2ed8c2f95d14ab4c93f Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Thu Sep 13 13:08:06 2012 +0200 [BZ 852169] - Add a copy of the downloadable sample modules to the CLI samples/modules, so that they're available locally, too. Updated the wording in the README file in samples to reflect the current state of things. diff --git a/modules/enterprise/remoting/cli/src/main/samples/README.txt b/modules/enterprise/remoting/cli/src/main/samples/README.txt index 913cf62..96f0d46 100644 --- a/modules/enterprise/remoting/cli/src/main/samples/README.txt +++ b/modules/enterprise/remoting/cli/src/main/samples/README.txt @@ -6,12 +6,33 @@ have not undergone the same level of testing as other parts of the code base. As such, the quality may not meet RHQ standards in some cases. Please consider this when using these scripts for anything other than demonstration or testing. -There may be inter-dependencies between some of the scripts. There is currently -no mechanism in place to automatically handle script-level dependencies; -consequently, you need to make sure to run scripts in the correct order. If a -script has a dependency on other scripts, it will be documented within the -script itself so that you know which scripts need to be run and in what order. +There are inter-dependencies between some of the scripts. But because these +scripts are not implemented as modules but rather as examples of what +can be done, those dependencies are not expressed in code but have to be +expressed manually on the commandline of the interactive CLI as suggested by +the comments in the respective files (another reason is to keep the scripts +backwards compatible in case someone used them in previous versions of RHQ +that didn't offer CommonJS modules). +In the "modules" directory, there are sample modules that mirror many of +these sample scripts in a "modularized" form so that they are more easily +available in your scripts (if you compare the files, you will find that +the changes are fairly minor). + +The scripts in the "modules" directory are also available in the downloads +section of the RHQ server. From your scripts, they are therefore available +in at least two ways: + +1) var bundles = require("rhq://samples/modules/bundles"); +This will load the module stored locally in the samples/modules directory. + +2) var util = require("rhq://downloads/util"); +This will, as long as the CLI session is connected to an RHQ server, download +the script from the RHQ server. + +Note that the latter, i.e. the "rhq://downloads/...", is also usable in the +alert scripts that run on the RHQ server as alert notifications (unlike, +of course, the former form). Feedback -------- diff --git a/modules/enterprise/remoting/cli/src/main/samples/modules/bundles.js b/modules/enterprise/remoting/cli/src/main/samples/modules/bundles.js new file mode 100644 index 0000000..f7fbdc2 --- /dev/null +++ b/modules/enterprise/remoting/cli/src/main/samples/modules/bundles.js @@ -0,0 +1,150 @@ +/** + * file: bundles.js + * + * description: this file contains a few helper functions to make working + * with the bundle subsystem more convenient. + * + * Note that you must login before you can load the scripts. + * + * author: lkrejci(a)redhat.com + */ + +var util = require('./util'); + +/** + * A simple function to create a new bundle version from a zip file containing + * the bundle. + * + * @param pathToBundleZipFile the path to the bundle on the local file system + * + * @return an instance of BundleVersion class describing what's been created on + * the RHQ server. + */ +exports.createBundleVersion = function(pathToBundleZipFile) { + var bytes = getFileBytes(pathToBundleZipFile) + return BundleManager.createBundleVersionViaByteArray(bytes) +} + +/** + * This is a helper function that one can use to find out what base directories + * given resource type defines. + * + * These base directories then can be used when specifying bundle destinations. + * + * @param resourceTypeId + * @returns a java.util.Set of ResourceTypeBundleConfiguration objects + */ +exports.getAllBaseDirectories = function(resourceTypeId) { + var crit = new ResourceTypeCriteria; + crit.addFilterId(resourceTypeId); + crit.fetchBundleConfiguration(true); + + var types = ResourceTypeManager.findResourceTypesByCriteria(crit); + + if (types.size() == 0) { + throw "Could not find a resource type with id " + resourceTypeId; + } else if (types.size() > 1) { + throw "More than one resource type found with id " + resourceTypeId + "! How did that happen!"; + } + + var type = types.get(0); + + return type.getResourceTypeBundleConfiguration().getBundleDestinationBaseDirectories(); +} + +/** + * Creates a new destination for given bundle. Once a destination exists, + * actual bundle versions can be deployed to it. + * + * Note that this only differs from the <code>BundleManager.createBundleDestination</code> + * method in the fact that one can provide bundle and resource group names instead of their + * ids. + * + * @param destinationName the name of the destination to be created + * @param description the description for the destination + * @param bundleName the name of the bundle to create the destination for + * @param groupName name of a group of resources that the destination will handle + * @param baseDirName the name of the basedir definition that represents where inside the + * deployment of the individual resources the bundle will get deployed + * @param deployDir the specific sub directory of the base dir where the bundles will get deployed + * + * @return BundleDestination object + */ +exports.createBundleDestination = function(destinationName, description, bundleName, groupName, baseDirName, deployDir) { + var groupCrit = new ResourceGroupCriteria; + groupCrit.addFilterName(groupName); + var groups = ResourceGroupManager.findResourceGroupsByCriteria(groupCrit); + + if (groups.empty) { + throw "No group called '" + groupName + "' found."; + } + + var group = groups.get(0); + + var bundleCrit = new BundleCriteria; + bundleCrit.addFilterName(bundleName); + var bundles = BundleManager.findBundlesByCriteria(bundleCrit); + + if (bundles.empty) { + throw "No bundle called '" + bundleName + "' found."; + } + + var bundle = bundles.get(0); + + return BundleManager.createBundleDestination(bundle.id, destinationName, description, baseDirName, deployDir, group.id); +} + +/** + * Tries to deploy given bundle version to provided destination using given configuration. + * + * This method blocks while waiting for the deployment to complete or fail. + * + * @param destination the bundle destination (or id thereof) + * @param bundleVersion the bundle version to deploy (or id thereof) + * @param deploymentConfiguration the deployment configuration. This can be an ordinary + * javascript object (hash) or an instance of RHQ's Configuration. If it is the former, + * it is converted to a Configuration instance using the <code>asConfiguration</code> + * function from <code>util.js</code>. Please consult the documentation of that method + * to understand the limitations of that approach. + * @param description the deployment description + * @param isCleanDeployment if true, perform a wipe of the deploy directory prior to the deployment; if false, + * perform as an upgrade to the existing deployment, if any + * + * @return the BundleDeployment instance describing the deployment + */ +exports.deployBundle = function(destination, bundleVersion, deploymentConfiguration, description, isCleanDeployment) { + var destinationId = destination; + if (typeof(destination) == 'object') { + destinationId = destination.id; + } + + var bundleVersionId = bundleVersion; + if (typeof(bundleVersion) == 'object') { + bundleVersionId = bundleVersion.id; + } + + var deploymentConfig = deploymentConfiguration; + if (!(deploymentConfiguration instanceof Configuration)) { + deploymentConfig = util.asConfiguration(deploymentConfiguration); + } + + var deployment = BundleManager.createBundleDeployment(bundleVersionId, destinationId, description, deploymentConfig); + + deployment = BundleManager.scheduleBundleDeployment(deployment.id, isCleanDeployment); + + var crit = new BundleDeploymentCriteria; + crit.addFilterId(deployment.id); + + while (deployment.status == BundleDeploymentStatus.PENDING || deployment.status == BundleDeploymentStatus.IN_PROGRESS) { + java.lang.Thread.currentThread().sleep(1000); + var dps = BundleManager.findBundleDeploymentsByCriteria(crit); + if (dps.empty) { + throw "The deployment disappeared while we were waiting for it to complete."; + } + + deployment = dps.get(0); + } + + return deployment; +} + diff --git a/modules/enterprise/remoting/cli/src/main/samples/modules/drift.js b/modules/enterprise/remoting/cli/src/main/samples/modules/drift.js new file mode 100644 index 0000000..b07eaec --- /dev/null +++ b/modules/enterprise/remoting/cli/src/main/samples/modules/drift.js @@ -0,0 +1,240 @@ +/** + * file: drift.js + * + * description: This script contains functions that illustrate and highlight + * drift monitoring functionality. Some of the functionality demonstrated in + * this script is currently available only via RHQ's remote client (and CLI) + * at the time of this writing. + * + * Note that you must login before you can load the scripts. Also please note + * that if a function is not documented, then it is not intended for public + * use. It is used only as an internal helper function. + * + * author: jsanda(a)redhat.com + */ + +var util = require("./util"); + +/** + * description: Generates a snapshot of changes sets belonging to a particular + * drift definition of a specific resource. By default all change sets are + * included in the snapshot. An optional third argument can be specified to + * limit or control the number of change sets included in the snapshot. + * + * Note that a snapshot is an accumulation or aggregation of change sets that + * provides a view of a resource, or more precisely, all files being monitored + * for drift, at a particular version or point in time. + * + * arguments: + * rid: A resource id, expected to be an integer + * + * defName: The drift definition name as a string + * + * filter: (optional) A map or JS object that limits the number of + * change sets included in the snapshot. It should specify two + * properties - startVersion and endVersion. + * + * return: A org.rhq.core.domamin.drift.DriftSnapshot object + * + * usage: + * // generates a snapshot that includes all change sets belonging to the + * // mydrift drift configuration. + * createSnapshot(123, 'mydrift') + * + * // generates a snapshot that includes change sets 3 through 5 inclusive. + * createSnapshot(123, 'mydrift', {startVersion: 3, endVersion: 5}) + */ +exports.createSnapshot = function(rid, defName) { + var driftDef = findDriftDefinition(rid, function(d) { return defName.equals(d.name) }); + var snapshotRequest; + + if (arguments.length > 2) { + var filters = arguments[2]; + snapshotRequest = DriftSnapshotRequest(driftDef.id, filters.startVersion, filters.endVersion); + } else { + snapshotRequest = DriftSnapshotRequest(driftDef.id); + } + + return DriftManager.getSnapshot(snapshotRequest); +} + +/** private helper function to find a drift definition by a filter */ +function findDriftDefinition(rid, filter) { + var criteria = ResourceCriteria(); + criteria.addFilterId(rid); + criteria.fetchDriftDefinitions(true); + + var resources = ResourceManager.findResourcesByCriteria(criteria); + var resource = resources.get(0); + + return util.find(resource.driftDefinitions, function(config) { + return filter(DriftDefinition(config)); + }); +} + +/** + * description: Generates a diff report that is printed to the console. By + * default this function generates a snapshot diff. The function expects two + * arguments which should be DriftSnapshot objects. A diff between those two + * snapshots is generated and printed to the console. A path can be specified + * as an optional third argument. If a path is a specified as a third argument, + * then a file diff will be performed using the file that matches the path in + * each change set. The format will be a unified diff. + * + * Note that the snapshots can be from the same or from different resources; + * however, if they are from different resources, it is assumed that the + * resources are of the same type. + * + * arguments: + * s1: A DriftSnapshot object + * + * s2: A DriftSnapshot object + * + * path: (optional) A string that specifies a path that exists in both s1 and + * s2. + * + * return: This function does not return a useful value. It may be an empty + * string or it could be null. Instead of returning its results, the function + * prints them to the CLI console. As such, this function is intended for + * use from the interactive CLI shell. + * + * usage: + * // Generates a snapshot diff report + * diff(s1, s2) + * + * // Generates a file diff report in the unified format + * diff(s1, s2, 'jboss_home/bin/run.conf') + */ +exports.diff = function(s1, s2) { + var theDiff = s1.diff(s2); + + if (arguments.length > 2) { + var path = arguments[2]; + + if (theDiff.elementsInConflict.size() == 0) { + // If the snapshot diff reports no files in conflict, then there + // is no need to call the server to perform the file diff. We can + // instead return quickly. + println("There are no differences to report"); + return ""; + } + + var pathFilter = function(entry) { return entry.path == path; }; + var e1 = util.find(s1.driftInstances, pathFilter); + var e2 = util.find(s2.driftInstances, pathFilter); + + var fileDiff = DriftManager.generateUnifiedDiff(e1, e2); + util.foreach(fileDiff.diff, println); + return ""; + } + + function printEntry(entry) { + println(entry.newDriftFile.hashId + '\t' + entry.path); + } + + function report(header, elements) { + println(header + ':'); + util.foreach(elements, printEntry); + println('\n'); + } + + report('elements in conflict', theDiff.elementsInConflict); + report('elements not in left', theDiff.elementsNotInLeft); + report('elements not in right', theDiff.elementsNotInRight); +} + +/** + * description: Generates and returns the drift history for a file being + * monitored for drift. This function takes three arguments. The first two, the + * resource id drift configuration name, uniquely identify the drift + * configuration. The third argument specifies a path that is set up for + * monitoring by the drift configuration. + * + * arguments: + * rid: A resource id + * + * configName: A drift configuration name + * + * path: A path that is set up for drift monitoring by the drift + * configuration that is identified by the first two arguments. The path + * should be specified as relative to the base directory from which + * monitoring is done. + * + * return: A History object, which is a native JS object. This object contains + * a few methods for working with the file history: + * + * list: prints a short summary of all versions of the file + * view: returns the contents of a particular version of the file + * compare: compares two versions of the file and prints a unified diff + * + * usage: + * $ history = fetchHistory(123, 'mydrift', 'bin/run.conf') + * $ history.list() // prints a summary of all versions of 'bin/run.conf' + * $ history.view(1) // returns the full contents of version 1 of the file + * $ history.compare(1, 2) // generates and prints a unified diff of versions 1 and 2 + */ +exports.fetchHistory = function(rid, driftDefName, path) { + function History() { + var entries = []; + + function findDrift(version) { + return util.find(entries, function(drift) { + return drift.changeSet.version == version + }); + } + + + var generate = function() { + entries = []; + var criteria = GenericDriftCriteria(); + criteria.addFilterResourceIds([rid]); + criteria.fetchChangeSet(true); + criteria.addFilterPath(path); + + var drifts = DriftManager.findDriftsByCriteria(criteria); + util.foreach(drifts, function(drift) { + if (drift.changeSet.driftDefinition.name == driftDefName && + drift.path == path) { + entries.push(drift); + } + }); + + entries.sort(function(d1, d2) { + return d1.changeSet.version <= d2.changeSet.version + }); + } + + this.list = function() { + var format = java.text.DateFormat.getDateTimeInstance(); + println(path + "\n-----------------------------------"); + util.foreach(entries, function(drift) { + println(drift.changeSet.version + "\t" + format.format(drift.ctime)); + }); + } + + this.view = function(version) { + var drift = findDrift(version); + if (drift == null) { + return "Could not find version " + version; + } + return java.lang.String(DriftManager.getDriftFileAsByteArray(drift.newDriftFile.hashId)); + } + + this.compare = function(v1, v2) { + var d1 = findDrift(v1); + if (d1 == null) { + return "Could not find version " + v1; + } + var d2 = findDrift(v2); + if (d2 == null) { + return "Could not find version " + v2; + } + var fileDiff = DriftManager.generateUnifiedDiff(d1, d2); + util.foreach(fileDiff.diff, println); + } + + generate(); + } + + return new History(); +} diff --git a/modules/enterprise/remoting/cli/src/main/samples/modules/jbossas.js b/modules/enterprise/remoting/cli/src/main/samples/modules/jbossas.js new file mode 100644 index 0000000..6369cc1 --- /dev/null +++ b/modules/enterprise/remoting/cli/src/main/samples/modules/jbossas.js @@ -0,0 +1,811 @@ +/** + * This module contains a variety of utility functions for working with JBoss AS in different versions. + * + * @author Lukas Krejci + */ + + +var util = require('./util'); +var bundles = require("./bundles"); + +//init the version-specific objects. We'll be adding the functions to them further down below. +exports.as7 = {} + +/** + * This creates a new destination in the JBoss AS (4,5,6,7) servers from the provided + * group and deploys the application provided by the bundle to it. Once the app is deployed, + * the servers in the group are sequentially stopped and started. + * + * @param bundleZipFile the path to the zip file with the application bundle + * @param deploymentConfiguration the deployment configuration required by the bundle. + * See the <code>deployBundle</code> in <code>bundles.js</code> to find out about + * supported formats. + * @param groupName the name of the compatible group of JBossAS servers to deploy the bundle to + * @param destinationName the name of the destination that will be created so that the bundle + * can be deployed to it + * @param destinationDescription the description of the destination + * @param baseDirName the name of the base directory for the deployment. Each resource type + * defines a list of deployment base directories which you can review using, for example, + * the <code>getAllBaseDirectories(resourceTypeId)</code> function from <code>bundles.js</code>. + * @param deployDir the name of the directory under the base dir in which the bundle will be + * deployed to. + * + * @return the BundleDeployment instance + */ +exports.createAppAndRestart = function(bundleZipFile, deploymentConfiguration, groupName, destinationName, destinationDescription, baseDirName, deployDir) { + var gcrit = new ResourceGroupCriteria; + gcrit.addFilterName(groupName); + gcrit.fetchResourceType(true); + + var groups = ResourceGroupManager.findResourceGroupsByCriteria(gcrit); + if (groups.empty) { + throw "Could not find a resource group called " + groupName; + } else if (groups.size() > 1) { + throw "There are more than 1 groups called " + groupName; + } + + var group = groups.get(0); + var targetResourceType = group.resourceType; + + var deployFn = function(restartFn) { + + var bundleVersion = bundles.createBundleVersion(bundleZipFile); + var destination = BundleManager.createBundleDestination(bundleVersion.bundle.id, destinationName, destinationDescription, baseDirName, deployDir, group.id); + + var deployment = bundles.deployBundle(bundleVersion, destination, deploymentConfiguration, null); + + if (deployment.status != BundleDeploymentStatus.SUCCESS) { + throw "Deployment wasn't successful: " + deployment; + } + + restartFn(group); + + return deployment; + }; + + if (targetResourceType.plugin == "JBossAS" && targetResourceType.name == "JBossAS Server") { + return deployFn(_restartAS4); + } else if (targetResourceType.plugin == "JBossAS5" && targetResourceType.name == "JBossAS Server") { + return deployFn(_restartAS5); + } else if (targetResourceType.plugin == "jboss-as-7" && + (targetResourceType.name == "JBossAS7-Standalone" || + targetResourceType.name == "JBossAS-Managed")) { + return deployFn(_restartAS7); + } + + throw "The resource group the destination targets doesn't seem to be a JBoss AS server group."; +} + +/** + * Deploys an updated bundle of an enterprise application to a destination that + * points to a group of JBoss AS(4,5,6,7) servers and then stops all the servers + * serially and then starts them up again sequentially. + * + * @param bundleZipFile + * the path to the bundle zip file with the application + * @param jbasDestination + * the bundle destination the bundle should be deployed to (or id + * thereof) + * @param deploymentConfiguration + * the deployment configuration. This can be an ordinary javascript + * object (hash) or an instance of RHQ's Configuration. If it is the + * former, it is converted to the Configuration instance using the + * <code>asConfiguration</code> function from <code>util.js</code>. + * Please consult the documentation of that method to understand the + * limitations of that approach. + * @param description + * the deployment description + * + * @return the deployment instance + */ +exports.updateAppAndRestart = function(bundleZipFile, jbasDestination, deploymentConfiguration) { + // first figure out the jbas version we are deploying to + var destinationId = jbasDestination; + if (typeof(jbasDestination) == 'object') { + destinationId = jbasDestination.id; + } + + var destCrit = new BundleDestinationCriteria + destCrit.fetchGroup(true) + + var destinations = BundleManager.findBundleDestinationsByCriteria(destCrit); + + if (destinations.empty) { + throw "No destinations corresponding to " + jbasDestination + " found on the server."; + } + + var destination = destinations.get(0); + + var targetResourceType = destination.group.resourceType; + + if (targetResourceType == null) { + throw "This function expects a compatible group of JBoss AS (4,5,6 or 7) resources but the provided destination is connected with " + destination.group; + } + + var deployFn = function(restartFn) { + var bundleVersion = bundles.createBundleVersion(bundleZipFile); + var deployment = bundles.deployBundle(bundleVersion, destination, deploymentConfiguration, null); + + if (deployment.status != BundleDeploymentStatus.SUCCESS) { + throw "Deployment wasn't successful: " + deployment; + } + + restartFn(destination.group); + + return deployment; + }; + + if (targetResourceType.plugin == "JBossAS" && targetResourceType.name == "JBossAS Server") { + return deployFn(_restartAS4); + } else if (targetResourceType.plugin == "JBossAS5" && targetResourceType.name == "JBossAS Server") { + return deployFn(_restartAS5); + } else if (targetResourceType.plugin == "jboss-as-7" && + (targetResourceType.name == "JBossAS7-Standalone" || + targetResourceType.name == "JBossAS-Managed")) { + return deployFn(_restartAS7); + } + + throw "The resource group the destination targets doesn't seem to be a JBoss AS server group."; +} + +/** + * This function adds an AS7 server to a cluster with another AS7 instance, using + * the provided node name as its identifier. + * + * This method only makes the new member use the same configuration as the existing + * member and synchronizes its jgroups, messaging and modcluster socket bindings + * with the cluster. Optionally it also copies over all the deployments to the + * new member. + * + * The configurations are therefore assumed to be otherwise compatible - i.e. + * the infinispan cache containers should be configured correctly (or left at + * default values, which are configured correctly), etc. + * + * @param newAs7Resource the resource proxy of the AS7 instance to add + * @param newNodeName the node name, i.e. unique identification, of the new member + * in the cluster + * @param existingClusterMemberResource an AS7 instance that belongs to a cluster + * the new member should join into. + * @param copyDeployments whether or not to copy the deployments from the existing + * member to the new member + */ +exports.as7.addToCluster = function(newAs7Resource, newNodeName, existingClusterMemberResource, doCopyDeployments) { + println("Reading config of the existing cluster member"); + var existingMember = { + 'id' : existingClusterMemberResource.id, + 'resourceConfiguration' : _getLiveResourceConfiguration(existingClusterMemberResource), + 'pluginConfiguration' : _getPluginConfiguration(existingClusterMemberResource) + }; + + var clusterConfig = _getClusterSignificantConfig(existingClusterMemberResource.children, + existingMember.pluginConfiguration, existingMember.resourceConfiguration); + + println("Reading config of the new member"); + var newMember = { + 'id' : newAs7Resource.id, + 'resourceConfiguration' : _getLiveResourceConfiguration(newAs7Resource), + 'pluginConfiguration' : _getPluginConfiguration(newAs7Resource) + }; + + var memberConfig = _getClusterSignificantConfig(newAs7Resource.children, newMember.pluginConfiguration, newMember.resourceConfiguration); + + var memberResourceConfiguration = newMember.resourceConfiguration.deepCopy(false); + + if (memberConfig['config'] != clusterConfig['config']) { + println("The configurations of the servers differ.\n" + + "The new cluster member's configuration will be changed to match the configuration of the existing member."); + + newAs7Resource.updatePluginConfiguration(_changeConfig(newMember.pluginConfiguration, clusterConfig['config'])); + + //we need to restart straight away so that we see the changes to the + //rest of the configuration caused by the change of current config. + println("Restarting the new cluster member to switch it to the new configuration."); + newAs7Resource.restart(); + + //refresh the resource + newAs7Resource = ProxyFactory.getResource(newMember.id); + newMember = { + 'id' : newAs7Resource.id, + 'resourceConfiguration' : _getLiveResourceConfiguration(newAs7Resource), + 'pluginConfiguration' : _getPluginConfiguration(newAs7Resource) + }; + + //refresh the cluster specific config after the restart with the new + //config + memberConfig = _getClusterSignificantConfig(newAs7Resource.children, newMember.pluginConfiguration, newMember.resourceConfiguration); + memberResourceConfiguration = newMember.resourceConfiguration; + } + + //now check what's the node name we see + if (memberConfig['node-name'] != newNodeName) { + println("Updating the node name of the new cluster member from '" + memberConfig['node-name'] + "' to '" + newNodeName + "'"); + _updateNodeName(memberResourceConfiguration, newNodeName); + + newAs7Resource.updateResourceConfiguration(memberResourceConfiguration); + memberResourceConfiguration = newMember.resourceConfiguration.deepCopy(false); + } + + //now apply the socket binding changes for jgroups and other cluster + //significant subsystems + //first find the socket binding group config in the new member + for(i in newAs7Resource.children) { + var child = newAs7Resource.children[i]; + if (child.resourceType.name == 'SocketBindingGroup' && + child.resourceType.plugin == 'JBossAS7') { + + println("Updating socket bindings of jgroups, messaging and modcluster subsystems"); + + var resourceConfig = _getLiveResourceConfiguration(child); + + var portOffset = javascriptString(resourceConfig.getSimpleValue('port-offset', '0')); + var clusterMemberPortOffset = clusterConfig['port-offset']; + + var newConfig = resourceConfig.deepCopy(false); + + _updateSocketBindings(newConfig, portOffset, clusterMemberPortOffset, clusterConfig['jgroups']); + _updateSocketBindings(newConfig, portOffset, clusterMemberPortOffset, clusterConfig['messaging']); + _updateSocketBindings(newConfig, portOffset, clusterMemberPortOffset, clusterConfig['modcluster']); + + child.updateResourceConfiguration(newConfig); + } + } + + println("Restarting the new member for the new socket bindings to take effect."); + newAs7Resource.restart(); + + if (doCopyDeployments) { + println("Copying the deployments to the new cluster member..."); + copyDeployments(existingClusterMemberResource, newAs7Resource); + + println("Restarting the new cluster member."); + newAs7Resource.restart(); + } +} + +/** + * Copies all deployments from the source to the target. Both resources must + * be standalone AS7 servers. + * + * @param sourceAS7 the resource id or object of the source AS7 standalone instance + * @param targetAS7 the resource id or object of the target AS7 standalone instance + */ +exports.as7.copyDeployments = function(sourceAS7, targetAS7) { + if (typeof sourceAS7 == 'object') { + sourceAS7 = sourceAS7.id; + } + + if (typeof targetAS7 == 'object') { + targetAS7 = targetAS7.id; + } + + var deploymentResourceType = ResourceTypeManager.getResourceTypeByNameAndPlugin('Deployment', 'JBossAS7'); + + var deploymentsCrit = new ResourceCriteria; + deploymentsCrit.addFilterParentResourceId(sourceAS7); + deploymentsCrit.addFilterResourceTypeId(deploymentResourceType.id); + + var unlimitedPageControl = PageControl.unlimitedInstance; + + var sourceDeployments = ResourceManager.findResourcesByCriteria(deploymentsCrit); + var iterator = sourceDeployments.iterator(); + while (iterator.hasNext()) { + var deploymentResource = iterator.next(); + //get a resource proxy for easy access to configurations, etc. + deploymentResource = ProxyFactory.getResource(deploymentResource.id); + + println("Copying deployment " + deploymentResource.name); + + var installedPackage = ContentManager.getBackingPackageForResource(deploymentResource.id); + var content = ContentManager.getPackageBytes(deploymentResource.id, installedPackage.id); + + var runtimeName = deploymentResource.resourceConfiguration.getSimpleValue('runtime-name', deploymentResource.name); + + var deploymentConfiguration = new Configuration; + deploymentConfiguration.put(new PropertySimple('runtimeName', runtimeName)); + + //so now we have both metadata and the data of the deployment, let's + //push a copy of it to the target server + var history = ResourceFactoryManager.createPackageBackedResource(targetAS7, + deploymentResourceType.id, deploymentResource.name, + deploymentResource.pluginConfiguration, + installedPackage.packageVersion.generalPackage.name, + installedPackage.packageVersion.version, + installedPackage.packageVersion.architecture.id, + deploymentConfiguration, content, null); + + while (history.status.name() == 'IN_PROGRESS') { + java.lang.Thread.sleep(1000); + //the API for checking the create histories is kinda weird.. + var histories = ResourceFactoryManager.findCreateChildResourceHistory(targetAS7, null, null, unlimitedPageControl); + var hit = histories.iterator(); + var found = false; + while(hit.hasNext()) { + var h = hit.next(); + + if (h.id == history.id) { + history = h; + found = true; + break; + } + } + + if (!found) { + throw "The history object for the deployment seems to have disappeared, this is very strange."; + } + } + + println("Deployment finished with status: " + history.status.toString() + + (history.status.name() == 'SUCCESS' ? "." : (", error message: " + history.errorMessage + "."))); + } +} + +function _getConfigName(as7PluginConfig) { + var argsValue = as7PluginConfig.getSimpleValue('startScriptArgs', ''); + + var args = argsValue.split('\n'); + + var possibleParams = ['-c ', '-c=', '--server-config=']; + + var ret = null; + for (i in args) { + var arg = args[i]; + + var found = false; + + for(j in possibleParams) { + var param = possibleParams[j]; + var pos = arg.indexOf(param); + + if (pos >= 0) { + ret = arg.substring(pos + param.length).trim(); + found = true; + break; + } + } + + if (found) { + break; + } + } + + if (ret != null && ret.startsWith('%') && ret.endsWith('%')) { + var pluginConfRef = ret.substring(1, ret.length - 1); + ret = as7PluginConfig.getSimpleValue(pluginConfigRef, null); + } + + return ret; +} + +function _changeConfig(pluginConfig, configName) { + var argsValue = javascriptString(pluginConfig.getSimpleValue('startScriptArgs', '')); + + var args = argsValue.split('\n'); + + var possibleParams = ['-c ', '-c=', '--server-config=']; + + var updated = false; + + for (i in args) { + var arg = args[i]; + + for(j in possibleParams) { + var param = possibleParams[j]; + + var pos = arg.indexOf(param); + + if (pos >= 0) { + args[i] = param + configName; + updated = true; + break; + } + } + + if (updated) { + break; + } + } + + if (!updated) { + args.push("-c " + configName); + } + + //join the config back together + for(i in args) { + if (i == 0) { + argsValue = args[i]; + } else { + argsValue += "\n" + args[i]; + } + } + + pluginConfig.put(new PropertySimple('startScriptArgs', argsValue)); + + return pluginConfig; +} + +/** + * The config properties of AS7 can have a form of ${propertyName:defaultvalue}. + * Because we can't figure out the value of the property if it is defined, + * (or get at its default value), we return the following hash from this function + * { + * property : propertyName, + * value : defaultvalue + * } + * + * At least one of the keys in the above hash will have a value. + */ +function _parseValueFromExpr(expr) { + var strExpr = expr + ''; + if (strExpr.indexOf('${') == 0) { + var colonIdx = strExpr.indexOf(':'); + if (colonIdx == -1) { + return { 'property' : expr }; + } else { + var property = strExpr.substring(2, colonIdx); + var value = strExpr.substring(colonIdx + 1, strExpr.length - 1); + + return { 'property' : property, 'value' : value }; + } + } else { + return { 'value' : expr }; + } +} + +/** + * This converts the result of _parseValueFromExpr() function back into the + * ${property:defaultvalue} format. + */ +function _composeValueExpr(parsedValue) { + if (parsedValue.property == undefined) { + return parsedValue.value; + } else { + return '${' + parsedValue.property + ':' + parsedValue.value + '}'; + } +} + +function _updateNodeName(serverResourceConfiguration, newNodeName) { + //define it as a system prop + var systemProps = serverResourceConfiguration.getList('*2'); + if (systemProps == null) { + systemProps = new PropertyList('*2'); + serverResourceConfiguration.put(systemProps); + } + + var it = systemProps.list.iterator(); + var updated = false; + while (it.hasNext()) { + var systemProp = it.next(); + var systemPropName = javascriptString(systemProp.getSimpleValue('name', null)); + if (systemPropName == 'jboss.node.name') { + var systemPropValue = systemProp.getSimple('value'); + if (systemPropValue == null) { + systemPropValue = new PropertySimple('value', newNodeName); + systemProp.put(systemPropValue); + } else { + systemPropValue.setValue(newNodeName); + } + + updated = true; + break; + } + } + + if (!updated) { + var systemProp = new PropertyMap('*:name'); + systemProp.put(new PropertySimple('name', 'jboss.node.name')); + systemProp.put(new PropertySimple('value', newNodeName)); + systemProps.add(systemProp); + } +} + +function _updateSocketBindings(socketBindingsConfig, portOffset, clusterMemberPortOffset, socketBindingConfig) { + portOffset = _parseValueFromExpr(portOffset); + clusterMemberPortOffset = _parseValueFromExpr(clusterMemberPortOffset); + + var portOffsetValue = portOffset.value != undefined ? portOffset.value : 0; + var clusterMemberPortOffsetValue = clusterMemberPortOffset.value != undefined ? + clusterMemberPortOffset.value : 0; + + var portOffsetDiff = clusterMemberPortOffsetValue - portOffsetValue; + + var ports = socketBindingsConfig.get('*'); + var portIterator = ports.list.iterator(); + + var appliedProperties = []; + + while (portIterator.hasNext()) { + var port = portIterator.next(); + + var name = port.getSimpleValue('name', null); + + if (socketBindingConfig[name] != undefined) { + //k, this is a significant config, port it over + + //compute the value of the ports + if (socketBindingConfig[name]['fixed-port'] == 'true') { + port.put(new PropertySimple('port:expr', socketBindingConfig[name]['port:expr'])); + port.put(new PropertySimple('multicast-port:expr', socketBindingConfig[name]['multicast-port:expr'])); + port.put(new PropertySimple('multicast-address', socketBindingConfig[name]['multicast-address'])); + port.put(new PropertySimple('fixed-port', 'true')); + } else { + var portExprToUse = _parseValueFromExpr(socketBindingConfig[name]['port:expr']); + if (portExprToUse.value != undefined) { + portExprToUse.value = portOffsetDiff + parseInt(portExprToUse.value) + ''; + } + + var multicastPortExprToUse = _parseValueFromExpr(socketBindingConfig[name]['multicast-port:expr']); + if (multicastPortExprToUse.value != undefined) { + multicastPortExprToUse.value = portOffsetDiff + parseInt(multicastPortExprToUse.value) + ''; + } + + port.put(new PropertySimple('port:expr', _composeValueExpr(portExprToUse))); + port.put(new PropertySimple('multicast-port:expr', _composeValueExpr(multicastPortExprToUse))); + port.put(new PropertySimple('multicast-address', socketBindingConfig[name]['multicast-address'])); + port.put(new PropertySimple('fixed-port', 'false')); + } + appliedProperties.push(name); + } + } + + //I need contains() and Rhino's Array object apparently doesn't have indexOf() + //which I could otherwise use. + appliedProperties = java.util.Arrays.asList(appliedProperties); + + //now add to the list the props that were not there + for(name in socketBindingConfig) { + if (appliedProperties.contains(name)) { + continue; + } + + var port = new PropertyMap('binding'); + ports.add(port); + + port.put(new PropertySimple('name', name)); + port.put(new PropertySimple('multicast-address', socketBindingConfig[name]['multicast-address'])); + port.put(new PropertySimple('fixed-port', socketBindingConfig[name]['fixed-port'])); + + var portExprToUse = _parseValueFromExpr(socketBindingConfig[name]['port:expr']); + if (portExprToUse.value != undefined && !socketBindingConfig[name]['fixed-port']) { + portExprToUse.value = portOffsetDiff + parseInt(portExprToUse.value) + ''; + } + + var multicastPortExprToUse = _parseValueFromExpr(socketBindingConfig[name]['multicast-port:expr']); + if (multicastPortExprToUse.value != undefined && !socketBindingConfig[name]['fixed-port']) { + multicastPortExprToUse.value = portOffsetDiff + parseInt(multicastPortExprToUse.value) + ''; + } + + port.put(new PropertySimple('port:expr', _composeValueExpr(portExprToUse))); + port.put(new PropertySimple('multicast-port:expr', _composeValueExpr(multicastPortExprToUse))); + } +} + + +/** + * Returns a javascript hash of configuration properties significant for the + * cluster configuration. + * + * This method is quite simplistic - it merely reads out the important socket + * bindings and Infinispan configuration properties. + * + * It doesn't try to be smart about specifying which concrete caches and cache + * containers are used for individual subsystems like EJB3, JPA or web apps. + * + * @param resource the resource proxy of the AS7 + */ +function _getClusterSignificantConfig(children, pluginConfiguration, resourceConfiguration) { + var ret = {}; + + ret['config'] = javascriptString(_getConfigName(pluginConfiguration)); + + ret['node-name'] = javascriptString(resourceConfiguration.getSimpleValue('node-name', null)); + + //the standalone server has a single socket binding group + for(var i in children) { + var child = children[i]; + if (child.resourceType.plugin != 'JBossAS7') { + continue; + } + if (child.resourceType.name == 'SocketBindingGroup') { + + var resourceConfig = _getLiveResourceConfiguration(child); + + ret['port-offset'] = javascriptString(resourceConfig.getSimpleValue('port-offset', '0')); + var ports = resourceConfig.get('*'); + var portIterator = ports.list.iterator(); + + var jgroups = {}; + var messaging = {}; + var modcluster = {}; + + ret['jgroups'] = jgroups; + ret['messaging'] = messaging; + ret['modcluster'] = modcluster; + + while (portIterator.hasNext()) { + var port = portIterator.next(); + var name = javascriptString(port.getSimpleValue('name', null)); + + if (name.indexOf('jgroups') == 0) { + jgroups[name] = _getSocketBinding(port); + } else if (name.indexOf('messaging') == 0) { + messaging[name] = _getSocketBinding(port); + } else if (name.indexOf('modcluster') == 0) { + modcluster[name] = _getSocketBinding(port); + } + } + } else if (child.resourceType.name == 'Infinispan') { + var ispn = {}; + ret['infinispan'] = ispn; + + //This has disappeared + //ispn['default-cache-container'] = javascriptString(child.defaultCacheContainer.value); + var cacheContainers = {}; + ispn['cache-containers'] = cacheContainers; + + for(cc in child.children) { + var cacheContainer = child.children[cc]; + + var caches = {}; + + var containerConfig = _getLiveResourceConfiguration(cacheContainer); + + cacheContainers[cacheContainer.name] = { + 'default-cache' : javascriptString(containerConfig.getSimpleValue('default-cache', null)), + 'aliases' : _asArray(containerConfig.get('aliases')), + 'caches' : caches + }; + + for (c in cacheContainer.children) { + var cache = cacheContainer.children[c]; + + caches[cache.name] = { + '_flavor' : javascriptString(containerConfig.getSimpleValue('_flavor', null)), + 'batching' : javascriptString(containerConfig.getSimpleValue('batching', null)), + 'indexing' : javascriptString(containerConfig.getSimpleValue('indexing', null)), + 'mode' : javascriptString(containerConfig.getSimpleValue('mode', null)) + }; + } + } + } + } + + return ret; +} + +function _getSocketBinding(port) { + return { + 'port:expr' : javascriptString(port.getSimpleValue('port:expr', '0')), + 'multicast-port:expr' : javascriptString(port.getSimpleValue('multicast-port:expr', null)), + 'multicast-address' : javascriptString(port.getSimpleValue('multicast-address', null)), + 'fixed-port' : javascriptString(port.getSimpleValue('fixed-port', null)) + }; +} + +function javascriptString(string) { + return string == null || string == undefined ? string : string + ''; +} + +function _asArray(propertyList) { + var ret = []; + if (propertyList == undefined || propertyList == null) { + return ret; + } + + var it = propertyList.list.iterator(); + while (it.hasNext()) { + var prop = it.next(); + + if (prop instanceof PropertySimple) { + ret.push(javascriptString(prop.stringValue)); + } + } + + return ret; +} + +function _getPluginConfiguration(resource) { + if (typeof(resource) == 'number') { + resource = ProxyFactory.getResource(resource) + } else { + resource = ProxyFactory.getResource(resource.id) + } + return resource.pluginConfiguration +} + +function _getLiveResourceConfiguration(resource) { + var id; + if (typeof(resource) == 'number') { + id = resource; + } else { + id = resource.id + } + + return ConfigurationManager.getLiveResourceConfiguration(id, false) +} + +function _loadGroupMembers(group) { + var crit = new ResourceGroupCriteria; + crit.addFilterId(group.id); + crit.fetchExplicitResources(true); + crit.fetchImplicitResources(true); + + var groups = ResourceGroupManager.findResourceGroupsByCriteria(crit) + + if (groups.empty) { + throw "Could not find a previously loaded group on the server: " + group; + } + + return groups.get(0); +} + +function _allResourceIds(group) { + var list = []; + + if (group.explicitResources != null) { + foreach(group.explicitResources, function(resource) { + list.push(resource.id); + }); + } + + return list; +} + +function _runOperationSequentially(group, operationName, operationConfig) { + group = _loadGroupMembers(group); + var resourceIds = _allResourceIds(group); + + var conf = operationConfig; + if (!(conf instanceof Configuration)) { + conf = asConfiguration(conf); + } + + // by specifying the resource ids explicitly, we define the order in which + // the operations will be executed on individual resources (in sequence). + // if the resourceIds were null, the operations would be invoked all at once + // in no particular order. + var schedule = OperationManager.scheduleGroupOperation(group.id, resourceIds, false, operationName, conf, 0, 0, 0, 0, null); + + // now we need to wait for all the individual operations on resources to + // complete + var crit = new GroupOperationHistoryCriteria; + crit.addFilterJobId(new JobId(schedule.jobName, schedule.jobGroup)); + + while (true) { + // XXX should this be configurable? + // we're waiting for an AS to start/shutdown which takes time.. + // Let's check in 5s intervals. + // We're waiting at the start of this loop to also ensure that the server + // had time to issue the quartz job and persist the history entry. + java.lang.Thread.currentThread().sleep(5000); + + var results = OperationManager.findGroupOperationHistoriesByCriteria(crit); + + if (results.empty) { + throw "Could not find operation history for schedule " + schedule + ". This should not happen."; + } + + var history = results.get(0); + + if (history.status != OperationRequestStatus.INPROGRESS) { + return history; + } + } +} + +function _restartAS4(group) { + _runOperationSequentially(group, "shutdown", new Configuration); + _runOperationSequentially(group, "start", new Configuration); +} + +function _restartAS5(group) { + _runOperationSequentially(group, "shutdown", new Configuration); + _runOperationSequentially(group, "start", new Configuration); +} + +function _restartAS7(group) { + var shutdownOp = group.resourceType.name == "JBossAS7-Standalone" ? "shutdown" : "server:stop"; + var startOp = group.resourceType.name == "JBossAS7-Standalone" ? "start" : "server:start"; + + _runOperationSequentially(group, shutdownOp, new Configuration); + _runOperationSequentially(group, startOp, new Configuration); +} diff --git a/modules/enterprise/remoting/cli/src/main/samples/modules/util.js b/modules/enterprise/remoting/cli/src/main/samples/modules/util.js new file mode 100644 index 0000000..b67eebc --- /dev/null +++ b/modules/enterprise/remoting/cli/src/main/samples/modules/util.js @@ -0,0 +1,280 @@ +/** + * file: util.js + * + * description: This script contains functions that provide core, low-level + * functionality such as iterating over a collection or searching a collection. + * This has no other script or library dependencies. + * + * author: jsanda(a)redhat.com + * author: lkrejci(a)redhat.com + * + * See also http://johnsanda.blogspot.com/search/label/javascript + */ + + +/** + * If obj is a JS array or a java.util.Collection, each element is passed to + * the callback function. If obj is a java.util.Map, each map entry is passed + * to the callback function as a key/value pair. If obj is none of the + * aforementioned types, it is treated as a generic object and each of its + * properties is passed to the callback function as a name/value pair. + */ +exports.foreach = function (obj, fn) { + if (obj instanceof Array) { + for (i in obj) { + fn(obj[i]); + } + } + else if (obj instanceof java.util.Collection) { + var iterator = obj.iterator(); + while (iterator.hasNext()) { + fn(iterator.next()); + } + } + else if (obj instanceof java.util.Map) { + var iterator = obj.entrySet().iterator() + while (iterator.hasNext()) { + var entry = iterator.next(); + fn(entry.key, entry.value); + } + } + else { // assume we have a generic object + for (i in obj) { + fn(i, obj[i]); + } + } +} + +/** + * Iterates over obj similar to foreach. fn should be a predicate that evaluates + * to true or false. The first match that is found is returned. + */ +exports.find = function(obj, fn) { + if (obj instanceof Array) { + for (i in obj) { + if (fn(obj[i])) { + return obj[i] + } + } + } + else if (obj instanceof java.util.Collection) { + var iterator = obj.iterator(); + while (iterator.hasNext()) { + var next = iterator.next(); + if (fn(next)) { + return next; + } + } + } + else if (obj instanceof java.util.Map) { + var iterator = obj.entrySet().iterator(); + while (iterator.hasNext()) { + var entry = iterator.next(); + if (fn(entry.key, entry.value)) { + return {key: entry.key, value: entry.value}; + } + } + } + else { + for (i in obj) { + if (fn(i, obj[i])) { + return {key: i, value: obj[i]}; + } + } + } + return null; +} + +/** + * Iterates over obj similar to foreach. fn should be a predicate that evaluates + * to true or false. All of the matches are returned in a java.util.List. + */ +exports.findAll = function(obj, fn) { + var matches = java.util.ArrayList(); + if ((obj instanceof Array) || (obj instanceof java.util.Collection)) { + foreach(obj, function(element) { + if (fn(element)) { + matches.add(element); + } + }); + } + else { + foreach(obj, function(key, value) { + if (fn(theKey, theValue)) { + matches.add({key: theKey, value: theValue}); + } + }); + } + return matches; +} + +/** + * A convenience function to convert javascript hashes into RHQ's configuration + * objects. + * + * The conversion of individual keys in the hash follows these rules: + * <ol> + * <li> if a value of a key is a javascript array, it is interpreted as PropertyList + * <li> if a value is a hash, it is interpreted as a PropertyMap + * <li> otherwise it is interpreted as a PropertySimple + * <li> a null or undefined value is ignored + * </ol> + * + * Note that the conversion isn't perfect, because the hash does not contain enough + * information to restore the names of the list members. + * + * Example: + * <pre><code> + * { + * simple : "value", + * list : [ "value1", "value2"], + * listOfMaps : [ { k1 : "value", k2 : "value" }, { k1 : "value2", k2 : "value2" } ] + * } + * </code></pre> + * gets converted to a configuration object: + * Configuration: + * <ul> + * <li> PropertySimple(name = "simple", value = "value") + * <li> PropertyList(name = "list") + * <ol> + * <li>PropertySimple(name = "list", value = "value1") + * <li>PropertySimple(name = "list", value = "value2") + * </ol> + * <li> PropertyList(name = "listOfMaps") + * <ol> + * <li> PropertyMap(name = "listOfMaps") + * <ul> + * <li>PropertySimple(name = "k1", value = "value") + * <li>PropertySimple(name = "k2", value = "value") + * </ul> + * <li> PropertyMap(name = "listOfMaps") + * <ul> + * <li>PropertySimple(name = "k1", value = "value2") + * <li>PropertySimple(name = "k2", value = "value2") + * </ul> + * </ol> + * </ul> + * Notice that the members of the list have the same name as the list itself + * which generally is not the case. + */ +exports.asConfiguration = function(hash) { + + config = new Configuration; + + for(key in hash) { + value = hash[key]; + + if (value == null) { + continue; + } + + (function(parent, key, value) { + function isArray(obj) { + return typeof(obj) == 'object' && (obj instanceof Array); + } + + function isHash(obj) { + return typeof(obj) == 'object' && !(obj instanceof Array); + } + + function isPrimitive(obj) { + return typeof(obj) != 'object'; + } + + //this is an anonymous function, so the only way it can call itself + //is by getting its reference via argument.callee. Let's just assign + //a shorter name for it. + var me = arguments.callee; + + var prop = null; + + if (isPrimitive(value)) { + prop = new PropertySimple(key, new java.lang.String(value)); + } else if (isArray(value)) { + prop = new PropertyList(key); + for(var i = 0; i < value.length; ++i) { + var v = value[i]; + if (v != null) { + me(prop, key, v); + } + } + } else if (isHash(value)) { + prop = new PropertyMap(key); + for(var i in value) { + var v = value[i]; + if (value != null) { + me(prop, i, v); + } + } + } + + if (parent instanceof PropertyList) { + parent.add(prop); + } else { + parent.put(prop); + } + })(config, key, value); + } + + return config; +} + +/** + * Opposite of <code>asConfiguration</code>. Converts an RHQ's configuration object + * into a javascript hash. + * + * @param configuration + */ +exports.asHash = function(configuration) { + ret = {} + + iterator = configuration.getMap().values().iterator(); + while(iterator.hasNext()) { + prop = iterator.next(); + + (function(parent, prop) { + function isArray(obj) { + return typeof(obj) == 'object' && (obj instanceof Array); + } + + function isHash(obj) { + return typeof(obj) == 'object' && !(obj instanceof Array); + } + + var me = arguments.callee; + + var representation = null; + + if (prop instanceof PropertySimple) { + representation = prop.stringValue; + } else if (prop instanceof PropertyList) { + representation = []; + + for(var i = 0; i < prop.list.size(); ++i) { + var child = prop.list.get(i); + me(representation, child); + } + } else if (prop instanceof PropertyMap) { + representation = {}; + + var childIterator = prop.getMap().values().iterator(); + while(childIterator.hasNext()) { + var child = childIterator.next(); + + me(representation, child); + } + } + + if (isArray(parent)) { + parent.push(representation); + } else if (isHash(parent)) { + parent[prop.name] = representation; + } + })(ret, prop); + } + (function(parent) { + + })(configuration); + + return ret; +} \ No newline at end of file commit 37153dce50218cf46b46ce86c4482b87c494a303 Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Wed Sep 12 13:40:49 2012 +0200 Fixing the RhqDownloadsScriptSourceProvider unit test. diff --git a/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java b/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java index 78c0c57..01a38e6 100644 --- a/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java +++ b/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java @@ -22,13 +22,21 @@ package org.rhq.enterprise.clienapi; import static org.testng.Assert.assertEquals; import java.io.File; +import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.Reader; import java.net.URI; +import java.net.URL; +import org.apache.tools.ant.filters.StringInputStream; import org.mockito.Mockito; +import org.powermock.api.mockito.PowerMockito; +import org.powermock.core.classloader.annotations.PrepareForTest; +import org.powermock.modules.testng.PowerMockObjectFactory; +import org.testng.IObjectFactory; import org.testng.annotations.AfterClass; import org.testng.annotations.BeforeClass; +import org.testng.annotations.ObjectFactory; import org.testng.annotations.Test; import org.rhq.bindings.StandardBindings; @@ -43,11 +51,18 @@ import org.rhq.enterprise.clientapi.RhqDownloadsScriptSourceProvider; * @author Lukas Krejci */ @Test +(a)PrepareForTest(RhqDownloadsScriptSourceProvider.class) public class RhqDownloadsScriptSourceProviderTest { private File tmpDir; + @ObjectFactory + public IObjectFactory getObjectFactory() { + return new PowerMockObjectFactory(); + } + private static final String EXPECTED_CONTENTS = "println('Hello, World!')"; + @BeforeClass public void createTmpDir() throws Exception { tmpDir = FileUtil.createTempDirectory(getClass().getName(), null, null); @@ -76,7 +91,11 @@ public class RhqDownloadsScriptSourceProviderTest { public void canLocateScripts() throws Exception { RemoteClient client = Mockito.mock(RemoteClient.class); - Mockito.when(client.getRemoteURI()).thenReturn(tmpDir.toURI()); + //this is akin to what the remote client actually returns as the remote URI + URI remoteURI = new URI("socket://localhost:7080"); + Mockito.when(client.getRemoteURI()).thenReturn(remoteURI); + + URI real = tmpDir.toURI().resolve("downloads/script-modules/test-script.js"); RhqDownloadsScriptSourceProvider provider = new RhqDownloadsScriptSourceProvider(); @@ -86,6 +105,10 @@ public class RhqDownloadsScriptSourceProviderTest { URI location = new URI("rhq://downloads/test-script.js"); + //let's actually cheat - the source provider will try to locate the script using HTTP + //but we subvert that and use the local file URL anyway... + PowerMockito.whenNew(URI.class).withArguments("http", "localhost:7080", "/downloads/script-modules/test-script.js", null, null).thenReturn(real); + Reader rdr = provider.getScriptSource(location); try { commit b7fd2841ad43677014d97161f7472ea7f76f6ccb Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Mon Aug 27 20:24:42 2012 +0200 [BZ 852169] - Modifying the rhq://downloads script source providers to download the scripts from a new download section with scripts. Also added the UI for listing the scripts. diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/admin/DownloadsView.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/admin/DownloadsView.java index bcc4ad4..0096c58 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/admin/DownloadsView.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/admin/DownloadsView.java @@ -60,6 +60,8 @@ public class DownloadsView extends LocatableVLayout { private SectionStackSection bundleSection; private SectionStackSection connectorsSection; private SectionStackSection cliAlertScriptsSection; + private SectionStackSection scriptModulesSection; + private ProductInfo productInfo; public DownloadsView(String locatorId) { @@ -81,18 +83,21 @@ public class DownloadsView extends LocatableVLayout { bundleSection = new SectionStackSection(MSG.view_admin_downloads_bundleDownload()); connectorsSection = new SectionStackSection(MSG.view_admin_downloads_connectorsDownload()); cliAlertScriptsSection = new SectionStackSection(MSG.view_admin_downloads_cliAlertScriptsDownload()); + scriptModulesSection = new SectionStackSection(MSG.view_admin_downloads_scriptModulesDownload()); agentSection.setExpanded(false); cliSection.setExpanded(false); bundleSection.setExpanded(false); connectorsSection.setExpanded(false); cliAlertScriptsSection.setExpanded(false); + scriptModulesSection.setExpanded(false); sectionStack.addSection(agentSection); sectionStack.addSection(cliSection); sectionStack.addSection(bundleSection); sectionStack.addSection(connectorsSection); sectionStack.addSection(cliAlertScriptsSection); + sectionStack.addSection(scriptModulesSection); addMember(sectionStack); } @@ -106,6 +111,7 @@ public class DownloadsView extends LocatableVLayout { prepareBundleSection(); prepareConnectorsSection(); prepareCliAlertScriptsSection(); + prepareScriptModulesSection(); } private void prepareAgentSection() { @@ -352,4 +358,55 @@ public class DownloadsView extends LocatableVLayout { } }); } + + private void prepareScriptModulesSection() { + systemManager.getScriptModulesDownloads(new AsyncCallback<HashMap<String, String>>() { + + @Override + public void onSuccess(HashMap<String, String> result) { + LocatableDynamicForm form = new LocatableDynamicForm(extendLocatorId("scriptModules")); + form.setMargin(10); + form.setWidth100(); + + if (result != null && !result.isEmpty()) { + int i = 0; + FormItem[] items = new FormItem[result.size() + 2]; + + for (Map.Entry<String, String> entry : result.entrySet()) { + StaticTextItem linkItem = new StaticTextItem("link" + i); + linkItem.setTitle(MSG.common_label_link()); + linkItem.setValue("<a href=\"" + entry.getValue() + "\">" + entry.getKey() + "</a>"); + items[i++] = linkItem; + } + + SpacerItem spacerItem = new SpacerItem("spacer"); + spacerItem.setHeight(5); + items[i++] = spacerItem; + + StaticTextItem helpText = new StaticTextItem("scriptModulesHelp"); + helpText.setColSpan(2); + helpText.setShowTitle(false); + helpText.setValue(MSG.view_admin_downloads_scriptModules_help()); + items[i++] = helpText; + + form.setItems(items); + } else { + StaticTextItem item = new StaticTextItem("noScriptModules"); + item.setColSpan(2); + item.setShowTitle(false); + item.setValue(MSG.view_admin_downloads_scriptModules_none()); + form.setItems(item); + } + + scriptModulesSection.setItems(form); + scriptModulesSection.setExpanded(true); + sectionStack.markForRedraw(); + } + + @Override + public void onFailure(Throwable caught) { + CoreGUI.getErrorHandler().handleError(MSG.view_admin_downloads_scriptModules_loadError(), caught); + } + }); + } } diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/gwt/SystemGWTService.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/gwt/SystemGWTService.java index a9fd575..b63b1c0 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/gwt/SystemGWTService.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/gwt/SystemGWTService.java @@ -68,6 +68,16 @@ public interface SystemGWTService extends RemoteService { HashMap<String, String> getCliAlertScriptDownloads() throws RuntimeException; /** + * Returns the name and download URL (key and value respectively) of all script modules + * that are available on the server for download. These are provided by RHQ for other + * scripts to peruse using the module-loading mechanism of particular language. + * + * @return info about the available script modules + * @throws RuntimeException + */ + HashMap<String, String> getScriptModulesDownloads() throws RuntimeException; + + /** * @return metadata properties about the CLI download available on the server. */ HashMap<String, String> getClientVersionProperties() throws RuntimeException; diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SystemGWTServiceImpl.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SystemGWTServiceImpl.java index 5cbc8de..59c5bd8 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SystemGWTServiceImpl.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/SystemGWTServiceImpl.java @@ -150,6 +150,26 @@ public class SystemGWTServiceImpl extends AbstractGWTServiceImpl implements Syst } @Override + public HashMap<String, String> getScriptModulesDownloads() throws RuntimeException { + try { + File downloadsDir = getScriptModulesDownloadsDir(); + List<File> files = getFiles(downloadsDir); + if (files == null) { + return new HashMap<String, String>(0); + } else { + HashMap<String, String> ret = new HashMap<String, String>(files.size()); + + for (File file : files) { + ret.put(file.getName(), "/downloads/script-modules/" + file.getName()); + } + return ret; + } + } catch (Throwable t) { + throw getExceptionToThrowToClient(t); + } + } + + @Override public HashMap<String, String> getClientVersionProperties() throws RuntimeException { File versionFile = new File(getClientDownloadDir(), "rhq-client-version.properties"); try { @@ -211,6 +231,15 @@ public class SystemGWTServiceImpl extends AbstractGWTServiceImpl implements Syst return downloadDir; } + private File getScriptModulesDownloadsDir() { + File serverHomeDir = getServerHomeDir(); + File downloadDir = new File(serverHomeDir, "deploy/rhq.ear/rhq-downloads/script-modules"); + if (!downloadDir.exists()) { + throw new RuntimeException("Server is missing connectors download directory at [" + downloadDir + "]"); + } + return downloadDir; + } + private File getClientDownloadDir() { File serverHomeDir = getServerHomeDir(); File downloadDir = new File(serverHomeDir, "deploy/rhq.ear/rhq-downloads/rhq-client"); diff --git a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages.properties b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages.properties index ab0eed7..4002fc7 100644 --- a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages.properties +++ b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages.properties @@ -566,6 +566,10 @@ view_admin_downloads_connectorsDownload = Connectors Download view_admin_downloads_connectors_help = Connectors are software that is needed in order for some products to be manageable by {0}. You install connectors into some managed products so {0} agents can talk to them. See the documentation for more information. view_admin_downloads_connectors_loadError = Cannot get connectors info view_admin_downloads_connectors_none = No connectors are available for download +view_admin_downloads_scriptModulesDownload = Script Modules Download +view_admin_downloads_scriptModules_help = Script modules are reusable components provided by RHQ to be used in your scripts (either alert scripts or CLI scripts). You can access them by using the "rhq://downloads/<module-name-without-file-extension>" URI in your scripting language of choice (i.e. in javascript, you would use the "require" function). +view_admin_downloads_scriptModules_none = No script modules are available for download +view_admin_downloads_scriptModules_loadError = Cannot load the list of available script modules view_admin_landing = From this section, the {0} global settings can be administered. This includes configuring security, setting up plugins, and managing {0} Servers and Agents. view_admin_measTemplates_updateExisting_title = Update Existing Schedules view_admin_measTemplates_updateExisting_tooltip = Check this box to update the collection schedules for the selected metrics on all existing resources of this type. If this is not checked, the template schedules will only be applied to new resources of this type that are added to inventory in the future. diff --git a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_cs.properties b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_cs.properties index dfd116e..ac127b4 100644 --- a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_cs.properties +++ b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_cs.properties @@ -585,6 +585,10 @@ view_admin_downloads_connectorsDownload = Stažení konektorů ##view_admin_downloads_connectors_help = Connectors are software that is needed in order for some products to be manageable by {0}. You install connectors into some managed products so {0} agents can talk to them. See the documentation for more information. view_admin_downloads_connectors_loadError = Nelze získat informace o konektorech view_admin_downloads_connectors_none = Žádné konektory nejsou dostupné pro stažení +##view_admin_downloads_scriptModulesDownload = Script Modules Download +##view_admin_downloads_scriptModules_help = Script modules are reusable components provided by RHQ to be used in your scripts (either alert scripts or CLI scripts). You can access them by using the "rhq://downloads/<module-name-without-file-extension>" URI in your scripting language of choice (i.e. in javascript, you would use the "require" function). +##view_admin_downloads_scriptModules_none = No script modules are available for download +##view_admin_downloads_scriptModules_loadError = Cannot load the list of available script modules ##view_admin_landing = From this section, the {0} global settings can be administered. This includes configuring security, setting up plugins, and managing {0} Servers and Agents. view_admin_measTemplates_updateExisting_title = Změnit existující rozvrhy ##view_admin_measTemplates_updateExisting_tooltip = Check this box to update the collection schedules for the selected metrics on all existing resources of this type. If this is not checked, the template schedules will only be applied to new resources of this type that are added to inventory in the future. diff --git a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_de.properties b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_de.properties index 473bc14..7f3fafa 100644 --- a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_de.properties +++ b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_de.properties @@ -533,6 +533,10 @@ view_admin_downloads_cli_version = Version des CLI ##view_admin_downloads_connectors_help = Connectors are software that is needed in order for some products to be manageable by {0}. You install connectors into some managed products so {0} agents can talk to them. See the documentation for more information. ##view_admin_downloads_connectors_loadError = Cannot get connectors info ##view_admin_downloads_connectors_none = No connectors are available for download +##view_admin_downloads_scriptModulesDownload = Script Modules Download +##view_admin_downloads_scriptModules_help = Script modules are reusable components provided by RHQ to be used in your scripts (either alert scripts or CLI scripts). You can access them by using the "rhq://downloads/<module-name-without-file-extension>" URI in your scripting language of choice (i.e. in javascript, you would use the "require" function). +##view_admin_downloads_scriptModules_none = No script modules are available for download +##view_admin_downloads_scriptModules_loadError = Cannot load the list of available script modules view_admin_landing = In dieser Sektion können die globalen Einstellungen für {0} verwaltet werden. Dies schließt Sicherheitseinstellungen und Plugins ein, sowie die Verwaltung der {0} Server- und Agentplugins. view_admin_measTemplates_updateExisting_title = Existierende Zeitpläne aktualisieren ##view_admin_measTemplates_updateExisting_tooltip = Check this box to update the collection schedules for the selected metrics on all existing resources of this type. If this is not checked, the template schedules will only be applied to new resources of this type that are added to inventory in the future. diff --git a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ja.properties b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ja.properties index 35f696e..ad760f9 100644 --- a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ja.properties +++ b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ja.properties @@ -564,6 +564,10 @@ view_admin_downloads_connectorsDownload = コネクタのダウンロード view_admin_downloads_connectors_help = コネクターは製品が{0}によって管理可能であるために必要となるソフトウェアです。RHQエージェントが通信できるように、管理製品にコネクターをインストールします。詳細はドキュメントをご覧ください。 view_admin_downloads_connectors_loadError = コネクター情報を取得できません view_admin_downloads_connectors_none = ダウンロードのためのコネクターが見つかりません +##view_admin_downloads_scriptModulesDownload = Script Modules Download +##view_admin_downloads_scriptModules_help = Script modules are reusable components provided by RHQ to be used in your scripts (either alert scripts or CLI scripts). You can access them by using the "rhq://downloads/<module-name-without-file-extension>" URI in your scripting language of choice (i.e. in javascript, you would use the "require" function). +##view_admin_downloads_scriptModules_none = No script modules are available for download +##view_admin_downloads_scriptModules_loadError = Cannot load the list of available script modules view_admin_landing = このセクションにおいて、{0}グローバル設定が管理されます。これはセキュリティ構成、プラグイン設定、RHQサーバーとエージェントの管理を含みます。 view_admin_measTemplates_updateExisting_title = 既存スケジュールの更新 view_admin_measTemplates_updateExisting_tooltip = このボックスをチェックすると、このタイプのすべてのリソースを対象に選択したメトリックスの収集スケジュールを更新します。もしこれがチェックされていなければ、テンプレートスケジュールが将来的にインベントリに追加されるこのタイプの新規リソースに適用されるだけです。 diff --git a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_pt.properties b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_pt.properties index 38b0f01..4241b3f 100644 --- a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_pt.properties +++ b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_pt.properties @@ -569,6 +569,10 @@ view_admin_downloads_connectorsDownload = Download dos Conectores ##view_admin_downloads_connectors_help = Connectors are software that is needed in order for some products to be manageable by RHQ. You install connectors into some managed products so RHQ agents can talk to them. See the documentation for more information. view_admin_downloads_connectors_loadError = Imposs\u00EDvel recuperar informa\u00E7\u00F5es dos conectores view_admin_downloads_connectors_none = Nenhum conector est\u00E1 dispon\u00EDvel para download +##view_admin_downloads_scriptModulesDownload = Script Modules Download +##view_admin_downloads_scriptModules_help = Script modules are reusable components provided by RHQ to be used in your scripts (either alert scripts or CLI scripts). You can access them by using the "rhq://downloads/<module-name-without-file-extension>" URI in your scripting language of choice (i.e. in javascript, you would use the "require" function). +##view_admin_downloads_scriptModules_none = No script modules are available for download +##view_admin_downloads_scriptModules_loadError = Cannot load the list of available script modules ##view_admin_landing = Nesta se\u00E7\u00E3o \u00E9 poss\u00EDvel administrar propriedades globais do RHQ. Isso inclui configura\u00E7\u00F5es de Seguran\u00E7a, Plugins, e gerenciamento de servidores RHQ e agentes. view_admin_measTemplates_updateExisting_title = Atualizar agendamentos existentes view_admin_measTemplates_updateExisting_tooltip = Marque esta op\u00E7\u00E3o para atualizar os agendamentos de coleta para as m\u00E9tricas selecionadas, em todos os recursos existentes para para este tipo. Caso contr\u00E1rio, o template dos agendamentos ser\u00E1 apenas aplicado para os novos recursos deste tipo, que ser\u00E1o adicionados ao invent\u00E1rio no futuro. diff --git a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ru.properties b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ru.properties index 64479c7..d74907e 100644 --- a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ru.properties +++ b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_ru.properties @@ -2462,6 +2462,10 @@ view_admin_downloads_cli_version = Версия CLI ##view_admin_downloads_connectors_help = Connectors are software that is needed in order for some products to be manageable by {0}. You install connectors into some managed products so {0} agents can talk to them. See the documentation for more information. ##view_admin_downloads_connectors_loadError = Cannot get connectors info ##view_admin_downloads_connectors_none = No connectors are available for download +##view_admin_downloads_scriptModulesDownload = Script Modules Download +##view_admin_downloads_scriptModules_help = Script modules are reusable components provided by RHQ to be used in your scripts (either alert scripts or CLI scripts). You can access them by using the "rhq://downloads/<module-name-without-file-extension>" URI in your scripting language of choice (i.e. in javascript, you would use the "require" function). +##view_admin_downloads_scriptModules_none = No script modules are available for download +##view_admin_downloads_scriptModules_loadError = Cannot load the list of available script modules ##view_alert_details_field_resource_ancestry = Resource Ancestry ##view_alert_details_field_watched_resource = Watched Resource ##view_bundle_list_error4 = No bundles found in this repository diff --git a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_zh.properties b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_zh.properties index c1f347f..56e6d59 100644 --- a/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_zh.properties +++ b/modules/enterprise/gui/coregui/src/main/resources/org/rhq/enterprise/gui/coregui/client/Messages_zh.properties @@ -556,6 +556,10 @@ view_admin_downloads_connectorsDownload = \u8fde\u63a5\u5668\u4e0b\u8f7d ##view_admin_downloads_connectors_help = Connectors are software that is needed in order for some products to be manageable by RHQ. You install connectors into some managed products so RHQ agents can talk to them. See the documentation for more information. view_admin_downloads_connectors_loadError = \u65e0\u6cd5\u83b7\u5f97\u8fde\u63a5\u5668\u4fe1\u606f view_admin_downloads_connectors_none = \u6ca1\u6709\u53ef\u7528\u8fde\u63a5\u5668\u4e0b\u8f7d +##view_admin_downloads_scriptModulesDownload = Script Modules Download +##view_admin_downloads_scriptModules_help = Script modules are reusable components provided by RHQ to be used in your scripts (either alert scripts or CLI scripts). You can access them by using the "rhq://downloads/<module-name-without-file-extension>" URI in your scripting language of choice (i.e. in javascript, you would use the "require" function). +##view_admin_downloads_scriptModules_none = No script modules are available for download +##view_admin_downloads_scriptModules_loadError = Cannot load the list of available script modules ##view_admin_landing = \u8fd9\u91cc\u4f60\u53ef\u4ee5\u7ba1\u7406RHQ\u5168\u5c40\u914d\u7f6e.\u5305\u62ec\u914d\u7f6e\u5b89\u5168,\u5b89\u88c5\u63d2\u4ef6,\u7ba1\u7406RHQ\u670d\u52a1\u5668\u548c\u4ee3\u7406. view_admin_measTemplates_updateExisting_title = \u66f4\u65b0\u5b58\u5728\u7684\u8ba1\u5212\u4efb\u52a1 view_admin_measTemplates_updateExisting_tooltip = Check this box to update the collection schedules for the selected metrics on all existing resources of this type. If this is not checked, the template schedules will only be applied to new resources of this type that are added to inventory in the future. diff --git a/modules/enterprise/remoting/cli/src/main/scripts/rhq-client.build.xml b/modules/enterprise/remoting/cli/src/main/scripts/rhq-client.build.xml index 715bd9b..2690dd3 100644 --- a/modules/enterprise/remoting/cli/src/main/scripts/rhq-client.build.xml +++ b/modules/enterprise/remoting/cli/src/main/scripts/rhq-client.build.xml @@ -86,7 +86,7 @@ <mkdir dir="${samples.home}" /> <echo>*** Populating sample scripts...</echo> <copy verbose="true" toDir="${samples.home}"> - <fileset dir="${basedir}/src/main/samples/" includes="*.*" /> + <fileset dir="${basedir}/src/main/samples/" includes="**" /> </copy> </target> diff --git a/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java b/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java index 6b866db..c9096f9 100644 --- a/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java +++ b/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java @@ -25,6 +25,7 @@ import java.io.InputStreamReader; import java.io.Reader; import java.net.MalformedURLException; import java.net.URI; +import java.net.URISyntaxException; import java.net.URL; import org.apache.commons.logging.Log; @@ -33,6 +34,7 @@ import org.apache.commons.logging.LogFactory; import org.rhq.bindings.StandardBindings; import org.rhq.bindings.client.RhqFacade; import org.rhq.bindings.script.BaseRhqSchemeScriptSourceProvider; +import org.rhq.enterprise.communications.util.SecurityUtil; /** * @author Lukas Krejci @@ -44,6 +46,8 @@ public class RhqDownloadsScriptSourceProvider extends BaseRhqSchemeScriptSourceP private static final String AUTHORITY = "downloads"; + private static final String URL_PATH_PREFIX = "/downloads/script-modules"; + private RemoteClient remoteClient; public RhqDownloadsScriptSourceProvider() { @@ -69,7 +73,15 @@ public class RhqDownloadsScriptSourceProvider extends BaseRhqSchemeScriptSourceP String path = scriptUri.getPath(); - URI remoteUri = remoteClient.getRemoteURI().resolve(AUTHORITY + path); + URI remoteUri = remoteClient.getRemoteURI().resolve(URL_PATH_PREFIX + path); + + String replacementScheme = SecurityUtil.isTransportSecure(remoteUri.getScheme()) ? "https" : "http"; + + try { + remoteUri = new URI(replacementScheme, remoteUri.getAuthority(), remoteUri.getPath(), remoteUri.getQuery(), remoteUri.getFragment()); + } catch (URISyntaxException e) { + LOG.error("Failed to copy the RHQ server download URI: " + remoteUri + " to the " + replacementScheme + " scheme."); + } try { URL downloadUrl = remoteUri.toURL(); diff --git a/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java b/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java index 591df06..78c0c57 100644 --- a/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java +++ b/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java @@ -52,7 +52,7 @@ public class RhqDownloadsScriptSourceProviderTest { public void createTmpDir() throws Exception { tmpDir = FileUtil.createTempDirectory(getClass().getName(), null, null); - File downloadsDir = new File(tmpDir, "downloads"); + File downloadsDir = new File(new File(tmpDir, "downloads"), "script-modules"); downloadsDir.mkdirs(); File testScript = new File(downloadsDir, "test-script.js"); diff --git a/modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java b/modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java index 7711078..c065b48 100644 --- a/modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java +++ b/modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java @@ -69,7 +69,7 @@ public class RhqDownloadsScriptSourceProvider extends BaseRhqSchemeScriptSourceP String serverHomeDir = serverDetails.getDetails().get(ServerDetails.Detail.SERVER_HOME_DIR); - File downloads = new File(serverHomeDir, "deploy/rhq.ear/rhq-downloads"); + File downloads = new File(serverHomeDir, "deploy/rhq.ear/rhq-downloads/script-modules"); File file = new File(downloads, path); diff --git a/modules/enterprise/server/client-api/src/test/java/org/rhq/enterprise/client/test/RhqDownloadsScriptSourceProviderTest.java b/modules/enterprise/server/client-api/src/test/java/org/rhq/enterprise/client/test/RhqDownloadsScriptSourceProviderTest.java index 2c73eec..a2c4a33 100644 --- a/modules/enterprise/server/client-api/src/test/java/org/rhq/enterprise/client/test/RhqDownloadsScriptSourceProviderTest.java +++ b/modules/enterprise/server/client-api/src/test/java/org/rhq/enterprise/client/test/RhqDownloadsScriptSourceProviderTest.java @@ -54,7 +54,7 @@ public class RhqDownloadsScriptSourceProviderTest { @BeforeClass public void createTmpDir() throws Exception { tmpDir = FileUtil.createTempDirectory(getClass().getName(), null, null); - File downloadsDir = new File(new File(new File(tmpDir, "deploy"), "rhq.ear"), "rhq-downloads"); + File downloadsDir = new File(new File(new File(new File(tmpDir, "deploy"), "rhq.ear"), "rhq-downloads"), "script-modules"); downloadsDir.mkdirs(); File testScript = new File(downloadsDir, "test-script.js"); diff --git a/modules/enterprise/server/container/src/main/downloadable-resources/cli-alert-scripts/fix-bundle-deployment.js b/modules/enterprise/server/container/src/main/downloadable-resources/cli-alert-scripts/fix-bundle-deployment.js index 5dba002..f520488 100644 --- a/modules/enterprise/server/container/src/main/downloadable-resources/cli-alert-scripts/fix-bundle-deployment.js +++ b/modules/enterprise/server/container/src/main/downloadable-resources/cli-alert-scripts/fix-bundle-deployment.js @@ -1,10 +1,6 @@ /** * Using this script one can automatically reset a bundle deployment to a specified version. * - * This script consists of several utility methods originally included in standalone files - * in the samples of the CLI distribution, which have been included in this file so that it - * is usable on its own even in the server environment. - * * The configuration of the bundle and its version to reset to is located at the top of this file. * Please provide the values to the variables as instructed to make this script work in * a concrete situation. @@ -70,415 +66,8 @@ var description = "redeploy due to drift"; // original versions from the bundle. var isCleanDeployment = true; -//-------------------- util.js - -/** - * If obj is a JS array or a java.util.Collection, each element is passed to - * the callback function. If obj is a java.util.Map, each map entry is passed - * to the callback function as a key/value pair. If obj is none of the - * aforementioned types, it is treated as a generic object and each of its - * properties is passed to the callback function as a name/value pair. - */ -function foreach(obj, fn) { - if (obj instanceof Array) { - for (i in obj) { - fn(obj[i]); - } - } - else if (obj instanceof java.util.Collection) { - var iterator = obj.iterator(); - while (iterator.hasNext()) { - fn(iterator.next()); - } - } - else if (obj instanceof java.util.Map) { - var iterator = obj.entrySet().iterator() - while (iterator.hasNext()) { - var entry = iterator.next(); - fn(entry.key, entry.value); - } - } - else { // assume we have a generic object - for (i in obj) { - fn(i, obj[i]); - } - } -} - -/** - * Iterates over obj similar to foreach. fn should be a predicate that evaluates - * to true or false. The first match that is found is returned. - */ -function find(obj, fn) { - if (obj instanceof Array) { - for (i in obj) { - if (fn(obj[i])) { - return obj[i] - } - } - } - else if (obj instanceof java.util.Collection) { - var iterator = obj.iterator(); - while (iterator.hasNext()) { - var next = iterator.next(); - if (fn(next)) { - return next; - } - } - } - else if (obj instanceof java.util.Map) { - var iterator = obj.entrySet().iterator(); - while (iterator.hasNext()) { - var entry = iterator.next(); - if (fn(entry.key, entry.value)) { - return {key: entry.key, value: entry.value}; - } - } - } - else { - for (i in obj) { - if (fn(i, obj[i])) { - return {key: i, value: obj[i]}; - } - } - } - return null; -} - -/** - * Iterates over obj similar to foreach. fn should be a predicate that evaluates - * to true or false. All of the matches are returned in a java.util.List. - */ -function findAll(obj, fn) { - var matches = java.util.ArrayList(); - if ((obj instanceof Array) || (obj instanceof java.util.Collection)) { - foreach(obj, function(element) { - if (fn(element)) { - matches.add(element); - } - }); - } - else { - foreach(obj, function(key, value) { - if (fn(theKey, theValue)) { - matches.add({key: theKey, value: theValue}); - } - }); - } - return matches; -} - -/** - * A convenience function to convert javascript hashes into RHQ's configuration - * objects. - * - * The conversion of individual keys in the hash follows these rules: - * <ol> - * <li> if a value of a key is a javascript array, it is interpreted as PropertyList - * <li> if a value is a hash, it is interpreted as a PropertyMap - * <li> otherwise it is interpreted as a PropertySimple - * <li> a null or undefined value is ignored - * </ol> - * - * Note that the conversion isn't perfect, because the hash does not contain enough - * information to restore the names of the list members. - * - * Example: - * <pre><code> - * { - * simple : "value", - * list : [ "value1", "value2"], - * listOfMaps : [ { k1 : "value", k2 : "value" }, { k1 : "value2", k2 : "value2" } ] - * } - * </code></pre> - * gets converted to a configuration object: - * Configuration: - * <ul> - * <li> PropertySimple(name = "simple", value = "value") - * <li> PropertyList(name = "list") - * <ol> - * <li>PropertySimple(name = "list", value = "value1") - * <li>PropertySimple(name = "list", value = "value2") - * </ol> - * <li> PropertyList(name = "listOfMaps") - * <ol> - * <li> PropertyMap(name = "listOfMaps") - * <ul> - * <li>PropertySimple(name = "k1", value = "value") - * <li>PropertySimple(name = "k2", value = "value") - * </ul> - * <li> PropertyMap(name = "listOfMaps") - * <ul> - * <li>PropertySimple(name = "k1", value = "value2") - * <li>PropertySimple(name = "k2", value = "value2") - * </ul> - * </ol> - * </ul> - * Notice that the members of the list have the same name as the list itself - * which generally is not the case. - */ -function asConfiguration(hash) { - - config = new Configuration; - - for(key in hash) { - value = hash[key]; - - if (value == null) { - continue; - } - - (function(parent, key, value) { - function isArray(obj) { - return typeof(obj) == 'object' && (obj instanceof Array); - } - - function isHash(obj) { - return typeof(obj) == 'object' && !(obj instanceof Array); - } - - function isPrimitive(obj) { - return typeof(obj) != 'object'; - } - - //this is an anonymous function, so the only way it can call itself - //is by getting its reference via argument.callee. Let's just assign - //a shorter name for it. - var me = arguments.callee; - - var prop = null; - - if (isPrimitive(value)) { - prop = new PropertySimple(key, new java.lang.String(value)); - } else if (isArray(value)) { - prop = new PropertyList(key); - for(var i = 0; i < value.length; ++i) { - var v = value[i]; - if (v != null) { - me(prop, key, v); - } - } - } else if (isHash(value)) { - prop = new PropertyMap(key); - for(var i in value) { - var v = value[i]; - if (value != null) { - me(prop, i, v); - } - } - } - - if (parent instanceof PropertyList) { - parent.add(prop); - } else { - parent.put(prop); - } - })(config, key, value); - } - - return config; -} - -/** - * Opposite of <code>asConfiguration</code>. Converts an RHQ's configuration object - * into a javascript hash. - * - * @param configuration - */ -function asHash(configuration) { - ret = {} - - iterator = configuration.getMap().values().iterator(); - while(iterator.hasNext()) { - prop = iterator.next(); - - (function(parent, prop) { - function isArray(obj) { - return typeof(obj) == 'object' && (obj instanceof Array); - } - - function isHash(obj) { - return typeof(obj) == 'object' && !(obj instanceof Array); - } - - var me = arguments.callee; - - var representation = null; - - if (prop instanceof PropertySimple) { - representation = prop.stringValue; - } else if (prop instanceof PropertyList) { - representation = []; - - for(var i = 0; i < prop.list.size(); ++i) { - var child = prop.list.get(i); - me(representation, child); - } - } else if (prop instanceof PropertyMap) { - representation = {}; - - var childIterator = prop.getMap().values().iterator(); - while(childIterator.hasNext()) { - var child = childIterator.next(); - - me(representation, child); - } - } - - if (isArray(parent)) { - parent.push(representation); - } else if (isHash(parent)) { - parent[prop.name] = representation; - } - })(ret, prop); - } - (function(parent) { - - })(configuration); - - return ret; -} - -//------------------------------ bundles.js - -/** - * A simple function to create a new bundle version from a zip file containing - * the bundle. - * - * @param pathToBundleZipFile the path to the bundle on the local file system - * - * @return an instance of BundleVersion class describing what's been created on - * the RHQ server. - */ -function createBundleVersion(pathToBundleZipFile) { - var bytes = getFileBytes(pathToBundleZipFile) - return BundleManager.createBundleVersionViaByteArray(bytes) -} - -/** - * This is a helper function that one can use to find out what base directories - * given resource type defines. - * - * These base directories then can be used when specifying bundle destinations. - * - * @param resourceTypeId - * @returns a java.util.Set of ResourceTypeBundleConfiguration objects - */ -function getAllBaseDirectories(resourceTypeId) { - var crit = new ResourceTypeCriteria; - crit.addFilterId(resourceTypeId); - crit.fetchBundleConfiguration(true); - - var types = ResourceTypeManager.findResourceTypesByCriteria(crit); - - if (types.size() == 0) { - throw "Could not find a resource type with id " + resourceTypeId; - } else if (types.size() > 1) { - throw "More than one resource type found with id " + resourceTypeId + "! How did that happen!"; - } - - var type = types.get(0); - - return type.getResourceTypeBundleConfiguration().getBundleDestinationBaseDirectories(); -} - -/** - * Creates a new destination for given bundle. Once a destination exists, - * actual bundle versions can be deployed to it. - * - * Note that this only differs from the <code>BundleManager.createBundleDestination</code> - * method in the fact that one can provide bundle and resource group names instead of their - * ids. - * - * @param destinationName the name of the destination to be created - * @param description the description for the destination - * @param bundleName the name of the bundle to create the destination for - * @param groupName name of a group of resources that the destination will handle - * @param baseDirName the name of the basedir definition that represents where inside the - * deployment of the individual resources the bundle will get deployed - * @param deployDir the specific sub directory of the base dir where the bundles will get deployed - * - * @return BundleDestination object - */ -function createBundleDestination(destinationName, description, bundleName, groupName, baseDirName, deployDir) { - var groupCrit = new ResourceGroupCriteria; - groupCrit.addFilterName(groupName); - var groups = ResourceGroupManager.findResourceGroupsByCriteria(groupCrit); - - if (groups.empty) { - throw "No group called '" + groupName + "' found."; - } - - var group = groups.get(0); - - var bundleCrit = new BundleCriteria; - bundleCrit.addFilterName(bundleName); - var bundles = BundleManager.findBundlesByCriteria(bundleCrit); - - if (bundles.empty) { - throw "No bundle called '" + bundleName + "' found."; - } - - var bundle = bundles.get(0); - - return BundleManager.createBundleDestination(bundle.id, destinationName, description, baseDirName, deployDir, group.id); -} - -/** - * Tries to deploy given bundle version to provided destination using given configuration. - * - * This method blocks while waiting for the deployment to complete or fail. - * - * @param destination the bundle destination (or id thereof) - * @param bundleVersion the bundle version to deploy (or id thereof) - * @param deploymentConfiguration the deployment configuration. This can be an ordinary - * javascript object (hash) or an instance of RHQ's Configuration. If it is the former, - * it is converted to a Configuration instance using the <code>asConfiguration</code> - * function from <code>util.js</code>. Please consult the documentation of that method - * to understand the limitations of that approach. - * @param description the deployment description - * @param isCleanDeployment if true, perform a wipe of the deploy directory prior to the deployment; if false, - * perform as an upgrade to the existing deployment, if any - * - * @return the BundleDeployment instance describing the deployment - */ -function deployBundle(destination, bundleVersion, deploymentConfiguration, description, isCleanDeployment) { - var destinationId = destination; - if (typeof(destination) == 'object') { - destinationId = destination.id; - } - - var bundleVersionId = bundleVersion; - if (typeof(bundleVersion) == 'object') { - bundleVersionId = bundleVersion.id; - } - - var deploymentConfig = deploymentConfiguration; - if (!(deploymentConfiguration instanceof Configuration)) { - deploymentConfig = asConfiguration(deploymentConfiguration); - } - - var deployment = BundleManager.createBundleDeployment(bundleVersionId, destinationId, description, deploymentConfig); - - deployment = BundleManager.scheduleBundleDeployment(deployment.id, isCleanDeployment); - - var crit = new BundleDeploymentCriteria; - crit.addFilterId(deployment.id); - - while (deployment.status == BundleDeploymentStatus.PENDING || deployment.status == BundleDeploymentStatus.IN_PROGRESS) { - java.lang.Thread.currentThread().sleep(1000); - var dps = BundleManager.findBundleDeploymentsByCriteria(crit); - if (dps.empty) { - throw "The deployment disappeared while we were waiting for it to complete."; - } - - deployment = dps.get(0); - } - - return deployment; -} - -//------------------- script body +//-------------------------- script body -deployBundle(destinationId, bundleVersionId, deploymentConfig, description, isCleanDeployment); +var bundles = require('rhq://downloads/bundles'); +bundles.deployBundle(destinationId, bundleVersionId, deploymentConfig, description, isCleanDeployment); diff --git a/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/bundles.js b/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/bundles.js new file mode 100644 index 0000000..f7fbdc2 --- /dev/null +++ b/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/bundles.js @@ -0,0 +1,150 @@ +/** + * file: bundles.js + * + * description: this file contains a few helper functions to make working + * with the bundle subsystem more convenient. + * + * Note that you must login before you can load the scripts. + * + * author: lkrejci(a)redhat.com + */ + +var util = require('./util'); + +/** + * A simple function to create a new bundle version from a zip file containing + * the bundle. + * + * @param pathToBundleZipFile the path to the bundle on the local file system + * + * @return an instance of BundleVersion class describing what's been created on + * the RHQ server. + */ +exports.createBundleVersion = function(pathToBundleZipFile) { + var bytes = getFileBytes(pathToBundleZipFile) + return BundleManager.createBundleVersionViaByteArray(bytes) +} + +/** + * This is a helper function that one can use to find out what base directories + * given resource type defines. + * + * These base directories then can be used when specifying bundle destinations. + * + * @param resourceTypeId + * @returns a java.util.Set of ResourceTypeBundleConfiguration objects + */ +exports.getAllBaseDirectories = function(resourceTypeId) { + var crit = new ResourceTypeCriteria; + crit.addFilterId(resourceTypeId); + crit.fetchBundleConfiguration(true); + + var types = ResourceTypeManager.findResourceTypesByCriteria(crit); + + if (types.size() == 0) { + throw "Could not find a resource type with id " + resourceTypeId; + } else if (types.size() > 1) { + throw "More than one resource type found with id " + resourceTypeId + "! How did that happen!"; + } + + var type = types.get(0); + + return type.getResourceTypeBundleConfiguration().getBundleDestinationBaseDirectories(); +} + +/** + * Creates a new destination for given bundle. Once a destination exists, + * actual bundle versions can be deployed to it. + * + * Note that this only differs from the <code>BundleManager.createBundleDestination</code> + * method in the fact that one can provide bundle and resource group names instead of their + * ids. + * + * @param destinationName the name of the destination to be created + * @param description the description for the destination + * @param bundleName the name of the bundle to create the destination for + * @param groupName name of a group of resources that the destination will handle + * @param baseDirName the name of the basedir definition that represents where inside the + * deployment of the individual resources the bundle will get deployed + * @param deployDir the specific sub directory of the base dir where the bundles will get deployed + * + * @return BundleDestination object + */ +exports.createBundleDestination = function(destinationName, description, bundleName, groupName, baseDirName, deployDir) { + var groupCrit = new ResourceGroupCriteria; + groupCrit.addFilterName(groupName); + var groups = ResourceGroupManager.findResourceGroupsByCriteria(groupCrit); + + if (groups.empty) { + throw "No group called '" + groupName + "' found."; + } + + var group = groups.get(0); + + var bundleCrit = new BundleCriteria; + bundleCrit.addFilterName(bundleName); + var bundles = BundleManager.findBundlesByCriteria(bundleCrit); + + if (bundles.empty) { + throw "No bundle called '" + bundleName + "' found."; + } + + var bundle = bundles.get(0); + + return BundleManager.createBundleDestination(bundle.id, destinationName, description, baseDirName, deployDir, group.id); +} + +/** + * Tries to deploy given bundle version to provided destination using given configuration. + * + * This method blocks while waiting for the deployment to complete or fail. + * + * @param destination the bundle destination (or id thereof) + * @param bundleVersion the bundle version to deploy (or id thereof) + * @param deploymentConfiguration the deployment configuration. This can be an ordinary + * javascript object (hash) or an instance of RHQ's Configuration. If it is the former, + * it is converted to a Configuration instance using the <code>asConfiguration</code> + * function from <code>util.js</code>. Please consult the documentation of that method + * to understand the limitations of that approach. + * @param description the deployment description + * @param isCleanDeployment if true, perform a wipe of the deploy directory prior to the deployment; if false, + * perform as an upgrade to the existing deployment, if any + * + * @return the BundleDeployment instance describing the deployment + */ +exports.deployBundle = function(destination, bundleVersion, deploymentConfiguration, description, isCleanDeployment) { + var destinationId = destination; + if (typeof(destination) == 'object') { + destinationId = destination.id; + } + + var bundleVersionId = bundleVersion; + if (typeof(bundleVersion) == 'object') { + bundleVersionId = bundleVersion.id; + } + + var deploymentConfig = deploymentConfiguration; + if (!(deploymentConfiguration instanceof Configuration)) { + deploymentConfig = util.asConfiguration(deploymentConfiguration); + } + + var deployment = BundleManager.createBundleDeployment(bundleVersionId, destinationId, description, deploymentConfig); + + deployment = BundleManager.scheduleBundleDeployment(deployment.id, isCleanDeployment); + + var crit = new BundleDeploymentCriteria; + crit.addFilterId(deployment.id); + + while (deployment.status == BundleDeploymentStatus.PENDING || deployment.status == BundleDeploymentStatus.IN_PROGRESS) { + java.lang.Thread.currentThread().sleep(1000); + var dps = BundleManager.findBundleDeploymentsByCriteria(crit); + if (dps.empty) { + throw "The deployment disappeared while we were waiting for it to complete."; + } + + deployment = dps.get(0); + } + + return deployment; +} + diff --git a/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/drift.js b/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/drift.js new file mode 100644 index 0000000..b07eaec --- /dev/null +++ b/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/drift.js @@ -0,0 +1,240 @@ +/** + * file: drift.js + * + * description: This script contains functions that illustrate and highlight + * drift monitoring functionality. Some of the functionality demonstrated in + * this script is currently available only via RHQ's remote client (and CLI) + * at the time of this writing. + * + * Note that you must login before you can load the scripts. Also please note + * that if a function is not documented, then it is not intended for public + * use. It is used only as an internal helper function. + * + * author: jsanda(a)redhat.com + */ + +var util = require("./util"); + +/** + * description: Generates a snapshot of changes sets belonging to a particular + * drift definition of a specific resource. By default all change sets are + * included in the snapshot. An optional third argument can be specified to + * limit or control the number of change sets included in the snapshot. + * + * Note that a snapshot is an accumulation or aggregation of change sets that + * provides a view of a resource, or more precisely, all files being monitored + * for drift, at a particular version or point in time. + * + * arguments: + * rid: A resource id, expected to be an integer + * + * defName: The drift definition name as a string + * + * filter: (optional) A map or JS object that limits the number of + * change sets included in the snapshot. It should specify two + * properties - startVersion and endVersion. + * + * return: A org.rhq.core.domamin.drift.DriftSnapshot object + * + * usage: + * // generates a snapshot that includes all change sets belonging to the + * // mydrift drift configuration. + * createSnapshot(123, 'mydrift') + * + * // generates a snapshot that includes change sets 3 through 5 inclusive. + * createSnapshot(123, 'mydrift', {startVersion: 3, endVersion: 5}) + */ +exports.createSnapshot = function(rid, defName) { + var driftDef = findDriftDefinition(rid, function(d) { return defName.equals(d.name) }); + var snapshotRequest; + + if (arguments.length > 2) { + var filters = arguments[2]; + snapshotRequest = DriftSnapshotRequest(driftDef.id, filters.startVersion, filters.endVersion); + } else { + snapshotRequest = DriftSnapshotRequest(driftDef.id); + } + + return DriftManager.getSnapshot(snapshotRequest); +} + +/** private helper function to find a drift definition by a filter */ +function findDriftDefinition(rid, filter) { + var criteria = ResourceCriteria(); + criteria.addFilterId(rid); + criteria.fetchDriftDefinitions(true); + + var resources = ResourceManager.findResourcesByCriteria(criteria); + var resource = resources.get(0); + + return util.find(resource.driftDefinitions, function(config) { + return filter(DriftDefinition(config)); + }); +} + +/** + * description: Generates a diff report that is printed to the console. By + * default this function generates a snapshot diff. The function expects two + * arguments which should be DriftSnapshot objects. A diff between those two + * snapshots is generated and printed to the console. A path can be specified + * as an optional third argument. If a path is a specified as a third argument, + * then a file diff will be performed using the file that matches the path in + * each change set. The format will be a unified diff. + * + * Note that the snapshots can be from the same or from different resources; + * however, if they are from different resources, it is assumed that the + * resources are of the same type. + * + * arguments: + * s1: A DriftSnapshot object + * + * s2: A DriftSnapshot object + * + * path: (optional) A string that specifies a path that exists in both s1 and + * s2. + * + * return: This function does not return a useful value. It may be an empty + * string or it could be null. Instead of returning its results, the function + * prints them to the CLI console. As such, this function is intended for + * use from the interactive CLI shell. + * + * usage: + * // Generates a snapshot diff report + * diff(s1, s2) + * + * // Generates a file diff report in the unified format + * diff(s1, s2, 'jboss_home/bin/run.conf') + */ +exports.diff = function(s1, s2) { + var theDiff = s1.diff(s2); + + if (arguments.length > 2) { + var path = arguments[2]; + + if (theDiff.elementsInConflict.size() == 0) { + // If the snapshot diff reports no files in conflict, then there + // is no need to call the server to perform the file diff. We can + // instead return quickly. + println("There are no differences to report"); + return ""; + } + + var pathFilter = function(entry) { return entry.path == path; }; + var e1 = util.find(s1.driftInstances, pathFilter); + var e2 = util.find(s2.driftInstances, pathFilter); + + var fileDiff = DriftManager.generateUnifiedDiff(e1, e2); + util.foreach(fileDiff.diff, println); + return ""; + } + + function printEntry(entry) { + println(entry.newDriftFile.hashId + '\t' + entry.path); + } + + function report(header, elements) { + println(header + ':'); + util.foreach(elements, printEntry); + println('\n'); + } + + report('elements in conflict', theDiff.elementsInConflict); + report('elements not in left', theDiff.elementsNotInLeft); + report('elements not in right', theDiff.elementsNotInRight); +} + +/** + * description: Generates and returns the drift history for a file being + * monitored for drift. This function takes three arguments. The first two, the + * resource id drift configuration name, uniquely identify the drift + * configuration. The third argument specifies a path that is set up for + * monitoring by the drift configuration. + * + * arguments: + * rid: A resource id + * + * configName: A drift configuration name + * + * path: A path that is set up for drift monitoring by the drift + * configuration that is identified by the first two arguments. The path + * should be specified as relative to the base directory from which + * monitoring is done. + * + * return: A History object, which is a native JS object. This object contains + * a few methods for working with the file history: + * + * list: prints a short summary of all versions of the file + * view: returns the contents of a particular version of the file + * compare: compares two versions of the file and prints a unified diff + * + * usage: + * $ history = fetchHistory(123, 'mydrift', 'bin/run.conf') + * $ history.list() // prints a summary of all versions of 'bin/run.conf' + * $ history.view(1) // returns the full contents of version 1 of the file + * $ history.compare(1, 2) // generates and prints a unified diff of versions 1 and 2 + */ +exports.fetchHistory = function(rid, driftDefName, path) { + function History() { + var entries = []; + + function findDrift(version) { + return util.find(entries, function(drift) { + return drift.changeSet.version == version + }); + } + + + var generate = function() { + entries = []; + var criteria = GenericDriftCriteria(); + criteria.addFilterResourceIds([rid]); + criteria.fetchChangeSet(true); + criteria.addFilterPath(path); + + var drifts = DriftManager.findDriftsByCriteria(criteria); + util.foreach(drifts, function(drift) { + if (drift.changeSet.driftDefinition.name == driftDefName && + drift.path == path) { + entries.push(drift); + } + }); + + entries.sort(function(d1, d2) { + return d1.changeSet.version <= d2.changeSet.version + }); + } + + this.list = function() { + var format = java.text.DateFormat.getDateTimeInstance(); + println(path + "\n-----------------------------------"); + util.foreach(entries, function(drift) { + println(drift.changeSet.version + "\t" + format.format(drift.ctime)); + }); + } + + this.view = function(version) { + var drift = findDrift(version); + if (drift == null) { + return "Could not find version " + version; + } + return java.lang.String(DriftManager.getDriftFileAsByteArray(drift.newDriftFile.hashId)); + } + + this.compare = function(v1, v2) { + var d1 = findDrift(v1); + if (d1 == null) { + return "Could not find version " + v1; + } + var d2 = findDrift(v2); + if (d2 == null) { + return "Could not find version " + v2; + } + var fileDiff = DriftManager.generateUnifiedDiff(d1, d2); + util.foreach(fileDiff.diff, println); + } + + generate(); + } + + return new History(); +} diff --git a/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/jbossas.js b/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/jbossas.js new file mode 100644 index 0000000..6369cc1 --- /dev/null +++ b/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/jbossas.js @@ -0,0 +1,811 @@ +/** + * This module contains a variety of utility functions for working with JBoss AS in different versions. + * + * @author Lukas Krejci + */ + + +var util = require('./util'); +var bundles = require("./bundles"); + +//init the version-specific objects. We'll be adding the functions to them further down below. +exports.as7 = {} + +/** + * This creates a new destination in the JBoss AS (4,5,6,7) servers from the provided + * group and deploys the application provided by the bundle to it. Once the app is deployed, + * the servers in the group are sequentially stopped and started. + * + * @param bundleZipFile the path to the zip file with the application bundle + * @param deploymentConfiguration the deployment configuration required by the bundle. + * See the <code>deployBundle</code> in <code>bundles.js</code> to find out about + * supported formats. + * @param groupName the name of the compatible group of JBossAS servers to deploy the bundle to + * @param destinationName the name of the destination that will be created so that the bundle + * can be deployed to it + * @param destinationDescription the description of the destination + * @param baseDirName the name of the base directory for the deployment. Each resource type + * defines a list of deployment base directories which you can review using, for example, + * the <code>getAllBaseDirectories(resourceTypeId)</code> function from <code>bundles.js</code>. + * @param deployDir the name of the directory under the base dir in which the bundle will be + * deployed to. + * + * @return the BundleDeployment instance + */ +exports.createAppAndRestart = function(bundleZipFile, deploymentConfiguration, groupName, destinationName, destinationDescription, baseDirName, deployDir) { + var gcrit = new ResourceGroupCriteria; + gcrit.addFilterName(groupName); + gcrit.fetchResourceType(true); + + var groups = ResourceGroupManager.findResourceGroupsByCriteria(gcrit); + if (groups.empty) { + throw "Could not find a resource group called " + groupName; + } else if (groups.size() > 1) { + throw "There are more than 1 groups called " + groupName; + } + + var group = groups.get(0); + var targetResourceType = group.resourceType; + + var deployFn = function(restartFn) { + + var bundleVersion = bundles.createBundleVersion(bundleZipFile); + var destination = BundleManager.createBundleDestination(bundleVersion.bundle.id, destinationName, destinationDescription, baseDirName, deployDir, group.id); + + var deployment = bundles.deployBundle(bundleVersion, destination, deploymentConfiguration, null); + + if (deployment.status != BundleDeploymentStatus.SUCCESS) { + throw "Deployment wasn't successful: " + deployment; + } + + restartFn(group); + + return deployment; + }; + + if (targetResourceType.plugin == "JBossAS" && targetResourceType.name == "JBossAS Server") { + return deployFn(_restartAS4); + } else if (targetResourceType.plugin == "JBossAS5" && targetResourceType.name == "JBossAS Server") { + return deployFn(_restartAS5); + } else if (targetResourceType.plugin == "jboss-as-7" && + (targetResourceType.name == "JBossAS7-Standalone" || + targetResourceType.name == "JBossAS-Managed")) { + return deployFn(_restartAS7); + } + + throw "The resource group the destination targets doesn't seem to be a JBoss AS server group."; +} + +/** + * Deploys an updated bundle of an enterprise application to a destination that + * points to a group of JBoss AS(4,5,6,7) servers and then stops all the servers + * serially and then starts them up again sequentially. + * + * @param bundleZipFile + * the path to the bundle zip file with the application + * @param jbasDestination + * the bundle destination the bundle should be deployed to (or id + * thereof) + * @param deploymentConfiguration + * the deployment configuration. This can be an ordinary javascript + * object (hash) or an instance of RHQ's Configuration. If it is the + * former, it is converted to the Configuration instance using the + * <code>asConfiguration</code> function from <code>util.js</code>. + * Please consult the documentation of that method to understand the + * limitations of that approach. + * @param description + * the deployment description + * + * @return the deployment instance + */ +exports.updateAppAndRestart = function(bundleZipFile, jbasDestination, deploymentConfiguration) { + // first figure out the jbas version we are deploying to + var destinationId = jbasDestination; + if (typeof(jbasDestination) == 'object') { + destinationId = jbasDestination.id; + } + + var destCrit = new BundleDestinationCriteria + destCrit.fetchGroup(true) + + var destinations = BundleManager.findBundleDestinationsByCriteria(destCrit); + + if (destinations.empty) { + throw "No destinations corresponding to " + jbasDestination + " found on the server."; + } + + var destination = destinations.get(0); + + var targetResourceType = destination.group.resourceType; + + if (targetResourceType == null) { + throw "This function expects a compatible group of JBoss AS (4,5,6 or 7) resources but the provided destination is connected with " + destination.group; + } + + var deployFn = function(restartFn) { + var bundleVersion = bundles.createBundleVersion(bundleZipFile); + var deployment = bundles.deployBundle(bundleVersion, destination, deploymentConfiguration, null); + + if (deployment.status != BundleDeploymentStatus.SUCCESS) { + throw "Deployment wasn't successful: " + deployment; + } + + restartFn(destination.group); + + return deployment; + }; + + if (targetResourceType.plugin == "JBossAS" && targetResourceType.name == "JBossAS Server") { + return deployFn(_restartAS4); + } else if (targetResourceType.plugin == "JBossAS5" && targetResourceType.name == "JBossAS Server") { + return deployFn(_restartAS5); + } else if (targetResourceType.plugin == "jboss-as-7" && + (targetResourceType.name == "JBossAS7-Standalone" || + targetResourceType.name == "JBossAS-Managed")) { + return deployFn(_restartAS7); + } + + throw "The resource group the destination targets doesn't seem to be a JBoss AS server group."; +} + +/** + * This function adds an AS7 server to a cluster with another AS7 instance, using + * the provided node name as its identifier. + * + * This method only makes the new member use the same configuration as the existing + * member and synchronizes its jgroups, messaging and modcluster socket bindings + * with the cluster. Optionally it also copies over all the deployments to the + * new member. + * + * The configurations are therefore assumed to be otherwise compatible - i.e. + * the infinispan cache containers should be configured correctly (or left at + * default values, which are configured correctly), etc. + * + * @param newAs7Resource the resource proxy of the AS7 instance to add + * @param newNodeName the node name, i.e. unique identification, of the new member + * in the cluster + * @param existingClusterMemberResource an AS7 instance that belongs to a cluster + * the new member should join into. + * @param copyDeployments whether or not to copy the deployments from the existing + * member to the new member + */ +exports.as7.addToCluster = function(newAs7Resource, newNodeName, existingClusterMemberResource, doCopyDeployments) { + println("Reading config of the existing cluster member"); + var existingMember = { + 'id' : existingClusterMemberResource.id, + 'resourceConfiguration' : _getLiveResourceConfiguration(existingClusterMemberResource), + 'pluginConfiguration' : _getPluginConfiguration(existingClusterMemberResource) + }; + + var clusterConfig = _getClusterSignificantConfig(existingClusterMemberResource.children, + existingMember.pluginConfiguration, existingMember.resourceConfiguration); + + println("Reading config of the new member"); + var newMember = { + 'id' : newAs7Resource.id, + 'resourceConfiguration' : _getLiveResourceConfiguration(newAs7Resource), + 'pluginConfiguration' : _getPluginConfiguration(newAs7Resource) + }; + + var memberConfig = _getClusterSignificantConfig(newAs7Resource.children, newMember.pluginConfiguration, newMember.resourceConfiguration); + + var memberResourceConfiguration = newMember.resourceConfiguration.deepCopy(false); + + if (memberConfig['config'] != clusterConfig['config']) { + println("The configurations of the servers differ.\n" + + "The new cluster member's configuration will be changed to match the configuration of the existing member."); + + newAs7Resource.updatePluginConfiguration(_changeConfig(newMember.pluginConfiguration, clusterConfig['config'])); + + //we need to restart straight away so that we see the changes to the + //rest of the configuration caused by the change of current config. + println("Restarting the new cluster member to switch it to the new configuration."); + newAs7Resource.restart(); + + //refresh the resource + newAs7Resource = ProxyFactory.getResource(newMember.id); + newMember = { + 'id' : newAs7Resource.id, + 'resourceConfiguration' : _getLiveResourceConfiguration(newAs7Resource), + 'pluginConfiguration' : _getPluginConfiguration(newAs7Resource) + }; + + //refresh the cluster specific config after the restart with the new + //config + memberConfig = _getClusterSignificantConfig(newAs7Resource.children, newMember.pluginConfiguration, newMember.resourceConfiguration); + memberResourceConfiguration = newMember.resourceConfiguration; + } + + //now check what's the node name we see + if (memberConfig['node-name'] != newNodeName) { + println("Updating the node name of the new cluster member from '" + memberConfig['node-name'] + "' to '" + newNodeName + "'"); + _updateNodeName(memberResourceConfiguration, newNodeName); + + newAs7Resource.updateResourceConfiguration(memberResourceConfiguration); + memberResourceConfiguration = newMember.resourceConfiguration.deepCopy(false); + } + + //now apply the socket binding changes for jgroups and other cluster + //significant subsystems + //first find the socket binding group config in the new member + for(i in newAs7Resource.children) { + var child = newAs7Resource.children[i]; + if (child.resourceType.name == 'SocketBindingGroup' && + child.resourceType.plugin == 'JBossAS7') { + + println("Updating socket bindings of jgroups, messaging and modcluster subsystems"); + + var resourceConfig = _getLiveResourceConfiguration(child); + + var portOffset = javascriptString(resourceConfig.getSimpleValue('port-offset', '0')); + var clusterMemberPortOffset = clusterConfig['port-offset']; + + var newConfig = resourceConfig.deepCopy(false); + + _updateSocketBindings(newConfig, portOffset, clusterMemberPortOffset, clusterConfig['jgroups']); + _updateSocketBindings(newConfig, portOffset, clusterMemberPortOffset, clusterConfig['messaging']); + _updateSocketBindings(newConfig, portOffset, clusterMemberPortOffset, clusterConfig['modcluster']); + + child.updateResourceConfiguration(newConfig); + } + } + + println("Restarting the new member for the new socket bindings to take effect."); + newAs7Resource.restart(); + + if (doCopyDeployments) { + println("Copying the deployments to the new cluster member..."); + copyDeployments(existingClusterMemberResource, newAs7Resource); + + println("Restarting the new cluster member."); + newAs7Resource.restart(); + } +} + +/** + * Copies all deployments from the source to the target. Both resources must + * be standalone AS7 servers. + * + * @param sourceAS7 the resource id or object of the source AS7 standalone instance + * @param targetAS7 the resource id or object of the target AS7 standalone instance + */ +exports.as7.copyDeployments = function(sourceAS7, targetAS7) { + if (typeof sourceAS7 == 'object') { + sourceAS7 = sourceAS7.id; + } + + if (typeof targetAS7 == 'object') { + targetAS7 = targetAS7.id; + } + + var deploymentResourceType = ResourceTypeManager.getResourceTypeByNameAndPlugin('Deployment', 'JBossAS7'); + + var deploymentsCrit = new ResourceCriteria; + deploymentsCrit.addFilterParentResourceId(sourceAS7); + deploymentsCrit.addFilterResourceTypeId(deploymentResourceType.id); + + var unlimitedPageControl = PageControl.unlimitedInstance; + + var sourceDeployments = ResourceManager.findResourcesByCriteria(deploymentsCrit); + var iterator = sourceDeployments.iterator(); + while (iterator.hasNext()) { + var deploymentResource = iterator.next(); + //get a resource proxy for easy access to configurations, etc. + deploymentResource = ProxyFactory.getResource(deploymentResource.id); + + println("Copying deployment " + deploymentResource.name); + + var installedPackage = ContentManager.getBackingPackageForResource(deploymentResource.id); + var content = ContentManager.getPackageBytes(deploymentResource.id, installedPackage.id); + + var runtimeName = deploymentResource.resourceConfiguration.getSimpleValue('runtime-name', deploymentResource.name); + + var deploymentConfiguration = new Configuration; + deploymentConfiguration.put(new PropertySimple('runtimeName', runtimeName)); + + //so now we have both metadata and the data of the deployment, let's + //push a copy of it to the target server + var history = ResourceFactoryManager.createPackageBackedResource(targetAS7, + deploymentResourceType.id, deploymentResource.name, + deploymentResource.pluginConfiguration, + installedPackage.packageVersion.generalPackage.name, + installedPackage.packageVersion.version, + installedPackage.packageVersion.architecture.id, + deploymentConfiguration, content, null); + + while (history.status.name() == 'IN_PROGRESS') { + java.lang.Thread.sleep(1000); + //the API for checking the create histories is kinda weird.. + var histories = ResourceFactoryManager.findCreateChildResourceHistory(targetAS7, null, null, unlimitedPageControl); + var hit = histories.iterator(); + var found = false; + while(hit.hasNext()) { + var h = hit.next(); + + if (h.id == history.id) { + history = h; + found = true; + break; + } + } + + if (!found) { + throw "The history object for the deployment seems to have disappeared, this is very strange."; + } + } + + println("Deployment finished with status: " + history.status.toString() + + (history.status.name() == 'SUCCESS' ? "." : (", error message: " + history.errorMessage + "."))); + } +} + +function _getConfigName(as7PluginConfig) { + var argsValue = as7PluginConfig.getSimpleValue('startScriptArgs', ''); + + var args = argsValue.split('\n'); + + var possibleParams = ['-c ', '-c=', '--server-config=']; + + var ret = null; + for (i in args) { + var arg = args[i]; + + var found = false; + + for(j in possibleParams) { + var param = possibleParams[j]; + var pos = arg.indexOf(param); + + if (pos >= 0) { + ret = arg.substring(pos + param.length).trim(); + found = true; + break; + } + } + + if (found) { + break; + } + } + + if (ret != null && ret.startsWith('%') && ret.endsWith('%')) { + var pluginConfRef = ret.substring(1, ret.length - 1); + ret = as7PluginConfig.getSimpleValue(pluginConfigRef, null); + } + + return ret; +} + +function _changeConfig(pluginConfig, configName) { + var argsValue = javascriptString(pluginConfig.getSimpleValue('startScriptArgs', '')); + + var args = argsValue.split('\n'); + + var possibleParams = ['-c ', '-c=', '--server-config=']; + + var updated = false; + + for (i in args) { + var arg = args[i]; + + for(j in possibleParams) { + var param = possibleParams[j]; + + var pos = arg.indexOf(param); + + if (pos >= 0) { + args[i] = param + configName; + updated = true; + break; + } + } + + if (updated) { + break; + } + } + + if (!updated) { + args.push("-c " + configName); + } + + //join the config back together + for(i in args) { + if (i == 0) { + argsValue = args[i]; + } else { + argsValue += "\n" + args[i]; + } + } + + pluginConfig.put(new PropertySimple('startScriptArgs', argsValue)); + + return pluginConfig; +} + +/** + * The config properties of AS7 can have a form of ${propertyName:defaultvalue}. + * Because we can't figure out the value of the property if it is defined, + * (or get at its default value), we return the following hash from this function + * { + * property : propertyName, + * value : defaultvalue + * } + * + * At least one of the keys in the above hash will have a value. + */ +function _parseValueFromExpr(expr) { + var strExpr = expr + ''; + if (strExpr.indexOf('${') == 0) { + var colonIdx = strExpr.indexOf(':'); + if (colonIdx == -1) { + return { 'property' : expr }; + } else { + var property = strExpr.substring(2, colonIdx); + var value = strExpr.substring(colonIdx + 1, strExpr.length - 1); + + return { 'property' : property, 'value' : value }; + } + } else { + return { 'value' : expr }; + } +} + +/** + * This converts the result of _parseValueFromExpr() function back into the + * ${property:defaultvalue} format. + */ +function _composeValueExpr(parsedValue) { + if (parsedValue.property == undefined) { + return parsedValue.value; + } else { + return '${' + parsedValue.property + ':' + parsedValue.value + '}'; + } +} + +function _updateNodeName(serverResourceConfiguration, newNodeName) { + //define it as a system prop + var systemProps = serverResourceConfiguration.getList('*2'); + if (systemProps == null) { + systemProps = new PropertyList('*2'); + serverResourceConfiguration.put(systemProps); + } + + var it = systemProps.list.iterator(); + var updated = false; + while (it.hasNext()) { + var systemProp = it.next(); + var systemPropName = javascriptString(systemProp.getSimpleValue('name', null)); + if (systemPropName == 'jboss.node.name') { + var systemPropValue = systemProp.getSimple('value'); + if (systemPropValue == null) { + systemPropValue = new PropertySimple('value', newNodeName); + systemProp.put(systemPropValue); + } else { + systemPropValue.setValue(newNodeName); + } + + updated = true; + break; + } + } + + if (!updated) { + var systemProp = new PropertyMap('*:name'); + systemProp.put(new PropertySimple('name', 'jboss.node.name')); + systemProp.put(new PropertySimple('value', newNodeName)); + systemProps.add(systemProp); + } +} + +function _updateSocketBindings(socketBindingsConfig, portOffset, clusterMemberPortOffset, socketBindingConfig) { + portOffset = _parseValueFromExpr(portOffset); + clusterMemberPortOffset = _parseValueFromExpr(clusterMemberPortOffset); + + var portOffsetValue = portOffset.value != undefined ? portOffset.value : 0; + var clusterMemberPortOffsetValue = clusterMemberPortOffset.value != undefined ? + clusterMemberPortOffset.value : 0; + + var portOffsetDiff = clusterMemberPortOffsetValue - portOffsetValue; + + var ports = socketBindingsConfig.get('*'); + var portIterator = ports.list.iterator(); + + var appliedProperties = []; + + while (portIterator.hasNext()) { + var port = portIterator.next(); + + var name = port.getSimpleValue('name', null); + + if (socketBindingConfig[name] != undefined) { + //k, this is a significant config, port it over + + //compute the value of the ports + if (socketBindingConfig[name]['fixed-port'] == 'true') { + port.put(new PropertySimple('port:expr', socketBindingConfig[name]['port:expr'])); + port.put(new PropertySimple('multicast-port:expr', socketBindingConfig[name]['multicast-port:expr'])); + port.put(new PropertySimple('multicast-address', socketBindingConfig[name]['multicast-address'])); + port.put(new PropertySimple('fixed-port', 'true')); + } else { + var portExprToUse = _parseValueFromExpr(socketBindingConfig[name]['port:expr']); + if (portExprToUse.value != undefined) { + portExprToUse.value = portOffsetDiff + parseInt(portExprToUse.value) + ''; + } + + var multicastPortExprToUse = _parseValueFromExpr(socketBindingConfig[name]['multicast-port:expr']); + if (multicastPortExprToUse.value != undefined) { + multicastPortExprToUse.value = portOffsetDiff + parseInt(multicastPortExprToUse.value) + ''; + } + + port.put(new PropertySimple('port:expr', _composeValueExpr(portExprToUse))); + port.put(new PropertySimple('multicast-port:expr', _composeValueExpr(multicastPortExprToUse))); + port.put(new PropertySimple('multicast-address', socketBindingConfig[name]['multicast-address'])); + port.put(new PropertySimple('fixed-port', 'false')); + } + appliedProperties.push(name); + } + } + + //I need contains() and Rhino's Array object apparently doesn't have indexOf() + //which I could otherwise use. + appliedProperties = java.util.Arrays.asList(appliedProperties); + + //now add to the list the props that were not there + for(name in socketBindingConfig) { + if (appliedProperties.contains(name)) { + continue; + } + + var port = new PropertyMap('binding'); + ports.add(port); + + port.put(new PropertySimple('name', name)); + port.put(new PropertySimple('multicast-address', socketBindingConfig[name]['multicast-address'])); + port.put(new PropertySimple('fixed-port', socketBindingConfig[name]['fixed-port'])); + + var portExprToUse = _parseValueFromExpr(socketBindingConfig[name]['port:expr']); + if (portExprToUse.value != undefined && !socketBindingConfig[name]['fixed-port']) { + portExprToUse.value = portOffsetDiff + parseInt(portExprToUse.value) + ''; + } + + var multicastPortExprToUse = _parseValueFromExpr(socketBindingConfig[name]['multicast-port:expr']); + if (multicastPortExprToUse.value != undefined && !socketBindingConfig[name]['fixed-port']) { + multicastPortExprToUse.value = portOffsetDiff + parseInt(multicastPortExprToUse.value) + ''; + } + + port.put(new PropertySimple('port:expr', _composeValueExpr(portExprToUse))); + port.put(new PropertySimple('multicast-port:expr', _composeValueExpr(multicastPortExprToUse))); + } +} + + +/** + * Returns a javascript hash of configuration properties significant for the + * cluster configuration. + * + * This method is quite simplistic - it merely reads out the important socket + * bindings and Infinispan configuration properties. + * + * It doesn't try to be smart about specifying which concrete caches and cache + * containers are used for individual subsystems like EJB3, JPA or web apps. + * + * @param resource the resource proxy of the AS7 + */ +function _getClusterSignificantConfig(children, pluginConfiguration, resourceConfiguration) { + var ret = {}; + + ret['config'] = javascriptString(_getConfigName(pluginConfiguration)); + + ret['node-name'] = javascriptString(resourceConfiguration.getSimpleValue('node-name', null)); + + //the standalone server has a single socket binding group + for(var i in children) { + var child = children[i]; + if (child.resourceType.plugin != 'JBossAS7') { + continue; + } + if (child.resourceType.name == 'SocketBindingGroup') { + + var resourceConfig = _getLiveResourceConfiguration(child); + + ret['port-offset'] = javascriptString(resourceConfig.getSimpleValue('port-offset', '0')); + var ports = resourceConfig.get('*'); + var portIterator = ports.list.iterator(); + + var jgroups = {}; + var messaging = {}; + var modcluster = {}; + + ret['jgroups'] = jgroups; + ret['messaging'] = messaging; + ret['modcluster'] = modcluster; + + while (portIterator.hasNext()) { + var port = portIterator.next(); + var name = javascriptString(port.getSimpleValue('name', null)); + + if (name.indexOf('jgroups') == 0) { + jgroups[name] = _getSocketBinding(port); + } else if (name.indexOf('messaging') == 0) { + messaging[name] = _getSocketBinding(port); + } else if (name.indexOf('modcluster') == 0) { + modcluster[name] = _getSocketBinding(port); + } + } + } else if (child.resourceType.name == 'Infinispan') { + var ispn = {}; + ret['infinispan'] = ispn; + + //This has disappeared + //ispn['default-cache-container'] = javascriptString(child.defaultCacheContainer.value); + var cacheContainers = {}; + ispn['cache-containers'] = cacheContainers; + + for(cc in child.children) { + var cacheContainer = child.children[cc]; + + var caches = {}; + + var containerConfig = _getLiveResourceConfiguration(cacheContainer); + + cacheContainers[cacheContainer.name] = { + 'default-cache' : javascriptString(containerConfig.getSimpleValue('default-cache', null)), + 'aliases' : _asArray(containerConfig.get('aliases')), + 'caches' : caches + }; + + for (c in cacheContainer.children) { + var cache = cacheContainer.children[c]; + + caches[cache.name] = { + '_flavor' : javascriptString(containerConfig.getSimpleValue('_flavor', null)), + 'batching' : javascriptString(containerConfig.getSimpleValue('batching', null)), + 'indexing' : javascriptString(containerConfig.getSimpleValue('indexing', null)), + 'mode' : javascriptString(containerConfig.getSimpleValue('mode', null)) + }; + } + } + } + } + + return ret; +} + +function _getSocketBinding(port) { + return { + 'port:expr' : javascriptString(port.getSimpleValue('port:expr', '0')), + 'multicast-port:expr' : javascriptString(port.getSimpleValue('multicast-port:expr', null)), + 'multicast-address' : javascriptString(port.getSimpleValue('multicast-address', null)), + 'fixed-port' : javascriptString(port.getSimpleValue('fixed-port', null)) + }; +} + +function javascriptString(string) { + return string == null || string == undefined ? string : string + ''; +} + +function _asArray(propertyList) { + var ret = []; + if (propertyList == undefined || propertyList == null) { + return ret; + } + + var it = propertyList.list.iterator(); + while (it.hasNext()) { + var prop = it.next(); + + if (prop instanceof PropertySimple) { + ret.push(javascriptString(prop.stringValue)); + } + } + + return ret; +} + +function _getPluginConfiguration(resource) { + if (typeof(resource) == 'number') { + resource = ProxyFactory.getResource(resource) + } else { + resource = ProxyFactory.getResource(resource.id) + } + return resource.pluginConfiguration +} + +function _getLiveResourceConfiguration(resource) { + var id; + if (typeof(resource) == 'number') { + id = resource; + } else { + id = resource.id + } + + return ConfigurationManager.getLiveResourceConfiguration(id, false) +} + +function _loadGroupMembers(group) { + var crit = new ResourceGroupCriteria; + crit.addFilterId(group.id); + crit.fetchExplicitResources(true); + crit.fetchImplicitResources(true); + + var groups = ResourceGroupManager.findResourceGroupsByCriteria(crit) + + if (groups.empty) { + throw "Could not find a previously loaded group on the server: " + group; + } + + return groups.get(0); +} + +function _allResourceIds(group) { + var list = []; + + if (group.explicitResources != null) { + foreach(group.explicitResources, function(resource) { + list.push(resource.id); + }); + } + + return list; +} + +function _runOperationSequentially(group, operationName, operationConfig) { + group = _loadGroupMembers(group); + var resourceIds = _allResourceIds(group); + + var conf = operationConfig; + if (!(conf instanceof Configuration)) { + conf = asConfiguration(conf); + } + + // by specifying the resource ids explicitly, we define the order in which + // the operations will be executed on individual resources (in sequence). + // if the resourceIds were null, the operations would be invoked all at once + // in no particular order. + var schedule = OperationManager.scheduleGroupOperation(group.id, resourceIds, false, operationName, conf, 0, 0, 0, 0, null); + + // now we need to wait for all the individual operations on resources to + // complete + var crit = new GroupOperationHistoryCriteria; + crit.addFilterJobId(new JobId(schedule.jobName, schedule.jobGroup)); + + while (true) { + // XXX should this be configurable? + // we're waiting for an AS to start/shutdown which takes time.. + // Let's check in 5s intervals. + // We're waiting at the start of this loop to also ensure that the server + // had time to issue the quartz job and persist the history entry. + java.lang.Thread.currentThread().sleep(5000); + + var results = OperationManager.findGroupOperationHistoriesByCriteria(crit); + + if (results.empty) { + throw "Could not find operation history for schedule " + schedule + ". This should not happen."; + } + + var history = results.get(0); + + if (history.status != OperationRequestStatus.INPROGRESS) { + return history; + } + } +} + +function _restartAS4(group) { + _runOperationSequentially(group, "shutdown", new Configuration); + _runOperationSequentially(group, "start", new Configuration); +} + +function _restartAS5(group) { + _runOperationSequentially(group, "shutdown", new Configuration); + _runOperationSequentially(group, "start", new Configuration); +} + +function _restartAS7(group) { + var shutdownOp = group.resourceType.name == "JBossAS7-Standalone" ? "shutdown" : "server:stop"; + var startOp = group.resourceType.name == "JBossAS7-Standalone" ? "start" : "server:start"; + + _runOperationSequentially(group, shutdownOp, new Configuration); + _runOperationSequentially(group, startOp, new Configuration); +} diff --git a/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/util.js b/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/util.js new file mode 100644 index 0000000..b67eebc --- /dev/null +++ b/modules/enterprise/server/container/src/main/downloadable-resources/script-modules/util.js @@ -0,0 +1,280 @@ +/** + * file: util.js + * + * description: This script contains functions that provide core, low-level + * functionality such as iterating over a collection or searching a collection. + * This has no other script or library dependencies. + * + * author: jsanda(a)redhat.com + * author: lkrejci(a)redhat.com + * + * See also http://johnsanda.blogspot.com/search/label/javascript + */ + + +/** + * If obj is a JS array or a java.util.Collection, each element is passed to + * the callback function. If obj is a java.util.Map, each map entry is passed + * to the callback function as a key/value pair. If obj is none of the + * aforementioned types, it is treated as a generic object and each of its + * properties is passed to the callback function as a name/value pair. + */ +exports.foreach = function (obj, fn) { + if (obj instanceof Array) { + for (i in obj) { + fn(obj[i]); + } + } + else if (obj instanceof java.util.Collection) { + var iterator = obj.iterator(); + while (iterator.hasNext()) { + fn(iterator.next()); + } + } + else if (obj instanceof java.util.Map) { + var iterator = obj.entrySet().iterator() + while (iterator.hasNext()) { + var entry = iterator.next(); + fn(entry.key, entry.value); + } + } + else { // assume we have a generic object + for (i in obj) { + fn(i, obj[i]); + } + } +} + +/** + * Iterates over obj similar to foreach. fn should be a predicate that evaluates + * to true or false. The first match that is found is returned. + */ +exports.find = function(obj, fn) { + if (obj instanceof Array) { + for (i in obj) { + if (fn(obj[i])) { + return obj[i] + } + } + } + else if (obj instanceof java.util.Collection) { + var iterator = obj.iterator(); + while (iterator.hasNext()) { + var next = iterator.next(); + if (fn(next)) { + return next; + } + } + } + else if (obj instanceof java.util.Map) { + var iterator = obj.entrySet().iterator(); + while (iterator.hasNext()) { + var entry = iterator.next(); + if (fn(entry.key, entry.value)) { + return {key: entry.key, value: entry.value}; + } + } + } + else { + for (i in obj) { + if (fn(i, obj[i])) { + return {key: i, value: obj[i]}; + } + } + } + return null; +} + +/** + * Iterates over obj similar to foreach. fn should be a predicate that evaluates + * to true or false. All of the matches are returned in a java.util.List. + */ +exports.findAll = function(obj, fn) { + var matches = java.util.ArrayList(); + if ((obj instanceof Array) || (obj instanceof java.util.Collection)) { + foreach(obj, function(element) { + if (fn(element)) { + matches.add(element); + } + }); + } + else { + foreach(obj, function(key, value) { + if (fn(theKey, theValue)) { + matches.add({key: theKey, value: theValue}); + } + }); + } + return matches; +} + +/** + * A convenience function to convert javascript hashes into RHQ's configuration + * objects. + * + * The conversion of individual keys in the hash follows these rules: + * <ol> + * <li> if a value of a key is a javascript array, it is interpreted as PropertyList + * <li> if a value is a hash, it is interpreted as a PropertyMap + * <li> otherwise it is interpreted as a PropertySimple + * <li> a null or undefined value is ignored + * </ol> + * + * Note that the conversion isn't perfect, because the hash does not contain enough + * information to restore the names of the list members. + * + * Example: + * <pre><code> + * { + * simple : "value", + * list : [ "value1", "value2"], + * listOfMaps : [ { k1 : "value", k2 : "value" }, { k1 : "value2", k2 : "value2" } ] + * } + * </code></pre> + * gets converted to a configuration object: + * Configuration: + * <ul> + * <li> PropertySimple(name = "simple", value = "value") + * <li> PropertyList(name = "list") + * <ol> + * <li>PropertySimple(name = "list", value = "value1") + * <li>PropertySimple(name = "list", value = "value2") + * </ol> + * <li> PropertyList(name = "listOfMaps") + * <ol> + * <li> PropertyMap(name = "listOfMaps") + * <ul> + * <li>PropertySimple(name = "k1", value = "value") + * <li>PropertySimple(name = "k2", value = "value") + * </ul> + * <li> PropertyMap(name = "listOfMaps") + * <ul> + * <li>PropertySimple(name = "k1", value = "value2") + * <li>PropertySimple(name = "k2", value = "value2") + * </ul> + * </ol> + * </ul> + * Notice that the members of the list have the same name as the list itself + * which generally is not the case. + */ +exports.asConfiguration = function(hash) { + + config = new Configuration; + + for(key in hash) { + value = hash[key]; + + if (value == null) { + continue; + } + + (function(parent, key, value) { + function isArray(obj) { + return typeof(obj) == 'object' && (obj instanceof Array); + } + + function isHash(obj) { + return typeof(obj) == 'object' && !(obj instanceof Array); + } + + function isPrimitive(obj) { + return typeof(obj) != 'object'; + } + + //this is an anonymous function, so the only way it can call itself + //is by getting its reference via argument.callee. Let's just assign + //a shorter name for it. + var me = arguments.callee; + + var prop = null; + + if (isPrimitive(value)) { + prop = new PropertySimple(key, new java.lang.String(value)); + } else if (isArray(value)) { + prop = new PropertyList(key); + for(var i = 0; i < value.length; ++i) { + var v = value[i]; + if (v != null) { + me(prop, key, v); + } + } + } else if (isHash(value)) { + prop = new PropertyMap(key); + for(var i in value) { + var v = value[i]; + if (value != null) { + me(prop, i, v); + } + } + } + + if (parent instanceof PropertyList) { + parent.add(prop); + } else { + parent.put(prop); + } + })(config, key, value); + } + + return config; +} + +/** + * Opposite of <code>asConfiguration</code>. Converts an RHQ's configuration object + * into a javascript hash. + * + * @param configuration + */ +exports.asHash = function(configuration) { + ret = {} + + iterator = configuration.getMap().values().iterator(); + while(iterator.hasNext()) { + prop = iterator.next(); + + (function(parent, prop) { + function isArray(obj) { + return typeof(obj) == 'object' && (obj instanceof Array); + } + + function isHash(obj) { + return typeof(obj) == 'object' && !(obj instanceof Array); + } + + var me = arguments.callee; + + var representation = null; + + if (prop instanceof PropertySimple) { + representation = prop.stringValue; + } else if (prop instanceof PropertyList) { + representation = []; + + for(var i = 0; i < prop.list.size(); ++i) { + var child = prop.list.get(i); + me(representation, child); + } + } else if (prop instanceof PropertyMap) { + representation = {}; + + var childIterator = prop.getMap().values().iterator(); + while(childIterator.hasNext()) { + var child = childIterator.next(); + + me(representation, child); + } + } + + if (isArray(parent)) { + parent.push(representation); + } else if (isHash(parent)) { + parent[prop.name] = representation; + } + })(ret, prop); + } + (function(parent) { + + })(configuration); + + return ret; +} \ No newline at end of file commit ced6234fd469a54719153e558faec20372c6530b Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Fri Aug 24 15:29:28 2012 +0200 Fixing the FileSystemScriptSourceProvider to only support the absolute paths. This is so that it conforms with the "file" scheme known from browsers, etc. The relative path support was done through handling URIs that actually didn't conform to the spec. Adding a ModulesDirectoryScriptSourceProvider so that modules can be loaded from user-defined location in the CLI. diff --git a/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/FileSystemScriptSourceProvider.java b/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/FileSystemScriptSourceProvider.java index 531222b..60c8da8 100644 --- a/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/FileSystemScriptSourceProvider.java +++ b/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/FileSystemScriptSourceProvider.java @@ -37,25 +37,28 @@ import org.rhq.scripting.ScriptSourceProvider; public class FileSystemScriptSourceProvider implements ScriptSourceProvider { private static final Log LOG = LogFactory.getLog(FileSystemScriptSourceProvider.class); - private static final String SCHEME = "file"; + private static final String DEFAULT_SCHEME = "file"; + private final String scheme; + + public FileSystemScriptSourceProvider() { + this(DEFAULT_SCHEME); + } + + public FileSystemScriptSourceProvider(String scheme) { + this.scheme = scheme; + } + @Override public Reader getScriptSource(URI location) { String scheme = location.getScheme(); //return early if we can't handle this URI - if (scheme != null && !SCHEME.equals(scheme)) { + if (scheme == null || !this.scheme.equals(scheme)) { return null; } - String path = location.getSchemeSpecificPart(); - - if (scheme != null) { - // leave out the leading '//'; - path = path.substring(2); - } - - File f = new File(path); + File f = getFile(location); try { if (f.exists() && f.isFile() && f.canRead()) { @@ -69,4 +72,9 @@ public class FileSystemScriptSourceProvider implements ScriptSourceProvider { return null; } + protected File getFile(URI location) { + String path = location.getPath(); + + return new File(path); + } } diff --git a/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/ModulesDirectoryScriptSourceProvider.java b/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/ModulesDirectoryScriptSourceProvider.java new file mode 100644 index 0000000..0e46abe --- /dev/null +++ b/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/ModulesDirectoryScriptSourceProvider.java @@ -0,0 +1,49 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.client.script; + +import java.io.File; +import java.net.URI; + +/** + * This is a configurable source provider that the users can use to load modules from + * a configured directory. + * + * @author Lukas Krejci + */ +public class ModulesDirectoryScriptSourceProvider extends FileSystemScriptSourceProvider { + + private static final File ROOT_DIR = new File(System.getProperty("rhq.scripting.modules.root-dir", "./samples/modules")); + private static final String SCHEME = "modules"; + + public ModulesDirectoryScriptSourceProvider() { + super(SCHEME); + } + + @Override + protected File getFile(URI location) { + String path = location.getPath(); + + //remove the leading / + path = path.substring(1); + + return new File(ROOT_DIR, path); + } +} diff --git a/modules/enterprise/remoting/cli/src/main/resources/META-INF/services/org.rhq.scripting.ScriptSourceProvider b/modules/enterprise/remoting/cli/src/main/resources/META-INF/services/org.rhq.scripting.ScriptSourceProvider index a935c58..20b3f0c 100644 --- a/modules/enterprise/remoting/cli/src/main/resources/META-INF/services/org.rhq.scripting.ScriptSourceProvider +++ b/modules/enterprise/remoting/cli/src/main/resources/META-INF/services/org.rhq.scripting.ScriptSourceProvider @@ -1,2 +1,3 @@ org.rhq.enterprise.client.script.SamplesScriptSourceProvider org.rhq.enterprise.client.script.FileSystemScriptSourceProvider +org.rhq.enterprise.client.script.ModulesDirectoryScriptSourceProvider \ No newline at end of file commit 791ec17efbc286f78b5b17977b652f9aaec94920 Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Fri Aug 24 10:19:41 2012 +0200 Simplified the existing source providers to use URI authority and paths instead of the whole scheme-specific part. Added unit tests for the script source providers. diff --git a/modules/enterprise/binding/src/main/java/org/rhq/bindings/script/BaseRhqSchemeScriptSourceProvider.java b/modules/enterprise/binding/src/main/java/org/rhq/bindings/script/BaseRhqSchemeScriptSourceProvider.java index d90403d..4c6756f 100644 --- a/modules/enterprise/binding/src/main/java/org/rhq/bindings/script/BaseRhqSchemeScriptSourceProvider.java +++ b/modules/enterprise/binding/src/main/java/org/rhq/bindings/script/BaseRhqSchemeScriptSourceProvider.java @@ -31,19 +31,22 @@ import org.rhq.scripting.ScriptSourceProvider; public abstract class BaseRhqSchemeScriptSourceProvider implements ScriptSourceProvider { public static final String SCHEME = "rhq"; - + private final String authority; + + protected BaseRhqSchemeScriptSourceProvider(String expectedAuthority) { + this.authority = expectedAuthority; + } + @Override public Reader getScriptSource(URI scriptUri) { if (scriptUri == null || !SCHEME.equals(scriptUri.getScheme())) { return null; } - String path = scriptUri.getSchemeSpecificPart(); - - if (!path.startsWith("//")) { + if (!authority.equals(scriptUri.getAuthority())) { return null; } - + return doGetScriptSource(scriptUri); } diff --git a/modules/enterprise/binding/src/main/java/org/rhq/bindings/script/RepoScriptSourceProvider.java b/modules/enterprise/binding/src/main/java/org/rhq/bindings/script/RepoScriptSourceProvider.java index b316dea..2a1f944 100644 --- a/modules/enterprise/binding/src/main/java/org/rhq/bindings/script/RepoScriptSourceProvider.java +++ b/modules/enterprise/binding/src/main/java/org/rhq/bindings/script/RepoScriptSourceProvider.java @@ -55,10 +55,14 @@ public class RepoScriptSourceProvider extends BaseRhqSchemeScriptSourceProvider private static final Log LOG = LogFactory.getLog(RepoScriptSourceProvider.class); - private static final String PREFIX = "//repositories/"; + private static final String AUTHORITY = "repositories"; private RhqFacade rhqFacade; + public RepoScriptSourceProvider() { + super(AUTHORITY); + } + @Override public void rhqFacadeChanged(StandardBindings bindings) { this.rhqFacade = bindings.getAssociatedRhqFacade(); @@ -70,13 +74,7 @@ public class RepoScriptSourceProvider extends BaseRhqSchemeScriptSourceProvider return null; } - String path = scriptUri.getSchemeSpecificPart(); - - if (!path.startsWith(PREFIX)) { - return null; - } - - path = path.substring(PREFIX.length()); + String path = scriptUri.getPath().substring(1); //remove the leading / from the path int slashIdx = path.indexOf('/'); diff --git a/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/SamplesScriptSourceProvider.java b/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/SamplesScriptSourceProvider.java index ca328b1..132915a 100644 --- a/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/SamplesScriptSourceProvider.java +++ b/modules/enterprise/remoting/cli/src/main/java/org/rhq/enterprise/client/script/SamplesScriptSourceProvider.java @@ -40,21 +40,21 @@ public class SamplesScriptSourceProvider extends BaseRhqSchemeScriptSourceProvid private static final Log LOG = LogFactory.getLog(SamplesScriptSourceProvider.class); - private static final String PREFIX = "//samples/"; + private static final String AUTHORITY = "samples"; + public SamplesScriptSourceProvider() { + super(AUTHORITY); + } + @Override protected Reader doGetScriptSource(URI scriptUri) { - String path = scriptUri.getSchemeSpecificPart(); - - if (!path.startsWith(PREFIX)) { - return null; - } + String path = scriptUri.getPath(); - path = path.substring(2); //remove the leading '//'; + path = path.substring(1); //remove the leading '/'; //here we suppose that the CLI was started using the rhq-cli.(sh|bat) script //which sets the working directory to the root of the CLI deployment - File file = new File(path); + File file = new File(AUTHORITY, path); try { return new InputStreamReader(new FileInputStream(file), Charset.forName("UTF-8")); diff --git a/modules/enterprise/remoting/client-api/pom.xml b/modules/enterprise/remoting/client-api/pom.xml index 530add9..eed1ac4 100644 --- a/modules/enterprise/remoting/client-api/pom.xml +++ b/modules/enterprise/remoting/client-api/pom.xml @@ -116,6 +116,20 @@ <scope>provided</scope>  </dependency> + <dependency> + <groupId>org.powermock</groupId> + <artifactId>powermock-module-testng</artifactId> + <version>${powermock.version}</version> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>org.powermock</groupId> + <artifactId>powermock-api-mockito</artifactId> + <version>${powermock.version}</version> + <scope>test</scope> + </dependency> + </dependencies> <profiles> diff --git a/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RemoteClient.java b/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RemoteClient.java index 0fd4b92..af434d2 100644 --- a/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RemoteClient.java +++ b/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RemoteClient.java @@ -20,6 +20,9 @@ package org.rhq.enterprise.clientapi; import java.lang.reflect.Method; import java.lang.reflect.Proxy; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; import java.util.HashMap; import java.util.Map; @@ -241,6 +244,17 @@ public class RemoteClient implements RhqFacade { return this.subject; } + public URI getRemoteURI() { + try { + return new URI(getTransport(), null, getHost(), getPort(), null, null, null); + } catch (URISyntaxException e) { + //does not happen, but hey + LOG.error("Error creating the remote URI with transport, host and port: " + getTransport() + ", " + + getHost() + " and " + getPort(), e); + return null; + } + } + public String getHost() { return this.host; } diff --git a/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java b/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java index 663e1b3..6b866db 100644 --- a/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java +++ b/modules/enterprise/remoting/client-api/src/main/java/org/rhq/enterprise/clientapi/RhqDownloadsScriptSourceProvider.java @@ -42,10 +42,14 @@ public class RhqDownloadsScriptSourceProvider extends BaseRhqSchemeScriptSourceP private static final Log LOG = LogFactory.getLog(RhqDownloadsScriptSourceProvider.class); - private static final String PREFIX = "//downloads/"; + private static final String AUTHORITY = "downloads"; private RemoteClient remoteClient; + public RhqDownloadsScriptSourceProvider() { + super(AUTHORITY); + } + @Override public void rhqFacadeChanged(StandardBindings bindings) { RhqFacade facade = bindings.getAssociatedRhqFacade(); @@ -63,25 +67,18 @@ public class RhqDownloadsScriptSourceProvider extends BaseRhqSchemeScriptSourceP return null; } - String path = scriptUri.getSchemeSpecificPart(); - - if (!path.startsWith(PREFIX)) { - return null; - } - - path.substring(1); //remove the leading '/' + String path = scriptUri.getPath(); - String urlString = remoteClient.getTransport() + "://" + remoteClient.getHost() + ":" + remoteClient.getPort() - + path; + URI remoteUri = remoteClient.getRemoteURI().resolve(AUTHORITY + path); try { - URL downloadUrl = new URL(urlString); + URL downloadUrl = remoteUri.toURL(); return new InputStreamReader(downloadUrl.openStream()); } catch (MalformedURLException e) { - LOG.debug("Failed to download the script from the RHQ server using URL: " + urlString, e); + LOG.debug("Failed to download the script from the RHQ server using URL: " + remoteUri, e); } catch (IOException e) { - LOG.debug("Failed to download the script from the RHQ server using URL: " + urlString, e); + LOG.debug("Failed to download the script from the RHQ server using URL: " + remoteUri, e); } return null; diff --git a/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java b/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java new file mode 100644 index 0000000..591df06 --- /dev/null +++ b/modules/enterprise/remoting/client-api/src/test/java/org/rhq/enterprise/clienapi/RhqDownloadsScriptSourceProviderTest.java @@ -0,0 +1,98 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.clienapi; + +import static org.testng.Assert.assertEquals; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.Reader; +import java.net.URI; + +import org.mockito.Mockito; +import org.testng.annotations.AfterClass; +import org.testng.annotations.BeforeClass; +import org.testng.annotations.Test; + +import org.rhq.bindings.StandardBindings; +import org.rhq.core.util.file.FileUtil; +import org.rhq.core.util.stream.StreamUtil; +import org.rhq.enterprise.clientapi.RemoteClient; +import org.rhq.enterprise.clientapi.RhqDownloadsScriptSourceProvider; + +/** + * + * + * @author Lukas Krejci + */ +@Test +public class RhqDownloadsScriptSourceProviderTest { + + private File tmpDir; + + private static final String EXPECTED_CONTENTS = "println('Hello, World!')"; + @BeforeClass + public void createTmpDir() throws Exception { + tmpDir = FileUtil.createTempDirectory(getClass().getName(), null, null); + + File downloadsDir = new File(tmpDir, "downloads"); + downloadsDir.mkdirs(); + + File testScript = new File(downloadsDir, "test-script.js"); + + FileOutputStream out = new FileOutputStream(testScript); + + try { + out.write(EXPECTED_CONTENTS.getBytes()); + } finally { + out.close(); + } + } + + @AfterClass + public void deleteTempDir() { + if (tmpDir != null) { + FileUtil.purge(tmpDir, true); + } + } + + public void canLocateScripts() throws Exception { + RemoteClient client = Mockito.mock(RemoteClient.class); + + Mockito.when(client.getRemoteURI()).thenReturn(tmpDir.toURI()); + + RhqDownloadsScriptSourceProvider provider = new RhqDownloadsScriptSourceProvider(); + + StandardBindings bindings = new StandardBindings(null, client); + + provider.rhqFacadeChanged(bindings); + + URI location = new URI("rhq://downloads/test-script.js"); + + Reader rdr = provider.getScriptSource(location); + + try { + String contents = StreamUtil.slurp(rdr); + assertEquals(contents, EXPECTED_CONTENTS, "Unexpected script loaded"); + } finally { + rdr.close(); + } + } +} diff --git a/modules/enterprise/server/client-api/pom.xml b/modules/enterprise/server/client-api/pom.xml index 91682fa..1810ecb 100644 --- a/modules/enterprise/server/client-api/pom.xml +++ b/modules/enterprise/server/client-api/pom.xml @@ -54,7 +54,22 @@ <artifactId>quartz</artifactId>  <scope>test</scope> - </dependency> + </dependency> + + <dependency> + <groupId>org.powermock</groupId> + <artifactId>powermock-module-testng</artifactId> + <version>${powermock.version}</version> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>org.powermock</groupId> + <artifactId>powermock-api-mockito</artifactId> + <version>${powermock.version}</version> + <scope>test</scope> + </dependency> + </dependencies> <profiles> diff --git a/modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java b/modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java index 7b9232a..7711078 100644 --- a/modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java +++ b/modules/enterprise/server/client-api/src/main/java/org/rhq/enterprise/client/RhqDownloadsScriptSourceProvider.java @@ -44,20 +44,24 @@ public class RhqDownloadsScriptSourceProvider extends BaseRhqSchemeScriptSourceP private static final Log LOG = LogFactory.getLog(RhqDownloadsScriptSourceProvider.class); - private static final String PREFIX = "//downloads/"; + private static final String AUTHORITY = "downloads"; - private SystemManagerLocal systemManager = LookupUtil.getSystemManager(); - private SubjectManagerLocal subjectManager = LookupUtil.getSubjectManager(); + private SystemManagerLocal systemManager; + private SubjectManagerLocal subjectManager; + public RhqDownloadsScriptSourceProvider() { + this(LookupUtil.getSystemManager(), LookupUtil.getSubjectManager()); + } + + public RhqDownloadsScriptSourceProvider(SystemManagerLocal systemManager, SubjectManagerLocal subjectManager) { + super(AUTHORITY); + this.systemManager = systemManager; + this.subjectManager = subjectManager; + } + @Override protected Reader doGetScriptSource(URI scriptUri) { - String path = scriptUri.getSchemeSpecificPart(); - - if (!path.startsWith(PREFIX)) { - return null; - } - - path = path.substring(PREFIX.length()); + String path = scriptUri.getPath().substring(1); //remove the leading / Subject overlord = subjectManager.getOverlord(); diff --git a/modules/enterprise/server/client-api/src/test/java/org/rhq/enterprise/client/test/RhqDownloadsScriptSourceProviderTest.java b/modules/enterprise/server/client-api/src/test/java/org/rhq/enterprise/client/test/RhqDownloadsScriptSourceProviderTest.java new file mode 100644 index 0000000..2c73eec --- /dev/null +++ b/modules/enterprise/server/client-api/src/test/java/org/rhq/enterprise/client/test/RhqDownloadsScriptSourceProviderTest.java @@ -0,0 +1,102 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.client.test; + +import static org.testng.Assert.assertEquals; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.Reader; +import java.net.URI; +import java.util.HashMap; + +import org.mockito.Mockito; +import org.testng.annotations.AfterClass; +import org.testng.annotations.BeforeClass; +import org.testng.annotations.Test; + +import org.rhq.core.domain.auth.Subject; +import org.rhq.core.domain.common.ServerDetails; +import org.rhq.core.util.file.FileUtil; +import org.rhq.core.util.stream.StreamUtil; +import org.rhq.enterprise.client.RhqDownloadsScriptSourceProvider; +import org.rhq.enterprise.server.auth.SubjectManagerLocal; +import org.rhq.enterprise.server.system.SystemManagerLocal; + +/** + * + * + * @author Lukas Krejci + */ +@Test +public class RhqDownloadsScriptSourceProviderTest { + + private File tmpDir; + + private static final String EXPECTED_CONTENTS = "println('Hello, World!')"; + @BeforeClass + public void createTmpDir() throws Exception { + tmpDir = FileUtil.createTempDirectory(getClass().getName(), null, null); + File downloadsDir = new File(new File(new File(tmpDir, "deploy"), "rhq.ear"), "rhq-downloads"); + downloadsDir.mkdirs(); + + File testScript = new File(downloadsDir, "test-script.js"); + + FileOutputStream out = new FileOutputStream(testScript); + + try { + out.write(EXPECTED_CONTENTS.getBytes()); + } finally { + out.close(); + } + } + + @AfterClass + public void deleteTempDir() { + if (tmpDir != null) { + FileUtil.purge(tmpDir, true); + } + } + + public void canLocateScripts() throws Exception { + SystemManagerLocal systemManager = Mockito.mock(SystemManagerLocal.class); + SubjectManagerLocal subjectManager = Mockito.mock(SubjectManagerLocal.class); + + ServerDetails details = new ServerDetails(); + HashMap<ServerDetails.Detail, String> map = new HashMap<ServerDetails.Detail, String>(); + map.put(ServerDetails.Detail.SERVER_HOME_DIR, tmpDir.getAbsolutePath()); + details.setDetails(map); + + Mockito.when(systemManager.getServerDetails(Mockito.<Subject>any())).thenReturn(details); + + RhqDownloadsScriptSourceProvider provider = new RhqDownloadsScriptSourceProvider(systemManager, subjectManager); + + URI location = new URI("rhq://downloads/test-script.js"); + + Reader rdr = provider.getScriptSource(location); + + try { + String contents = StreamUtil.slurp(rdr); + assertEquals(contents, EXPECTED_CONTENTS, "Unexpected script loaded"); + } finally { + rdr.close(); + } + } +} commit f835c490a057254d71aba7b8714c3f04af257bfd Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Fri Aug 24 10:17:29 2012 +0200 Making the module loading conforming with CommonJS: 1) The .js extension is optional (and according to the spec it even shouldn't be there) 2) Relative module IDs are working now 3) Added unit tests for the module resolution 4) Modified exisiting unit tests to use CommonJS-conforming module URIs diff --git a/modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/JsEngineProvider.java b/modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/JsEngineProvider.java index 63c5023..af89772 100644 --- a/modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/JsEngineProvider.java +++ b/modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/JsEngineProvider.java @@ -30,6 +30,8 @@ import org.rhq.scripting.ScriptEngineProvider; */ public class JsEngineProvider implements ScriptEngineProvider { + public static final String SCRIPT_FILE_EXTENSION = "js"; + @Override public String getSupportedLanguage() { return "javascript"; @@ -37,7 +39,7 @@ public class JsEngineProvider implements ScriptEngineProvider { @Override public String getScriptFileExtension() { - return "js"; + return SCRIPT_FILE_EXTENSION; } @Override diff --git a/modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapter.java b/modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapter.java index fb3926b..9a02210 100644 --- a/modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapter.java +++ b/modules/enterprise/scripting/javascript/src/main/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapter.java @@ -25,47 +25,55 @@ import java.net.URI; import java.net.URISyntaxException; import org.mozilla.javascript.commonjs.module.provider.ModuleSource; +import org.mozilla.javascript.commonjs.module.provider.ModuleSourceProvider; import org.mozilla.javascript.commonjs.module.provider.ModuleSourceProviderBase; import org.rhq.scripting.ScriptSourceProvider; +import org.rhq.scripting.javascript.JsEngineProvider; /** + * This is an adapter that acts as a {@link ModuleSourceProvider} for Rhino + * but uses RHQ's {@link ScriptSourceProvider} to load the scripts. * - * * @author Lukas Krejci */ public class ScriptSourceToModuleSourceProviderAdapter extends ModuleSourceProviderBase { private static final long serialVersionUID = 1L; - + + private static final String SUFFIX = "." + JsEngineProvider.SCRIPT_FILE_EXTENSION; + private ScriptSourceProvider scriptSourceProvider; - + public ScriptSourceToModuleSourceProviderAdapter(ScriptSourceProvider provider) { scriptSourceProvider = provider; } - + @Override protected ModuleSource loadFromPrivilegedLocations(String moduleId, Object validator) throws IOException, URISyntaxException { - //if the URI is absolute, we make sure to define the ModuleSource as sandboxed. - //this is done by making the URI a "subpath" of the base. URI uri = new URI(moduleId); - URI base = null; - if (uri.isAbsolute()) { - base = uri; + if (!uri.isAbsolute()) { + return null; } - return loadFromUri(uri, base, validator); + return loadFromUri(uri, null, validator); } @Override protected ModuleSource loadFromUri(URI uri, URI base, Object validator) throws IOException, URISyntaxException { URI fullUri = uri; if (base != null) { - fullUri = uri.resolve(base); + fullUri = base.resolve(uri); + } + + if (!fullUri.getSchemeSpecificPart().endsWith(SUFFIX)) { + fullUri = + new URI(fullUri.getScheme(), fullUri.getAuthority(), fullUri.getPath() + SUFFIX, fullUri.getQuery(), + fullUri.getFragment()); } Reader sourceReader = scriptSourceProvider.getScriptSource(fullUri); - + if (sourceReader == null) { return null; } else { diff --git a/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/EngineTest.java b/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/EngineTest.java index 6aa9355..6ed5757 100644 --- a/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/EngineTest.java +++ b/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/EngineTest.java @@ -63,8 +63,8 @@ public class EngineTest { public void modulesCanBeLoaded() throws Exception { String script = "" + - "var m1 = require('target/test-classes/test-module1.js'); \n" + - "var m2 = require('target/test-classes/test-module2.js'); \n" + + "var m1 = require('target/test-classes/test-module1'); \n" + + "var m2 = require('target/test-classes/test-module2'); \n" + "println(typeof(m1.func1));\n" + "println(typeof(m1.func2));\n" + "println(typeof(m2.func3));\n" + @@ -85,7 +85,7 @@ public class EngineTest { + "var test2 = \"strstr\"\n" + "var test3 = new java.lang.String(\"strstr\")\n"; - ScriptEngine engine = new ScriptEngineManager().getEngineByName("javascript"); + ScriptEngine engine = getScriptEngine(); engine.eval(script); @@ -104,6 +104,19 @@ public class EngineTest { assertEquals(ret, 12, "Engine failed to pass a concatenated string as a string parameter."); } + public void relativeModuleAddressingWorks() throws Exception { + String script = "var n = require('target/test-classes/nest');"; + + ScriptEngine engine = getScriptEngine(); + + Object ret = engine.eval(script + "n.nest()"); + assertEquals(ret, "Deep nest", "A module could not be loaded using a relative path."); + + ret = engine.eval(script + "n.maze()"); + assertEquals(ret, "func1", "A module could not be loaded using a relative path."); + + } + private ScriptEngine getScriptEngine() { ScriptEngineManager manager = new ScriptEngineManager(); return manager.getEngineByName("rhino-nonjdk"); diff --git a/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/InitializerTest.java b/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/InitializerTest.java index e71155b..36bfbb9 100644 --- a/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/InitializerTest.java +++ b/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/InitializerTest.java @@ -100,7 +100,7 @@ public class InitializerTest { public void scriptSourceProviderApplied() throws Exception { - String script = "var m = require('rhq://test-module1.js'); m.func1();"; + String script = "var m = require('rhq:/test-module1'); m.func1();"; //first let's try to find the scripts with the default source provider... ScriptEngine eng = new JsEngineInitializer().instantiate(Collections.<String>emptySet(), null); @@ -118,7 +118,7 @@ public class InitializerTest { if (!"rhq".equals(location.getScheme())) { return null; } - String scriptName = location.getSchemeSpecificPart().substring(2); //remove the '//' + String scriptName = location.getPath().substring(1); //remove the '/' InputStream src = getClass().getClassLoader().getResourceAsStream(scriptName); return new InputStreamReader(src); } diff --git a/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapterTest.java b/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapterTest.java new file mode 100644 index 0000000..72b6d25 --- /dev/null +++ b/modules/enterprise/scripting/javascript/src/test/java/org/rhq/scripting/javascript/util/ScriptSourceToModuleSourceProviderAdapterTest.java @@ -0,0 +1,117 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.scripting.javascript.util; + +import static org.testng.Assert.assertEquals; + +import java.io.InputStreamReader; +import java.io.Reader; +import java.net.URI; +import java.util.Collections; + +import javax.script.ScriptEngine; +import javax.script.ScriptException; + +import org.testng.annotations.Test; + +import org.rhq.scripting.ScriptSourceProvider; +import org.rhq.scripting.javascript.JsEngineInitializer; + +/** + * + * + * @author Lukas Krejci + */ +@Test +public class ScriptSourceToModuleSourceProviderAdapterTest { + + private JsEngineInitializer initializer = new JsEngineInitializer(); + + private static class ClasspathScriptSourceProvider implements ScriptSourceProvider { + private ClassLoader cl; + + public ClasspathScriptSourceProvider() { + this(ClasspathScriptSourceProvider.class.getClassLoader()); + } + + public ClasspathScriptSourceProvider(ClassLoader cl) { + this.cl = cl; + } + + private static final String SCHEME = "classpath"; + @Override + public Reader getScriptSource(URI uri) { + if (!SCHEME.equals(uri.getScheme())) { + return null; + } + + String path = uri.getPath().substring(1); //remove the leading / + + return new InputStreamReader(cl.getResourceAsStream(path)); + } + } + + private ScriptEngine getScriptEngine() throws ScriptException { + ScriptEngine engine = initializer.instantiate(Collections.<String>emptySet(), null); + initializer.installScriptSourceProvider(engine, new ClasspathScriptSourceProvider()); + + return engine; + } + + public void simpleModuleLoad() throws Exception { + String script = "var m = require('classpath:/nested/deep-nest'); m.nest();"; + + Object ret = getScriptEngine().eval(script); + + assertEquals(ret, "Deep nest", "deep-nest.js#nest() returned unexpected value"); + } + + public void relativePathsInRequire() throws Exception { + String script = "var m = require('classpath:/nest'); m.maze();"; + + Object ret = getScriptEngine().eval(script); + + assertEquals(ret, "func1", "nest.js#maze() returned unexpected value"); + } + + public void urisWithAuthorityDontConfuseResolution() throws Exception { + String script = "var m = require('classpath://authority/nest'); m.maze();"; + + Object ret = getScriptEngine().eval(script); + + assertEquals(ret, "func1", "nest.js#maze() returned unexpected value"); + } + + public void urisWithQueryDontConfuseResolution() throws Exception { + String script = "var m = require('classpath:/nest?query'); m.maze();"; + + Object ret = getScriptEngine().eval(script); + + assertEquals(ret, "func1", "nest.js#maze() returned unexpected value"); + } + + public void urisWithFragmentDontConfuseResolution() throws Exception { + String script = "var m = require('classpath:/nest#fragment'); m.maze();"; + + Object ret = getScriptEngine().eval(script); + + assertEquals(ret, "func1", "nest.js#maze() returned unexpected value"); + } +} diff --git a/modules/enterprise/scripting/javascript/src/test/resources/nest.js b/modules/enterprise/scripting/javascript/src/test/resources/nest.js new file mode 100644 index 0000000..e9ea75e --- /dev/null +++ b/modules/enterprise/scripting/javascript/src/test/resources/nest.js @@ -0,0 +1,9 @@ +var dn = require('./nested/deep-nest'); + +exports.nest = function() { + return dn.nest(); +} + +exports.maze = function() { + return dn.maze(); +} \ No newline at end of file diff --git a/modules/enterprise/scripting/javascript/src/test/resources/nested/deep-nest.js b/modules/enterprise/scripting/javascript/src/test/resources/nested/deep-nest.js new file mode 100644 index 0000000..25110cd --- /dev/null +++ b/modules/enterprise/scripting/javascript/src/test/resources/nested/deep-nest.js @@ -0,0 +1,8 @@ +exports.nest = function() { + return "Deep nest"; +} + +exports.maze = function() { + var m1 = require('../test-module1'); + return m1.func1(); +}

1 0

[rhq] modules/enterprise
by Heiko W. Rupp 13 Sep '12

13 Sep '12

modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/components/form/DateTimeFilterItem.java | 86 ++++++++++ modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeDatasource.java | 19 +- modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeHistoryView.java | 13 + 3 files changed, 112 insertions(+), 6 deletions(-) New commits: commit 82877c7c61a21cc22685f0183671b16632155ede Author: Heiko W. Rupp <hwr(a)redhat.com> Date: Thu Sep 13 11:19:18 2012 +0200 BZ 856695 - Allow to filter events by time range diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/components/form/DateTimeFilterItem.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/components/form/DateTimeFilterItem.java new file mode 100644 index 0000000..a89cebd --- /dev/null +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/components/form/DateTimeFilterItem.java @@ -0,0 +1,86 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.gui.coregui.client.components.form; + +import java.util.Date; + +import com.google.gwt.user.datepicker.client.CalendarUtil; +import com.smartgwt.client.util.DateUtil; +import com.smartgwt.client.widgets.form.fields.DateItem; +import com.smartgwt.client.widgets.form.fields.DateTimeItem; + +import static com.smartgwt.client.data.RelativeDate.END_OF_TODAY; +import static com.smartgwt.client.data.RelativeDate.START_OF_TODAY; +import static com.smartgwt.client.types.RelativeDateRangePosition.END; +import static com.smartgwt.client.types.RelativeDateRangePosition.START; + +/** + * DateTimeItem used for filtering. This component adds the ability to returns + * its date and time value a Integer offset of the current Date. For instance, + * yesterday would return a -1. This ability to use Integer days instead of + * Dates provides for a more robust solution when sending Dates across the wire + * as Date.toString() in GWT creates a date format that has the local timezone + * in it. GWT is not able to parse these dates with the local timezone in them. + * GWT only knows how to parse RFC and GMT dates. + * + * @author Mike Thompson + */ +public class DateTimeFilterItem extends DateTimeItem { + + public final static String START_DATE_FILTER = "startTime"; + public final static String END_DATE_FILTER = "endTime"; + + + public DateTimeFilterItem() { + standardConfiguration(); + } + + public DateTimeFilterItem(String name) { + super(name); + standardConfiguration(); + } + + public DateTimeFilterItem(String name, String title) { + super(name, title); + standardConfiguration(); + } + + private void standardConfiguration() { + this.setUseTextField(true); + this.setEnforceDate(true); + this.setEndDate(new Date()); + + } + + + @Override + public Object getValue() { + Date date = getValueAsDate(); + if (date!=null) + return date.getTime(); + return null; + } + + @Override + public String toString() { + return String.valueOf(getValue()); + } + +} diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeDatasource.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeDatasource.java index a1aca43..9be8b30 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeDatasource.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeDatasource.java @@ -23,6 +23,7 @@ package org.rhq.enterprise.gui.coregui.client.inventory.common.event; import java.util.ArrayList; +import java.util.Date; import java.util.HashSet; import java.util.List; import java.util.Map; @@ -79,7 +80,7 @@ public class EventCompositeDatasource extends RPCDataSource<EventComposite, Even /** * The view that contains the list grid which will display this datasource's data will call this * method to get the field information which is used to control the display of the data. - * + * * @return list grid fields used to display the datasource data */ public ArrayList<ListGridField> getListGridFields() { @@ -211,7 +212,7 @@ public class EventCompositeDatasource extends RPCDataSource<EventComposite, Even record.setAttribute("severity", from.getSeverity().name()); record.setAttribute("source", from.getSourceLocation()); - // for ancestry handling + // for ancestry handling record.setAttribute(AncestryUtil.RESOURCE_ID, from.getResourceId()); record.setAttribute(AncestryUtil.RESOURCE_NAME, from.getResourceName()); record.setAttribute(AncestryUtil.RESOURCE_ANCESTRY, from.getResourceAncestry()); @@ -276,7 +277,7 @@ public class EventCompositeDatasource extends RPCDataSource<EventComposite, Even typeRepo.getResourceTypes(typesSet.toArray(new Integer[typesSet.size()]), new TypesLoadedCallback() { @Override public void onTypesLoaded(Map<Integer, ResourceType> types) { - // Smartgwt has issues storing a Map as a ListGridRecord attribute. Wrap it in a pojo. + // Smartgwt has issues storing a Map as a ListGridRecord attribute. Wrap it in a pojo. AncestryUtil.MapWrapper typesWrapper = new AncestryUtil.MapWrapper(types); Record[] records = buildRecords(result); @@ -284,7 +285,7 @@ public class EventCompositeDatasource extends RPCDataSource<EventComposite, Even for (Record record : records) { // To avoid a lot of unnecessary String construction, be lazy about building ancestry hover text. - // Store the types map off the records so we can build a detailed hover string as needed. + // Store the types map off the records so we can build a detailed hover string as needed. record.setAttribute(AncestryUtil.RESOURCE_ANCESTRY_TYPES, typesWrapper); // Build the decoded ancestry Strings now for display @@ -311,7 +312,7 @@ public class EventCompositeDatasource extends RPCDataSource<EventComposite, Even EventCriteria criteria = new EventCriteria(); // This code is unlikely to be necessary as the encompassing view should be using an initial - // sort specifier. But just in case, make sure we set the initial sort. Note that we have to + // sort specifier. But just in case, make sure we set the initial sort. Note that we have to // manipulate the PageControl directly as per the restrictions on getFetchCriteria() (see jdoc). PageControl pageControl = getPageControl(request); if (pageControl.getOrderingFields().isEmpty()) { @@ -324,6 +325,14 @@ public class EventCompositeDatasource extends RPCDataSource<EventComposite, Even criteria.addFilterSourceName((String) criteriaMap.get("source")); criteria.addFilterDetail((String) criteriaMap.get("detail")); + if (criteriaMap.get("startTime")!=null) { + Date tmp = (Date) criteriaMap.get("startTime"); + criteria.addFilterStartTime(tmp.getTime()); + } + if (criteriaMap.get("endTime")!=null) { + Date tmp = (Date) criteriaMap.get("endTime"); + criteria.addFilterEndTime(tmp.getTime()); + } // There's no need to add a severities filter to the criteria if the user specified all severities. if (severities.length != EventSeverity.values().length) { criteria.addFilterSeverities(severities); diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeHistoryView.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeHistoryView.java index e146f0e..1268690 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeHistoryView.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/inventory/common/event/EventCompositeHistoryView.java @@ -31,6 +31,7 @@ import com.smartgwt.client.data.Criteria; import com.smartgwt.client.data.SortSpecifier; import com.smartgwt.client.types.SortDirection; import com.smartgwt.client.widgets.Canvas; +import com.smartgwt.client.widgets.form.fields.SpacerItem; import com.smartgwt.client.widgets.form.fields.TextItem; import com.smartgwt.client.widgets.grid.CellFormatter; import com.smartgwt.client.widgets.grid.ListGridField; @@ -42,6 +43,7 @@ import org.rhq.core.domain.resource.composite.ResourceComposite; import org.rhq.core.domain.resource.group.composite.ResourceGroupComposite; import org.rhq.enterprise.gui.coregui.client.CoreGUI; import org.rhq.enterprise.gui.coregui.client.ImageManager; +import org.rhq.enterprise.gui.coregui.client.components.form.DateTimeFilterItem; import org.rhq.enterprise.gui.coregui.client.components.form.EnumSelectItem; import org.rhq.enterprise.gui.coregui.client.components.table.AbstractTableAction; import org.rhq.enterprise.gui.coregui.client.components.table.TableActionEnablement; @@ -62,6 +64,9 @@ public class EventCompositeHistoryView extends TableSection<EventCompositeDataso private EntityContext context; private boolean hasWriteAccess; + protected DateTimeFilterItem startDateFilter; + protected DateTimeFilterItem endDateFilter; + static { EventSeverity[] severityValues = EventSeverity.values(); String[] severityNames = new String[severityValues.length]; @@ -123,7 +128,13 @@ public class EventCompositeHistoryView extends TableSection<EventCompositeDataso final EnumSelectItem severityFilter = new EnumSelectItem(EventCompositeDatasource.FILTER_SEVERITIES, MSG .view_inventory_eventHistory_severityFilter(), EventSeverity.class, severities, severityIcons); - setFilterFormItems(sourceFilter, detailsFilter, severityFilter); + startDateFilter = new DateTimeFilterItem(DateTimeFilterItem.START_DATE_FILTER, MSG.filter_from_date() ); + endDateFilter = new DateTimeFilterItem(DateTimeFilterItem.END_DATE_FILTER, MSG.filter_to_date()); + + SpacerItem spacerItem = new SpacerItem(); + spacerItem.setColSpan(2); + + setFilterFormItems(sourceFilter, detailsFilter, severityFilter, startDateFilter, spacerItem, endDateFilter); } @Override

1 0

[rhq] modules/core modules/enterprise
by lkrejci 13 Sep '12

13 Sep '12

modules/core/domain/src/main/java/org/rhq/core/domain/criteria/AlertDefinitionCriteria.java | 6 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/AbstractAlertDefinitionsView.java | 2 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/GroupAlertDefinitionsView.java | 6 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/ResourceAlertDefinitionsView.java | 6 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/SingleAlertDefinitionView.java | 12 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/TemplateAlertDefinitionsView.java | 6 modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/AlertDefinitionGWTServiceImpl.java | 2 modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/legacy/action/resource/common/monitor/alerts/config/NewDefinitionAction.java | 2 modules/enterprise/server/itests/pom.xml | 34 modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/TestServerPluginService.java | 148 ++ modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/TestServerPluginServiceMBean.java | 31 modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/AlertDefinitionWithComplexNotificationsTest.java | 716 ++++++++++ modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/TestAlertSender.java | 107 + modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/TestAlertSenderPluginService.java | 67 modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginService.java | 103 - modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginServiceMBean.java | 25 modules/enterprise/server/itests/src/test/resources/log4j.xml | 4 modules/enterprise/server/itests/src/test/resources/test-alert-sender-serverplugin.xml | 23 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerBean.java | 76 - modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerLocal.java | 42 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerBean.java | 18 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerLocal.java | 6 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertTemplateManagerBean.java | 18 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/GroupAlertDefinitionManagerBean.java | 16 modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/alert/test/AlertConditionTest.java | 10 modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/performance/test/AvailabilityInsertPurgeTest.java | 2 26 files changed, 1319 insertions(+), 169 deletions(-) New commits: commit e95b37895324937307723862c6ea229c2f91f375 Author: Lukas Krejci <lkrejci(a)redhat.com> Date: Thu Sep 13 10:10:24 2012 +0200 [BZ 846623] - Finishing the fix: 1) Make sure the UI doesn't contain stale data after an update of a alert def. 2) Provide a "copy-creation" of alert definition used for syncing the defs on a resource with the corresponding group and template alert defs (this is done by adding a "validateNotificationConfiguration boolean to the AlertDefinitionManagerLocal.createAlertDefinition()). 3) A new method for updating dependent alert defs (similar to previously added method for creating dependent alert defs) 4) Make sure conditions and notifications are loaded before leaving the update methods so that lazy load exceptions don't occur. 5) Only perform validation and finalization on new or changed notifications. 6) Marking several methods that supported the old JSF UI and are unused as deprecated. 7) new integration tests to check the behavior of alert senders that modify the notification configuration. diff --git a/modules/core/domain/src/main/java/org/rhq/core/domain/criteria/AlertDefinitionCriteria.java b/modules/core/domain/src/main/java/org/rhq/core/domain/criteria/AlertDefinitionCriteria.java index e75263d..a11b88e 100644 --- a/modules/core/domain/src/main/java/org/rhq/core/domain/criteria/AlertDefinitionCriteria.java +++ b/modules/core/domain/src/main/java/org/rhq/core/domain/criteria/AlertDefinitionCriteria.java @@ -56,6 +56,7 @@ public class AlertDefinitionCriteria extends Criteria { private String filterAlertTemplateResourceTypeName; // requires overrides private List<Integer> filterResourceIds; // requires overrides private List<Integer> filterResourceGroupIds; // requires overrides + private Integer filterGroupAlertDefinitionId; private Boolean filterEnabled; private Boolean filterDeleted = false; // find enabled definitions by default private NonBindingOverrideFilter filterResourceOnly; // requires overrides - finds only those associated with a resource @@ -80,6 +81,7 @@ public class AlertDefinitionCriteria extends Criteria { filterOverrides.put("alertTemplateResourceTypeName", "resourceType.name like ?"); filterOverrides.put("resourceIds", "resource.id IN ( ? )"); filterOverrides.put("resourceGroupIds", "resourceGroup.id IN ( ? )"); + filterOverrides.put("groupAlertDefinitionId", "groupAlertDefinition.id = ?"); filterOverrides.put("resourceOnly", "resource IS NOT NULL"); filterOverrides.put("notificationSenderNames", "id IN (" + "SELECT notif.alertDefinition.id FROM AlertNotification notif " + "WHERE notif.senderName IN ( ? ))"); @@ -158,6 +160,10 @@ public class AlertDefinitionCriteria extends Criteria { this.filterNotificationSenderNames = Arrays.asList(notificationNames); } + public void addFilterGroupAlertDefinitionId(Integer groupAlertDefinitionId) { + this.filterGroupAlertDefinitionId = groupAlertDefinitionId; + } + public void fetchAlerts(boolean fetchAlerts) { this.fetchAlerts = fetchAlerts; } diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/AbstractAlertDefinitionsView.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/AbstractAlertDefinitionsView.java index 6a2fbf5..ae46936 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/AbstractAlertDefinitionsView.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/AbstractAlertDefinitionsView.java @@ -199,5 +199,5 @@ public abstract class AbstractAlertDefinitionsView extends TableSection<Abstract protected abstract void disableButtonPressed(ListGridRecord[] selection); - protected abstract void commitAlertDefinition(AlertDefinition alertDefinition, boolean isPurgeInternals); + protected abstract void commitAlertDefinition(AlertDefinition alertDefinition, boolean isPurgeInternals, AsyncCallback<AlertDefinition> resultReceiver); } diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/GroupAlertDefinitionsView.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/GroupAlertDefinitionsView.java index b277077..4b8e072 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/GroupAlertDefinitionsView.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/GroupAlertDefinitionsView.java @@ -198,7 +198,7 @@ public class GroupAlertDefinitionsView extends AbstractAlertDefinitionsView { } @Override - protected void commitAlertDefinition(final AlertDefinition alertDefinition, boolean purgeInternals) { + protected void commitAlertDefinition(final AlertDefinition alertDefinition, boolean purgeInternals, final AsyncCallback<AlertDefinition> resultReceiver) { if (alertDefinition.getId() == 0) { GWTServiceLookup.getGroupAlertDefinitionService().createGroupAlertDefinitions(alertDefinition, Integer.valueOf(this.group.getId()), new AsyncCallback<Integer>() { @@ -208,11 +208,13 @@ public class GroupAlertDefinitionsView extends AbstractAlertDefinitionsView { new Message(MSG.view_alert_definitions_create_success(), Severity.Info)); alertDefinition.setId(result.intValue()); GroupAlertDefinitionsView.this.refresh(); + resultReceiver.onSuccess(alertDefinition); } @Override public void onFailure(Throwable caught) { CoreGUI.getErrorHandler().handleError(MSG.view_alert_definitions_create_failure(), caught); + resultReceiver.onFailure(caught); } }); } else { @@ -224,11 +226,13 @@ public class GroupAlertDefinitionsView extends AbstractAlertDefinitionsView { CoreGUI.getMessageCenter().notify( new Message(MSG.view_alert_definitions_update_success(), Severity.Info)); GroupAlertDefinitionsView.this.refresh(); + resultReceiver.onSuccess(result); } @Override public void onFailure(Throwable caught) { CoreGUI.getErrorHandler().handleError(MSG.view_alert_definitions_update_failure(), caught); + resultReceiver.onFailure(caught); } }); } diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/ResourceAlertDefinitionsView.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/ResourceAlertDefinitionsView.java index 00aa951..5dfacc8 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/ResourceAlertDefinitionsView.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/ResourceAlertDefinitionsView.java @@ -194,7 +194,7 @@ public class ResourceAlertDefinitionsView extends AbstractAlertDefinitionsView { } @Override - protected void commitAlertDefinition(final AlertDefinition alertDefinition, boolean purgeInternals) { + protected void commitAlertDefinition(final AlertDefinition alertDefinition, boolean purgeInternals, final AsyncCallback<AlertDefinition> resultReceiver) { if (alertDefinition.getId() == 0) { GWTServiceLookup.getAlertDefinitionService().createAlertDefinition(alertDefinition, Integer.valueOf(resource.getId()), new AsyncCallback<Integer>() { @@ -204,11 +204,13 @@ public class ResourceAlertDefinitionsView extends AbstractAlertDefinitionsView { new Message(MSG.view_alert_definitions_create_success(), Severity.Info)); alertDefinition.setId(result.intValue()); ResourceAlertDefinitionsView.this.refresh(); + resultReceiver.onSuccess(alertDefinition); } @Override public void onFailure(Throwable caught) { CoreGUI.getErrorHandler().handleError(MSG.view_alert_definitions_create_failure(), caught); + resultReceiver.onFailure(caught); } }); } else { @@ -219,11 +221,13 @@ public class ResourceAlertDefinitionsView extends AbstractAlertDefinitionsView { CoreGUI.getMessageCenter().notify( new Message(MSG.view_alert_definitions_update_success(), Severity.Info)); ResourceAlertDefinitionsView.this.refresh(); + resultReceiver.onSuccess(result); } @Override public void onFailure(Throwable caught) { CoreGUI.getErrorHandler().handleError(MSG.view_alert_definitions_update_failure(), caught); + resultReceiver.onFailure(caught); } }); } diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/SingleAlertDefinitionView.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/SingleAlertDefinitionView.java index f2007ce..a5d15e9 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/SingleAlertDefinitionView.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/SingleAlertDefinitionView.java @@ -23,6 +23,7 @@ package org.rhq.enterprise.gui.coregui.client.alert.definitions; +import com.google.gwt.user.client.rpc.AsyncCallback; import com.smartgwt.client.widgets.Button; import com.smartgwt.client.widgets.events.ClickEvent; import com.smartgwt.client.widgets.events.ClickHandler; @@ -139,7 +140,16 @@ public class SingleAlertDefinitionView extends LocatableVLayout { setAlertDefinition(getAlertDefinition()); // loads data into static fields makeViewOnly(); - alertDefView.commitAlertDefinition(getAlertDefinition(), resetMatching); + alertDefView.commitAlertDefinition(getAlertDefinition(), resetMatching, new AsyncCallback<AlertDefinition>() { + @Override + public void onSuccess(AlertDefinition result) { + setAlertDefinition(result); + } + + @Override + public void onFailure(Throwable caught) { + } + }); } else { tabSet.selectTab(generalPropertiesTab); } diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/TemplateAlertDefinitionsView.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/TemplateAlertDefinitionsView.java index 0c710b4..1218c3a 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/TemplateAlertDefinitionsView.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/client/alert/definitions/TemplateAlertDefinitionsView.java @@ -206,7 +206,7 @@ public class TemplateAlertDefinitionsView extends AbstractAlertDefinitionsView { } @Override - protected void commitAlertDefinition(final AlertDefinition alertDefinition, boolean resetMatching) { + protected void commitAlertDefinition(final AlertDefinition alertDefinition, boolean resetMatching, final AsyncCallback<AlertDefinition> resultReceiver) { if (alertDefinition.getId() == 0) { GWTServiceLookup.getAlertTemplateService().createAlertTemplate(alertDefinition, Integer.valueOf(this.resourceType.getId()), new AsyncCallback<Integer>() { @@ -216,11 +216,13 @@ public class TemplateAlertDefinitionsView extends AbstractAlertDefinitionsView { new Message(MSG.view_alert_definitions_create_success(), Severity.Info)); alertDefinition.setId(result.intValue()); TemplateAlertDefinitionsView.this.refresh(); + resultReceiver.onSuccess(alertDefinition); } @Override public void onFailure(Throwable caught) { CoreGUI.getErrorHandler().handleError(MSG.view_alert_definitions_create_failure(), caught); + resultReceiver.onFailure(caught); } }); } else { @@ -231,11 +233,13 @@ public class TemplateAlertDefinitionsView extends AbstractAlertDefinitionsView { CoreGUI.getMessageCenter().notify( new Message(MSG.view_alert_definitions_update_success(), Severity.Info)); TemplateAlertDefinitionsView.this.refresh(); + resultReceiver.onSuccess(result); } @Override public void onFailure(Throwable caught) { CoreGUI.getErrorHandler().handleError(MSG.view_alert_definitions_update_failure(), caught); + resultReceiver.onFailure(caught); } }); } diff --git a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/AlertDefinitionGWTServiceImpl.java b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/AlertDefinitionGWTServiceImpl.java index 01ba237..07d6132 100644 --- a/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/AlertDefinitionGWTServiceImpl.java +++ b/modules/enterprise/gui/coregui/src/main/java/org/rhq/enterprise/gui/coregui/server/gwt/AlertDefinitionGWTServiceImpl.java @@ -65,7 +65,7 @@ public class AlertDefinitionGWTServiceImpl extends AbstractGWTServiceImpl implem @Override public int createAlertDefinition(AlertDefinition alertDefinition, Integer resourceId) throws RuntimeException { try { - int results = alertDefManager.createAlertDefinition(getSessionSubject(), alertDefinition, resourceId); + int results = alertDefManager.createAlertDefinition(getSessionSubject(), alertDefinition, resourceId, true); return results; } catch (Throwable t) { throw getExceptionToThrowToClient(t); diff --git a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/legacy/action/resource/common/monitor/alerts/config/NewDefinitionAction.java b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/legacy/action/resource/common/monitor/alerts/config/NewDefinitionAction.java index e4c25f8..1db7d05 100644 --- a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/legacy/action/resource/common/monitor/alerts/config/NewDefinitionAction.java +++ b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/legacy/action/resource/common/monitor/alerts/config/NewDefinitionAction.java @@ -92,7 +92,7 @@ public class NewDefinitionAction extends BaseAction { alertDefinitionId = alertTemplateManager.createAlertTemplate(subject, alertDef, defForm.getType()); } else if (context == FormContext.Resource) { AlertDefinitionManagerLocal alertDefinitionManager = LookupUtil.getAlertDefinitionManager(); - alertDefinitionId = alertDefinitionManager.createAlertDefinition(subject, alertDef, defForm.getId()); + alertDefinitionId = alertDefinitionManager.createAlertDefinition(subject, alertDef, defForm.getId(), true); } else if (context == FormContext.Group) { GroupAlertDefinitionManagerLocal groupAlertDefinitionManager = LookupUtil .getGroupAlertDefinitionManager(); diff --git a/modules/enterprise/server/itests/pom.xml b/modules/enterprise/server/itests/pom.xml index 43a14c8..d16253a 100644 --- a/modules/enterprise/server/itests/pom.xml +++ b/modules/enterprise/server/itests/pom.xml @@ -141,6 +141,18 @@ <scope>test</scope> </dependency> +  + <dependency> + <groupId>org.jboss.shrinkwrap</groupId> + <artifactId>shrinkwrap-api</artifactId> + </dependency> + + <dependency> + <groupId>org.jboss.shrinkwrap</groupId> + <artifactId>shrinkwrap-impl-base</artifactId> + <scope>compile</scope> + </dependency> +  <dependency> @@ -274,8 +286,30 @@ <version>${resteasy.version}</version> </dependency> +  + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>rhq-serverplugin-drift</artifactId> + <version>${project.version}</version> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>org.powermock</groupId> + <artifactId>powermock-module-testng</artifactId> + <version>${powermock.version}</version> + <scope>test</scope> + </dependency> + + <dependency> + <groupId>org.powermock</groupId> + <artifactId>powermock-api-mockito</artifactId> + <version>${powermock.version}</version> + <scope>test</scope> + </dependency> </dependencies> + <build> <testResources> <testResource> diff --git a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/TestServerPluginService.java b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/TestServerPluginService.java new file mode 100644 index 0000000..be9b752 --- /dev/null +++ b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/TestServerPluginService.java @@ -0,0 +1,148 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.server; + +import java.io.File; +import java.net.URL; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.rhq.core.domain.configuration.Configuration; +import org.rhq.core.domain.configuration.definition.ConfigurationDefinition; +import org.rhq.core.domain.plugin.PluginKey; +import org.rhq.core.domain.plugin.PluginStatusType; +import org.rhq.core.domain.plugin.ServerPlugin; +import org.rhq.core.util.MessageDigestGenerator; +import org.rhq.enterprise.server.plugin.pc.AbstractTypeServerPluginContainer; +import org.rhq.enterprise.server.plugin.pc.MasterServerPluginContainer; +import org.rhq.enterprise.server.plugin.pc.MasterServerPluginContainerConfiguration; +import org.rhq.enterprise.server.plugin.pc.ServerPluginEnvironment; +import org.rhq.enterprise.server.plugin.pc.ServerPluginService; +import org.rhq.enterprise.server.plugin.pc.ServerPluginType; +import org.rhq.enterprise.server.xmlschema.ServerPluginDescriptorMetadataParser; +import org.rhq.enterprise.server.xmlschema.ServerPluginDescriptorUtil; +import org.rhq.enterprise.server.xmlschema.generated.serverplugin.ServerPluginDescriptorType; + +/** + * + * + * @author Lukas Krejci + */ +public abstract class TestServerPluginService extends ServerPluginService implements TestServerPluginServiceMBean { + public TestMasterServerPluginContainer master; + public MasterServerPluginContainerConfiguration masterConfig; + + protected TestServerPluginService() { + // build the config at constructor time so tests have it even before the PC is initialized + File dir = new File(System.getProperty("java.io.tmpdir"), "test-server-plugins"); + this.masterConfig = new MasterServerPluginContainerConfiguration(dir, dir, dir, null); + } + + @Override + public MasterServerPluginContainer createMasterPluginContainer() { + this.master = new TestMasterServerPluginContainer(); + this.master.initialize(this.masterConfig); + return this.master; + } + + protected abstract List<AbstractTypeServerPluginContainer> createPluginContainers(MasterServerPluginContainer master); + + public static ServerPlugin getPlugin(ServerPluginEnvironment env) { + return getPlugin(env.getPluginUrl(), env.getPluginDescriptor()); + } + + public static ServerPlugin getPlugin(URL pluginUrl, ServerPluginDescriptorType pluginDescriptor) { + try { + Configuration pluginConfig = null; + Configuration scheduledJobsConfig = null; + ConfigurationDefinition configDef; + + configDef = ServerPluginDescriptorMetadataParser.getPluginConfigurationDefinition(pluginDescriptor); + if (configDef != null) { + pluginConfig = configDef.getDefaultTemplate().createConfiguration(); + } + + configDef = ServerPluginDescriptorMetadataParser.getScheduledJobsDefinition(pluginDescriptor); + if (configDef != null) { + scheduledJobsConfig = configDef.getDefaultTemplate().createConfiguration(); + } + + File pluginFile = new File(pluginUrl.toURI()); + PluginKey pluginKey = PluginKey.createServerPluginKey(new ServerPluginType(pluginDescriptor).stringify(), pluginDescriptor.getName()); + ServerPlugin plugin = + new ServerPlugin(0, pluginKey.getPluginName(), pluginFile.getName(), + pluginDescriptor.getDisplayName(), true, PluginStatusType.INSTALLED, + pluginDescriptor.getDescription(), "", MessageDigestGenerator.getDigestString(pluginFile), + pluginDescriptor.getVersion(), pluginDescriptor.getVersion(), pluginConfig, + scheduledJobsConfig, new ServerPluginType(pluginDescriptor).stringify(), + System.currentTimeMillis(), System.currentTimeMillis()); + return plugin; + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + public static ServerPlugin getPlugin(URL pluginUrl) throws Exception { + ServerPluginDescriptorType type = ServerPluginDescriptorUtil.loadPluginDescriptorFromUrl(pluginUrl); + + return getPlugin(pluginUrl, type); + } + + protected Map<URL, ? extends ServerPluginDescriptorType> preloadAllPlugins() throws Exception { + return null; + } + + private class TestMasterServerPluginContainer extends MasterServerPluginContainer { + + @Override + protected ClassLoader createRootServerPluginClassLoader() { + return getClass().getClassLoader(); + } + + @Override + protected Map<URL, ? extends ServerPluginDescriptorType> preloadAllPlugins() throws Exception { + Map<URL, ? extends ServerPluginDescriptorType> plugins = TestServerPluginService.this.preloadAllPlugins(); + if (plugins != null) { + return plugins; + } + + // if our test never setup any plugins, ignore it and just return an empty map + File pluginDir = getConfiguration().getPluginDirectory(); + if (pluginDir == null || pluginDir.listFiles() == null || pluginDir.listFiles().length == 0) { + return new HashMap<URL, ServerPluginDescriptorType>(); + } else { + return super.preloadAllPlugins(); + } + } + + @Override + protected List<PluginKey> getDisabledPluginKeys() { + // in the real world, the db is checked for enable flag, here we say all plugins are enabled + return new ArrayList<PluginKey>(); + } + + @Override + protected List<AbstractTypeServerPluginContainer> createPluginContainers() { + return TestServerPluginService.this.createPluginContainers(this); + } + } +} diff --git a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/TestServerPluginServiceMBean.java b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/TestServerPluginServiceMBean.java new file mode 100644 index 0000000..3cd24a4 --- /dev/null +++ b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/TestServerPluginServiceMBean.java @@ -0,0 +1,31 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.server; + +import org.rhq.enterprise.server.plugin.pc.ServerPluginServiceManagement; + +/** + * + * + * @author Lukas Krejci + */ +public interface TestServerPluginServiceMBean extends ServerPluginServiceManagement { + +} diff --git a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/AlertDefinitionWithComplexNotificationsTest.java b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/AlertDefinitionWithComplexNotificationsTest.java new file mode 100644 index 0000000..d89855e --- /dev/null +++ b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/AlertDefinitionWithComplexNotificationsTest.java @@ -0,0 +1,716 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.server.alert; + +import java.io.File; +import java.util.Collections; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Set; + +import javax.persistence.EntityManager; +import javax.transaction.TransactionManager; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.testng.annotations.AfterClass; +import org.testng.annotations.AfterMethod; +import org.testng.annotations.BeforeClass; +import org.testng.annotations.BeforeMethod; +import org.testng.annotations.Test; + +import org.jboss.shrinkwrap.api.ShrinkWrap; +import org.jboss.shrinkwrap.api.exporter.ZipExporter; +import org.jboss.shrinkwrap.api.spec.JavaArchive; + +import org.rhq.core.domain.alert.AlertDampening; +import org.rhq.core.domain.alert.AlertDefinition; +import org.rhq.core.domain.alert.AlertPriority; +import org.rhq.core.domain.alert.BooleanExpression; +import org.rhq.core.domain.alert.notification.AlertNotification; +import org.rhq.core.domain.auth.Subject; +import org.rhq.core.domain.authz.Permission; +import org.rhq.core.domain.authz.Role; +import org.rhq.core.domain.cloud.Server; +import org.rhq.core.domain.cloud.Server.OperationMode; +import org.rhq.core.domain.configuration.Configuration; +import org.rhq.core.domain.configuration.PropertySimple; +import org.rhq.core.domain.criteria.AlertDefinitionCriteria; +import org.rhq.core.domain.criteria.ResourceCriteria; +import org.rhq.core.domain.plugin.ServerPlugin; +import org.rhq.core.domain.resource.Agent; +import org.rhq.core.domain.resource.InventoryStatus; +import org.rhq.core.domain.resource.Resource; +import org.rhq.core.domain.resource.ResourceType; +import org.rhq.core.domain.resource.group.ResourceGroup; +import org.rhq.core.domain.shared.ResourceBuilder; +import org.rhq.core.domain.shared.ResourceTypeBuilder; +import org.rhq.enterprise.server.TestServerPluginService; +import org.rhq.enterprise.server.auth.SessionManager; +import org.rhq.enterprise.server.test.AbstractEJB3Test; +import org.rhq.enterprise.server.test.TestServerCommunicationsService; +import org.rhq.enterprise.server.util.LookupUtil; +import org.rhq.enterprise.server.util.ResourceTreeHelper; +import org.rhq.test.JPAUtils; +import org.rhq.test.TransactionCallback; +import org.rhq.test.TransactionCallbackWithContext; + +/** + * + * + * @author Lukas Krejci + */ +@Test(groups = "alert") +public class AlertDefinitionWithComplexNotificationsTest extends AbstractEJB3Test { + + private static final Log LOG = LogFactory.getLog(AlertDefinitionWithComplexNotificationsTest.class); + + private enum ParentType { + GROUP, TEMPLATE + } + + private String universalName; + + private Server server; + private Agent agent; + private Subject subject; + private Role role; + private ResourceType resourceType; + private ResourceGroup resourceGroup; + private Set<Resource> resources; + private AlertDefinition templateAlertDefinition; + private AlertDefinition groupAlertDefinition; + private AlertDefinition resourceAlertDefinition; + private ServerPlugin serverPlugin; + private Set<Object> junk = new LinkedHashSet<Object>(); + + private int resourceLevelAlertDefinitionId; + private int groupLevelAlertDefinitionId; + private int templateLevelAlertDefinitionId; + private Resource copyTestsResource; + + private TestAlertSenderPluginService alertSenderService; + private TestServerCommunicationsService agentService; + + @BeforeClass + public void prepareDB() { + executeInTransaction(new TransactionCallback() { + @Override + public void execute() throws Exception { + EntityManager em = getEntityManager(); + + universalName = getClass().getName(); + + agent = new Agent("localhost", "localhost", 0, "foo", "bar"); + + server = new Server(); + server.setAddress("localhost"); + server.setName("localhost"); + server.setOperationMode(OperationMode.NORMAL); + + server.setAgents(Collections.singletonList(agent)); + + role = new Role(universalName); + role.addPermission(Permission.MANAGE_INVENTORY); + role.addPermission(Permission.MANAGE_SETTINGS); + + subject = new Subject(universalName, true, false); + subject.addRole(role); + + resourceType = + new ResourceTypeBuilder().createPlatformResourceType().withId(0).withName(universalName) + .withPlugin(universalName).build(); + + resourceGroup = new ResourceGroup(universalName, resourceType); + + resources = new LinkedHashSet<Resource>(); + for (int i = 0; i < 10; ++i) { + Resource res = createResourceForTest(universalName + i); + + resources.add(res); + + resourceGroup.addExplicitResource(res); + } + + templateAlertDefinition = createDefinitionForTest(universalName + " template", true); + templateAlertDefinition.setResourceType(resourceType); + + groupAlertDefinition = createDefinitionForTest(universalName + " group", true); + groupAlertDefinition.setResourceGroup(resourceGroup); + + resourceAlertDefinition = createDefinitionForTest(universalName + " resource", true); + resourceAlertDefinition.setResource(resources.iterator().next()); + + em.persist(agent); + em.persist(server); + em.persist(role); + em.persist(subject); + em.persist(resourceType); + em.persist(resourceGroup); + for (Resource r : resources) { + em.persist(r); + } + em.persist(templateAlertDefinition); + em.persist(groupAlertDefinition); + em.persist(resourceAlertDefinition); + + //only need this for a short time now, so that we can precreate the plugin structure + alertSenderService = new TestAlertSenderPluginService(); + prepareCustomServerPluginService(alertSenderService); + alertSenderService.masterConfig.getPluginDirectory().mkdirs(); + unprepareServerPluginService(); + + JavaArchive archive = + ShrinkWrap.create(JavaArchive.class).addClass(TestAlertSender.class) + .addAsResource("test-alert-sender-serverplugin.xml", "META-INF/rhq-serverplugin.xml"); + + File pluginFile = + new File(alertSenderService.masterConfig.getPluginDirectory(), "test-aler-plugin.jar"); + + archive.as(ZipExporter.class).exportTo(pluginFile, true); + + //the alert sender plugin manager needs the plugins in the database... + serverPlugin = TestServerPluginService.getPlugin(pluginFile.toURI().toURL()); + em.persist(serverPlugin); + } + }); + } + + @BeforeMethod + public void containerSetup() { + alertSenderService = new TestAlertSenderPluginService(); + prepareCustomServerPluginService(alertSenderService); + alertSenderService.masterConfig.getPluginDirectory().mkdirs(); + + alertSenderService.startMasterPluginContainer(); + + agentService = prepareForTestAgents(); + } + + @AfterMethod + public void containerTearDown() throws Exception { + unprepareServerPluginService(); + unprepareForTestAgents(); + } + + @AfterClass(alwaysRun = true) + public void cleanDB() throws Exception { + for (Object o : junk) { + removeNoExceptions(o); + } + + removeNoExceptions(resourceAlertDefinition); + removeNoExceptions(groupAlertDefinition); + removeNoExceptions(templateAlertDefinition); + removeNoExceptions(resourceGroup); + for (Resource r : resources) { + r.removeExplicitGroup(resourceGroup); + r.getAlertDefinitions().clear(); + removeNoExceptions(r); + } + removeNoExceptions(resourceType); + removeNoExceptions(subject); + removeNoExceptions(role); + removeNoExceptions(server); + removeNoExceptions(agent); + + removeNoExceptions(serverPlugin); + } + + @BeforeMethod + public void login() throws Exception { + //the embedded server cannot do a full-blown login + //so we hack our way in + subject = SessionManager.getInstance().put(subject); + } + + @AfterMethod(alwaysRun = true) + public void logout() throws Exception { + SessionManager.getInstance().invalidate(subject.getSessionId()); + } + + private Resource getCopyTestsResource() throws Exception { + if (copyTestsResource == null) { + final String keyAndName = universalName + "-copyTests"; + + LookupUtil.getResourceManager().createResource(subject, createResourceForTest(keyAndName), Resource.ROOT_ID); + + //ok, now the new resource should contain the alert definition defined by the template + ResourceCriteria crit = new ResourceCriteria(); + crit.addFilterResourceKey(keyAndName); + crit.fetchExplicitGroups(true); //so that cleanup works + crit.fetchAlertDefinitions(true); //so that cleanup works + + List<Resource> foundResources = LookupUtil.getResourceManager().findResourcesByCriteria(subject, crit); + + assertEquals("A new resource should have been created", 1, foundResources.size()); + + Resource res = foundResources.get(0); + resources.add(res); + + copyTestsResource = res; + } + + return copyTestsResource; + } + + public void testNotificationsCopiedOnAlertTemplateApplication() throws Exception { + TestAlertSender.setExpectedSubject(null); + TestAlertSender.resetValidateMethodCallCount(); + + Resource res = getCopyTestsResource(); + + //apply the template manually - this is done in server-agent back-and-forth that we + //don't test here and which is complex to mock out. + //this method has to be called using the overlord subject + LookupUtil.getAlertTemplateManager().updateAlertDefinitionsForResource(LookupUtil.getSubjectManager().getOverlord(), res.getId()); + + assertEquals("No validation should occur on the copied notifications", 0, TestAlertSender.getValidateMethodCallCount()); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + AlertDefinitionCriteria adCrit = new AlertDefinitionCriteria(); + adCrit.addFilterResourceIds(res.getId()); + adCrit.fetchAlertNotifications(true); + + List<AlertDefinition> foundAlertDefs = adm.findAlertDefinitionsByCriteria(subject, adCrit); + junk.addAll(foundAlertDefs); + + assertEquals("The new resource should have an alert definition obtained from the template.", 1, foundAlertDefs.size()); + + AlertDefinition defWithNotifications = foundAlertDefs.get(0); + + testSingleDependentAlertDefinition(defWithNotifications, ParentType.TEMPLATE, defWithNotifications.getParentId()); + } + + @Test(dependsOnMethods = "testNotificationsCopiedOnAlertTemplateApplication") + public void testNotificationsCopiedOnGroupMemberAddition() throws Exception { + TestAlertSender.setExpectedSubject(null); + TestAlertSender.resetValidateMethodCallCount(); + + Resource res = getCopyTestsResource(); + + LookupUtil.getResourceGroupManager().addResourcesToGroup(subject, resourceGroup.getId(), new int[] { res.getId() }); + + assertEquals("No validation should occur on the copied notifications", 0, TestAlertSender.getValidateMethodCallCount()); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + AlertDefinitionCriteria adCrit = new AlertDefinitionCriteria(); + adCrit.addFilterResourceIds(res.getId()); + adCrit.fetchAlertNotifications(true); + + List<AlertDefinition> foundAlertDefs = adm.findAlertDefinitionsByCriteria(subject, adCrit); + junk.addAll(foundAlertDefs); + + //1 from the group, 1 from the template + assertEquals("The new resource should have an alert definition obtained from the group.", 2, foundAlertDefs.size()); + + AlertDefinition groupOriginatingDef = null; + for(AlertDefinition d : foundAlertDefs) { + if ((universalName + " group").equals(d.getName())) { + groupOriginatingDef = d; + break; + } + } + + assertNotNull("The alert definition originating from the group not present on the resource.", groupOriginatingDef); + + testSingleDependentAlertDefinition(groupOriginatingDef, ParentType.GROUP, groupOriginatingDef.getGroupAlertDefinition().getId()); + } + + public void testCorrectSubjectPassedOnResourceLevelAlertDefinitionCreation() throws Exception { + TestAlertSender.setExpectedSubject(subject); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + + Resource res = resources.iterator().next(); + + AlertDefinition def = createDefinitionForTest("testCorrectSubjectPassedOnResourceLevelAlertDefinitionCreation", false); + def.setResource(resources.iterator().next()); + + int id = adm.createAlertDefinition(subject, def, res.getId(), true); + def.setId(id); + + resourceLevelAlertDefinitionId = id; + + junk.add(def); + + testMainAlertDefinition(id); + } + + @Test(dependsOnMethods = { "testNotificationsCopiedOnAlertTemplateApplication", "testNotificationsCopiedOnGroupMemberAddition" }) + public void testCorrectSubjectPassedOnGroupLevelAlertDefinitionCreation() throws Exception { + TestAlertSender.setExpectedSubject(subject); + + GroupAlertDefinitionManagerLocal gadm = LookupUtil.getGroupAlertDefinitionManager(); + + AlertDefinition def = createDefinitionForTest("testCorrectSubjectPassedOnGroupLevelAlertDefinitionCreation", false); + def.setResourceGroup(resourceGroup); + + int id = gadm.createGroupAlertDefinitions(subject, def, resourceGroup.getId()); + def.setId(id); + + groupLevelAlertDefinitionId = id; + + junk.add(def); + + testMainAlertDefinition(id); + List<AlertDefinition> deps = testDependentAlertDefinitions(id, ParentType.GROUP); + + junk.addAll(deps); + } + + @Test(dependsOnMethods = { "testNotificationsCopiedOnAlertTemplateApplication", "testNotificationsCopiedOnGroupMemberAddition" }) + public void testCorrectSubjectPassedOnTemplateLevelAlertDefinitionCreation() throws Exception { + TestAlertSender.setExpectedSubject(subject); + + AlertTemplateManagerLocal atm = LookupUtil.getAlertTemplateManager(); + + AlertDefinition def = createDefinitionForTest("testCorrectSubjectPassedOnTemplateLevelAlertDefinitionCreation", false); + def.setResourceGroup(resourceGroup); + + int id = atm.createAlertTemplate(subject, def, resourceType.getId()); + def.setId(id); + + templateLevelAlertDefinitionId = id; + + junk.add(def); + + testMainAlertDefinition(id); + List<AlertDefinition> deps = testDependentAlertDefinitions(id, ParentType.TEMPLATE); + + junk.addAll(deps); + } + + @Test(dependsOnMethods = "testCorrectSubjectPassedOnResourceLevelAlertDefinitionCreation") + public void testNoValidationWhenNoNotificationUpdateOnResourceLevel() throws Exception { + TestAlertSender.setExpectedSubject(subject); + TestAlertSender.resetValidateMethodCallCount(); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + + AlertDefinitionCriteria crit = new AlertDefinitionCriteria(); + crit.addFilterId(resourceLevelAlertDefinitionId); + crit.fetchAlertNotifications(true); + crit.fetchConditions(true); + + List<AlertDefinition> foundDefs = adm.findAlertDefinitionsByCriteria(subject, crit); + + assertEquals("Failed to find the previously created resource level alert definition.", 1, foundDefs.size()); + + AlertDefinition foundDef = foundDefs.get(0); + + foundDef.setEnabled(true); + + adm.updateAlertDefinition(subject, resourceLevelAlertDefinitionId, foundDef, false); + + assertEquals("The notification validation method shouldn't have been called", 0, TestAlertSender.getValidateMethodCallCount()); + } + + @Test(dependsOnMethods = "testCorrectSubjectPassedOnGroupLevelAlertDefinitionCreation") + public void testNoValidationWhenNoNotificationUpdateOnGroupLevel() throws Exception { + TestAlertSender.setExpectedSubject(subject); + TestAlertSender.resetValidateMethodCallCount(); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + + AlertDefinitionCriteria crit = new AlertDefinitionCriteria(); + crit.addFilterId(groupLevelAlertDefinitionId); + crit.fetchAlertNotifications(true); + crit.fetchConditions(true); + + List<AlertDefinition> foundDefs = adm.findAlertDefinitionsByCriteria(subject, crit); + + assertEquals("Failed to find the previously created group level alert definition.", 1, foundDefs.size()); + + AlertDefinition foundDef = foundDefs.get(0); + + foundDef.setEnabled(true); + + GroupAlertDefinitionManagerLocal gadm = LookupUtil.getGroupAlertDefinitionManager(); + gadm.updateGroupAlertDefinitions(subject, foundDef, true); + + assertEquals("The notification validation method shouldn't have been called", 0, TestAlertSender.getValidateMethodCallCount()); + } + + @Test(dependsOnMethods = "testCorrectSubjectPassedOnTemplateLevelAlertDefinitionCreation") + public void testNoValidationWhenNoNotificationUpdateOnTemplateLevel() throws Exception { + TestAlertSender.setExpectedSubject(subject); + TestAlertSender.resetValidateMethodCallCount(); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + + AlertDefinitionCriteria crit = new AlertDefinitionCriteria(); + crit.addFilterId(templateLevelAlertDefinitionId); + crit.fetchAlertNotifications(true); + crit.fetchConditions(true); + + List<AlertDefinition> foundDefs = adm.findAlertDefinitionsByCriteria(subject, crit); + + assertEquals("Failed to find the previously created resource level alert definition.", 1, foundDefs.size()); + + AlertDefinition foundDef = foundDefs.get(0); + + foundDef.setEnabled(true); + + AlertTemplateManagerLocal atm = LookupUtil.getAlertTemplateManager(); + + atm.updateAlertTemplate(subject, foundDef, true); + + assertEquals("The notification validation method shouldn't have been called", 0, TestAlertSender.getValidateMethodCallCount()); + } + + @Test(dependsOnMethods = "testNoValidationWhenNoNotificationUpdateOnResourceLevel") + public void testCorrectSubjectPassedOnResourceLevelAlertDefinitionUpdate() throws Exception { + TestAlertSender.setExpectedSubject(subject); + TestAlertSender.resetValidateMethodCallCount(); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + + AlertDefinitionCriteria crit = new AlertDefinitionCriteria(); + crit.addFilterId(resourceLevelAlertDefinitionId); + crit.fetchAlertNotifications(true); + crit.fetchConditions(true); + + List<AlertDefinition> foundDefs = adm.findAlertDefinitionsByCriteria(subject, crit); + + assertEquals("Failed to find the previously created resource level alert definition.", 1, foundDefs.size()); + + AlertDefinition foundDef = foundDefs.get(0); + + AlertNotification newNotif = createAlertNotificationForTest(foundDef, false); + //just add some dummy config property so that the 2 notifs are distinguishable from each other + //and are saved separately + newNotif.getConfiguration().put(new PropertySimple("foo-resource", "bar")); + + adm.updateAlertDefinition(subject, resourceLevelAlertDefinitionId, foundDef, false); + + assertEquals("Validation should have been called for a new notification during alert def update", 1, TestAlertSender.getValidateMethodCallCount()); + } + + @Test(dependsOnMethods = "testCorrectSubjectPassedOnGroupLevelAlertDefinitionCreation") + public void testCorrectSubjectPassedOnGroupLevelAlertDefinitionUpdate() throws Exception { + TestAlertSender.setExpectedSubject(subject); + TestAlertSender.resetValidateMethodCallCount(); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + + AlertDefinitionCriteria crit = new AlertDefinitionCriteria(); + crit.addFilterId(groupLevelAlertDefinitionId); + crit.fetchAlertNotifications(true); + crit.fetchConditions(true); + + List<AlertDefinition> foundDefs = adm.findAlertDefinitionsByCriteria(subject, crit); + + assertEquals("Failed to find the previously created group level alert definition.", 1, foundDefs.size()); + + AlertDefinition foundDef = foundDefs.get(0); + + AlertNotification newNotif = createAlertNotificationForTest(foundDef, false); + //just add some dummy config property so that the 2 notifs are distinguishable from each other + //and are saved separately + newNotif.getConfiguration().put(new PropertySimple("foo-group", "bar")); + + GroupAlertDefinitionManagerLocal gadm = LookupUtil.getGroupAlertDefinitionManager(); + gadm.updateGroupAlertDefinitions(subject, foundDef, true); + + //notice that the validation should be called just once, even though in effect we're creating 11 notifs + //1 for group and 10 for its members. + assertEquals("Validation should have been called for a new notification during alert def update", 1, TestAlertSender.getValidateMethodCallCount()); + } + + @Test(dependsOnMethods = "testCorrectSubjectPassedOnTemplateLevelAlertDefinitionCreation") + public void testCorrectSubjectPassedOnTemplateLevelAlertDefinitionUpdate() throws Exception { + TestAlertSender.setExpectedSubject(subject); + TestAlertSender.resetValidateMethodCallCount(); + + AlertDefinitionManagerLocal adm = LookupUtil.getAlertDefinitionManager(); + + AlertDefinitionCriteria crit = new AlertDefinitionCriteria(); + crit.addFilterId(templateLevelAlertDefinitionId); + crit.fetchAlertNotifications(true); + crit.fetchConditions(true); + + List<AlertDefinition> foundDefs = adm.findAlertDefinitionsByCriteria(subject, crit); + + assertEquals("Failed to find the previously created template level alert definition.", 1, foundDefs.size()); + + AlertDefinition foundDef = foundDefs.get(0); + + AlertNotification newNotif = createAlertNotificationForTest(foundDef, false); + //just add some dummy config property so that the 2 notifs are distinguishable from each other + //and are saved separately + newNotif.getConfiguration().put(new PropertySimple("foo-template", "bar")); + + AlertTemplateManagerLocal atm = LookupUtil.getAlertTemplateManager(); + atm.updateAlertTemplate(subject, foundDef, true); + + //notice that the validation should be called just once, even though in effect we're creating 11 notifs + //1 for template and 10 for its members. + assertEquals("Validation should have been called for a new notification during alert def update", 1, TestAlertSender.getValidateMethodCallCount()); + } + + private void removeNoExceptions(final Object o) { + try { + JPAUtils.executeInTransaction(new TransactionCallbackWithContext<Void>() { + @Override + public Void execute(TransactionManager tm, EntityManager em) { + Object o2 = em.merge(o); + + if (o2 instanceof Resource) { + ResourceTreeHelper.deleteResource(em, (Resource) o2); + } else { + em.remove(o2); + } + return null; + } + }); + } catch (Exception e) { + LOG.error("Failed to DELETE an object from database: " + o, e); + } + } + + private AlertDefinition createDefinition(String name) { + AlertDefinition ret = new AlertDefinition(); + ret.setName(name); + ret.setPriority(AlertPriority.MEDIUM); + ret.setAlertDampening(new AlertDampening(AlertDampening.Category.NONE)); + ret.setConditionExpression(BooleanExpression.ANY); + ret.setRecoveryId(0); + + return ret; + } + + private AlertDefinition createDefinitionForTest(String name, boolean precanned) { + AlertDefinition def = createDefinition(name); + createAlertNotificationForTest(def, precanned); + + return def; + } + + private AlertNotification createAlertNotificationForTest(AlertDefinition alertDefinition, boolean precanned) { + AlertNotification notif = new AlertNotification("Test Alert Sender"); + + Configuration alertConfig = new Configuration(); + + if (precanned) { + alertConfig.put(new PropertySimple(TestAlertSender.PERSISTENT_PROPERTY_NAME, TestAlertSender.PERSISTEN_PROPERTY_EXPECTED_VALUE)); + } else { + alertConfig.put(new PropertySimple(TestAlertSender.PERSISTENT_PROPERTY_NAME, "persistent")); + alertConfig.put(new PropertySimple(TestAlertSender.EPHEMERAL_PROPERTY_NAME, "ephemeral")); + } + + Configuration extraConfig = new Configuration(); + + if (precanned) { + extraConfig.put(new PropertySimple(TestAlertSender.PERSISTENT_PROPERTY_NAME, TestAlertSender.PERSISTEN_PROPERTY_EXPECTED_VALUE)); + } else { + extraConfig.put(new PropertySimple(TestAlertSender.PERSISTENT_PROPERTY_NAME, "persistent")); + extraConfig.put(new PropertySimple(TestAlertSender.EPHEMERAL_PROPERTY_NAME, "ephemeral")); + } + + notif.setConfiguration(alertConfig); + notif.setExtraConfiguration(extraConfig); + + alertDefinition.addAlertNotification(notif); + notif.setAlertDefinition(alertDefinition); + + return notif; + } + + private void testMainAlertDefinition(int id) { + AlertDefinitionCriteria crit = new AlertDefinitionCriteria(); + crit.addFilterId(id); + crit.fetchAlertNotifications(true); + + List<AlertDefinition> checkList = + LookupUtil.getAlertDefinitionManager().findAlertDefinitionsByCriteria(subject, crit); + + assertNotNull("Failed to retrieve the save alert definition", checkList); + assertEquals("The alert definition should have been saved.", 1, checkList.size()); + + AlertDefinition check = checkList.get(0); + + assertEquals("There should be exactly 1 notification on the definition", 1, check.getAlertNotifications() + .size()); + + Configuration config = check.getAlertNotifications().get(0).getConfiguration(); + assertEquals("Unexpected persistent value in notif config", TestAlertSender.PERSISTEN_PROPERTY_EXPECTED_VALUE, + config.getSimpleValue(TestAlertSender.PERSISTENT_PROPERTY_NAME, null)); + assertNull("Ephemeral property seems to have been saved", + config.getSimpleValue(TestAlertSender.EPHEMERAL_PROPERTY_NAME, null)); + } + + private List<AlertDefinition> testDependentAlertDefinitions(int expectedParentId, ParentType parentType) { + AlertDefinitionCriteria crit = new AlertDefinitionCriteria(); + + Set<Integer> resourceIds = new HashSet<Integer>(resources.size()); + for (Resource r : resources) { + resourceIds.add(r.getId()); + } + + if (parentType == ParentType.TEMPLATE) { + crit.addFilterAlertTemplateParentId(expectedParentId); + } else if (parentType == ParentType.GROUP) { + crit.addFilterGroupAlertDefinitionId(expectedParentId); + } + + crit.fetchAlertNotifications(true); + + List<AlertDefinition> checkList = + LookupUtil.getAlertDefinitionManager().findAlertDefinitionsByCriteria(subject, crit); + + assertNotNull("Failed to retrieve the save alert definition", checkList); + assertEquals("The dependent alert definitions should have been saved.", resources.size(), checkList.size()); + + for (AlertDefinition check : checkList) { + testSingleDependentAlertDefinition(check, parentType, expectedParentId); + } + + return checkList; + } + + private void testSingleDependentAlertDefinition(AlertDefinition alertDef, ParentType parentType, int expectedParentId) { + assertEquals("There should be exactly 1 notification on the definition " + alertDef, 1, alertDef + .getAlertNotifications().size()); + + Configuration config = alertDef.getAlertNotifications().get(0).getConfiguration(); + assertEquals("Unexpected persistent value in notif config " + alertDef, + TestAlertSender.PERSISTEN_PROPERTY_EXPECTED_VALUE, + config.getSimpleValue(TestAlertSender.PERSISTENT_PROPERTY_NAME, null)); + assertNull("Ephemeral property seems to have been saved " + alertDef, + config.getSimpleValue(TestAlertSender.EPHEMERAL_PROPERTY_NAME, null)); + + if (parentType == ParentType.GROUP) { + assertEquals("The group parent id has unexpected value", expectedParentId, alertDef.getGroupAlertDefinition().getId()); + } else if (parentType == ParentType.TEMPLATE) { + assertEquals("The parent id has unexpected value", Integer.valueOf(expectedParentId), alertDef.getParentId()); + } + } + + private Resource createResourceForTest(String resourceKey) { + Resource res = new ResourceBuilder().createPlatform().withRandomUuid().withResourceKey(resourceKey) + .withResourceType(resourceType).withName(resourceKey) + .withInventoryStatus(InventoryStatus.COMMITTED).build(); + res.setAgent(agent); + + return res; + } +} diff --git a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/TestAlertSender.java b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/TestAlertSender.java new file mode 100644 index 0000000..900d74c --- /dev/null +++ b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/TestAlertSender.java @@ -0,0 +1,107 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.server.alert; + +import org.testng.Assert; + +import org.rhq.core.domain.alert.Alert; +import org.rhq.core.domain.alert.notification.SenderResult; +import org.rhq.core.domain.auth.Subject; +import org.rhq.core.domain.configuration.Configuration; +import org.rhq.core.domain.configuration.PropertySimple; +import org.rhq.enterprise.server.plugin.pc.ServerPluginComponent; +import org.rhq.enterprise.server.plugin.pc.alert.AlertSender; +import org.rhq.enterprise.server.plugin.pc.alert.AlertSenderValidationResults; + +/** + * + * + * @author Lukas Krejci + */ +public class TestAlertSender extends AlertSender<ServerPluginComponent> { + + public static final String NAME = "Test Alert Sender"; + + public static final String PERSISTENT_PROPERTY_NAME = "persistent"; + public static final String PERSISTEN_PROPERTY_EXPECTED_VALUE = "persistentephemeral"; + public static final String EPHEMERAL_PROPERTY_NAME = "ephemeral"; + + private static Subject EXPECTED_SUBJECT; + private static volatile int VALIDATE_METHOD_CALL_COUNT; + private static Runnable VALIDATION_CHECKER; + + public static void setExpectedSubject(Subject subject) { + EXPECTED_SUBJECT = subject; + } + + public static void setValidationChecker(Runnable validationChecker) { + VALIDATION_CHECKER = validationChecker; + } + + public static int getValidateMethodCallCount() { + return VALIDATE_METHOD_CALL_COUNT; + } + + public static void resetValidateMethodCallCount() { + VALIDATE_METHOD_CALL_COUNT = 0; + } + + @Override + public SenderResult send(Alert alert) { + SenderResult ret = new SenderResult(); + ret.addSuccessMessage("kachny"); + + return ret; + } + + @Override + public AlertSenderValidationResults validateAndFinalizeConfiguration(Subject subject) { + ++VALIDATE_METHOD_CALL_COUNT; + + if (EXPECTED_SUBJECT != null && !subject.equals(EXPECTED_SUBJECT)) { + throw new AssertionError("Unexpected subject. Expected " + EXPECTED_SUBJECT + " but was " + subject); + } + + if (VALIDATION_CHECKER != null) { + VALIDATION_CHECKER.run(); + } + + if (alertParameters.getSimple(EPHEMERAL_PROPERTY_NAME) == null) { + Assert.fail("Ephemeral property not present in alert parameters during validation. This should never happen."); + } + + if (extraParameters.getSimple(EPHEMERAL_PROPERTY_NAME) == null) { + Assert.fail("Ephemeral property not present in extra parameters during validation. This should never happen."); + } + + updateConfig(alertParameters); + updateConfig(extraParameters); + + return new AlertSenderValidationResults(alertParameters, extraParameters); + } + + private void updateConfig(Configuration configuration) { + String persistentValue = configuration.getSimpleValue(PERSISTENT_PROPERTY_NAME, ""); + String ephemeralValue = configuration.getSimpleValue(EPHEMERAL_PROPERTY_NAME, ""); + + configuration.put(new PropertySimple(PERSISTENT_PROPERTY_NAME, persistentValue + ephemeralValue)); + configuration.remove(EPHEMERAL_PROPERTY_NAME); + } +} diff --git a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/TestAlertSenderPluginService.java b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/TestAlertSenderPluginService.java new file mode 100644 index 0000000..9aae985 --- /dev/null +++ b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/alert/TestAlertSenderPluginService.java @@ -0,0 +1,67 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2012 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ + +package org.rhq.enterprise.server.alert; + +import java.util.Collections; +import java.util.List; + +import org.rhq.core.domain.plugin.ServerPlugin; +import org.rhq.enterprise.server.TestServerPluginService; +import org.rhq.enterprise.server.plugin.pc.AbstractTypeServerPluginContainer; +import org.rhq.enterprise.server.plugin.pc.MasterServerPluginContainer; +import org.rhq.enterprise.server.plugin.pc.ServerPluginEnvironment; +import org.rhq.enterprise.server.plugin.pc.ServerPluginManager; +import org.rhq.enterprise.server.plugin.pc.alert.AlertSenderPluginManager; +import org.rhq.enterprise.server.plugin.pc.alert.AlertServerPluginContainer; + +/** + * + * + * @author Lukas Krejci + */ +public class TestAlertSenderPluginService extends TestServerPluginService { + + @Override + protected List<AbstractTypeServerPluginContainer> createPluginContainers(MasterServerPluginContainer master) { + return Collections.<AbstractTypeServerPluginContainer>singletonList(new TestAlertServerPluginContainer(master)); + } + + class TestAlertServerPluginContainer extends AlertServerPluginContainer { + public TestAlertServerPluginContainer(MasterServerPluginContainer master) { + super(master); + } + + @Override + protected ServerPluginManager createPluginManager() { + return new TestAlertServerPluginManager(this); + } + } + + class TestAlertServerPluginManager extends AlertSenderPluginManager { + public TestAlertServerPluginManager(AlertServerPluginContainer pc) { + super(pc); + } + + @Override + protected ServerPlugin getPlugin(ServerPluginEnvironment env) { + return TestServerPluginService.getPlugin(env); + } + } +} diff --git a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginService.java b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginService.java index 64c6537..46d725f 100644 --- a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginService.java +++ b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginService.java @@ -19,81 +19,25 @@ package org.rhq.enterprise.server.drift; -import java.io.File; -import java.net.URL; -import java.util.ArrayList; -import java.util.HashMap; +import java.util.Collections; import java.util.List; -import java.util.Map; -import org.rhq.core.domain.configuration.Configuration; -import org.rhq.core.domain.configuration.definition.ConfigurationDefinition; -import org.rhq.core.domain.plugin.PluginKey; -import org.rhq.core.domain.plugin.PluginStatusType; import org.rhq.core.domain.plugin.ServerPlugin; -import org.rhq.core.util.MessageDigestGenerator; +import org.rhq.enterprise.server.TestServerPluginService; import org.rhq.enterprise.server.plugin.pc.AbstractTypeServerPluginContainer; import org.rhq.enterprise.server.plugin.pc.MasterServerPluginContainer; -import org.rhq.enterprise.server.plugin.pc.MasterServerPluginContainerConfiguration; import org.rhq.enterprise.server.plugin.pc.ServerPluginEnvironment; import org.rhq.enterprise.server.plugin.pc.ServerPluginManager; -import org.rhq.enterprise.server.plugin.pc.ServerPluginService; -import org.rhq.enterprise.server.plugin.pc.ServerPluginType; import org.rhq.enterprise.server.plugin.pc.drift.DriftServerPluginContainer; import org.rhq.enterprise.server.plugin.pc.drift.DriftServerPluginManager; -import org.rhq.enterprise.server.xmlschema.ServerPluginDescriptorMetadataParser; -import org.rhq.enterprise.server.xmlschema.generated.serverplugin.ServerPluginDescriptorType; -public class DriftServerPluginService extends ServerPluginService implements DriftServerPluginServiceMBean { - - public TestMasterServerPluginContainer master; - public MasterServerPluginContainerConfiguration masterConfig; - - public DriftServerPluginService() { - // build the config at constructor time so tests have it even before the PC is initialized - File dir = new File(System.getProperty("java.io.tmpdir"), "test-server-plugins"); - this.masterConfig = new MasterServerPluginContainerConfiguration(dir, dir, dir, null); - } +public class DriftServerPluginService extends TestServerPluginService { @Override - public MasterServerPluginContainer createMasterPluginContainer() { - this.master = new TestMasterServerPluginContainer(); - this.master.initialize(this.masterConfig); - return this.master; + protected List<AbstractTypeServerPluginContainer> createPluginContainers(MasterServerPluginContainer master) { + return Collections.<AbstractTypeServerPluginContainer>singletonList(new TestDriftServerPluginContainer(master)); } - class TestMasterServerPluginContainer extends MasterServerPluginContainer { - @Override - protected ClassLoader createRootServerPluginClassLoader() { - return getClass().getClassLoader(); - } - - @Override - protected Map<URL, ? extends ServerPluginDescriptorType> preloadAllPlugins() throws Exception { - // if our test never setup any plugins, ignore it and just return an empty map - File pluginDir = getConfiguration().getPluginDirectory(); - if (pluginDir == null || pluginDir.listFiles() == null || pluginDir.listFiles().length == 0) { - return new HashMap<URL, ServerPluginDescriptorType>(); - } else { - return super.preloadAllPlugins(); - } - } - - @Override - protected List<PluginKey> getDisabledPluginKeys() { - // in the real world, the db is checked for enable flag, here we say all plugins are enabled - return new ArrayList<PluginKey>(); - } - - @Override - protected List<AbstractTypeServerPluginContainer> createPluginContainers() { - ArrayList<AbstractTypeServerPluginContainer> pcs = new ArrayList<AbstractTypeServerPluginContainer>(1); - DriftServerPluginContainer driftPC = new TestDriftServerPluginContainer(this); - pcs.add(driftPC); - - return pcs; - } - } class TestDriftServerPluginContainer extends DriftServerPluginContainer { public TestDriftServerPluginContainer(MasterServerPluginContainer master) { @@ -101,9 +45,9 @@ public class DriftServerPluginService extends ServerPluginService implements Dri } @Override - protected ServerPluginManager createPluginManager() { - return new TestDriftServerPluginManager(this); - } + protected ServerPluginManager createPluginManager() { + return new TestDriftServerPluginManager(this); + } } class TestDriftServerPluginManager extends DriftServerPluginManager { @@ -113,34 +57,7 @@ public class DriftServerPluginService extends ServerPluginService implements Dri @Override protected ServerPlugin getPlugin(ServerPluginEnvironment env) { - try { - Configuration pluginConfig = null; - Configuration scheduledJobsConfig = null; - ConfigurationDefinition configDef; - - ServerPluginDescriptorType pluginDescriptor = env.getPluginDescriptor(); - - configDef = ServerPluginDescriptorMetadataParser.getPluginConfigurationDefinition(pluginDescriptor); - if (configDef != null) { - pluginConfig = configDef.getDefaultTemplate().createConfiguration(); - } - - configDef = ServerPluginDescriptorMetadataParser.getScheduledJobsDefinition(pluginDescriptor); - if (configDef != null) { - scheduledJobsConfig = configDef.getDefaultTemplate().createConfiguration(); - } - - File pluginFile = new File(env.getPluginUrl().toURI()); - ServerPlugin plugin = new ServerPlugin(0, env.getPluginKey().getPluginName(), pluginFile.getName(), - pluginDescriptor.getDisplayName(), true, PluginStatusType.INSTALLED, pluginDescriptor - .getDescription(), "", MessageDigestGenerator.getDigestString(pluginFile), pluginDescriptor - .getVersion(), pluginDescriptor.getVersion(), pluginConfig, scheduledJobsConfig, - new ServerPluginType(pluginDescriptor).stringify(), System.currentTimeMillis(), System - .currentTimeMillis()); - return plugin; - } catch (Exception e) { - throw new RuntimeException(e); - } + return TestServerPluginService.getPlugin(env); } - } + } } diff --git a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginServiceMBean.java b/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginServiceMBean.java deleted file mode 100644 index d38374e..0000000 --- a/modules/enterprise/server/itests/src/test/java/org/rhq/enterprise/server/drift/DriftServerPluginServiceMBean.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * RHQ Management Platform - * Copyright (C) 2011 Red Hat, Inc. - * All rights reserved. - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation version 2 of the License. - * - * This program 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 General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - -package org.rhq.enterprise.server.drift; - -import org.rhq.enterprise.server.plugin.pc.ServerPluginServiceManagement; - -public interface DriftServerPluginServiceMBean extends ServerPluginServiceManagement { -} diff --git a/modules/enterprise/server/itests/src/test/resources/log4j.xml b/modules/enterprise/server/itests/src/test/resources/log4j.xml index bc65329..ca0936f 100644 --- a/modules/enterprise/server/itests/src/test/resources/log4j.xml +++ b/modules/enterprise/server/itests/src/test/resources/log4j.xml @@ -17,7 +17,7 @@ <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="true"> <appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender"> - <errorHandler class="org.jboss.logging.util.OnlyOnceErrorHandler"/> +  <param name="Target" value="System.out"/> <param name="Threshold" value="WARN"/> @@ -64,7 +64,7 @@ <category name="org.hibernate.SQL"> <priority value="DEBUG"/> </category> - --> + --> <root> <appender-ref ref="CONSOLE"/> diff --git a/modules/enterprise/server/itests/src/test/resources/test-alert-sender-serverplugin.xml b/modules/enterprise/server/itests/src/test/resources/test-alert-sender-serverplugin.xml new file mode 100644 index 0000000..f6bf879 --- /dev/null +++ b/modules/enterprise/server/itests/src/test/resources/test-alert-sender-serverplugin.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<alert-plugin + name="alert-complex-test" + displayName="Alert:ComplexTest" + xmlns="urn:xmlns:rhq-serverplugin.alert" + xmlns:c="urn:xmlns:rhq-configuration" + xmlns:serverplugin="urn:xmlns:rhq-serverplugin" + package="org.rhq.enterprise.server.alert" + description="Alert sender plugin for testing the complex validation behavior." + > + +  + <short-name>Test Alert Sender</short-name> + +  + <plugin-class>TestAlertSender</plugin-class> + + <alert-configuration> + <c:simple-property name="persistent" type="string" required="true" description="The property that is persisted into the database."/> + <c:simple-property name="ephemeral" type="string" required="true" description="The property used only at creation/update time. It is not stored into the datbase because the plugin actually removes it from the configuration." /> + </alert-configuration> +</alert-plugin> \ No newline at end of file diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerBean.java index 927ae74..0b3ff87 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerBean.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerBean.java @@ -18,6 +18,9 @@ */ package org.rhq.enterprise.server.alert; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Iterator; import java.util.List; import javax.ejb.EJB; @@ -201,19 +204,19 @@ public class AlertDefinitionManagerBean implements AlertDefinitionManagerLocal, public int createDependentAlertDefinition(Subject subject, AlertDefinition alertDefinition, int resourceId) throws InvalidAlertDefinitionException { - return createAlertDefinitionInternal(subject, alertDefinition, resourceId, false); + return createAlertDefinitionInternal(subject, alertDefinition, resourceId, false, false); } @Override @TransactionAttribute(TransactionAttributeType.REQUIRES_NEW) - public int createAlertDefinition(Subject subject, AlertDefinition alertDefinition, Integer resourceId) + public int createAlertDefinition(Subject subject, AlertDefinition alertDefinition, Integer resourceId, boolean validateNotificationConfiguration) throws InvalidAlertDefinitionException { - return createAlertDefinitionInternal(subject, alertDefinition, resourceId, true); + return createAlertDefinitionInternal(subject, alertDefinition, resourceId, true, validateNotificationConfiguration); } - private int createAlertDefinitionInternal(Subject subject, AlertDefinition alertDefinition, Integer resourceId, boolean checkPerms) throws InvalidAlertDefinitionException { - checkAlertDefinition(subject, alertDefinition, resourceId); + private int createAlertDefinitionInternal(Subject subject, AlertDefinition alertDefinition, Integer resourceId, boolean checkPerms, boolean validateNotificationConfiguration) throws InvalidAlertDefinitionException { + checkAlertDefinition(subject, null, alertDefinition, resourceId, validateNotificationConfiguration); // if this is an alert definition, set up the link to a resource if (resourceId != null) { @@ -463,21 +466,34 @@ public class AlertDefinitionManagerBean implements AlertDefinitionManagerLocal, return list; } + @Override @TransactionAttribute(TransactionAttributeType.REQUIRES_NEW) public AlertDefinition updateAlertDefinition(Subject subject, int alertDefinitionId, AlertDefinition alertDefinition, boolean resetMatching) throws InvalidAlertDefinitionException, AlertDefinitionUpdateException { + return updateAlertDefinitionInternal(subject, alertDefinitionId, alertDefinition, resetMatching, true, true); + } + + @Override + @TransactionAttribute(TransactionAttributeType.REQUIRES_NEW) + public AlertDefinition updateDependentAlertDefinition(Subject subject, int alertDefinitionId, AlertDefinition alertDefinition, boolean resetMatching) throws InvalidAlertDefinitionException, AlertDefinitionUpdateException { + return updateAlertDefinitionInternal(subject, alertDefinitionId, alertDefinition, resetMatching, false, false); + } + + private AlertDefinition updateAlertDefinitionInternal(Subject subject, int alertDefinitionId, + AlertDefinition alertDefinition, boolean resetMatching, boolean checkPerms, boolean finalizeNotifications) throws InvalidAlertDefinitionException, + AlertDefinitionUpdateException { if (resetMatching) { alertDefinitionManager.purgeInternals(alertDefinitionId); } - + /* * Method for catching ENABLE / DISABLE changes will use switch logic off of the delta instead of calling out to * the enable/disable functions */ AlertDefinition oldAlertDefinition = entityManager.find(AlertDefinition.class, alertDefinitionId); - if (checkPermission(subject, oldAlertDefinition) == false) { + if (checkPerms && checkPermission(subject, oldAlertDefinition) == false) { if (oldAlertDefinition.getResourceType() != null) { throw new PermissionException("User [" + subject.getName() + "] does not have permission to modify alert templates for type [" @@ -498,8 +514,9 @@ public class AlertDefinitionManagerBean implements AlertDefinitionManagerLocal, * is not currently deleted */ boolean isResourceLevel = (oldAlertDefinition.getResource() != null); - checkAlertDefinition(subject, alertDefinition, isResourceLevel ? oldAlertDefinition.getResource().getId() - : null); + + checkAlertDefinition(subject, oldAlertDefinition, alertDefinition, isResourceLevel ? oldAlertDefinition.getResource().getId() + : null, finalizeNotifications); /* * Should not be able to update an alert definition if the old alert definition is in an invalid state @@ -590,6 +607,11 @@ public class AlertDefinitionManagerBean implements AlertDefinitionManagerLocal, * begin with, and nothing needs to be added to the cache as a result */ + //we've been touching both conditions and notifications of the updated alert definition, so we should + //return an object with the same... let's force lazy load before we leave the persistence context + new ArrayList<AlertCondition>(newAlertDefinition.getConditions()); + new ArrayList<AlertNotification>(newAlertDefinition.getAlertNotifications()); + return newAlertDefinition; } @@ -612,7 +634,7 @@ public class AlertDefinitionManagerBean implements AlertDefinitionManagerLocal, } } - private void checkAlertDefinition(Subject subject, AlertDefinition alertDefinition, Integer resourceId) + private void checkAlertDefinition(Subject subject, AlertDefinition persistedAlertDefinition, AlertDefinition alertDefinition, Integer resourceId, boolean finalizeNotifications) throws InvalidAlertDefinitionException { // if someone enters a really long description, we need to truncate it - the column is only 250 chars if (alertDefinition.getDescription() != null && alertDefinition.getDescription().length() > 250) { @@ -640,8 +662,38 @@ public class AlertDefinitionManagerBean implements AlertDefinitionManagerLocal, } } - if (!alertNotificationManager.finalizeNotifications(subject, alertDefinition.getAlertNotifications())) { - throw new InvalidAlertDefinitionException("Some of the notifications failed to validate."); + if (finalizeNotifications) { + List<AlertNotification> notifications = new ArrayList<AlertNotification>(alertDefinition.getAlertNotifications()); + + //now remove the notifications that have not changed + if (persistedAlertDefinition != null) { + List<AlertNotification> persistedNotifications = persistedAlertDefinition.getAlertNotifications() == null ? Collections.<AlertNotification>emptyList() : persistedAlertDefinition.getAlertNotifications(); + + if (persistedNotifications.size() > 0) { + Iterator<AlertNotification> it = notifications.iterator(); + while (it.hasNext()) { + AlertNotification newNotification = it.next(); + + if (newNotification.getId() == 0) { + //this is a fresh, not persisted notif. These guys have to be always finalized. + continue; + } + + for(AlertNotification persistedNotification : persistedNotifications) { + //ignore the ids on the notifications as they may vary if we are comparing parent alert def with its children + //it's enough for us they they are semantically the same. + if (newNotification.getSenderName().equals(persistedNotification.getSenderName()) && newNotification.equalsData(persistedNotification)) { + it.remove(); + break; + } + } + } + } + } + + if (!alertNotificationManager.finalizeNotifications(subject, notifications)) { + throw new InvalidAlertDefinitionException("Some of the notifications failed to validate."); + } } } diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerLocal.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerLocal.java index 81f0ac0..95dd3a7 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerLocal.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertDefinitionManagerLocal.java @@ -45,11 +45,29 @@ public interface AlertDefinitionManagerLocal { List<IntegerOptionItem> findAlertDefinitionOptionItemsForGroup(Subject subject, int groupId); - int createAlertDefinition(Subject subject, AlertDefinition alertDefinition, Integer resourceId) + /** + * Creates a new alert definition. Note that the suject is checked to have necessary authz, which might not + * be what you want in all use cases. See {@link #createDependentAlertDefinition(Subject, AlertDefinition, int)} + * for further discussion of this. + * + * @param subject the user creating the alert definition + * @param alertDefinition the new alert definition to persist + * @param resourceId the resource id for which the def is being created + * @param finalizeNotificationConfiguration if true, the configuration of the def's notifications is validated. + * This is NOT what you want if, for example, you are merely creating a copy of an existing definition. + * Some notifications might require more input when creating the notification than is then persisted in their configs + * (prominent example being the CLI alert sender). + * This would then cause the validation to fail every time you created a copy of a definition and tried + * to persist it. Note that passing false AND having new, unpersisted notifications in the alert definition can + * lead to invalid configuration being stored for the notifications. + * @return the id of the newly persisted alert definition + * @throws InvalidAlertDefinitionException + */ + int createAlertDefinition(Subject subject, AlertDefinition alertDefinition, Integer resourceId, boolean finalizeNotificationConfiguration) throws InvalidAlertDefinitionException; - + /** - * This is exactly the same as {@link #createAlertDefinition(Subject, AlertDefinition, Integer)} but + * This is exactly the same as {@link #createAlertDefinition(Subject, AlertDefinition, Integer, boolean)} but * assumes the resource is part of a group (or has given resource type for templates) for which * a group or template alert definition is being created. * @@ -93,6 +111,24 @@ public interface AlertDefinitionManagerLocal { AlertDefinition updateAlertDefinition(Subject subject, int alertDefinitionId, AlertDefinition alertDefinition, boolean resetMatching) throws InvalidAlertDefinitionException, AlertDefinitionUpdateException; + /** + * This method is similar in use-case to {@link #createDependentAlertDefinition(Subject, AlertDefinition, int)}. + * It assumes that the the update is part of some more complex operation (like updating alert definition on a group + * or a template) and that authz checks have already been performed. + * + * This method is therefore identical to {@link #updateAlertDefinition(Subject, int, AlertDefinition, boolean)} but + * does not perform any authorization checks. + * + * @param subject the user that is updating the alert definition + * @param alertDefinitionId + * @param alertDefinition + * @param resetMatching + * @return + * @throws InvalidAlertDefinitionException + * @throws AlertDefinitionUpdateException + */ + AlertDefinition updateDependentAlertDefinition(Subject subject, int alertDefinitionId, AlertDefinition alertDefinition, boolean resetMatching) throws InvalidAlertDefinitionException, AlertDefinitionUpdateException; + int purgeUnusedAlertDefinitions(); void purgeInternals(int alertDefinitionId); diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerBean.java index 14b1dfb..0e38bb8 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerBean.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerBean.java @@ -109,6 +109,7 @@ public class AlertNotificationManagerBean implements AlertNotificationManagerLoc /** * @throws AlertDefinitionUpdateException if the {@link AlertNotification} is not associated with a known sender */ + @Deprecated @TransactionAttribute(TransactionAttributeType.NOT_SUPPORTED) public AlertNotification addAlertNotification(Subject user, int alertDefinitionId, AlertNotification notification) throws AlertDefinitionUpdateException { @@ -123,11 +124,12 @@ public class AlertNotificationManagerBean implements AlertNotificationManagerLoc List<AlertNotification> notifications = definition.getAlertNotifications(); notifications.add(notification); - postProcessAlertDefinition(definition); + postProcessAlertDefinition(user, definition); return notification; } + @Deprecated @TransactionAttribute(TransactionAttributeType.NOT_SUPPORTED) public void updateAlertNotification(Subject subject, int alertDefinitionId, AlertNotification notification) { AlertDefinition alertDefinition = getDetachedAlertDefinition(alertDefinitionId); // permissions check first @@ -144,9 +146,10 @@ public class AlertNotificationManagerBean implements AlertNotificationManagerLoc notifications.add(notification); } - postProcessAlertDefinition(alertDefinition); + postProcessAlertDefinition(subject, alertDefinition); } + @Deprecated @TransactionAttribute(TransactionAttributeType.NOT_SUPPORTED) public int removeNotifications(Subject subject, Integer alertDefinitionId, Integer[] notificationIds) { AlertDefinition alertDefinition = getDetachedAlertDefinition(alertDefinitionId); // permissions check first @@ -168,7 +171,7 @@ public class AlertNotificationManagerBean implements AlertNotificationManagerLoc alertDefinition.getAlertNotifications().removeAll(toBeRemoved); - postProcessAlertDefinition(alertDefinition); + postProcessAlertDefinition(subject, alertDefinition); return removed; } @@ -178,16 +181,15 @@ public class AlertNotificationManagerBean implements AlertNotificationManagerLoc return purgeQuery.executeUpdate(); } - private AlertDefinition postProcessAlertDefinition(AlertDefinition definition) { + private AlertDefinition postProcessAlertDefinition(Subject subject, AlertDefinition definition) { AlertDefinition updated = null; AlertDefinitionContext context = definition.getContext(); - Subject overlord = subjectManager.getOverlord(); if (context == AlertDefinitionContext.Type) { - updated = alertTemplateManager.updateAlertTemplate(overlord, definition, true); + updated = alertTemplateManager.updateAlertTemplate(subject, definition, true); } else if (context == AlertDefinitionContext.Group) { - updated = groupAlertDefintionManager.updateGroupAlertDefinitions(overlord, definition, true); + updated = groupAlertDefintionManager.updateGroupAlertDefinitions(subject, definition, true); } else if (context == AlertDefinitionContext.Resource) { - updated = alertDefinitionManager.updateAlertDefinition(overlord, definition.getId(), definition, false); + updated = alertDefinitionManager.updateAlertDefinition(subject, definition.getId(), definition, false); } else { throw new IllegalStateException("No support for updating alert notifications for AlertDefinitionContext: " + definition.getContext()); diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerLocal.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerLocal.java index 56f8eab..3aa21cf 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerLocal.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertNotificationManagerLocal.java @@ -44,7 +44,9 @@ public interface AlertNotificationManagerLocal { * @param senderName shortName of the {@link AlertSender} * @param configuration Properties for this alert sender. * @throws AlertNotificationValidationException if the alert sender of the notification failed to finalize and validate the provided notification's configuration + * @deprecated this is used only by the legacy JSF UI and no longer works correctly */ + @Deprecated AlertNotification addAlertNotification(Subject user, int alertDefinitionId, AlertNotification notification) throws AlertDefinitionUpdateException, AlertNotificationValidationException; /** @@ -52,7 +54,9 @@ public interface AlertNotificationManagerLocal { * * @param notification * @throws AlertNotificationValidationException if the alert sender of the notification failed to finalize and validate the notification's configuration + * @deprecated this is used only by the legacy JSF UI and no longer works correctly */ + @Deprecated void updateAlertNotification(Subject subject, int alertDefinitionId, AlertNotification notification) throws AlertDefinitionUpdateException, AlertNotificationValidationException; /** @@ -61,7 +65,9 @@ public interface AlertNotificationManagerLocal { * @param alertDefinitionId alert definition to modify * @param notificationIds Notifications to remove * @return number of notifications removed + * @deprecated this is used only by the legacy JSF UI and no longer works correctly */ + @Deprecated int removeNotifications(Subject subject, Integer alertDefinitionId, Integer[] notificationIds); /** diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertTemplateManagerBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertTemplateManagerBean.java index cda1e0f..5b5c2ef 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertTemplateManagerBean.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/AlertTemplateManagerBean.java @@ -118,16 +118,20 @@ public class AlertTemplateManagerBean implements AlertTemplateManagerLocal { } ResourceType type = resourceTypeManager.getResourceTypeById(user, resourceTypeId); - + alertTemplate.setResourceType(type); // mark this as an alert "template" definition + int alertTemplateId = 0; try { - alertTemplateId = alertDefinitionManager.createAlertDefinition(user, alertTemplate, null); + alertTemplateId = alertDefinitionManager.createAlertDefinition(user, alertTemplate, null, true); } catch (Throwable t) { throw new AlertDefinitionCreationException("Could not create alertTemplate for " + type + " with data " + alertTemplate.toSimpleString(), t); } + //get the alert definition we just created.. this is so that we can create copies of it + AlertDefinition persistedAlertTemplate = alertDefinitionManager.getAlertDefinition(user, alertTemplateId); + Throwable firstThrowable = null; List<Integer> resourceIdsForType = getCommittedResourceIdsNeedingTemplateApplication(user, alertTemplateId, @@ -136,7 +140,7 @@ public class AlertTemplateManagerBean implements AlertTemplateManagerLocal { for (Integer resourceId : resourceIdsForType) { try { // construct the child - AlertDefinition childAlertDefinition = new AlertDefinition(alertTemplate); + AlertDefinition childAlertDefinition = new AlertDefinition(persistedAlertTemplate); childAlertDefinition.setParentId(alertTemplate.getId()); // persist the child as a dependent alert definition @@ -187,7 +191,7 @@ public class AlertTemplateManagerBean implements AlertTemplateManagerLocal { // persist the child, user is known to be overlord at this point for this system side-effect try { - alertDefinitionManager.createAlertDefinition(user, childAlertDefinition, resourceId); + alertDefinitionManager.createAlertDefinition(user, childAlertDefinition, resourceId, false); } catch (Throwable t) { throw new AlertDefinitionCreationException("Failed to create child AlertDefinition for Resource[id=" + resourceId + "] with template " + template.toSimpleString()); @@ -259,7 +263,7 @@ public class AlertTemplateManagerBean implements AlertTemplateManagerLocal { for (Integer alertDefinitionId : alertDefinitions) { try { alertDefinitionManager - .updateAlertDefinition(overlord, alertDefinitionId, alertTemplate, resetMatching); + .updateDependentAlertDefinition(user, alertDefinitionId, updated, resetMatching); } catch (Throwable t) { // continue on error, update as many as possible if (firstThrowable == null) { @@ -279,11 +283,11 @@ public class AlertTemplateManagerBean implements AlertTemplateManagerLocal { for (Integer resourceId : resourceIds) { try { // construct the child - AlertDefinition childAlertDefinition = new AlertDefinition(alertTemplate); + AlertDefinition childAlertDefinition = new AlertDefinition(updated); childAlertDefinition.setParentId(alertTemplate.getId()); // persist the child - alertDefinitionManager.createAlertDefinition(overlord, childAlertDefinition, resourceId); + alertDefinitionManager.createAlertDefinition(overlord, childAlertDefinition, resourceId, false); } catch (Throwable t) { // continue on error, update as many as possible if (firstThrowable == null) { diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/GroupAlertDefinitionManagerBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/GroupAlertDefinitionManagerBean.java index 6df9ae0..8cac89c 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/GroupAlertDefinitionManagerBean.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/alert/GroupAlertDefinitionManagerBean.java @@ -146,12 +146,15 @@ public class GroupAlertDefinitionManagerBean implements GroupAlertDefinitionMana int groupAlertDefinitionId = 0; try { - groupAlertDefinitionId = alertDefinitionManager.createAlertDefinition(subject, groupAlertDefinition, null); + groupAlertDefinitionId = alertDefinitionManager.createAlertDefinition(subject, groupAlertDefinition, null, true); } catch (Throwable t) { throw new AlertDefinitionCreationException("Could not create groupAlertDefinitions for " + group + " with data " + groupAlertDefinition.toSimpleString(), t); } + //get the alert definition we just created.. this is so that we can create copies of it + AlertDefinition persistedDefinition = alertDefinitionManager.getAlertDefinition(subject, groupAlertDefinitionId); + Throwable firstThrowable = null; List<Integer> resourceIdsForGroup = getCommittedResourceIdsNeedingGroupAlertDefinitionApplication(subject, @@ -160,7 +163,7 @@ public class GroupAlertDefinitionManagerBean implements GroupAlertDefinitionMana for (Integer resourceId : resourceIdsForGroup) { try { // construct the child - AlertDefinition childAlertDefinition = new AlertDefinition(groupAlertDefinition); + AlertDefinition childAlertDefinition = new AlertDefinition(persistedDefinition); childAlertDefinition.setGroupAlertDefinition(groupAlertDefinition); // persist the child @@ -241,9 +244,10 @@ public class GroupAlertDefinitionManagerBean implements GroupAlertDefinitionMana LOG.debug("Need to update the following children alert definition ids: " + alertDefinitions); } List<Integer> alertDefinitionIdsInError = new ArrayList<Integer>(); + for (Integer alertDefinitionId : alertDefinitions) { try { - alertDefinitionManager.updateAlertDefinition(overlord, alertDefinitionId, groupAlertDefinition, + alertDefinitionManager.updateDependentAlertDefinition(subject, alertDefinitionId, updated, resetMatching); } catch (Throwable t) { // continue on error, update as many as possible @@ -261,11 +265,11 @@ public class GroupAlertDefinitionManagerBean implements GroupAlertDefinitionMana for (Integer resourceId : resourceIds) { try { // construct the child - AlertDefinition childAlertDefinition = new AlertDefinition(groupAlertDefinition); + AlertDefinition childAlertDefinition = new AlertDefinition(updated); childAlertDefinition.setGroupAlertDefinition(groupAlertDefinition); // persist the child - alertDefinitionManager.createAlertDefinition(overlord, childAlertDefinition, resourceId); + alertDefinitionManager.createAlertDefinition(subject, childAlertDefinition, resourceId, false); } catch (Throwable t) { // continue on error, update as many as possible if (firstThrowable == null) { @@ -308,7 +312,7 @@ public class GroupAlertDefinitionManagerBean implements GroupAlertDefinitionMana childAlertDefinition.setGroupAlertDefinition(groupAlertDefinition); // persist the child - alertDefinitionManager.createAlertDefinition(overlord, childAlertDefinition, resourceId); + alertDefinitionManager.createAlertDefinition(overlord, childAlertDefinition, resourceId, false); } catch (Throwable t) { // continue on error, create as many as possible if (firstThrowable == null) { diff --git a/modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/alert/test/AlertConditionTest.java b/modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/alert/test/AlertConditionTest.java index 47ba274..5116a90 100644 --- a/modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/alert/test/AlertConditionTest.java +++ b/modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/alert/test/AlertConditionTest.java @@ -479,7 +479,7 @@ public class AlertConditionTest extends UpdatePluginMetadataTestBase { alertDefinition.setConditions(conditions); AlertDefinitionManagerLocal alertDefManager = LookupUtil.getAlertDefinitionManager(); - int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId); + int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId, true); alertDefinition = alertDefManager.getAlertDefinition(getOverlord(), defId); // load it back so we get its ID and all condition IDs assert alertDefinition != null && alertDefinition.getId() > 0 : "did not persist alert def properly: " + alertDefinition; @@ -513,7 +513,7 @@ public class AlertConditionTest extends UpdatePluginMetadataTestBase { alertDefinition.setConditions(conditions); AlertDefinitionManagerLocal alertDefManager = LookupUtil.getAlertDefinitionManager(); - int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId); + int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId, true); alertDefinition = alertDefManager.getAlertDefinition(getOverlord(), defId); // load it back so we get its ID and all condition IDs assert alertDefinition != null && alertDefinition.getId() > 0 : "did not persist alert def properly: " + alertDefinition; @@ -546,7 +546,7 @@ public class AlertConditionTest extends UpdatePluginMetadataTestBase { alertDefinition.setConditions(conditions); AlertDefinitionManagerLocal alertDefManager = LookupUtil.getAlertDefinitionManager(); - int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId); + int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId, true); alertDefinition = alertDefManager.getAlertDefinition(getOverlord(), defId); // load it back so we get its ID and all condition IDs assert alertDefinition != null && alertDefinition.getId() > 0 : "did not persist alert def properly: " + alertDefinition; @@ -579,7 +579,7 @@ public class AlertConditionTest extends UpdatePluginMetadataTestBase { alertDefinition.setConditions(conditions); AlertDefinitionManagerLocal alertDefManager = LookupUtil.getAlertDefinitionManager(); - int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId); + int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId, true); alertDefinition = alertDefManager.getAlertDefinition(getOverlord(), defId); // load it back so we get its ID and all condition IDs assert alertDefinition != null && alertDefinition.getId() > 0 : "did not persist alert def properly: " + alertDefinition; @@ -613,7 +613,7 @@ public class AlertConditionTest extends UpdatePluginMetadataTestBase { alertDefinition.setConditions(conditions); AlertDefinitionManagerLocal alertDefManager = LookupUtil.getAlertDefinitionManager(); - int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId); + int defId = alertDefManager.createAlertDefinition(getOverlord(), alertDefinition, resourceId, true); alertDefinition = alertDefManager.getAlertDefinition(getOverlord(), defId); // load it back so we get its ID and all condition IDs assert alertDefinition != null && alertDefinition.getId() > 0 : "did not persist alert def properly: " + alertDefinition; diff --git a/modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/performance/test/AvailabilityInsertPurgeTest.java b/modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/performance/test/AvailabilityInsertPurgeTest.java index 825fdee..4b9dea2 100644 --- a/modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/performance/test/AvailabilityInsertPurgeTest.java +++ b/modules/enterprise/server/jar/src/test/java/org/rhq/enterprise/server/performance/test/AvailabilityInsertPurgeTest.java @@ -355,7 +355,7 @@ public class AvailabilityInsertPurgeTest extends AbstractEJB3PerformanceTest { def.setPriority(AlertPriority.MEDIUM); def.setAlertDampening(new AlertDampening(AlertDampening.Category.NONE)); def.setRecoveryId(0); - alertDefinitionManager.createAlertDefinition(overlord, def, res.getId()); + alertDefinitionManager.createAlertDefinition(overlord, def, res.getId(), true); for (int MULTI : ROUNDS) { String round = String.format(ROUND__FORMAT, MULTI);

1 0

[rhq] Branch 'jsanda/cassandra-plugin' - modules/plugins
by John Sanda 13 Sep '12

13 Sep '12

modules/plugins/cassandra/pom.xml | 9 - modules/plugins/cassandra/src/main/java/org/rhq/plugins/cassandra/ColumnFamilyComponent.java | 34 ++++ modules/plugins/cassandra/src/main/java/org/rhq/plugins/cassandra/ColumnFamilyDiscoveryComponent.java | 77 ++++++++++ modules/plugins/cassandra/src/main/resources/META-INF/rhq-plugin.xml | 11 + 4 files changed, 129 insertions(+), 2 deletions(-) New commits: commit f37a5b2b0648fc9ed3fbde9a8185dedf8bc4b23d Author: John Sanda <jsanda(a)redhat.com> Date: Thu Sep 13 01:13:10 2012 -0400 Adding initial support for ColumnFamily resource type Cassandra's JMX API does not expose an attribute or operation for retrieving column families; so, with this commit I discover column families using Hector. The JMX API does expose an attribute to obtain a list of keyspaces, but I am unaware of any attributes or operations to get a list of column families. This commit just handles discovery and setting the objectName plugin config property of the column family resource component. diff --git a/modules/plugins/cassandra/pom.xml b/modules/plugins/cassandra/pom.xml index c03d0dd..945c367 100644 --- a/modules/plugins/cassandra/pom.xml +++ b/modules/plugins/cassandra/pom.xml @@ -53,7 +53,7 @@ <dependency> <groupId>org.apache.cassandra</groupId> <artifactId>cassandra-all</artifactId> - <version>1.1.4</version> + <version>1.1.5</version> </dependency> <dependency> <groupId>org.apache.thrift</groupId> @@ -101,7 +101,7 @@ <artifactItem> <groupId>org.apache.cassandra</groupId> <artifactId>cassandra-thrift</artifactId> - <version>1.0.9</version> + <version>1.1.5</version> </artifactItem> <artifactItem> <groupId>com.google.guava</groupId> @@ -114,6 +114,11 @@ <version>1.6</version> </artifactItem> <artifactItem> + <groupId>commons-lang</groupId> + <artifactId>commons-lang</artifactId> + <version>2.3</version> + </artifactItem> + <artifactItem> <groupId>com.github.stephenc.eaio-uuid</groupId> <artifactId>uuid</artifactId> <version>3.2.0</version> diff --git a/modules/plugins/cassandra/src/main/java/org/rhq/plugins/cassandra/ColumnFamilyComponent.java b/modules/plugins/cassandra/src/main/java/org/rhq/plugins/cassandra/ColumnFamilyComponent.java new file mode 100644 index 0000000..3ec51bf --- /dev/null +++ b/modules/plugins/cassandra/src/main/java/org/rhq/plugins/cassandra/ColumnFamilyComponent.java @@ -0,0 +1,34 @@ +/* + * + * * RHQ Management Platform + * * Copyright (C) 2005-2012 Red Hat, Inc. + * * All rights reserved. + * * + * * This program is free software; you can redistribute it and/or modify + * * it under the terms of the GNU General Public License, version 2, as + * * published by the Free Software Foundation, and/or the GNU Lesser + * * General Public License, version 2.1, also as published by the Free + * * Software Foundation. + * * + * * This program 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 General Public License and the GNU Lesser General Public License + * * for more details. + * * + * * You should have received a copy of the GNU General Public License + * * and the GNU Lesser General Public License along with this program; + * * if not, write to the Free Software Foundation, Inc., + * * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + +package org.rhq.plugins.cassandra; + +import org.rhq.plugins.jmx.MBeanResourceComponent; + +/** + * @author John Sanda + */ +public class ColumnFamilyComponent extends MBeanResourceComponent { +} diff --git a/modules/plugins/cassandra/src/main/java/org/rhq/plugins/cassandra/ColumnFamilyDiscoveryComponent.java b/modules/plugins/cassandra/src/main/java/org/rhq/plugins/cassandra/ColumnFamilyDiscoveryComponent.java new file mode 100644 index 0000000..67196c8 --- /dev/null +++ b/modules/plugins/cassandra/src/main/java/org/rhq/plugins/cassandra/ColumnFamilyDiscoveryComponent.java @@ -0,0 +1,77 @@ +/* + * + * * RHQ Management Platform + * * Copyright (C) 2005-2012 Red Hat, Inc. + * * All rights reserved. + * * + * * This program is free software; you can redistribute it and/or modify + * * it under the terms of the GNU General Public License, version 2, as + * * published by the Free Software Foundation, and/or the GNU Lesser + * * General Public License, version 2.1, also as published by the Free + * * Software Foundation. + * * + * * This program 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 General Public License and the GNU Lesser General Public License + * * for more details. + * * + * * You should have received a copy of the GNU General Public License + * * and the GNU Lesser General Public License along with this program; + * * if not, write to the Free Software Foundation, Inc., + * * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ + +package org.rhq.plugins.cassandra; + +import java.util.HashSet; +import java.util.Set; + +import org.mc4j.ems.connection.EmsConnection; +import org.mc4j.ems.connection.bean.EmsBean; +import org.mc4j.ems.connection.bean.attribute.EmsAttribute; + +import org.rhq.core.domain.configuration.Configuration; +import org.rhq.core.domain.configuration.PropertySimple; +import org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails; +import org.rhq.core.pluginapi.inventory.ResourceDiscoveryComponent; +import org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext; + +import me.prettyprint.hector.api.Cluster; +import me.prettyprint.hector.api.ddl.ColumnFamilyDefinition; +import me.prettyprint.hector.api.ddl.KeyspaceDefinition; +import me.prettyprint.hector.api.factory.HFactory; + +/** + * @author John Sanda + */ +public class ColumnFamilyDiscoveryComponent implements ResourceDiscoveryComponent { + + @Override + public Set<DiscoveredResourceDetails> discoverResources(ResourceDiscoveryContext context) throws Exception { + CassandraNodeComponent parent = (CassandraNodeComponent) context.getParentResourceComponent(); + EmsConnection emsConnection = parent.getEmsConnection(); + EmsBean emsBean = emsConnection.getBean("org.apache.cassandra.db:type=StorageService"); + + EmsAttribute attribute = emsBean.getAttribute("keyspaces"); + + Cluster cluster = HFactory.getOrCreateCluster("rhq", "localhost:9160"); + Set<DiscoveredResourceDetails> details = new HashSet<DiscoveredResourceDetails>(); + + for (KeyspaceDefinition keyspaceDef : cluster.describeKeyspaces()) { + for (ColumnFamilyDefinition columnFamilyDef : keyspaceDef.getCfDefs()) { + String resourceKey = keyspaceDef.getName() + "." + columnFamilyDef.getName(); + Configuration pluginConfig = new Configuration(); + // org.apache.cassandra.db:type=ColumnFamilies,keyspace=test,columnfamily=users + pluginConfig.put(new PropertySimple("objectName", + "org.apache.cassandra.db:type=ColumnFamilies,keyspace=" + keyspaceDef.getName() + + ",columnfamily=" + columnFamilyDef.getName())); + details.add(new DiscoveredResourceDetails(context.getResourceType(), resourceKey, + columnFamilyDef.getName(), null, null, pluginConfig, null)); + } + } + + return details; + } +} diff --git a/modules/plugins/cassandra/src/main/resources/META-INF/rhq-plugin.xml b/modules/plugins/cassandra/src/main/resources/META-INF/rhq-plugin.xml index 9816f57..0abed08 100644 --- a/modules/plugins/cassandra/src/main/resources/META-INF/rhq-plugin.xml +++ b/modules/plugins/cassandra/src/main/resources/META-INF/rhq-plugin.xml @@ -80,5 +80,16 @@ </parameters> </operation> </service> + + <service name="ColumnFamily" + discovery="org.rhq.plugins.cassandra.ColumnFamilyDiscoveryComponent" + class="org.rhq.plugins.cassandra.ColumnFamilyComponent"> + <plugin-configuration> + <c:simple-property name="objectName" readOnly="true"/> + </plugin-configuration> +  +  +  + </service> </server> </plugin> \ No newline at end of file

1 0

[rhq] Changes to 'jsanda/cassandra-plugin'
by John Sanda 13 Sep '12

13 Sep '12

New branch 'jsanda/cassandra-plugin' available with the following commits: commit 90b3fb5bb23c9e54e162bab725fc8428bbbbb92a Author: John Sanda <jsanda(a)redhat.com> Date: Wed Sep 12 21:34:02 2012 -0400 Add some docs around what versions of cassandra are currently supported. commit 6a5a4ca3d35b211006c42d1f45c7b77ced4ced6b Author: John Sanda <jsanda(a)redhat.com> Date: Wed Sep 12 17:27:37 2012 -0400 Adding operation taking snapshot of an entire keyspace Snapshots are the way to perform point in time backups. A snapshot creates a full copy of the data. Data files are not actually copied. Cassandra instead uses hard links. commit cf2e14b3e25b1a0870d73929eebf64e9da0ca603 Author: John Sanda <jsanda(a)redhat.com> Date: Tue Sep 11 17:06:49 2012 -0400 Initial commit for Cassandra plugin This commit adds some basic support for discovery for CassandraDaemon, StorageProxy, and StorageService. I have also started adding in some configuration properties and operations. Most of the work is delegated to the JMX plugin.

1 0

[rhq] Branch 'rhq-on-as7' - modules/enterprise
by mazz 13 Sep '12

13 Sep '12

modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/ShutdownListener.java | 144 --------- modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java | 146 ++++++++++ modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java | 96 ++++-- modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/comm/ServerCommunicationsServiceUtil.java | 7 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/scheduler/SchedulerBean.java | 5 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/system/SystemManagerBean.java | 4 modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java | 2 7 files changed, 214 insertions(+), 190 deletions(-) New commits: commit 5dc0fa0c88c016ad391e0431b1d1bfcaceb54d3f Author: John Mazzitelli <mazz(a)redhat.com> Date: Wed Sep 12 18:03:54 2012 -0400 * add dependencies on the startup bean to the EJBs it needs. * make mbean server lookups get the platform mbean server * add the shutdown listener as a predestroy method on a singleton EJB diff --git a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/ShutdownListener.java b/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/ShutdownListener.java deleted file mode 100644 index 569b8b8..0000000 --- a/modules/enterprise/gui/portal-war/src/main/java/org/rhq/enterprise/gui/startup/ShutdownListener.java +++ /dev/null @@ -1,144 +0,0 @@ -/* - * RHQ Management Platform - * Copyright (C) 2005-2008 Red Hat, Inc. - * All rights reserved. - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation version 2 of the License. - * - * This program 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 General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ -package org.rhq.enterprise.gui.startup; - -import java.sql.Connection; -import java.sql.SQLException; -import java.sql.Statement; - -import javax.management.Notification; -import javax.management.NotificationListener; -import javax.sql.DataSource; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; - -import org.rhq.core.domain.cloud.Server; -import org.rhq.core.domain.cloud.Server.OperationMode; -import org.rhq.core.util.jdbc.JDBCUtil; -import org.rhq.enterprise.server.util.LookupUtil; - -/** - * This listens for the RHQ server's shutdown notification and when it hears it, will start shutting down RHQ components - * that need to clean up. - * - * @author John Mazzitelli - * @author Jay Shaughnessy - * @author Joseph Marques - */ -public class ShutdownListener implements NotificationListener { - /** - * Logger - */ - private final Log log = LogFactory.getLog(ShutdownListener.class); - - private final String RHQ_DB_TYPE_MAPPING_PROPERTY = "rhq.server.database.type-mapping"; - - /** - * This is called when the shutdown notification is received from the JBoss server. This gives a chance for us to - * cleanly shutdown our application in an orderly fashion. - * - * @see javax.management.NotificationListener#handleNotification(Notification, Object) - */ - public void handleNotification(Notification notification, Object handback) { - // TODO: JBossAS 4.2.3 used to send us this JMX notification on shutdown - how does AS7 provide this notification? - if (false) { - stopScheduler(); - - updateServerOperationMode(); - - stopEmbeddedDatabase(); - } - } - - /** - * This will shutdown the scheduler. - */ - private void stopScheduler() { - try { - log.info("Shutting down the scheduler gracefully - currently running jobs will be allowed to finish..."); - LookupUtil.getSchedulerBean().shutdown(true); - log.info("The scheduler has been shutdown and all jobs are done."); - } catch (Throwable t) { - // only show ugly stack traces if the user runs the server in debug mode - if (log.isDebugEnabled()) { - log.warn("Failed to shutdown the scheduler", t); - } else { - log.warn("Failed to shutdown the scheduler: " + t.getMessage()); - } - } - } - - private void updateServerOperationMode() { - try { - // Set the server operation mode to DOWN unless in MM - Server server = LookupUtil.getServerManager().getServer(); - if (Server.OperationMode.MAINTENANCE != server.getOperationMode()) { - LookupUtil.getCloudManager().updateServerMode(new Integer[] { server.getId() }, OperationMode.DOWN); - } - } catch (Throwable t) { - // only show ugly stack traces if the user runs the server in debug mode - if (log.isDebugEnabled()) { - log.warn("Could not update this server's OperationMode to DOWN in the database", t); - } else { - log.warn("Could not update this server's OperationMode to DOWN in the database: " + t.getMessage()); - } - } - } - - private void stopEmbeddedDatabase() { - if (!isEmbedded()) { - // only perform shutdown actions if we ABSOLUTELY know for sure this is the embedded database - return; - } - - Connection connection = null; - Statement statement = null; - try { - DataSource ds = LookupUtil.getDataSource(); - connection = ds.getConnection(); - statement = connection.createStatement(); - statement.execute("shutdown"); - log.info("Embedded database closed cleanly"); - } catch (SQLException sqle) { - if (sqle.getMessage().toLowerCase().indexOf("database is already closed") != -1) { - log.warn("Database is already shut down, can not perform graceful service shutdown"); - return; - } else { - // only show ugly stack traces if the user runs the server in debug mode - if (log.isDebugEnabled()) { - log.warn("Could not shut down the embedded database cleanly", sqle); - } else { - log.warn("Could not shut down the embedded database cleanly: " + sqle.getMessage()); - } - } - } finally { - JDBCUtil.safeClose(connection, statement, null); - } - } - - private boolean isEmbedded() { - String identity = System.getProperty(RHQ_DB_TYPE_MAPPING_PROPERTY, ""); - if (identity.equals("")) { - log.error("Could not determine datatype base; is the " + RHQ_DB_TYPE_MAPPING_PROPERTY - + " property set in rhq-server.properties?"); - } - return identity.toLowerCase().indexOf("h2") != -1; - } -} \ No newline at end of file diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java new file mode 100644 index 0000000..5194fb6 --- /dev/null +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/ShutdownListener.java @@ -0,0 +1,146 @@ +/* + * RHQ Management Platform + * Copyright (C) 2005-2008 Red Hat, Inc. + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation version 2 of the License. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + */ +package org.rhq.enterprise.server.core; + +import java.sql.Connection; +import java.sql.SQLException; +import java.sql.Statement; + +import javax.annotation.PreDestroy; +import javax.ejb.Singleton; +import javax.ejb.Startup; +import javax.management.Notification; +import javax.sql.DataSource; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import org.rhq.core.domain.cloud.Server; +import org.rhq.core.domain.cloud.Server.OperationMode; +import org.rhq.core.util.jdbc.JDBCUtil; +import org.rhq.enterprise.server.util.LookupUtil; + +/** + * This listens for the RHQ server's shutdown notification and when it hears it, will start shutting down RHQ components + * that need to clean up. + * + * @author John Mazzitelli + * @author Jay Shaughnessy + * @author Joseph Marques + */ +@Singleton +@Startup +public class ShutdownListener { + /** + * Logger + */ + private final Log log = LogFactory.getLog(ShutdownListener.class); + + private final String RHQ_DB_TYPE_MAPPING_PROPERTY = "rhq.server.database.type-mapping"; + + /** + * This is called when the shutdown notification is received from the JBoss server. This gives a chance for us to + * cleanly shutdown our application in an orderly fashion. + * + * @see javax.management.NotificationListener#handleNotification(Notification, Object) + */ + @PreDestroy + public void handleNotification(Notification notification, Object handback) { + // JBossAS 4.2.3 used to send us this JMX notification on shutdown - AS7 does not have shutdown notifications. + // So we are using the @PreDestroy mechanism on a singleton EJB to attempt to clean up the application before it is shutdown + stopScheduler(); + updateServerOperationMode(); + stopEmbeddedDatabase(); + } + + /** + * This will shutdown the scheduler. + */ + private void stopScheduler() { + try { + log.info("Shutting down the scheduler gracefully - currently running jobs will be allowed to finish..."); + LookupUtil.getSchedulerBean().shutdown(true); + log.info("The scheduler has been shutdown and all jobs are done."); + } catch (Throwable t) { + // only show ugly stack traces if the user runs the server in debug mode + if (log.isDebugEnabled()) { + log.warn("Failed to shutdown the scheduler", t); + } else { + log.warn("Failed to shutdown the scheduler: " + t.getMessage()); + } + } + } + + private void updateServerOperationMode() { + try { + // Set the server operation mode to DOWN unless in MM + Server server = LookupUtil.getServerManager().getServer(); + if (Server.OperationMode.MAINTENANCE != server.getOperationMode()) { + LookupUtil.getCloudManager().updateServerMode(new Integer[] { server.getId() }, OperationMode.DOWN); + } + } catch (Throwable t) { + // only show ugly stack traces if the user runs the server in debug mode + if (log.isDebugEnabled()) { + log.warn("Could not update this server's OperationMode to DOWN in the database", t); + } else { + log.warn("Could not update this server's OperationMode to DOWN in the database: " + t.getMessage()); + } + } + } + + private void stopEmbeddedDatabase() { + if (!isEmbedded()) { + // only perform shutdown actions if we ABSOLUTELY know for sure this is the embedded database + return; + } + + Connection connection = null; + Statement statement = null; + try { + DataSource ds = LookupUtil.getDataSource(); + connection = ds.getConnection(); + statement = connection.createStatement(); + statement.execute("shutdown"); + log.info("Embedded database closed cleanly"); + } catch (SQLException sqle) { + if (sqle.getMessage().toLowerCase().indexOf("database is already closed") != -1) { + log.warn("Database is already shut down, can not perform graceful service shutdown"); + return; + } else { + // only show ugly stack traces if the user runs the server in debug mode + if (log.isDebugEnabled()) { + log.warn("Could not shut down the embedded database cleanly", sqle); + } else { + log.warn("Could not shut down the embedded database cleanly: " + sqle.getMessage()); + } + } + } finally { + JDBCUtil.safeClose(connection, statement, null); + } + } + + private boolean isEmbedded() { + String identity = System.getProperty(RHQ_DB_TYPE_MAPPING_PROPERTY, ""); + if (identity.equals("")) { + log.error("Could not determine datatype base; is the " + RHQ_DB_TYPE_MAPPING_PROPERTY + + " property set in rhq-server.properties?"); + } + return identity.toLowerCase().indexOf("h2") != -1; + } +} \ No newline at end of file diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java index 13f1143..c5b0823 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/StartupBean.java @@ -27,6 +27,7 @@ import java.util.List; import java.util.Properties; import javax.annotation.PostConstruct; +import javax.ejb.EJB; import javax.ejb.Singleton; import javax.ejb.Startup; import javax.management.Attribute; @@ -39,8 +40,6 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.quartz.SchedulerException; -import org.jboss.mx.util.MBeanServerLocator; - import org.rhq.core.db.DatabaseTypeFactory; import org.rhq.core.domain.auth.Subject; import org.rhq.core.domain.cloud.Server; @@ -52,7 +51,10 @@ import org.rhq.enterprise.communications.ServiceContainerConfigurationConstants; import org.rhq.enterprise.communications.util.SecurityUtil; import org.rhq.enterprise.server.alert.engine.internal.AlertConditionCacheCoordinator; import org.rhq.enterprise.server.auth.SessionManager; +import org.rhq.enterprise.server.auth.SubjectManagerLocal; import org.rhq.enterprise.server.auth.prefs.SubjectPreferencesCache; +import org.rhq.enterprise.server.cloud.CloudManagerLocal; +import org.rhq.enterprise.server.cloud.instance.CacheConsistencyManagerLocal; import org.rhq.enterprise.server.cloud.instance.ServerManagerLocal; import org.rhq.enterprise.server.cloud.instance.SyncEndpointAddressException; import org.rhq.enterprise.server.core.comm.ServerCommunicationsServiceUtil; @@ -73,6 +75,7 @@ import org.rhq.enterprise.server.scheduler.jobs.DynaGroupAutoRecalculationJob; import org.rhq.enterprise.server.scheduler.jobs.PurgePluginsJob; import org.rhq.enterprise.server.scheduler.jobs.PurgeResourceTypesJob; import org.rhq.enterprise.server.scheduler.jobs.SavedSearchResultCountRecalculationJob; +import org.rhq.enterprise.server.system.SystemManagerLocal; import org.rhq.enterprise.server.util.LookupUtil; import org.rhq.enterprise.server.util.concurrent.AlertSerializer; import org.rhq.enterprise.server.util.concurrent.AvailabilityReportSerializer; @@ -89,6 +92,30 @@ public class StartupBean { private boolean initialized = false; + @EJB + private SystemManagerLocal systemManager; + + @EJB + private ServerManagerLocal serverManager; + + @EJB + private CloudManagerLocal cloudManager; + + @EJB + private ResourceTypeManagerLocal resourceTypeManager; + + @EJB + private SchedulerLocal schedulerBean; + + @EJB + private CacheConsistencyManagerLocal cacheConsistencyManager; + + @EJB + private AgentManagerLocal agentManager; + + @EJB + private SubjectManagerLocal subjectManager; + /** * Performs the final RHQ Server initialization work that needs to talk place. EJBs are available in this method. * @@ -101,7 +128,7 @@ public class StartupBean { log.info("All business tier deployments are complete - finishing the startup..."); // As a security measure, make sure the installer has been undeployed - LookupUtil.getSystemManager().undeployInstaller(); + systemManager.undeployInstaller(); // get singletons right now so we load the classes immediately into our classloader AlertConditionCacheCoordinator.getInstance(); @@ -112,8 +139,7 @@ public class StartupBean { // load resource facets cache try { - ResourceTypeManagerLocal typeManager = LookupUtil.getResourceTypeManager(); - typeManager.reloadResourceFacetsCache(); + resourceTypeManager.reloadResourceFacetsCache(); } catch (Throwable t) { log.error("Could not load ResourceFacets cache.", t); } @@ -171,14 +197,12 @@ public class StartupBean { // Ensure that this server is registered in the database. createDefaultServerIfNecessary(); - ServerManagerLocal serverManager = LookupUtil.getServerManager(); - // immediately put the server into MM if configured to do so if (ServerCommunicationsServiceUtil.getService().getMaintenanceModeAtStartup()) { log.info("Server is configured to start up in MAINTENANCE mode."); Server server = serverManager.getServer(); Integer[] serverId = new Integer[] { server.getId() }; - LookupUtil.getCloudManager().updateServerMode(serverId, OperationMode.MAINTENANCE); + cloudManager.updateServerMode(serverId, OperationMode.MAINTENANCE); } // Establish the current server mode for the server. This will move the server to NORMAL @@ -202,8 +226,8 @@ public class StartupBean { * in the {@link Server} table */ private void createDefaultServerIfNecessary() { - String identity = LookupUtil.getServerManager().getIdentity(); - Server server = LookupUtil.getCloudManager().getServerByName(identity); + String identity = serverManager.getIdentity(); + Server server = cloudManager.getServerByName(identity); if (server == null) { server = new Server(); server.setName(identity); @@ -219,7 +243,7 @@ public class StartupBean { server.setSecurePort(7443); server.setComputePower(1); server.setOperationMode(Server.OperationMode.INSTALLED); - LookupUtil.getServerManager().create(server); + serverManager.create(server); log.info("Default HA server created: " + server); } } @@ -232,7 +256,7 @@ public class StartupBean { private void startHibernateStatistics() throws RuntimeException { log.info("Starting hibernate statistics monitoring..."); try { - LookupUtil.getSystemManager().enableHibernateStatistics(); + systemManager.enableHibernateStatistics(); } catch (Exception e) { throw new RuntimeException("Cannot start hibernate statistics monitoring!", e); } @@ -293,7 +317,7 @@ public class StartupBean { log.info("Initializing the scheduler...."); try { - LookupUtil.getSchedulerBean().initQuartzScheduler(); + schedulerBean.initQuartzScheduler(); } catch (SchedulerException e) { throw new RuntimeException("Cannot initialize the scheduler!", e); } @@ -309,7 +333,7 @@ public class StartupBean { log.info("Starting the scheduler..."); try { - LookupUtil.getSchedulerBean().startQuartzScheduler(); + schedulerBean.startQuartzScheduler(); } catch (SchedulerException e) { throw new RuntimeException("Cannot start the scheduler!", e); } @@ -371,19 +395,17 @@ public class StartupBean { * non-volatile; */ - SchedulerLocal scheduler = LookupUtil.getSchedulerBean(); - // TODO [mazz]: make all of the intervals here configurable via something like SystemManagerBean - LookupUtil.getServerManager().scheduleServerHeartbeat(); - LookupUtil.getCacheConsistenyManager().scheduleServerCacheReloader(); - LookupUtil.getSystemManager().scheduleConfigCacheReloader(); + serverManager.scheduleServerHeartbeat(); + cacheConsistencyManager.scheduleServerCacheReloader(); + systemManager.scheduleConfigCacheReloader(); try { // Do not check until we are up at least 1 min, and every minute thereafter. final long initialDelay = 1000L * 60; final long interval = 1000L * 60; - scheduler.scheduleSimpleRepeatingJob(SavedSearchResultCountRecalculationJob.class, true, false, + schedulerBean.scheduleSimpleRepeatingJob(SavedSearchResultCountRecalculationJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule asynchronous resource deletion job.", e); @@ -393,7 +415,7 @@ public class StartupBean { // Do not check until we are up at least 1 min, and every 5 minutes thereafter. final long initialDelay = 1000L * 60; final long interval = 1000L * 60 * 5; - scheduler.scheduleSimpleRepeatingJob(AsyncResourceDeleteJob.class, true, false, initialDelay, interval); + schedulerBean.scheduleSimpleRepeatingJob(AsyncResourceDeleteJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule asynchronous resource deletion job.", e); } @@ -402,7 +424,7 @@ public class StartupBean { // Do not check until we are up at least 1 min, and every 5 minutes thereafter. final long initialDelay = 1000L * 60; final long interval = 1000L * 60 * 5; - scheduler.scheduleSimpleRepeatingJob(PurgeResourceTypesJob.class, true, false, initialDelay, interval); + schedulerBean.scheduleSimpleRepeatingJob(PurgeResourceTypesJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule purge resource types job.", e); } @@ -411,7 +433,7 @@ public class StartupBean { // Do not check until we are up at least 1 min, and every 5 minutes thereafter. final long initialDelay = 1000L * 60; final long interval = 1000L * 60 * 5; - scheduler.scheduleSimpleRepeatingJob(PurgePluginsJob.class, true, false, initialDelay, interval); + schedulerBean.scheduleSimpleRepeatingJob(PurgePluginsJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule purge plugins job.", e); } @@ -421,7 +443,7 @@ public class StartupBean { // Do not check until we are up at least 1 min, and every minute thereafter. final long initialDelay = 1000L * 60; final long interval = 1000L * 60; - scheduler.scheduleSimpleRepeatingJob(DynaGroupAutoRecalculationJob.class, true, false, initialDelay, + schedulerBean.scheduleSimpleRepeatingJob(DynaGroupAutoRecalculationJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule DynaGroup auto-recalculation job.", e); @@ -430,7 +452,7 @@ public class StartupBean { // Cluster Manager Job try { String oldJobName = "org.rhq.enterprise.server.scheduler.jobs.ClusterManagerJob"; - boolean foundAndDeleted = scheduler.deleteJob(oldJobName, oldJobName); + boolean foundAndDeleted = schedulerBean.deleteJob(oldJobName, oldJobName); if (foundAndDeleted) { log.info("Unscheduling deprecated job references for " + oldJobName + "..."); } else { @@ -440,7 +462,7 @@ public class StartupBean { // Wait long enough to allow the Server instance jobs to start executing first. final long initialDelay = 1000L * 60 * 2; // 2 mins final long interval = 1000L * 30; // 30 secs - scheduler.scheduleSimpleRepeatingJob(CloudManagerJob.class, true, false, initialDelay, interval); + schedulerBean.scheduleSimpleRepeatingJob(CloudManagerJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule cloud management job.", e); } @@ -450,7 +472,7 @@ public class StartupBean { // Do not check until we are up at least 10 mins, but check every 60 secs thereafter. final long initialDelay = 1000L * 60 * 10; // 10 mins final long interval = 1000L * 60; // 60 secs - scheduler.scheduleSimpleRepeatingJob(CheckForSuspectedAgentsJob.class, true, false, initialDelay, interval); + schedulerBean.scheduleSimpleRepeatingJob(CheckForSuspectedAgentsJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule suspected Agents job.", e); } @@ -459,7 +481,7 @@ public class StartupBean { try { final long initialDelay = 1000L * 60 * 3; // 3 min final long interval = 1000L * 60 * 10; // 10 minutes - scheduler.scheduleSimpleRepeatingJob(CheckForTimedOutOperationsJob.class, true, false, initialDelay, + schedulerBean.scheduleSimpleRepeatingJob(CheckForTimedOutOperationsJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule check-for-timed-out-operations job.", e); @@ -470,7 +492,7 @@ public class StartupBean { try { final long initialDelay = 1000L * 60 * 4; // 4 mins final long interval = 1000L * 60 * 10; // 10 mins - scheduler.scheduleSimpleRepeatingJob(CheckForTimedOutConfigUpdatesJob.class, true, false, initialDelay, + schedulerBean.scheduleSimpleRepeatingJob(CheckForTimedOutConfigUpdatesJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule check-for-timed-out-configuration-update-requests job.", e); @@ -480,7 +502,7 @@ public class StartupBean { try { final long initialDelay = 1000L * 60 * 5; // 5 mins final long interval = 1000L * 60 * 15; // 15 mins - scheduler.scheduleSimpleRepeatingJob(CheckForTimedOutContentRequestsJob.class, true, false, initialDelay, + schedulerBean.scheduleSimpleRepeatingJob(CheckForTimedOutContentRequestsJob.class, true, false, initialDelay, interval); } catch (Exception e) { log.error("Cannot schedule check-for-timed-out-artifact-requests job.", e); @@ -491,7 +513,7 @@ public class StartupBean { // TODO [mazz]: make the data purge job's cron string configurable via SystemManagerBean // For Quartz cron syntax, see: http://www.quartz-scheduler.org/documentation/quartz-2.1.x/tutorials/crontr… String cronString = "0 0 * * * ?"; // every hour, on the hour - scheduler.scheduleSimpleCronJob(DataPurgeJob.class, true, false, cronString); + schedulerBean.scheduleSimpleCronJob(DataPurgeJob.class, true, false, cronString); } catch (Exception e) { log.error("Cannot schedule data purge job.", e); } @@ -507,7 +529,7 @@ public class StartupBean { // Alerting Availability Duration Job (create only, nothing actually scheduled here) try { - scheduler.scheduleTriggeredJob(AlertAvailabilityDurationJob.class, false, null); + schedulerBean.scheduleTriggeredJob(AlertAvailabilityDurationJob.class, false, null); } catch (Exception e) { log.error("Cannot create alert availability duration job.", e); } @@ -524,7 +546,6 @@ public class StartupBean { private void startAgentClients() { log.info("Starting agent clients - any persisted messages with guaranteed delivery will be sent..."); - AgentManagerLocal agentManager = LookupUtil.getAgentManager(); List<Agent> agents = agentManager.getAllAgents(); if (agents != null) { @@ -587,7 +608,7 @@ public class StartupBean { serverPort = overrides.getProperty(AgentConfigurationConstants_SERVER_BIND_PORT); agentAddress = overrides.getProperty(ServiceContainerConfigurationConstants.CONNECTOR_BIND_ADDRESS); - Server server = LookupUtil.getServerManager().getServer(); + Server server = serverManager.getServer(); if (agentAddress == null || agentAddress.trim().equals("")) { overrides.setProperty(ServiceContainerConfigurationConstants.CONNECTOR_BIND_ADDRESS, @@ -679,6 +700,7 @@ public class StartupBean { throw new RuntimeException("Failed to register the Server Shutdown Listener", e); } */ + log.warn("!!! TODO: REGISTER OUR SHUTDOWN LISTENER!!!"); } /** @@ -689,7 +711,7 @@ public class StartupBean { long elapsed; try { ObjectName jbossServerName = new ObjectName("jboss.system:type=Server"); - MBeanServer jbossServer = MBeanServerLocator.locateJBoss(); + MBeanServer jbossServer = ManagementFactory.getPlatformMBeanServer(); Date startTime = (Date) jbossServer.getAttribute(jbossServerName, "StartDate"); long currentTime = System.currentTimeMillis(); elapsed = currentTime - startTime.getTime(); @@ -700,8 +722,8 @@ public class StartupBean { } private void logServerStartedMessage() { - Subject overlord = LookupUtil.getSubjectManager().getOverlord(); - ProductInfo productInfo = LookupUtil.getSystemManager().getProductInfo(overlord); + Subject overlord = subjectManager.getOverlord(); + ProductInfo productInfo = systemManager.getProductInfo(overlord); log.info("--------------------------------------------------"); // 50 dashes log.info(productInfo.getFullName() + " " + productInfo.getVersion() + " (build " + productInfo.getBuildNumber() + ") Server started."); diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/comm/ServerCommunicationsServiceUtil.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/comm/ServerCommunicationsServiceUtil.java index 35c6728..8b7306c 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/comm/ServerCommunicationsServiceUtil.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/core/comm/ServerCommunicationsServiceUtil.java @@ -20,11 +20,14 @@ package org.rhq.enterprise.server.core.comm; import java.io.InputStream; import java.io.OutputStream; +import java.lang.management.ManagementFactory; + import javax.management.MBeanServer; import javax.management.MBeanServerInvocationHandler; + import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; -import org.jboss.mx.util.MBeanServerLocator; + import org.rhq.core.util.exception.WrappedRemotingException; import org.rhq.enterprise.communications.ServiceContainer; import org.rhq.enterprise.communications.command.client.RemoteInputStream; @@ -59,7 +62,7 @@ public class ServerCommunicationsServiceUtil { public static ServerCommunicationsServiceMBean getService() { ServerCommunicationsServiceMBean serverBootstrapService; try { - MBeanServer mbean_server = MBeanServerLocator.locateJBoss(); + MBeanServer mbean_server = ManagementFactory.getPlatformMBeanServer(); serverBootstrapService = (ServerCommunicationsServiceMBean) MBeanServerInvocationHandler.newProxyInstance( mbean_server, ServerCommunicationsServiceMBean.OBJECT_NAME, ServerCommunicationsServiceMBean.class, false); diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/scheduler/SchedulerBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/scheduler/SchedulerBean.java index baf3663..a451db5 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/scheduler/SchedulerBean.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/scheduler/SchedulerBean.java @@ -18,6 +18,7 @@ */ package org.rhq.enterprise.server.scheduler; +import java.lang.management.ManagementFactory; import java.util.Date; import java.util.List; import java.util.Properties; @@ -42,8 +43,6 @@ import org.quartz.TriggerListener; import org.quartz.UnableToInterruptJobException; import org.quartz.spi.JobFactory; -import org.jboss.mx.util.MBeanServerLocator; - /** * The Scheduler session bean is a proxy to the Quartz scheduler MBean that is used for scheduling jobs to be executed * within the JON Server. Use this to provide transactional access to Quartz. @@ -65,7 +64,7 @@ public class SchedulerBean implements SchedulerLocal { private SchedulerServiceMBean getSchedulerService() throws SchedulerException { try { return (SchedulerServiceMBean) MBeanServerInvocationHandler.newProxyInstance( - MBeanServerLocator.locateJBoss(), SCHEDULER_MBEAN_NAME, SchedulerServiceMBean.class, false); + ManagementFactory.getPlatformMBeanServer(), SCHEDULER_MBEAN_NAME, SchedulerServiceMBean.class, false); } catch (Exception e) { throw new SchedulerException("Failed to get a proxy to the scheduler service MBean", e); } diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/system/SystemManagerBean.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/system/SystemManagerBean.java index c8de105..4e2a9ab 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/system/SystemManagerBean.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/system/SystemManagerBean.java @@ -46,8 +46,6 @@ import javax.sql.DataSource; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; -import org.jboss.mx.util.MBeanServerLocator; - import org.rhq.core.db.DatabaseType; import org.rhq.core.db.DatabaseTypeFactory; import org.rhq.core.domain.auth.Subject; @@ -487,7 +485,7 @@ public class SystemManagerBean implements SystemManagerLocal, SystemManagerRemot try { Object mbean; - mbean = MBeanServerInvocationHandler.newProxyInstance(MBeanServerLocator.locateJBoss(), + mbean = MBeanServerInvocationHandler.newProxyInstance(ManagementFactory.getPlatformMBeanServer(), CustomJaasDeploymentServiceMBean.OBJECT_NAME, CustomJaasDeploymentServiceMBean.class, false); ((CustomJaasDeploymentServiceMBean) mbean).installJaasModules(); } catch (Exception e) { diff --git a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java index 537bb1a..313f295 100644 --- a/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java +++ b/modules/enterprise/server/jar/src/main/java/org/rhq/enterprise/server/util/LookupUtil.java @@ -497,7 +497,7 @@ public final class LookupUtil { return lookupLocal(ServerManagerBean.class); } - public static CacheConsistencyManagerLocal getCacheConsistenyManager() { + public static CacheConsistencyManagerLocal getCacheConsistencyManager() { return lookupLocal(CacheConsistencyManagerBean.class); }

1 0

← Newer
1
...
9
10
11
12
13
14
15
...
18
Older →

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

rhq-commits September 2012