[overlord-commits] Overlord SVN: r778 - in cdl/trunk/validator/jbossesb: src/main/java/org/jboss and 4 other directories.

Author: jeff.yuchang Date: 2009-08-20 04:57:33 -0400 (Thu, 20 Aug 2009) New Revision: 778 Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/AbstractServiceValidator.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/DefaultValidatorConfig.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ESBUtil.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/Endpoint.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidator.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidatorFactory.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidatorManager.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfig.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfigFactory.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfigLoader.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorFilter.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorName.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAServiceRecorder.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAServiceValidator.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAValidatorConfigLoader.java cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/ValidatorConfigGenerator.java Removed: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/soa/ Modified: cdl/trunk/validator/jbossesb/pom.xml Log: * Update the package name for validator. Modified: cdl/trunk/validator/jbossesb/pom.xml =================================================================== --- cdl/trunk/validator/jbossesb/pom.xml 2009-08-20 07:20:13 UTC (rev 777) +++ cdl/trunk/validator/jbossesb/pom.xml 2009-08-20 08:57:33 UTC (rev 778) @@ -6,7 +6,7 @@ <artifactId>savara-validator-jbossesb</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> - <name>Savara::Validator::JBossESB</name> + <name>Savara::Validator::JBoss ESB</name> <parent> <groupId>org.jboss</groupId> Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/AbstractServiceValidator.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/AbstractServiceValidator.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/AbstractServiceValidator.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,70 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +/** + * Abstract base class representing the ServiceValidator. + */ +public abstract class AbstractServiceValidator implements ServiceValidator { + + private static final String MODELS_PATH = "models/"; + + /** + * This is the constructor for the abstract + * service validator, initialised with the validator + * name. + * + * @param name The validator name + */ + public AbstractServiceValidator(ValidatorName name) { + m_name = name; + } + + /** + * This method returns the validator name. + * + * @return The validator name + */ + public ValidatorName getValidatorName() { + return(m_name); + } + + /** + * This method returns the input stream associated + * with the model. Once the input stream has been + * used, it is the caller's responsibility to close + * the stream. + * + * @return The model's input stream, or null if + * not found + */ + protected java.io.InputStream getModel() { + String filePath=MODELS_PATH+getValidatorName().getModelName(); + + java.io.InputStream ret = AbstractServiceValidator.class. + getClassLoader().getResourceAsStream(filePath); + + return(ret); + } + + public String toString() { + return("ServiceValidator["+getValidatorName()+"]"); + } + + private ValidatorName m_name=null; +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/DefaultValidatorConfig.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/DefaultValidatorConfig.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/DefaultValidatorConfig.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,63 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +import org.jboss.soa.esb.helpers.*; + +/** + * This class represents a default configuration that will be used for + * validation against a stream of ESB based messages. + */ +public class DefaultValidatorConfig implements ValidatorConfig { + + /** + * This is the constructor for the default validator model. + * + * @param modeType The model type + * @param config The configuration + */ + public DefaultValidatorConfig(String modelType, ConfigTree config) { + m_modelType = modelType; + m_configuration = config; + } + + /** + * This method returns the type of the model associated + * with this validator configuration. This will + * general be based on the file extension of the model + * file. + * + * @return The model type + */ + public String getModelType() { + return(m_modelType); + } + + /** + * This method returns the validator configuration + * associated with the model. + * + * @return The validator model + */ + public ConfigTree getConfiguration() { + return(m_configuration); + } + + private String m_modelType=null; + private ConfigTree m_configuration=null; +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ESBUtil.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ESBUtil.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ESBUtil.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,82 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +import org.apache.log4j.Logger; + +/** + * This class provides utility functions for processing + * ESB messages. + */ +public class ESBUtil { + + /** + * This method returns the message content associated + * with the supplied JBoss ESB message. + * + * @param message The esb message + * @return The message content + */ + public static java.io.Serializable getMessage( + org.jboss.soa.esb.message.Message message) { + java.io.Serializable ret=null; + + ret = (java.io.Serializable)message.getBody().get(); + + // Check if should return a multipart message + if (ret == null) { + + // Check if single or multipart message + if (message.getBody().getNames() != null && + message.getBody().getNames().length == 1) { + + Object mesg=message.getBody().get(message.getBody().getNames()[0]); + + if (logger.isDebugEnabled()) { + logger.debug("MESSAGE("+ + message.getBody().getNames()[0]+")="+mesg); + } + + if (mesg instanceof java.io.Serializable) { + ret = (java.io.Serializable)mesg; + } + + } else if (message.getBody().getNames() != null && + message.getBody().getNames().length > 1) { + + java.util.Hashtable<String,Object> multipart= + new java.util.Hashtable<String,Object>(); + + for (int i=0; i < message.getBody().getNames().length; i++) { + multipart.put(message.getBody().getNames()[i], + message.getBody().get(message.getBody().getNames()[i])); + } + + ret = multipart; + } + } + + if (ret instanceof byte[]) { + ret = new String((byte[])ret); + } + + return(ret); + } + + private static Logger logger = Logger.getLogger(ESBUtil.class); +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/Endpoint.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/Endpoint.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/Endpoint.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,87 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +/** + * This class represents an endpoint being monitored by one + * or more service validator. + */ +public class Endpoint { + + /** + * This is the constructor for the endpoint, supplying + * the destination associated with the endpoint. + * + * @param destination The destination + */ + public Endpoint(String destination) { + m_destination = destination; + } + + /** + * This method returns the destination for the endpoint. + * + * @return The destination + */ + public String getDestination() { + return(m_destination); + } + + /** + * This method returns the list of service validators + * associated with this endpoint. + * + * @return The list of service validators for this endpoint + */ + public java.util.List<ServiceValidator> getServiceValidators() { + return(m_validators); + } + + public boolean equals(Object obj) { + boolean ret=false; + + if (obj instanceof Endpoint) { + Endpoint ep=(Endpoint)obj; + + if (ep.getDestination() != null && + ep.getDestination().equals(m_destination)) { + ret = true; + } + } + + return(ret); + } + + public int hashCode() { + int ret=0; + + if (m_destination != null) { + ret = m_destination.hashCode(); + } + + return(ret); + } + + public String toString() { + return("Endpoint["+m_destination+"]"); + } + + private String m_destination=null; + private java.util.List<ServiceValidator> m_validators= + new java.util.Vector<ServiceValidator>(); +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidator.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidator.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidator.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,68 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +import org.jboss.soa.esb.message.Message; + +/** + * This interface represents a service validator responsible for + * validing a stream of ESB messages against a model. + */ +public interface ServiceValidator { + + /** + * This method returns the validator name. + * + * @return The validator name + */ + public ValidatorName getValidatorName(); + + /** + * This method processes a sent message against a service + * behavioural description. + * + * @param msg The message + * @throws Exception Failed to process sent message + */ + public void messageSent(Message msg) throws Exception; + + /** + * This method processes a received message against a service + * behavioural description. + * + * @param msg The message + * @throws Exception Failed to process received message + */ + public void messageReceived(Message msg) throws Exception; + + /** + * This method is called to update the model associated + * with the service validator. + * + * @throws Exception Failed to update the service validator + */ + public void update() throws Exception; + + /** + * This method closes the service validator. + * + * @throws Exception Failed to close the service validator + */ + public void close() throws Exception; + +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidatorFactory.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidatorFactory.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidatorFactory.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,71 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +import java.lang.reflect.Constructor; +import org.apache.log4j.Logger; + +/** + * This class provides a factory for Service Validators. + */ +public class ServiceValidatorFactory { + + /** + * This method returns the Service Validator appropriate + * for the supplied validator name. + * + * @param name The validator name + * @return The service validator + * @exception IOException Failed to create the service validator + */ + public static ServiceValidator getServiceValidator(ValidatorName name) + throws Exception { + ServiceValidator ret=null; + + String modelType=name.getModelType(); + + if (modelType != null && + m_validatorClasses.containsKey(modelType)) { + Class<?> cls=m_validatorClasses.get(modelType); + + Constructor<?> con=cls.getConstructor( + new Class[]{ValidatorName.class}); + + ret = (ServiceValidator)con.newInstance(new Object[]{name}); + } + + if (logger.isDebugEnabled()) { + logger.debug("Returning service validator for "+ + name+": "+ret); + } + + return(ret); + } + + private static final Logger logger = Logger.getLogger(ServiceValidatorFactory.class); + + private static java.util.Map<String,Class<?>> m_validatorClasses= + new java.util.HashMap<String,Class<?>>(); + + static { + m_validatorClasses.put(org.jboss.savara.validator.jbossesb.pi4soa.Pi4SOAServiceRecorder.getModelType(), + org.jboss.savara.validator.jbossesb.pi4soa.Pi4SOAServiceRecorder.class); + m_validatorClasses.put(org.jboss.savara.validator.jbossesb.pi4soa.Pi4SOAServiceValidator.getModelType(), + org.jboss.savara.validator.jbossesb.pi4soa.Pi4SOAServiceValidator.class); + } +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidatorManager.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidatorManager.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ServiceValidatorManager.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,966 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +import org.apache.log4j.Logger; + +import org.jboss.soa.esb.helpers.ConfigTree; + +/** + * This class is responsible for managing the active + * service validators, the mapping of endpoints to the service + * validators and updating the configuration when changes + * are detected. + */ +public class ServiceValidatorManager { + + /** + * Default constructor for the service validator manager. + */ + private ServiceValidatorManager() { + initialize(); + } + + /** + * This method returns the singleton ValidatorConfigurationManager. + * + * @return The singleton + */ + public synchronized static ServiceValidatorManager instance() { + if (m_instance == null) { + m_instance = new ServiceValidatorManager(); + } + + return(m_instance); + } + + /** + * This method initializes the service validator manager on + * startup. + */ + protected void initialize() { + + java.net.URL url= + ValidatorFilter.class.getClassLoader().getResource(CONFIG_FILE); + + if (url != null) { + m_validatorConfigFile = new java.io.File(url.getFile()); + + java.io.File[] files=m_validatorConfigFile.getParentFile().listFiles(); + + for (int i=0; m_modelsDir == null && i < files.length; i++) { + if (files[i].getName().equals("models") && + files[i].isDirectory()) { + m_modelsDir = files[i]; + } + } + + if (m_modelsDir != null) { + ValidatorConfigChangeMonitor mon= + new ValidatorConfigChangeMonitor(); + + new Thread(mon).start(); + } + } + } + + /** + * This method returns the list of service validators associated + * with the supplied input endpoint. + * + * @param endpoint The input endpoint + * @return The list of service validators, or null if the endpoint + * is unknown + */ + public java.util.List<ServiceValidator> getInputServiceValidators(Endpoint endpoint) { + java.util.List<ServiceValidator> ret= + m_inputValidators.get(endpoint); + + if (ret == null) { + ret = m_replyToManager.getInputServiceValidators(endpoint); + } + + if (logger.isDebugEnabled()) { + logger.debug("Return input validators '"+endpoint+"': "+ret); + } + + return(ret); + } + + /** + * This method determines whether the supplied endpoint will be + * associated with a dynamic reply-to endpoint. + * + * @param endpoint The endpoint + * @return Whether the endpoint has a dynamic reply-to + */ + public boolean isInputDynamicReplyTo(Endpoint endpoint) { + boolean ret=m_inputDynaReplyTos.contains(endpoint); + + if (logger.isDebugEnabled()) { + logger.debug("Is input endpoint '"+endpoint+ + "' a dynamic reply-to: "+ret); + } + + return(ret); + } + + /** + * This method returns the list of service validators associated + * with the supplied output endpoint. + * + * @param endpoint The output endpoint + * @return The list of service validators, or null if the endpoint + * is unknown + */ + public java.util.List<ServiceValidator> getOutputServiceValidators(Endpoint endpoint) { + java.util.List<ServiceValidator> ret= + m_outputValidators.get(endpoint); + + if (ret == null) { + ret = m_replyToManager.getOutputServiceValidators(endpoint); + } + + if (logger.isDebugEnabled()) { + logger.debug("Return output validators '"+endpoint+"': "+ret); + } + + return(ret); + } + + /** + * This method determines whether the supplied endpoint will be + * associated with a dynamic reply-to endpoint. + * + * @param endpoint The endpoint + * @return Whether the endpoint has a dynamic reply-to + */ + public boolean isOutputDynamicReplyTo(Endpoint endpoint) { + boolean ret=m_outputDynaReplyTos.contains(endpoint); + + if (logger.isDebugEnabled()) { + logger.debug("Is output endpoint '"+endpoint+ + "' a dynamic reply-to: "+ret); + } + + return(ret); + } + + /** + * This method registers a list of service validators against + * a dynamic 'reply-to' endpoint. + * + * @param endpoint The endpoint + * @param validators The list of service validators + */ + public void registerInputReplyToValidators(Endpoint endpoint, + java.util.List<ServiceValidator> validators) { + + if (logger.isDebugEnabled()) { + logger.debug("Register input reply-to '"+endpoint+"': "+validators); + } + + m_replyToManager.registerInputDynamicReplyTo(endpoint, validators); + } + + /** + * This method registers a list of service validators against + * a dynamic 'reply-to' endpoint. + * + * @param endpoint The endpoint + * @param validators The list of service validators + */ + public void registerOutputReplyToValidators(Endpoint endpoint, + java.util.List<ServiceValidator> validators) { + if (logger.isDebugEnabled()) { + logger.debug("Register output reply-to '"+endpoint+"': "+validators); + } + + m_replyToManager.registerOutputDynamicReplyTo(endpoint, validators); + } + + /** + * This method returns a ServiceValidator associated with the + * supplied validator name. + * + * @param name The validator name + * @return The service validator + * @throws Exception Failed to create service validator + */ + public ServiceValidator createServiceValidator(ValidatorName name) + throws Exception { + ServiceValidator ret=null; + + synchronized(m_serviceValidators) { + ret = m_serviceValidators.get(name); + + // If does not exist, then create, else update + // the existing service validator + if (ret == null) { + ret = ServiceValidatorFactory.getServiceValidator(name); + + m_serviceValidators.put(name, ret); + } else { + + // Update the description + ret.update(); + } + } + + if (logger.isDebugEnabled()) { + logger.debug("Created Service Validator '"+name+"': "+ret); + } + + return(ret); + } + + /** + * This method removes the service validator associated with + * the supplied validator name. + * + * @param name The validator name + * @throws Exception Failed to remove the service validator + */ + protected void removeServiceValidator(ValidatorName name) + throws Exception { + synchronized(m_serviceValidators) { + ServiceValidator validator=(ServiceValidator) + m_serviceValidators.remove(name); + + // Check if validator should be removed from + // input/output endpoint mappings + java.util.Iterator<Endpoint> iter=m_inputValidators.keySet().iterator(); + + while (iter.hasNext()) { + Endpoint ep=iter.next(); + java.util.List<ServiceValidator> list= + m_inputValidators.get(ep); + + if (list.contains(validator)) { + list.remove(validator); + + if (list.size() == 0) { + logger.error("Input validator list, associated with endpoint '"+ + ep+"' contains no entries after removal of validator '"+ + name+"' - this Endpoint should have previously been removed"); + } + } + } + + iter=m_outputValidators.keySet().iterator(); + + while (iter.hasNext()) { + Endpoint ep=iter.next(); + java.util.List<ServiceValidator> list= + m_outputValidators.get(ep); + + if (list.contains(validator)) { + list.remove(validator); + + if (list.size() == 0) { + logger.error("Output validator list, associated with endpoint '"+ + ep+"' contains no entries after removal of validator '"+ + name+"' - this Endpoint should have previously been removed"); + } + } + } + + if (validator != null) { + validator.close(); + } + } + } + + /** + * This method returns the set of currently configured + * service validator names. + * + * @return The set of validator names + */ + protected java.util.Set<ValidatorName> getServiceValidatorNames() { + java.util.Set<ValidatorName> ret=new java.util.HashSet<ValidatorName>(); + + ret.addAll(m_serviceValidators.keySet()); + + return(ret); + } + + /** + * This method updates the configuration of the service + * validators and endpoint mappings. + */ + protected void updateConfigurations() { + java.util.Set<ValidatorName> existingValidatorNames= + getServiceValidatorNames(); + + java.util.Set<Endpoint> existingInputEndpoints= + new java.util.HashSet<Endpoint>(m_inputValidators.keySet()); + + java.util.Set<Endpoint> existingOutputEndpoints= + new java.util.HashSet<Endpoint>(m_outputValidators.keySet()); + + java.util.Set<Endpoint> existingInputDynaReplyTos= + new java.util.HashSet<Endpoint>(m_inputDynaReplyTos); + + java.util.Set<Endpoint> existingOutputDynaReplyTos= + new java.util.HashSet<Endpoint>(m_outputDynaReplyTos); + + java.io.InputStream is=ValidatorFilter.class.getClassLoader(). + getResourceAsStream(CONFIG_FILE); + + if (logger.isDebugEnabled()) { + logger.debug("ValidationFilter: config="+CONFIG_FILE+" is="+is); + } + + try { + ConfigTree config=ConfigTree.fromInputStream(is); + + if (config.getName().equals(VALIDATOR_NODE)) { + // Old 'active' attribute is now 'mode' + String active=config.getAttribute(ACTIVE_ATTR); + + if (active != null && active.equalsIgnoreCase("true")) { + m_managedMode = true; + } + + String mode=config.getAttribute(MODE_ATTR); + + if (mode != null) { + if (mode.equals("manage")) { + m_managedMode = true; + } else if (mode.equals("monitor")) { + m_managedMode = false; // will override active=true + } else { + logger.error("Unknown mode '"+mode+"' - setting to 'monitor'"); + m_managedMode = false; + } + } + + if (m_managedMode) { + logger.debug("Setting validators in 'manage' mode"); + } else { + logger.debug("Setting validators in 'monitor' mode"); + } + + // Check for dynamic replyTo endpoint timeout + String timeoutValue=config.getAttribute(REPLY_TO_TIMEOUT_ATTR); + + if (timeoutValue != null) { + try { + long tv=Long.parseLong(timeoutValue); + + m_replyToManager.setReplyToTimeout(tv); + } catch(Exception e) { + logger.error("Unable to set 'reply to' timeout", e); + } + } + } + + updateConfiguration(config, existingValidatorNames, + existingInputEndpoints, existingOutputEndpoints, + existingInputDynaReplyTos, existingOutputDynaReplyTos); + + // Work through choreography files in the models directory + java.io.File[] files=m_modelsDir.listFiles(); + + for (int i=0; i < files.length; i++) { + + // Check if a ValidatorModel exists for the + // file + try { + ValidatorConfig vm= + ValidatorConfigFactory.getValidatorConfig(files[i]); + + if (vm != null) { + ConfigTree vConfig=vm.getConfiguration(); + + if (vConfig != null) { + updateConfiguration(vConfig, + existingValidatorNames, + existingInputEndpoints, + existingOutputEndpoints, + existingInputDynaReplyTos, + existingOutputDynaReplyTos); + } else { + logger.error("Failed to obtain configuration for model '"+ + files[i].getName()+"'"); + } + } + } catch(Exception e) { + logger.error("Failed to update configuration for model '"+ + files[i].getName()+"'", e); + } + } + + // Any remaining input keys need to be removed + java.util.Iterator<Endpoint> iter= + existingInputEndpoints.iterator(); + + while (iter.hasNext()) { + Endpoint key=iter.next(); + m_inputValidators.remove(key); + } + + iter = existingInputDynaReplyTos.iterator(); + + while (iter.hasNext()) { + Endpoint key=iter.next(); + m_inputDynaReplyTos.remove(key); + } + + // Any remaining output keys need to be removed + iter = existingOutputEndpoints.iterator(); + + while (iter.hasNext()) { + Endpoint key=iter.next(); + m_outputValidators.remove(key); + } + + iter = existingOutputDynaReplyTos.iterator(); + + while (iter.hasNext()) { + Endpoint key=iter.next(); + m_outputDynaReplyTos.remove(key); + } + + // Any remaining service description names need to + // have their associated monitors removed + java.util.Iterator<ValidatorName> sviter= + existingValidatorNames.iterator(); + + while (sviter.hasNext()) { + ValidatorName svkey=sviter.next(); + + try { + logger.debug("Removing service validator: "+svkey); + removeServiceValidator(svkey); + } catch(Exception e) { + logger.error( + "Failed to remove service validator: "+svkey, e); + } + } + } catch(Exception e) { + logger.error("Failed to update configuration from input stream", e); + } + } + + /** + * This method performs the update of the configuration of + * service monitors, based on the information in the validator + * configuration XML file, and the choreographies defined in the + * models folder. + * + * @param config The configuration + * @param existingValidatorNames The list of validator names + * @param existingInputEndpoints The list of input endpoints + * @param existingOutputEndpoints The list of output endpoints + * @param existingInputDynaReplyTos The set of input dynamic replyTo endpoints + * @param existingOutputDynaReplyTos The set of output dynamic replyTo endpoints + */ + protected void updateConfiguration(ConfigTree config, + java.util.Set<ValidatorName> existingValidatorNames, + java.util.Set<Endpoint> existingInputEndpoints, + java.util.Set<Endpoint> existingOutputEndpoints, + java.util.Set<Endpoint> existingInputDynaReplyTos, + java.util.Set<Endpoint> existingOutputDynaReplyTos) { + logger.debug("Update Service Validator Configuration"); + + if (config != null) { + try { + if (config.getName().equals(VALIDATOR_NODE)) { + String active=config.getAttribute(ACTIVE_ATTR); + + if (active != null && active.equalsIgnoreCase("true")) { + + logger.debug("Setting validator into active mode"); + m_managedMode = true; + } + } + + ConfigTree[] services=config.getChildren(SERVICE_NODE); + + if (logger.isDebugEnabled()) { + if (services != null) { + logger.debug("ValidationFilter: services="+services.length); + } else { + logger.debug("ValidationFilter: services null"); + } + } + + for (int i=0; i < services.length; i++) { + ServiceValidator sm=null; + + // Create service monitor for service + String modelName= + services[i].getAttribute(MODEL_ATTR); + String role= + services[i].getAttribute(ROLE_ATTR); + boolean validate= + services[i].getBooleanAttribute(VALIDATE_ATTR, true); + + // Check for old attribute names, for + // backward compatibility - only support + // for a limited time + if (role == null) { + role = services[i].getAttribute("participantType"); + } + + if (modelName == null) { + modelName = services[i].getAttribute("cdmFilePath"); + + if (modelName != null) { + // Remove path + int pos=modelName.lastIndexOf('/'); + if (pos != -1) { + modelName = modelName.substring(pos+1); + } + } + } + + if (logger.isDebugEnabled()) { + logger.debug("Initialize service validator for: model="+ + modelName+" role="+role+" validate="+validate); + } + + if (role != null) { + + if (modelName != null || + validate == false) { + ValidatorName name=null; + + if (validate) { + name = new ValidatorName(modelName, role); + } else { + name = new ValidatorName(role); + + } + + try { + // Obtain the service container + sm = createServiceValidator(name); + + if (logger.isDebugEnabled()) { + logger.debug("Service validator for '"+modelName+ + "' and role '"+role+"' = "+sm); + } + + // Remove validator name from list + existingValidatorNames.remove(sm.getValidatorName()); + } catch(Exception e) { + logger.error( + "Failed to create service validator '"+ + name+"'", e); + } + } else { + logger.error("Model name must be specified in validation mode"); + } + } else { + logger.error("Role must be specified"); + } + + if (sm != null) { + // Map inputs to service + ConfigTree[] inputs=services[i].getChildren(INPUT_NODE); + + for (int j=0; j < inputs.length; j++) { + String epr=inputs[j].getAttribute(EPR_ATTR); + + if (epr != null) { + Endpoint endpoint=new Endpoint(epr); + + if (logger.isDebugEnabled()) { + logger.debug("Storing input endpoint '"+ + endpoint+"' against validator: "+sm); + } + + // Check if existing list + java.util.List<ServiceValidator> svs= + m_inputValidators.get(endpoint); + + if (svs == null) { + svs = new java.util.Vector<ServiceValidator>(); + m_inputValidators.put(endpoint, svs); + } + + if (svs.contains(sm) == false) { + svs.add(sm); + } + + existingInputEndpoints.remove(endpoint); + + // Check if dynamic replyTo + if (inputs[j].getAttribute(DYNAMIC_REPLY_TO_ATTR, + "false").equalsIgnoreCase("true")) { + + if (logger.isDebugEnabled()) { + logger.debug("Input endpoint '"+ + endpoint+"' has dynamic replyTo destination"); + } + + m_inputDynaReplyTos.add(endpoint); + + existingInputDynaReplyTos.remove(endpoint); + } + } + } + + // Map outputs to service + ConfigTree[] outputs=services[i].getChildren(OUTPUT_NODE); + + for (int j=0; j < outputs.length; j++) { + String epr=outputs[j].getAttribute(EPR_ATTR); + + if (epr != null) { + Endpoint endpoint=new Endpoint(epr); + + if (logger.isDebugEnabled()) { + logger.debug("Storing output endpoint '"+ + endpoint+"' against validator: "+sm); + } + + // Check if existing list + java.util.List<ServiceValidator> svs= + m_outputValidators.get(endpoint); + + if (svs == null) { + svs = new java.util.Vector<ServiceValidator>(); + m_outputValidators.put(endpoint, svs); + } + + if (svs.contains(sm) == false) { + svs.add(sm); + } + + existingOutputEndpoints.remove(endpoint); + + // Check if dynamic replyTo + if (outputs[j].getAttribute(DYNAMIC_REPLY_TO_ATTR, + "false").equalsIgnoreCase("true")) { + + if (logger.isDebugEnabled()) { + logger.debug("Output endpoint '"+ + endpoint+"' has dynamic replyTo destination"); + } + + m_outputDynaReplyTos.add(endpoint); + + existingOutputDynaReplyTos.remove(endpoint); + } + } + } + } + } + } catch(Exception e) { + logger.error("Failed to load validator config", e); + } + } + } + + /** + * This method returns whether the service validator configuration + * is in 'manage' mode. If yes, then invalid messages will + * be blocked from being delivered to their destination. + * + * @return Whether the service validator is in 'manage' mode + */ + public boolean isManagedMode() { + return(m_managedMode); + } + + private static final Logger logger = Logger.getLogger(ServiceValidatorManager.class); + + private static final String EPR_ATTR = "epr"; + private static final String DYNAMIC_REPLY_TO_ATTR = "dynamicReplyTo"; + + private static final String OUTPUT_NODE = "output"; + private static final String INPUT_NODE = "input"; + private static final String SERVICE_NODE = "service"; + private static final String ACTIVE_ATTR = "active"; + private static final String MODE_ATTR = "mode"; + private static final String REPLY_TO_TIMEOUT_ATTR = "replyToTimeout"; + private static final String VALIDATOR_NODE = "validator"; + + private static final String CONFIG_FILE = "validator-config.xml"; + private static final String MODEL_ATTR="model"; + private static final String ROLE_ATTR="role"; + private static final String VALIDATE_ATTR="validate"; + + private static ServiceValidatorManager m_instance=null; + private java.io.File m_validatorConfigFile=null; + private java.io.File m_modelsDir=null; + private java.util.Map<ValidatorName,ServiceValidator> m_serviceValidators= + new java.util.HashMap<ValidatorName,ServiceValidator>(); + private java.util.Map<Endpoint,java.util.List<ServiceValidator>> m_inputValidators=new java.util.Hashtable<Endpoint,java.util.List<ServiceValidator>>(); + private java.util.Map<Endpoint,java.util.List<ServiceValidator>> m_outputValidators=new java.util.Hashtable<Endpoint,java.util.List<ServiceValidator>>(); + private java.util.Set<Endpoint> m_inputDynaReplyTos=new java.util.HashSet<Endpoint>(); + private java.util.Set<Endpoint> m_outputDynaReplyTos=new java.util.HashSet<Endpoint>(); + private boolean m_managedMode=false; + private DynamicReplyToEndpointManager m_replyToManager=new DynamicReplyToEndpointManager(); + + /** + * This class is responsible for monitoring the models folder, + * within the overlord validator ESB bundle, to determine when + * the configuration has changed. + */ + public class ValidatorConfigChangeMonitor implements java.lang.Runnable { + + public ValidatorConfigChangeMonitor() { + // Do initial check for updates, so monitors + // initialized before returning from construct, + // as remainder of checks will be in a separate + // thread - so we need to ensure that the monitors + // are configured before the first message is + // passed through the filter. + checkForUpdates(); + } + + public void run() { + + while (true) { + checkForUpdates(); + + try { + synchronized(ValidatorConfigChangeMonitor.this) { + wait(30000); + } + } catch(Exception e) { + e.printStackTrace(); + } + } + } + + protected void checkForUpdates() { + logger.debug("Checking for config updates"); + + // Get last update time + long lastUpdate=getLastUpdate(); + + if (lastUpdate > m_lastUpdate) { + + updateConfigurations(); + + m_lastUpdate = lastUpdate; + } + } + + protected long getLastUpdate() { + long ret=0; + + if (m_validatorConfigFile != null) { + ret = m_validatorConfigFile.lastModified(); + } + + if (m_modelsDir != null) { + java.io.File[] files=m_modelsDir.listFiles(); + + for (int i=0; i < files.length; i++) { + if (files[i].getName().endsWith(".cdm") && + ret < files[i].lastModified()) { + ret = files[i].lastModified(); + } + } + + if (ret < m_modelsDir.lastModified()) { + ret = m_modelsDir.lastModified(); + } + } + + return(ret); + } + + private long m_lastUpdate=0; + } + + public class DynamicReplyToEndpointManager extends Thread { + + /** + * The default constructor + */ + public DynamicReplyToEndpointManager() { + setDaemon(true); + + start(); + } + + /** + * The run method is responsible for ensuring the dynamic + * 'reply-to' endpoints are cleaned up periodically. + */ + public void run() { + + while(true) { + + try { + synchronized(this) { + wait(m_replyToTimeout); + } + } catch(Exception e) { + logger.error("Failed to wait"); + } + + // Shift main entries to an emptied 'pending delete' + // map + synchronized(m_inputs) { + if (logger.isDebugEnabled()) { + java.util.Iterator<Endpoint> iter= + m_inputsPendingDelete.keySet().iterator(); + while (iter.hasNext()) { + Endpoint endpoint=iter.next(); + java.util.List<ServiceValidator> validators= + m_inputsPendingDelete.get(endpoint); + logger.debug("Deleting input (reply-to) validators '"+ + endpoint+"': "+validators); + } + } + + m_inputsPendingDelete.clear(); + m_inputsPendingDelete.putAll(m_inputs); + m_inputs.clear(); + } + + synchronized(m_outputs) { + if (logger.isDebugEnabled()) { + java.util.Iterator<Endpoint> iter= + m_outputsPendingDelete.keySet().iterator(); + while (iter.hasNext()) { + Endpoint endpoint=iter.next(); + java.util.List<ServiceValidator> validators= + m_outputsPendingDelete.get(endpoint); + logger.debug("Deleting output (reply-to) validators '"+ + endpoint+"': "+validators); + } + } + + m_outputsPendingDelete.clear(); + m_outputsPendingDelete.putAll(m_outputs); + m_outputs.clear(); + } + } + } + + /** + * This method returns the list of service validators + * associated with the dynamic reply-to endpoint. + * + * @param endpoint The input endpoint + * @return The list of service validators, or null if + * not found + */ + public java.util.List<ServiceValidator> getInputServiceValidators(Endpoint endpoint) { + java.util.List<ServiceValidator> ret=null; + + synchronized(m_inputs) { + ret = m_inputs.get(endpoint); + + if (ret == null) { + ret = m_inputsPendingDelete.get(endpoint); + } + } + + if (logger.isDebugEnabled()) { + logger.debug("Return input (reply-to) validators '"+endpoint+"': "+ret); + } + + return(ret); + } + + /** + * This method returns the list of service validators + * associated with the dynamic reply-to endpoint. + * + * @param endpoint The output endpoint + * @return The list of service validators, or null if + * not found + */ + public java.util.List<ServiceValidator> getOutputServiceValidators(Endpoint endpoint) { + java.util.List<ServiceValidator> ret=null; + + synchronized(m_outputs) { + ret = m_outputs.get(endpoint); + + if (ret == null) { + ret = m_outputsPendingDelete.get(endpoint); + } + } + + if (logger.isDebugEnabled()) { + logger.debug("Return output (reply-to) validators '"+endpoint+"': "+ret); + } + + return(ret); + } + + /** + * This method registers a list of service validators against + * a dynamic 'reply-to' endpoint. + * + * @param endpoint The endpoint + * @param validators The list of service validators + */ + public void registerInputDynamicReplyTo(Endpoint endpoint, + java.util.List<ServiceValidator> validators) { + + synchronized(m_inputs) { + m_inputs.put(endpoint, validators); + + // May not be necessary, as entry would not be + // used - but could save memory? + m_inputsPendingDelete.remove(endpoint); + } + } + + /** + * This method registers a list of service validators against + * a dynamic 'reply-to' endpoint. + * + * @param endpoint The endpoint + * @param validators The list of service validators + */ + public void registerOutputDynamicReplyTo(Endpoint endpoint, + java.util.List<ServiceValidator> validators) { + + synchronized(m_outputs) { + m_outputs.put(endpoint, validators); + + // May not be necessary, as entry would not be + // used - but could save memory? + m_outputsPendingDelete.remove(endpoint); + } + } + + /** + * This method sets the timeout period for purging the + * cache of reply-to endpoints. + * + * @param timeoutValue The timeout value + */ + public void setReplyToTimeout(long timeoutValue) { + m_replyToTimeout = timeoutValue; + } + + private java.util.Map<Endpoint,java.util.List<ServiceValidator>> m_inputs= + new java.util.HashMap<Endpoint,java.util.List<ServiceValidator>>(); + private java.util.Map<Endpoint,java.util.List<ServiceValidator>> m_outputs= + new java.util.HashMap<Endpoint,java.util.List<ServiceValidator>>(); + private java.util.Map<Endpoint,java.util.List<ServiceValidator>> m_inputsPendingDelete= + new java.util.HashMap<Endpoint,java.util.List<ServiceValidator>>(); + private java.util.Map<Endpoint,java.util.List<ServiceValidator>> m_outputsPendingDelete= + new java.util.HashMap<Endpoint,java.util.List<ServiceValidator>>(); + private long m_replyToTimeout=10000; + } +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfig.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfig.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfig.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,46 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +import org.jboss.soa.esb.helpers.*; + +/** + * This interface represents a configuration that will be used for + * validation against a stream of ESB based messages. + */ +public interface ValidatorConfig { + + /** + * This method returns the type of the model associated + * with this validator configuration. This will + * general be based on the file extension of the model + * file. + * + * @return The model type + */ + public String getModelType(); + + /** + * This method returns the validator configuration + * associated with the model. + * + * @return The validator model + */ + public ConfigTree getConfiguration(); + +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfigFactory.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfigFactory.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfigFactory.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,97 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +import org.apache.log4j.Logger; + +/** + * This class provides a factory for ValidatorConfig objects + * based on supplied model file details. + */ +public class ValidatorConfigFactory { + + /** + * This method retrieves a validator config associated with + * the supplied file. If the model associated with the + * file is not supported, then a null will be returned. + * + * @param file The file containing the model + * @return The validator config, or null if an unsupported type + * @exception IOException Failed to load supported model type + */ + public static ValidatorConfig getValidatorConfig(java.io.File file) + throws java.io.IOException { + ValidatorConfig ret=null; + + String modelType=null; + + if (file != null && (modelType=getModelType(file.getName())) != null) { + ValidatorConfigLoader loader=null; + + for (int i=0; loader == null && + i < m_loaders.size(); i++) { + + if (m_loaders.get(i).isSupported(modelType)) { + loader = m_loaders.get(i); + } + } + + if (loader != null) { + java.io.FileInputStream fis=new java.io.FileInputStream(file); + + ret = loader.loadValidatorConfig(fis, file.getName()); + + fis.close(); + } + } + + if (logger.isDebugEnabled()) { + logger.debug("Returning validator config for "+ + file.getName()+": "+ret); + } + + return(ret); + } + + /** + * This method determines the model type associated with the + * supplied model filename. + * + * @param name The model filename + * @return The model type, or null if not known + */ + protected static String getModelType(String name) { + String ret=null; + int pos=name.lastIndexOf('.'); + + if (pos != -1) { + ret = name.substring(pos+1); + } + + return(ret); + } + + private static final Logger logger = Logger.getLogger(ValidatorConfigFactory.class); + + private static java.util.List<ValidatorConfigLoader> m_loaders= + new java.util.Vector<ValidatorConfigLoader>(); + + static { + m_loaders.add(new org.jboss.savara.validator.jbossesb.pi4soa.Pi4SOAValidatorConfigLoader()); + } +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfigLoader.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfigLoader.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorConfigLoader.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,48 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +/** + * This interface is implemented by model specific loaders, to + * load a ValidatorConfig for the particular model type. + */ +public interface ValidatorConfigLoader { + + /** + * This method determines if the validator config loader + * implementation supports the supplied model type. + * + * @param modelType The model type + * @return Whether the loader supports the model type + */ + public boolean isSupported(String modelType); + + /** + * This method loads the validator config, contained within + * the supplied input stream representing a model of the + * supported type. + * + * @param is The input stream + * @param modelPath The path to the model file + * @return The validator config + * @throws java.io.IOException Failed to load validator config + */ + public ValidatorConfig loadValidatorConfig(java.io.InputStream is, + String modelPath) throws java.io.IOException; + +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorFilter.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorFilter.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorFilter.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,250 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +import org.apache.log4j.Logger; + +import org.jboss.soa.esb.message.*; +import org.jboss.soa.esb.couriers.*; + +/** + * This class represents the filter used to intercept ESB + * messages an apply them to relevant Service Validators. + */ +public class ValidatorFilter extends org.jboss.soa.esb.filter.InputOutputFilter { + + private static final String TOPIC_PREFIX = "topic/"; + private static final String QUEUE_PREFIX = "queue/"; + private static final String JMS_PROTOCOL_PREFIX = "jms:"; + + /** + * The default constructor. + */ + public ValidatorFilter() { + } + + /** + * This method is invoked when a message is sent by an + * ESB service. + * + * @param msg The ESB message + * @param params The parameters + * @throws CourierException Failed to validate message + */ + public Message onOutput(Message msg, java.util.Map params) + throws CourierException { + + Endpoint endpoint=getEndpoint(msg); + + if (endpoint != null) { + java.util.List<ServiceValidator> validators= + ServiceValidatorManager.instance().getOutputServiceValidators(endpoint); + + if (validators != null && validators.size() > 0) { + boolean validated=false; + Exception ex=null; + + for (int i=0; validators != null && + i < validators.size(); i++) { + try { + validators.get(i).messageSent(msg); + validated = true; + } catch(Exception t) { + // Ignore + ex = t; + } + } + + // Only raise exception if none of the service + // validators were able to validate the message + if (validated == false) { + String vnames=""; + + for (int i=0; validators != null && + i < validators.size(); i++) { + if (vnames.length() > 0) { + vnames += ", "; + } + vnames += validators.get(i).getValidatorName(); + } + + logger.error("Failed to handle sent message on endpoint '"+ + endpoint+"' validated against: "+vnames); + + if (ServiceValidatorManager.instance().isManagedMode()) { + throw new CourierException("Failed to handle sent message on endpoint '"+ + endpoint+"' validated against: "+vnames, ex); + } + } else { + + // Check whether a dynamic reply is expected + if (ServiceValidatorManager.instance().isOutputDynamicReplyTo(endpoint)) { + + // Register interest in the 'reply-to' endpoint + Endpoint replyTo=getReplyToEndpoint(msg); + + if (replyTo != null) { + ServiceValidatorManager.instance().registerInputReplyToValidators(replyTo, + validators); + } else { + logger.error("Unable to get 'reply-to' endpoint for message: "+msg); + } + } + } + } + } + + return(msg); + } + + /** + * This method is invoked when a message is received by an + * ESB service. + * + * @param msg The ESB message + * @param params The parameters + * @throws CourierException Failed to validate message + */ + public Message onInput(Message msg, java.util.Map params) + throws CourierException { + + Endpoint endpoint=getEndpoint(msg); + + if (endpoint != null) { + java.util.List<ServiceValidator> validators= + ServiceValidatorManager.instance().getInputServiceValidators(endpoint); + + if (validators != null && validators.size() > 0) { + boolean validated=false; + Exception ex=null; + + for (int i=0; validators != null && + i < validators.size(); i++) { + try { + validators.get(i).messageReceived(msg); + validated = true; + } catch(Exception t) { + // Ignore + ex = t; + } + } + + // Only raise exception if none of the service + // validators were able to validate the message + if (validated == false) { + String vnames=""; + + for (int i=0; validators != null && + i < validators.size(); i++) { + if (vnames.length() > 0) { + vnames += ", "; + } + vnames += validators.get(i).getValidatorName(); + } + + logger.error("Failed to handle received message on endpoint '"+ + endpoint+"' validated against: "+vnames); + + if (ServiceValidatorManager.instance().isManagedMode()) { + throw new CourierException("Failed to handle received message on endpoint '"+ + endpoint+"' validated against: "+vnames, ex); + } + } else { + + // Check whether a dynamic reply is expected + if (ServiceValidatorManager.instance().isInputDynamicReplyTo(endpoint)) { + + // Register interest in the 'reply-to' endpoint + Endpoint replyTo=getReplyToEndpoint(msg); + + if (replyTo != null) { + ServiceValidatorManager.instance().registerOutputReplyToValidators(replyTo, + validators); + } else { + logger.error("Unable to get 'reply-to' endpoint for message: "+msg); + } + } + } + } + } + + return(msg); + } + + /** + * This method returns an endpoint associated with the 'to' + * destination of the supplied message. + * + * @param msg The message + * @return The endpoint, or null if not relevant + */ + protected Endpoint getEndpoint(Message msg) { + Endpoint ret=null; + + if (msg != null && msg.getHeader() != null && + msg.getHeader().getCall() != null && + msg.getHeader().getCall().getTo() != null && + msg.getHeader().getCall().getTo().getAddr() != null) { + + String key=msg.getHeader().getCall().getTo().getAddr().getAddress(); + int ind=-1; + + if (key.startsWith(JMS_PROTOCOL_PREFIX) && + ((ind=key.indexOf(QUEUE_PREFIX)) != -1 || + (ind=key.indexOf(TOPIC_PREFIX)) != -1)) { + ret = new Endpoint(JMS_PROTOCOL_PREFIX+key.substring(ind)); + } + } + + logger.debug("Destination for message '"+msg+"' is: "+ret); + + return(ret); + } + + /** + * This method returns an endpoint associated with the 'to' + * destination of the supplied message. + * + * @param msg The message + * @return The endpoint, or null if not relevant + */ + protected Endpoint getReplyToEndpoint(Message msg) { + Endpoint ret=null; + + if (msg != null && msg.getHeader() != null && + msg.getHeader().getCall() != null && + msg.getHeader().getCall().getReplyTo() != null && + msg.getHeader().getCall().getReplyTo().getAddr() != null) { + + String key=msg.getHeader().getCall().getReplyTo().getAddr().getAddress(); + int ind=-1; + + if (key.startsWith(JMS_PROTOCOL_PREFIX) && + ((ind=key.indexOf(QUEUE_PREFIX)) != -1 || + (ind=key.indexOf(TOPIC_PREFIX)) != -1)) { + ret = new Endpoint(JMS_PROTOCOL_PREFIX+key.substring(ind)); + } + } + + logger.debug("Reply-To Destination for message '"+msg+"' is: "+ret); + + return(ret); + } + + private static final Logger logger = Logger.getLogger(ValidatorFilter.class); +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorName.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorName.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/ValidatorName.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,134 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb; + +/** + * This class represents a key for looking up a service validator. + */ +public class ValidatorName { + + /** + * This constructor is initialized with the details used to + * identify the validator. + * + * @param role The role + */ + public ValidatorName(String role) { + m_role = role; + m_validate = false; + } + + /** + * This constructor is initialized with the details used to + * identify the validator. + * + * @param modelName The model name + * @param role The role + * @param validate Whether to validate, or simply record + */ + public ValidatorName(String modelName, String role) { + m_modelName = modelName; + m_role = role; + m_validate = true; + } + + /** + * This method returns the model name associated with the + * service validator. + * + * @return The model name + */ + public String getModelName() { + return(m_modelName); + } + + /** + * This method returns the type associated with the model. + * If no model has been defined for the validator name, + * as in the case of a validator in record mode, then + * this method will return ValidatorName.NO_MODEL_TYPE. + * + * @return The model type + */ + public String getModelType() { + String ret=null; + int pos=0; + + if (m_modelName != null && + (pos=m_modelName.lastIndexOf('.')) != -1) { + ret = m_modelName.substring(pos+1); + } else { + ret = NO_MODEL_TYPE; + } + + return(ret); + } + + /** + * This method returns the role associated with the Service + * Validator. + * + * @return The role + */ + public String getRole() { + return(m_role); + } + + /** + * This method determines whether the associated service + * validator is in validation or record mode. + * + * @return Whether in validation or record mode + */ + public boolean isValidate() { + return(m_validate); + } + + public boolean equals(Object obj) { + boolean ret=false; + + if (obj instanceof ValidatorName) { + ret = (obj.toString().equals(toString()) && + ((ValidatorName)obj).m_validate == m_validate); + } + + return(ret); + } + + public int hashCode() { + return(toString().hashCode()); + } + + public String toString() { + String ret=null; + + if (isValidate()) { + ret = m_modelName+":"+m_role; + } else { + ret = m_role; + } + + return(ret); + } + + public static final String NO_MODEL_TYPE="NoModelType"; + + private String m_modelName=null; + private String m_role=null; + private boolean m_validate=false; +} \ No newline at end of file Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAServiceRecorder.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAServiceRecorder.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAServiceRecorder.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,155 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb.pi4soa; + +import org.apache.log4j.Logger; + +import org.jboss.savara.validator.jbossesb.*; +import org.jboss.soa.esb.message.Message; +import org.pi4soa.common.util.MessageUtil; +import org.pi4soa.service.ServiceException; +import org.pi4soa.service.behavior.*; +import org.pi4soa.service.monitor.*; + +/** + * This class implements the pi4soa service validator responsible for + * recording a stream of ESB messages. + */ +public class Pi4SOAServiceRecorder extends AbstractServiceValidator { + + /** + * This is the constructor for the pi4soa service + * recorder implementation. + * + * @param name The validator name + */ + public Pi4SOAServiceRecorder(ValidatorName name) { + super(name); + + initialize(); + } + + /** + * This method initializes the service recorder. + */ + protected void initialize() { + try { + // Use XML configuration, to enable alternative + // runtime configuration to be specified by + // including a pi4soa.xml file in the environment + DefaultMonitorConfiguration conf= + new XMLMonitorConfiguration(); + + conf.setValidateBehaviour(getValidatorName().isValidate()); + + m_monitor = ServiceMonitorFactory.getServiceMonitor(conf); + + ServiceDescription sdesc=BehaviorFactory.eINSTANCE.createServiceDescription(); + sdesc.setName(getValidatorName().getRole()); + + // Register service description + m_monitor.getConfiguration().getServiceRepository(). + addServiceDescription(sdesc); + + logger.debug("Created monitor for service description "+sdesc.getFullyQualifiedName()); + + } catch(Exception e) { + logger.error("Failed to initialize service monitor: "+e); + } + } + + /** + * This method returns the model type associated with this + * service recorder. + * + * @return The model type + */ + public static String getModelType() { + return(ValidatorName.NO_MODEL_TYPE); + } + + /** + * This method is called to update the model associated + * with the service validator. + */ + public void update() { + } + + /** + * This method processes a sent message against a service + * behavioural description. + * + * @param msg The message + * @throws Exception Failed to process sent message + */ + public void messageSent(Message msg) throws Exception { + java.io.Serializable value=ESBUtil.getMessage(msg); + + if (value == null) { + throw new ServiceException("Failed to obtain value from message: "+msg); + } + + String mesgType=MessageUtil.getMessageType(value); + + org.pi4soa.service.Message mesg= + m_monitor.createMessage(mesgType, + null, null, value, null, null); + + synchronized(m_monitor) { + m_monitor.messageSent(mesg); + } + } + + /** + * This method processes a received message against a service + * behavioural description. + * + * @param msg The message + * @throws Exception Failed to process received message + */ + public void messageReceived(Message msg) throws Exception { + java.io.Serializable value=ESBUtil.getMessage(msg); + + if (value == null) { + throw new ServiceException("Failed to obtain value from message: "+msg); + } + + String mesgType=MessageUtil.getMessageType(value); + + org.pi4soa.service.Message mesg= + m_monitor.createMessage(mesgType, + null, null, value, null, null); + + synchronized(m_monitor) { + m_monitor.messageReceived(mesg); + } + } + + /** + * This method closes the service validator. + * + * @throws Exception Failed to close the service validator + */ + public void close() throws Exception { + m_monitor.close(); + } + + private static final Logger logger = Logger.getLogger(Pi4SOAServiceRecorder.class); + + private org.pi4soa.service.monitor.ServiceMonitor m_monitor=null; +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAServiceValidator.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAServiceValidator.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAServiceValidator.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,216 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb.pi4soa; + +import org.apache.log4j.Logger; + +import org.jboss.savara.validator.jbossesb.*; +import org.jboss.soa.esb.message.Message; +import org.pi4soa.common.util.MessageUtil; +import org.pi4soa.service.ServiceException; +import org.pi4soa.service.behavior.*; +import org.pi4soa.service.monitor.*; + +/** + * This class implements the pi4soa service validator responsible for + * validating a stream of ESB messages against a choreography model. + */ +public class Pi4SOAServiceValidator extends AbstractServiceValidator { + + private static final String CDM_MODEL_TYPE = "cdm"; + + /** + * This is the constructor for the pi4soa service + * validator implementation. + * + * @param name The validator name + * @throws Exception Failed to initialize service validator + */ + public Pi4SOAServiceValidator(ValidatorName name) + throws Exception { + super(name); + + update(); + } + + /** + * This method returns the model type associated with this + * service validator. + * + * @return The model type + */ + public static String getModelType() { + return CDM_MODEL_TYPE; + } + + /** + * This method is called to update the model associated + * with the service validator. + * + * @throws Exception Failed to update the service validator + */ + public void update() throws Exception { + + if (logger.isDebugEnabled()) { + logger.debug("Update: "+getValidatorName()); + } + + java.io.InputStream is=getModel(); + + if (is != null) { + org.pi4soa.service.behavior.ServiceDescription sdesc= + org.pi4soa.service.util.DescriptionRetrievalUtil.instance().getServiceDescription(is, + getValidatorName().getRole()); + + try { + is.close(); + } catch(Exception e) { + logger.error("Failed to close model '"+ + getValidatorName()+"' input stream", e); + } + + if (sdesc != null) { + + if (m_monitor == null) { + + if (logger.isDebugEnabled()) { + logger.debug("Service monitor for '"+ + sdesc.getFullyQualifiedName()+ + "' being created"); + } + + try { + // Use XML configuration, to enable alternative + // runtime configuration to be specified by + // including a pi4soa.xml file in the environment + DefaultMonitorConfiguration conf= + new XMLMonitorConfiguration(); + + conf.setValidateBehaviour(getValidatorName().isValidate()); + + m_monitor = ServiceMonitorFactory.getServiceMonitor(conf); + + // Register service description + m_monitor.getConfiguration().getServiceRepository(). + addServiceDescription(sdesc); + + logger.debug("Created monitor for service description "+sdesc.getFullyQualifiedName()); + + } catch(Exception e) { + logger.error("Failed to initialize service monitor: "+e); + } + } else { + + synchronized(m_monitor) { + // Service monitor already in use for the service + // description, so update description + try { + // Clear previous version of the service description + ServiceDescription[] sdescs= + m_monitor.getConfiguration().getServiceRepository().getServiceDescriptions(); + + for (int i=0; sdescs != null && i < sdescs.length; i++) { + m_monitor.getConfiguration().getServiceRepository(). + removeServiceDescription(sdescs[i]); + } + + logger.debug("Updating service description for "+sdesc.getFullyQualifiedName()); + + m_monitor.getConfiguration().getServiceRepository().addServiceDescription(sdesc); + } catch(Exception e) { + logger.error("Failed to update service description '"+ + sdesc.getFullyQualifiedName()+"'", e); + } + } + } + } else { + logger.error("Unable to obtain service description for validator '"+ + getValidatorName()+"'"); + } + } else { + logger.error("Unable to obtain model for validator '"+ + getValidatorName()+"'"); + + throw new java.io.IOException("Failed to locate model '"+ + getValidatorName().getModelName()+"'"); + } + } + + /** + * This method processes a sent message against a service + * behavioural description. + * + * @param msg The message + * @throws Exception Failed to process sent message + */ + public void messageSent(Message msg) throws Exception { + java.io.Serializable value=ESBUtil.getMessage(msg); + + if (value == null) { + throw new ServiceException("Failed to obtain value from message: "+msg); + } + + String mesgType=MessageUtil.getMessageType(value); + + org.pi4soa.service.Message mesg= + m_monitor.createMessage(mesgType, + null, null, value, null, null); + + synchronized(m_monitor) { + m_monitor.messageSent(mesg); + } + } + + /** + * This method processes a received message against a service + * behavioural description. + * + * @param msg The message + * @throws Exception Failed to process received message + */ + public void messageReceived(Message msg) throws Exception { + java.io.Serializable value=ESBUtil.getMessage(msg); + + if (value == null) { + throw new ServiceException("Failed to obtain value from message: "+msg); + } + + String mesgType=MessageUtil.getMessageType(value); + + org.pi4soa.service.Message mesg= + m_monitor.createMessage(mesgType, + null, null, value, null, null); + + synchronized(m_monitor) { + m_monitor.messageReceived(mesg); + } + } + + /** + * This method closes the service validator. + * + * @throws Exception Failed to close the service validator + */ + public void close() throws Exception { + m_monitor.close(); + } + + private static final Logger logger = Logger.getLogger(Pi4SOAServiceValidator.class); + + private org.pi4soa.service.monitor.ServiceMonitor m_monitor=null; +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAValidatorConfigLoader.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAValidatorConfigLoader.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/Pi4SOAValidatorConfigLoader.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,69 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb.pi4soa; + +import org.jboss.savara.validator.jbossesb.*; +import org.jboss.soa.esb.helpers.ConfigTree; + +/** + * This class provides the pi4soa implementation of the + * validator config loader. + */ +public class Pi4SOAValidatorConfigLoader implements ValidatorConfigLoader { + + public static final String PI4SOA_MODEL_TYPE="cdm"; + + /** + * This method determines if the validator config loader + * implementation supports the supplied model type. + * + * @param modelType The model type + * @return Whether the loader supports the model type + */ + public boolean isSupported(String modelType) { + return(PI4SOA_MODEL_TYPE.equals(modelType)); + } + + /** + * This method loads the validator config, contained within + * the supplied input stream representing a model of the + * supported type. + * + * @param is The input stream + * @param modelPath The path to the model file + * @return The validator config + * @throws java.io.IOException Failed to load validator config + */ + public ValidatorConfig loadValidatorConfig(java.io.InputStream is, + String modelPath) throws java.io.IOException { + ValidatorConfig ret=null; + + org.pi4soa.cdl.Package cdlpack= + org.pi4soa.service.util.DescriptionRetrievalUtil.instance().getCDLPackage(is); + + ValidatorConfigGenerator generator=new ValidatorConfigGenerator(); + + org.w3c.dom.Element validator= + generator.generate(cdlpack, modelPath); + + ret = new DefaultValidatorConfig(PI4SOA_MODEL_TYPE, + ConfigTree.fromElement(validator)); + + return(ret); + } +} Added: cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/ValidatorConfigGenerator.java =================================================================== --- cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/ValidatorConfigGenerator.java (rev 0) +++ cdl/trunk/validator/jbossesb/src/main/java/org/jboss/savara/validator/jbossesb/pi4soa/ValidatorConfigGenerator.java 2009-08-20 08:57:33 UTC (rev 778) @@ -0,0 +1,285 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2008, Red Hat Middleware LLC, and others contributors as indicated + * by the @authors tag. All rights reserved. + * See the copyright.txt in the distribution for a + * full listing of individual contributors. + * This copyrighted material is made available to anyone wishing to use, + * modify, copy, or redistribute it subject to the terms and conditions + * of the GNU Lesser General Public License, v. 2.1. + * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + * You should have received a copy of the GNU Lesser General Public License, + * v.2.1 along with this distribution; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +package org.jboss.savara.validator.jbossesb.pi4soa; + +import java.util.Collections; +import org.apache.log4j.Logger; + +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; + +import org.pi4soa.cdl.*; +import org.pi4soa.common.annotations.*; + +/** + * This class provides a generator for the JBossESB Validator + * configuration. + */ +public class ValidatorConfigGenerator { + + private static final String ROLE_ATTR = "role"; + private static final String MODEL_ATTR = "model"; + private static final String SERVICE_ELEMENT = "service"; + private static final String VALIDATOR_ELEMENT = "validator"; + + /** + * The default constructor. + */ + public ValidatorConfigGenerator() { + } + + /** + * This method generates the validator configuration associated + * with the supplied choreography. + * + * @param cdlpack The CDL package + * @param model The model (choreography file name) + * @return The validator config + */ + public org.w3c.dom.Element generate(org.pi4soa.cdl.Package cdlpack, + String model) { + org.w3c.dom.Element ret=null; + + try { + ret = createValidatorConfig(); + + // Create the new entries for the supplied choreography + if (cdlpack != null) { + createEntries(ret, model, cdlpack); + } else { + logger.error("Choreography not supplied for '"+model+"'"); + } + + } catch(Exception e) { + e.printStackTrace(); + } + + return(ret); + } + + /** + * This method creates the initial template for the + * validator config. + * + * @return The initial validator config + * @throws Exception Failed to generate validator config + */ + protected org.w3c.dom.Element createValidatorConfig() + throws Exception { + org.w3c.dom.Element ret=null; + + org.w3c.dom.Document doc= + javax.xml.parsers.DocumentBuilderFactory. + newInstance().newDocumentBuilder().newDocument(); + + ret = doc.createElement(VALIDATOR_ELEMENT); + + doc.appendChild(ret); + + return(ret); + } + + /** + * This method creates the entries in the validator config. + * + * @param validator The validator config + * @param model The model + * @param cdlpack The choreography description + */ + protected void createEntries(org.w3c.dom.Element validator, + String model, org.pi4soa.cdl.Package cdlpack) { + + for (int i=0; i < cdlpack.getTypeDefinitions().getParticipantTypes().size(); i++) { + org.pi4soa.cdl.ParticipantType ptype= + cdlpack.getTypeDefinitions().getParticipantTypes().get(i); + + org.w3c.dom.Element service= + validator.getOwnerDocument().createElement(SERVICE_ELEMENT); + + service.setAttribute(MODEL_ATTR, model); + service.setAttribute(ROLE_ATTR, ptype.getName()); + + cdlpack.visit(new InputOutputAnalyser(ptype, service)); + + if (service.getFirstChild() != null) { + validator.appendChild(service); + } + } + } + + private static Logger logger = Logger.getLogger(ValidatorConfigGenerator.class); + + public class InputOutputAnalyser extends DefaultCDLVisitor { + + private static final String DYNAMIC_REPLY_TO_ATTR = "dynamicReplyTo"; + private static final String JBOSSESB_ANNOTATION = "jbossesb"; + private static final String JBOSSESB_ELEMENT = "jbossesb"; + private static final String DESTINATION_ELEMENT = "destination"; + private static final String NAME_ATTR = "name"; + private static final String EPR_ATTR = "epr"; + private static final String INPUT_ELEMENT = "input"; + private static final String OUTPUT_ELEMENT = "output"; + + public InputOutputAnalyser(org.pi4soa.cdl.ParticipantType ptype, + org.w3c.dom.Element service) { + m_participantType = ptype; + m_service = service; + + m_templateProcessor = + org.pi4soa.common.annotations.AnnotationsManagerFactory.getAnnotationsManager().getTemplateProcessor(JBOSSESB_ANNOTATION); + } + + /** + * This method inspects the supplied interaction. + * + */ + public void interaction(Interaction interaction) { + if (m_participantType.getRoleTypes().contains(interaction.getFromRoleType()) || + (interaction.getFromParticipant() != null && + Collections.disjoint(m_participantType.getRoleTypes(), + interaction.getFromParticipant().getRoleTypes()) == false)) { + + for (int i=0; i < interaction.getExchangeDetails().size(); i++) { + processExchangeDetails(interaction.getExchangeDetails().get(i), true); + } + } else if (m_participantType.getRoleTypes().contains(interaction.getToRoleType()) || + (interaction.getToParticipant() != null && + Collections.disjoint(m_participantType.getRoleTypes(), + interaction.getToParticipant().getRoleTypes()) == false)) { + for (int i=0; i < interaction.getExchangeDetails().size(); i++) { + processExchangeDetails(interaction.getExchangeDetails().get(i), false); + } + } + } + + /** + * This method checks the supplied exchange details to determine + * if there is a 'jbossesb' annotation containing information + * about a destination to be validated. + * + * @param details The exchange details + * @param from Whether the 'from' details should be checked, + * otherwise the 'to' details will be checked + */ + protected void processExchangeDetails(ExchangeDetails details, boolean from) { + + for (int i=0; i < details.getSemanticAnnotations().size(); i++) { + SemanticAnnotation sa=details.getSemanticAnnotations().get(i); + org.w3c.dom.Element dest=null; + + if (sa.getAnnotation() != null && sa.getName() != null && + sa.getName().equals(JBOSSESB_ANNOTATION)) { + try { + // Transform the text representation to DOM + DocumentBuilderFactory fact=DocumentBuilderFactory.newInstance(); + fact.setNamespaceAware(true); + + DocumentBuilder builder=fact.newDocumentBuilder(); + org.w3c.dom.Document doc= + builder.parse(new java.io.ByteArrayInputStream( + sa.getAnnotation().getBytes())); + + if (doc.getDocumentElement() != null && + doc.getDocumentElement().getNodeName().equals( + JBOSSESB_ELEMENT)) { + org.w3c.dom.NodeList nl= + doc.getDocumentElement().getElementsByTagName(DESTINATION_ELEMENT); + + if (nl.getLength() == 1) { + dest = (org.w3c.dom.Element)nl.item(0); + } else if (nl.getLength() > 1) { + logger.error("Too many destination elements ("+ + nl.getLength()+") found"); + } else { + logger.error("No destinations found"); + } + } + + } catch(Exception e) { + logger.error("Failed to load jbossesb annotation", e); + } + } + + if (dest != null) { + processDestination(details, dest, from); + } + } + } + + /** + * This method processes the destination information + * associated with the exchange details. + * + * @param details The exchange details + * @param dest The destination DOM element + * @param from Whether the 'from' or 'to' role should + * be considered + */ + protected void processDestination(ExchangeDetails details, + org.w3c.dom.Element dest, boolean from) { + String elemName=null; + + if (dest != null) { + if (from) { + if (details.getAction() == ExchangeActionType.REQUEST) { + elemName = OUTPUT_ELEMENT; + } else { + elemName = INPUT_ELEMENT; + } + } else { + if (details.getAction() == ExchangeActionType.REQUEST) { + elemName = INPUT_ELEMENT; + } else { + elemName = OUTPUT_ELEMENT; + } + } + + org.w3c.dom.Element elem=m_service.getOwnerDocument().createElement(elemName); + + // Parameter has been stored in a structured manner + // to support use of templates and presentations, + // so need to extract the value + java.util.List<TemplateParameter> params= + m_templateProcessor.getTemplateParameters(dest.getAttribute(NAME_ATTR)); + + if (params != null && params.size() > 0) { + elem.setAttribute(EPR_ATTR, params.get(0).getValue()); + } + + if (dest.hasAttribute(DYNAMIC_REPLY_TO_ATTR)) { + params=m_templateProcessor.getTemplateParameters(dest.getAttribute(DYNAMIC_REPLY_TO_ATTR)); + + if (params != null && params.size() > 0) { + + if (params.get(0).getValue().equalsIgnoreCase("true")) { + elem.setAttribute(DYNAMIC_REPLY_TO_ATTR, "true"); + } + } + } + + if (elem.hasAttribute(EPR_ATTR)) { + m_service.appendChild(elem); + } + } + } + + private ParticipantType m_participantType=null; + private org.w3c.dom.Element m_service=null; + private org.pi4soa.common.annotations.TemplateProcessor m_templateProcessor=null; + } +}