D-Net

{"type_source": "SVN", "goal": "package -U -T 4C source:jar", "url": "http://svn-public.driver.research-infrastructures.eu/driver/dnet40/modules/cnr-service-common/trunk/", "deploy_repository": "dnet4-snapshots", "version": "4", "mail": "sandro.labruzzo@isti.cnr.it,michele.artini@isti.cnr.it, claudio.atzori@isti.cnr.it, alessia.bardi@isti.cnr.it", "deploy_repository_url": "http://maven.research-infrastructures.eu/nexus/content/repositories/dnet4-snapshots", "name": "cnr-service-common"}

package eu.dnetlib.enabling.tools;

import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertNotNull;

import static org.junit.Assert.assertTrue;

import static org.mockito.Matchers.anyString;

import static org.mockito.Mockito.when;

import java.util.ArrayList;

import java.util.List;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.mockito.Mock;

import org.mockito.runners.MockitoJUnit44Runner;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpException;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpService;

import eu.dnetlib.enabling.tools.registration.ServiceNameResolver;

import eu.dnetlib.soap.cxf.StandaloneCxfEndpointReferenceBuilder;

/**

 * Test the dynamic service enumerator.

 *

 * @author marko

 *

 */

@RunWith(MockitoJUnit44Runner.class)

public class DynamicServiceEnumeratorTest {

	/**

	 * Dummy service interface.

	 *

	 * @author marko

	 *

	 */

	interface TestService {

	}

	/**

	 * instance under test.

	 */

	private transient DynamicServiceEnumerator<TestService> enumerator;

	/**

	 * lookup service locator mock

	 */

	@Mock

	private transient ISLookUpService lookUpService;

	/**

	 * lookup mock locator.

	 */

	private transient ServiceLocator<ISLookUpService> lookUpLocator;

	/**

	 * service name resolver mock.

	 */

	@Mock

	private transient ServiceNameResolver nameResolver;

	/**

	 * epr builder.

	 */

	StandaloneCxfEndpointReferenceBuilder eprBuilder;

	/**

	 * common preparation.

	 */

	@Before

	public void setUp()  {

		lookUpLocator = new StaticServiceLocator<ISLookUpService>(lookUpService);

		eprBuilder = new StandaloneCxfEndpointReferenceBuilder();

		enumerator = new DynamicServiceEnumerator<TestService>(TestService.class);

		enumerator.setLookUpLocator(lookUpLocator);

		enumerator.setServiceNameResolver(nameResolver);

		enumerator.setEprBuilder(eprBuilder);

		when(nameResolver.getName(TestService.class)).thenReturn("TestService");

	}

	/**

	 * test get services.

	 *

	 * @throws ISLookUpException mock exception

	 */

	@Test

	public void testGetServices() throws ISLookUpException {

		List<String> services = new ArrayList<String>();

		services.add("<service><id>123</id><url>http://test.com</url></service>");

		when(lookUpService.quickSearchProfile(anyString())).thenReturn(services);

		List<ServiceRunningInstance<TestService>> instances = enumerator.getServices();

		assertEquals("query size", 1, instances.size());

		assertEquals("service id", "123", instances.get(0).getServiceId());

		assertEquals("service url", "http://test.com", instances.get(0).getUrl());

		assertNotNull("service epr", instances.get(0).getEpr());

	}

	@Test

	public void testEmptyGetServices() throws ISLookUpException {

		List<String> services = new ArrayList<String>();

		when(lookUpService.quickSearchProfile(anyString())).thenReturn(services);

		List<ServiceRunningInstance<TestService>> instances = enumerator.getServices();

		assertTrue("empty", instances.isEmpty());

	}

}

package eu.dnetlib.enabling.tools;

import static org.junit.Assert.*; // NOPMD

import static org.mockito.Matchers.*; // NOPMD

import static org.mockito.Mockito.*; // NOPMD

import java.util.List;

import javax.xml.ws.wsaddressing.W3CEndpointReference;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.test.context.ContextConfiguration;

import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpException;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpService;

import eu.dnetlib.enabling.resultset.rmi.ResultSetService;

/**

 * Test dynamic service locator.

 *

 * @author marko

 *

 */

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration

public class DynamicServiceLocatorTest {

	/**

	 * instance under test.

	 */

	@Autowired

	private transient DynamicServiceLocator<ResultSetService> serviceLocator;

	/**

	 * list of mock service profiles saved in files.

	 */

	@javax.annotation.Resource(name = "serviceProfiles")

	private transient List<String> serviceUris;

	/**

	 * service resolver mock.

	 */

	private transient ServiceResolver serviceResolver;

	/**

	 * setup.

	 *

	 * @throws ISLookUpException

	 *             mock

	 */

	@Before

	public void setUp() throws ISLookUpException {

//		final ISLookUpService lookupService = mock(ISLookUpService.class);

//		serviceLocator.setLookUpLocator(new StaticServiceLocator<ISLookUpService>(lookupService));

		serviceResolver = mock(ServiceResolver.class);

		serviceLocator.setServiceResolver(serviceResolver);

		final ISLookUpService lookupService = serviceLocator.getLookUpLocator().getService();

		when(lookupService.quickSearchProfile(anyString())).thenReturn(serviceUris);

	}

	/**

	 * test get service.

	 */

	@Test

	public void testGetService() {

		assertNull("dummy", serviceLocator.getService());

		verify(serviceResolver).getService(eq(ResultSetService.class), (W3CEndpointReference) anyObject());

	}

}

package eu.dnetlib.enabling.tools.registration;

import static org.junit.Assert.assertEquals;

import org.junit.Before;

import org.junit.Test;

import eu.dnetlib.enabling.is.registry.rmi.ISRegistryService;

import eu.dnetlib.enabling.resultset.rmi.ResultSetService;

public class InterfaceServiceNameResolverCompatibilityTest {

	private transient InterfaceServiceNameResolverCompatibility resolver;

	private interface IndexService {}

	private interface ISomethingService {}

	@Before

	public void setUp() throws Exception {

		resolver = new InterfaceServiceNameResolverCompatibility();

	}

	@Test

	public void testGetNameClassOfQ() {

		assertEquals("IndexService", resolver.getName(IndexService.class));

		assertEquals("SomethingService", resolver.getName(ISomethingService.class));

		assertEquals("ISRegistryService", resolver.getName(ISRegistryService.class));

		assertEquals("ResultSetService", resolver.getName(ResultSetService.class));

	}

}

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"

	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"

	xmlns:util="http://www.springframework.org/schema/util"

	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd

		http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">

	<bean id="propertyConfigurer"

		class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">

		<property name="properties">

			<props>

				<prop key="transport.soap.baseAddress">http://localhost:8090/app/services/

				</prop>

				<prop key="infrastructure.name">junitTest</prop>

				<prop key="transport.soap.force.local.address">true</prop>

			</props>

		</property>

	</bean>

	<import

		resource="classpath:/eu/dnetlib/soap/cxf/applicationContext-eprbuilders.xml" />

	<bean id="defaultServiceNameResolver"

		class="eu.dnetlib.enabling.tools.registration.InterfaceServiceNameResolver" />

	<bean id="dynamicLocator" class="eu.dnetlib.enabling.tools.DynamicServiceLocator"

		p:clazz="eu.dnetlib.enabling.resultset.rmi.ResultSetService">

		<property name="lookUpLocator">

			<bean class="eu.dnetlib.enabling.tools.StaticServiceLocator">

				<property name="service">

					<bean class="eu.dnetlib.test.utils.MockBeanFactory" p:clazz="eu.dnetlib.enabling.is.lookup.rmi.ISLookUpService" />

				</property>

			</bean>

		</property>

	</bean>

	<util:list id="serviceProfiles">

		<value><![CDATA[<service><id>1234</id><url>http://localhost:1234/app/services/resultSet</url></service>]]>

		</value>

		<value><![CDATA[<service><id>1234</id><url>http://localhost:8090/otherContext/services/resultSet</url></service>]]>

		</value>

		<value><![CDATA[<service><id>1234</id><url>http://localhost:8090/app/services/resultSet</url></service>]]>

		</value>

		<value><![CDATA[<service><id>1234</id><url>http://192.168.1.12:8090/app/services/resultSet</url></service>]]>

		</value>

	</util:list>

</beans>

package eu.dnetlib.enabling.tools;

import java.net.MalformedURLException;

import java.net.URL;

/**

 * Implementors of this interface provide custom methods to assign scores to services based solely on their location.

 * @author marko

 *

 */

public interface DynamicServiceLocatorLocationScorer {

	/**

	 * Compute the score assigned to a given service location (url).

	 * 

	 * @param url service url

	 * @return score (the higher the better)

	 * @throws MalformedURLException could happen

	 */

	int score(URL url) throws MalformedURLException;

}

package eu.dnetlib.enabling.tools;

import java.net.MalformedURLException;

import java.net.URL;

import javax.annotation.Resource;

import eu.dnetlib.soap.cxf.StandaloneCxfEndpointReferenceBuilder;

/**

 * Assign better scores for near services. Can be configured.

 * 

 * @author marko

 *

 */

public class DefaultServiceLocatorLocationScorer implements DynamicServiceLocatorLocationScorer {

	/**

	 * default score assigned when the other service has the same host.

	 */

	private static final int LOCAL_HOST_SCORE = 5;

	/**

	 * default score assigned when the other service has the same host and port (same container).

	 */

	private static final int LOCAL_PORT_SCORE = 10;

	/**

	 * default score assigned when the other service has the same host and port (same container and context).

	 */

	private static final int LOCAL_SRV_SCORE = 15;

	/**

	 * score assigned when the other service has the same host.

	 */

	private int localHostScore = LOCAL_HOST_SCORE;

	/**

	 * score assigned when the other service has the same host and port (same container).

	 */

	private int localPortScore = LOCAL_PORT_SCORE;

	/**

	 * score assigned when the other service has the same host and port (same container and context).

	 */

	private int localSrvScore = LOCAL_SRV_SCORE; 

	/**

	 * build epr.

	 */

	@Resource

	private StandaloneCxfEndpointReferenceBuilder eprBuilder;

	/** 

	 * {@inheritDoc}

	 * @throws MalformedURLException 

	 * @see eu.dnetlib.enabling.tools.DynamicServiceLocatorLocationScorer#score(java.net.URL)

	 */

	@Override

	public int score(final URL url) throws MalformedURLException {

		final URL localBase = new URL(eprBuilder.getBaseAddress());

		if (url.toString().startsWith(localBase.toString()))

			return localSrvScore;

		if (localBase.getHost().equals(url.getHost())) {

			if (localBase.getPort() == url.getPort())

				return localPortScore;

			return localHostScore;

		}

		return 0;

	}

	public StandaloneCxfEndpointReferenceBuilder getEprBuilder() {

		return eprBuilder;

	}

	public void setEprBuilder(final StandaloneCxfEndpointReferenceBuilder eprBuilder) {

		this.eprBuilder = eprBuilder;

	}

	public int getLocalHostScore() {

		return localHostScore;

	}

	public void setLocalHostScore(final int localHostScore) {

		this.localHostScore = localHostScore;

	}

	public int getLocalPortScore() {

		return localPortScore;

	}

	public void setLocalPortScore(final int localPortScore) {

		this.localPortScore = localPortScore;

	}

	public int getLocalSrvScore() {

		return localSrvScore;

	}

	public void setLocalSrvScore(final int localSrvScore) {

		this.localSrvScore = localSrvScore;

	}

}

package eu.dnetlib.enabling.tools;

/**

 * simplest HNM locator: doesn't find any.

 * 

 * @author marko

 *

 */

public class NullHNMLocator implements HNMLocator {

	/** 

	 * {@inheritDoc}

	 * @see eu.dnetlib.enabling.tools.HNMLocator#getHNMForUrl(java.lang.String)

	 */

	@Override

	public String getHNMForUrl(final String url) {

		return "";

	}

}

package eu.dnetlib.enabling.tools;

import java.util.List;

/**

 * A service enumerator returns a bunch of service descriptions. The logic depends on the service enumerator.

 *

 * @author marko

 *

 */

public interface ServiceEnumerator<T> {

	/**

	 * Obtain a list of services.

	 *

	 * @return a list of service running instance descriptions

	 */

	List<ServiceRunningInstance<T>> getServices();

}

package eu.dnetlib.enabling.tools;

import java.util.Date;

import org.w3c.dom.Document;

/**

 * Some services, in particular the enabling layer, needs to manipulate all types of resources without knowing the exact

 * structure of their content, but only some well defined properties defined here.

 * 

 * <p>

 * Different wrappers can be provided for different kind of resources. For example resources returned from the xmldb

 * layer can be cheaply mapped to an OpaqueResource, without going to full xml->bean conversion.

 * </p>

 * 

 * @author marko

 * 

 */

public interface OpaqueResource {

	/**

	 * Resource type.

	 * 

	 * @return resource type string

	 */

	String getResourceType();

	/**

	 * Resource kind.

	 * 

	 * @return resource kind string

	 */

	String getResourceKind();

	/**

	 * Resource identifier.

	 * 

	 * @return resource identifier string

	 */

	String getResourceId();

	/**

	 * Resource URI.

	 * 

	 * @return resource uri string

	 */

	String getResourceUri();

	/**

	 * get modification time stamp.

	 * 

	 * @return time stamp

	 */

	Date getModificationDate();

	/**

	 * Implementors may need to serialize the resource to a xml string representation.

	 * 

	 * @return xml serialization

	 */

	String asString();

	/**

	 * Implementors may store the DOM in the first place. Otherwise they should

	 * return a parsed w3c DOM instance.

	 * 

	 * @return DOM document

	 */

	Document asDom();

	/**

	 * change the resource identifier.

	 * 

	 * @param identifier new identifier

	 */

	void setResourceId(String identifier);

	/**

	 * change the resource kind.

	 * 

	 * @param kind new kind

	 */

	void setResourceKind(String kind);

	/**

	 * change the resource uri.

	 * 

	 * @param uri new uri

	 */

	void setResourceUri(String uri);

	/**

	 * set modification timestamp.

	 * 

	 * @param timeStamp modification time stamp

	 */

	void setModificationDate(Date timeStamp);

}

package eu.dnetlib.enabling.tools;

import java.io.StringWriter;

import java.util.Date;

import javax.xml.transform.Transformer;

import javax.xml.transform.TransformerConfigurationException;

import javax.xml.transform.TransformerException;

import javax.xml.transform.TransformerFactory;

import javax.xml.transform.TransformerFactoryConfigurationError;

import javax.xml.transform.dom.DOMSource;

import javax.xml.transform.stream.StreamResult;

import javax.xml.xpath.XPath;

import javax.xml.xpath.XPathConstants;

import javax.xml.xpath.XPathExpressionException;

import javax.xml.xpath.XPathFactory;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.w3c.dom.Document;

import org.w3c.dom.Element;

import eu.dnetlib.miscutils.datetime.DateUtils;

/**

 * OpaqueResource holding a plain old DOM document.

 *

 * @author marko

 *

 */

public class DOMOpaqueResource implements OpaqueResource {

	/**

	 * xpath expression error message.

	 */

	private static final String XPATH_ERROR = "cannot compile xpath expression";

	/**

	 * value attribute.

	 */

	private static final String VALUE_ATTR = "value";

	/**

	 * logger.

	 */

	private static final Log log = LogFactory.getLog(DOMOpaqueResource.class); // NOPMD by marko on 11/24/08 5:02 PM

	/**

	 * resource identifier.

	 */

	private String resourceId;

	/**

	 * resource type.

	 */

	private String resourceType;

	/**

	 * resource kind.

	 */

	private String resourceKind;

	/**

	 * resource uri.

	 */

	private String resourceUri;

	/**

	 * modification time stamp.

	 */

	private Date modificationDate;

	/**

	 * original document DOM.

	 */

	private Document dom;

	/**

	 * xslt transformer instance.

	 */

	private Transformer transformer;

	/**

	 * construct a DOMOpaqueInstance from a W3C DOM document.

	 *

	 * @param dom

	 *            DOM document

	 * @throws XPathExpressionException

	 *             happens

	 */

	public DOMOpaqueResource(final Document dom) throws XPathExpressionException {

		this.dom = dom;

		try {

			transformer = TransformerFactory.newInstance().newTransformer();

		} catch (TransformerConfigurationException e) {

			throw new IllegalStateException("transformer configuration", e);

		} catch (TransformerFactoryConfigurationError e) {

			throw new IllegalStateException("transformer configuration", e);

		}

		final XPath xpath = XPathFactory.newInstance().newXPath();

		this.resourceId = xpath.evaluate("/RESOURCE_PROFILE/HEADER/RESOURCE_IDENTIFIER/@value", dom);

		this.resourceType = xpath.evaluate("/RESOURCE_PROFILE/HEADER/RESOURCE_TYPE/@value", dom);

		this.resourceKind = xpath.evaluate("/RESOURCE_PROFILE/HEADER/RESOURCE_KIND/@value", dom);

		this.resourceUri = xpath.evaluate("/RESOURCE_PROFILE/HEADER/RESOURCE_URI/@value", dom);

		String modificationDateSource = xpath.evaluate("/RESOURCE_PROFILE/HEADER/DATE_OF_CREATION/@value", dom);

		try {

			this.modificationDate = new DateUtils().parse(modificationDateSource);

		} catch (IllegalStateException e) {

			log.debug("invalid date '" + modificationDateSource + "'", e);

		}

	}

	/**

	 * {@inheritDoc}

	 *

	 * @see eu.dnetlib.enabling.tools.OpaqueResource#asDom()

	 */

	@Override

	public Document asDom() {

		return getDom();

	}

	/**

	 * {@inheritDoc}

	 *

	 * @see eu.dnetlib.enabling.tools.OpaqueResource#asString()

	 */

	@Override

	public String asString() {

		final StringWriter writer = new StringWriter();

		try {

			transformer.transform(new DOMSource(getDom()), new StreamResult(writer));

		} catch (TransformerException e) {

			log.fatal("cannot serialize document", e);

			return null;

		}

		return writer.toString();

	}

	public Document getDom() {

		return dom;

	}

	public void setDom(final Document dom) {

		this.dom = dom;

	}

	@Override

	public String getResourceId() {

		return resourceId;

	}

	@Override

	public String getResourceType() {

		return resourceType;

	}

	public void setResourceType(final String resourceType) {

		this.resourceType = resourceType;

	}

	@Override

	public String getResourceKind() {

		return resourceKind;

	}

	/**

	 * {@inheritDoc}

	 *

	 * @see eu.dnetlib.enabling.tools.OpaqueResource#setResourceKind(java.lang.String)

	 */

	@Override

	public void setResourceKind(final String resourceKind) {

		try {

			final XPath xpath = XPathFactory.newInstance().newXPath();

			final Element kindEl = (Element) xpath.evaluate("/RESOURCE_PROFILE/HEADER/RESOURCE_KIND", asDom(), XPathConstants.NODE);

			kindEl.setAttribute(VALUE_ATTR, resourceKind);

			this.resourceKind = resourceKind;

		} catch (XPathExpressionException e) {

			throw new IllegalStateException(XPATH_ERROR, e);

		}

	}

	/**

	 * {@inheritDoc}

	 *

	 * @see eu.dnetlib.enabling.tools.OpaqueResource#setResourceId(java.lang.String)

	 */

	@Override

	public void setResourceId(final String identifier) {

		try {

			final XPath xpath = XPathFactory.newInstance().newXPath();

			final Element idEl = (Element) xpath.evaluate("/RESOURCE_PROFILE/HEADER/RESOURCE_IDENTIFIER", asDom(), XPathConstants.NODE);

			idEl.setAttribute(VALUE_ATTR, identifier);

			resourceId = identifier;

		} catch (XPathExpressionException e) {

			throw new IllegalStateException(XPATH_ERROR, e);

		}

	}

	@Override

	public Date getModificationDate() {

		return modificationDate;

	}

	/**

	 * {@inheritDoc}

	 *

	 * @see eu.dnetlib.enabling.tools.OpaqueResource#setModificationDate(java.util.Date)

	 */

	@Override

	public void setModificationDate(final Date modificationDate) {

		try {

			final XPath xpath = XPathFactory.newInstance().newXPath();

			final Element idEl = (Element) xpath.evaluate("/RESOURCE_PROFILE/HEADER/DATE_OF_CREATION", asDom(), XPathConstants.NODE);

			if (idEl == null) {

				log.warn("resource with type " + getResourceType() + " has no date of creation element");

				return;

			}

			idEl.setAttribute(VALUE_ATTR, new DateUtils(modificationDate).getDateAsISO8601String());

			this.modificationDate = modificationDate;

		} catch (XPathExpressionException e) {

			throw new IllegalStateException(XPATH_ERROR, e);

		}

	}

	@Override

	public String getResourceUri() {

		return resourceUri;

	}

	/**

	 * {@inheritDoc}

	 *

	 * @see eu.dnetlib.enabling.tools.OpaqueResource#setResourceUri(java.lang.String)

	 */

	@Override

	public void setResourceUri(final String resourceUri) {

		try {

			final XPath xpath = XPathFactory.newInstance().newXPath();

			final Element uriEl = (Element) xpath.evaluate("/RESOURCE_PROFILE/HEADER/RESOURCE_URI", asDom(), XPathConstants.NODE);

			uriEl.setAttribute(VALUE_ATTR, resourceUri);

			this.resourceUri = resourceUri;

		} catch (XPathExpressionException e) {

			throw new IllegalStateException(XPATH_ERROR, e);

		}

	}

	public Transformer getTransformer() {

		return transformer;

	}

	public void setTransformer(final Transformer transformer) {

		this.transformer = transformer;

	}

}

package eu.dnetlib.enabling.tools;

/**

 * finds an HNM profile for a giver service url.

 * 

 * @author marko

 *

 */

public interface HNMLocator {

	/**

	 * finds an HNM profile for a giver service url.

	 * 

	 * @param url service address

	 * @return hnm id

	 */

	String getHNMForUrl(String url);

}

package eu.dnetlib.enabling.tools;

import java.io.IOException;

import java.io.StringReader;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import javax.annotation.Resource;

import javax.xml.parsers.DocumentBuilder;

import javax.xml.parsers.DocumentBuilderFactory;

import javax.xml.parsers.ParserConfigurationException;

import javax.xml.ws.wsaddressing.W3CEndpointReference;

import javax.xml.xpath.XPath;

import javax.xml.xpath.XPathConstants;

import javax.xml.xpath.XPathExpressionException;

import javax.xml.xpath.XPathFactory;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.springframework.beans.factory.annotation.Required;

import org.w3c.dom.Document;

import org.w3c.dom.Element;

import org.w3c.dom.NodeList;

import org.xml.sax.InputSource;

import org.xml.sax.SAXException;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpException;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpService;

import eu.dnetlib.enabling.tools.registration.ServiceNameResolver;

import eu.dnetlib.miscutils.collections.EnsureCollection;

import eu.dnetlib.soap.cxf.StandaloneCxfEndpointReferenceBuilder;

/**

 * Enumerates all services of a given type.

 *

 * @author marko

 *

 * @param <T>

 *            service class

 */

public class DynamicServiceEnumerator<T> implements ServiceEnumerator<T> {

	/**

	 * logger.

	 */

	private static final Log log = LogFactory.getLog(DynamicServiceEnumerator.class); // NOPMD by marko on 11/24/08 5:02 PM

	/**

	 * service class

	 */

	private Class<T> clazz;

	/**

	 * lookup locator.

	 */

	private ServiceLocator<ISLookUpService> lookUpLocator;

	/**

	 * service name resolver.

	 */

	@Resource

	private ServiceNameResolver serviceNameResolver; // NOPMD

	/**

	 * build epr.

	 */

	@Resource

	private StandaloneCxfEndpointReferenceBuilder eprBuilder;

	/**

	 * default constructor, useful for spring based instantiation.

	 */

	public DynamicServiceEnumerator() {

		// default

	}

	/**

	 * Build a dynamic service enumerator for a given class

	 *

	 * @param clazz

	 *            class

	 */

	public DynamicServiceEnumerator(final Class<T> clazz) {

		super();

		this.clazz = clazz;

	}

	/**

	 * {@inheritDoc}

	 *

	 * @see eu.dnetlib.enabling.tools.ServiceEnumerator#getServices()

	 */

	@Override

	public List<ServiceRunningInstance<T>> getServices() {

		final String serviceName = serviceNameResolver.getName(clazz);

		log.debug("searching for service: " + serviceName);

		final String xquery = "for $x in collection('/db/DRIVER/ServiceResources')//RESOURCE_PROFILE[.//RESOURCE_TYPE/@value/string() = '"

				+ serviceName

				+ "ResourceType'] return <service><id>{$x//RESOURCE_IDENTIFIER/@value/string()}</id><url>{$x//PROTOCOL[@name = 'SOAP']/@address/string()}</url><properties>{$x//SERVICE_PROPERTIES/PROPERTY}</properties></service>";

		log.debug(xquery);

		final XPathFactory factory = XPathFactory.newInstance();

		final XPath xpath = factory.newXPath();

		final DocumentBuilderFactory docFactory = DocumentBuilderFactory.newInstance();

		try {

			final DocumentBuilder docBuilder = docFactory.newDocumentBuilder();

			final List<String> services = lookUpLocator.getService().quickSearchProfile(xquery);

			final List<ServiceRunningInstance<T>> instances = new ArrayList<ServiceRunningInstance<T>>();

			for (final String source : EnsureCollection.list(services)) {

				final Document doc = docBuilder.parse(new InputSource(new StringReader(source)));

				final String url = xpath.evaluate("//url", doc);

				final String serviceId = xpath.evaluate("//id", doc);

				final NodeList propElements = (NodeList) xpath.evaluate("//PROPERTY", doc, XPathConstants.NODESET);

				Map<String, String> props = new HashMap<String, String>();

				for (int i = 0; i < propElements.getLength(); i++) {

					Element propElement = (Element) propElements.item(i);

					props.put(propElement.getAttribute("key"), propElement.getAttribute("value"));

				}

				final W3CEndpointReference epr = eprBuilder.getEndpointReference(url, null, null, url + "?wsdl", null, null);

				instances.add(new ServiceRunningInstance<T>(epr, serviceId, url, props));

			}

			return instances;

		} catch (final ISLookUpException e) {

			throw new IllegalStateException("cannot locate service " + serviceName, e);

		} catch (final XPathExpressionException e) {

			throw new IllegalStateException("cannot locate service " + serviceName, e);

		} catch (final SAXException e) {

			throw new IllegalStateException("cannot locate service " + serviceName, e);

		} catch (final IOException e) {

			throw new IllegalStateException("cannot locate service " + serviceName, e);

		} catch (final ParserConfigurationException e) {

			throw new IllegalStateException("cannot locate service " + serviceName, e);

		}

	}

	public Class<T> getClazz() {

		return clazz;

	}

	@Required

	public void setClazz(final Class<T> clazz) {

		this.clazz = clazz;

	}

	public ServiceLocator<ISLookUpService> getLookUpLocator() {

		return lookUpLocator;

	}

	public void setLookUpLocator(final ServiceLocator<ISLookUpService> lookUpLocator) {

		this.lookUpLocator = lookUpLocator;

	}

	public ServiceNameResolver getServiceNameResolver() {

		return serviceNameResolver;

	}

	public void setServiceNameResolver(final ServiceNameResolver serviceNameResolver) {

		this.serviceNameResolver = serviceNameResolver;

	}

	public StandaloneCxfEndpointReferenceBuilder getEprBuilder() {

		return eprBuilder;

	}

	public void setEprBuilder(StandaloneCxfEndpointReferenceBuilder eprBuilder) {

		this.eprBuilder = eprBuilder;

	}

}

package eu.dnetlib.enabling.tools;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpDocumentNotFoundException;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpException;

import eu.dnetlib.enabling.is.lookup.rmi.ISLookUpService;

/**

 * Locates a registered HNM running on a given url.

 *

 * @author marko

 *

 */

public class DynamicHNMLocator implements HNMLocator {

	/**

	 * logger.

	 */

	private static final Log log = LogFactory.getLog(DynamicHNMLocator.class); // NOPMD by marko on 11/24/08 5:02 PM

	/**

	 * is lookup locator.

	 */

	ServiceLocator<ISLookUpService> lookupLocator;

	/**

	 * {@inheritDoc}

	 *

	 * @see eu.dnetlib.enabling.tools.HNMLocator#getHNMForUrl(java.lang.String)

	 */

	@Override

	public String getHNMForUrl(final String url) {

		final String prefix = url.substring(0, url.indexOf('/', "http://".length()));

		final String query = "collection('')//RESOURCE_PROFILE[.//RESOURCE_TYPE/@value = 'HostingNodeManagerServiceResourceType' and starts-with(.//RESOURCE_URI/@value, '"

				+ prefix + "')]//RESOURCE_IDENTIFIER/@value/string()";

		try {

			return lookupLocator.getService().getResourceProfileByQuery(query);

		} catch (final ISLookUpDocumentNotFoundException e) {

			log.debug("doument not found for query: " + query);

			return null;

		} catch (final ISLookUpException e) {

			throw new IllegalStateException("cannot search hnm", e);

		}

	}

	public ServiceLocator<ISLookUpService> getLookupLocator() {

		return lookupLocator;

	}

	public void setLookupLocator(final ServiceLocator<ISLookUpService> lookupLocator) {

		this.lookupLocator = lookupLocator;

	}

}

package eu.dnetlib.enabling.tools; // NOPMD

import java.io.IOException;

import java.io.InputStream;

import java.io.StringWriter;

import javax.xml.parsers.ParserConfigurationException;

import javax.xml.xpath.XPathExpressionException;

import org.apache.commons.io.IOUtils;

import org.xml.sax.SAXException;

/**

 * implements a possibly optimized OpaqueResource constructed from a stream containing the xml source.

 * 

 * <p>the optimization consists of postponing the parsing as possibly and parse the profile passing the stream

 * directly to the xml parser.<p>

 * 

 * <p>

 * TODO: implement the optimization, currenly converts to string and reuses StringOpaqueResource

 * </p>

 * 

 * @author marko

 *

 */

public class StreamOpaqueResource extends StringOpaqueResource {

	/**

	 * construct with an input stream.

	 * 

	 * @param source source stream of xml text

	 * @throws XPathExpressionException shouldn't happen

	 * @throws SAXException could happen

	 * @throws IOException could happen

	 * @throws ParserConfigurationException shouldn't happen

	 */

	public StreamOpaqueResource(final InputStream source) throws XPathExpressionException, SAXException, IOException, ParserConfigurationException {

		super(stringify(source));

	}

	/**

	 * helper method: reads a stream to a string.

	 * 

	 * @param source input stream

	 * @return string containing the whole stream content.

	 * @throws IOException could happen.

	 */

	private static String stringify(final InputStream source) throws IOException {

		final StringWriter writer = new StringWriter();

		IOUtils.copy(source, writer);

		return writer.getBuffer().toString();

	}

}

package eu.dnetlib.enabling.tools;

/**

 * Implementations of this interface will provide functionalities useful to create xqueries or parts of thereof, like

 * xmldb collection names for a given profile.

 * 

 * @author marko

 * 

 */

public interface XQueryUtils {

	/**

	 * obtain the name of the xmldb collection for a given resource.

	 * @param resource resource

	 * @return path of the collection relative to the xmldb dnet root.

	 */

	String getCollectionPath(OpaqueResource resource);

	/**

	 * obtain the absolute xmldb collection path for a given resource.

	 * @param resource resource

	 * @return collection absolute path

	 */

	String getCollectionAbsPath(OpaqueResource resource);

	/**

	 * get the absolute xmldb collection path.

	 * 

	 * @return root xmldb root collection path

	 */

	String getRootCollection();

	/**

	 * Return the xmldb filename for a given resource.

	 * 

	 * @param resource resource

	 * @return xmldb filename

	 */

	String getFileName(OpaqueResource resource);

}

package eu.dnetlib.enabling.tools;

import javax.jws.WebService;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.springframework.context.Lifecycle;

import eu.dnetlib.common.rmi.BaseService;

/**

 * This class contains default definition for BaseService contract and basic service lifecycle.

 * 

 * TODO: split BaseService contract implementation from lifecycle and other helper method

 * 

 * @author marko

 * 

 */

@WebService(targetNamespace = "http://services.dnetlib.eu/")

public abstract class AbstractBaseService implements BaseService, Lifecycle {

	/**

	 * logger.

	 */

	private static final Log log = LogFactory // NOPMD by marko on 11/24/08 5:02 PM

			.getLog(AbstractBaseService.class);

	private boolean started = false;

	/**

	 * {@inheritDoc}

	 * 

	 * @see eu.dnetlib.common.rmi.BaseService#identify()

	 */

	@Override

	public String identify() {

		return getClass().getName();

	}

	/**

	 * {@inheritDoc}

	 * 

	 * @see eu.dnetlib.common.rmi.BaseService#notify(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

	 */

	@Override

	public void notify(final String subscriptionId, final String topic, final String isId, final String message) {

		log.debug("got notification: " + topic + ", profile: " + isId + ", body: " + message);

	}

	/**

	 * {@inheritDoc}

	 * 

	 * @see eu.dnetlib.common.rmi.BaseService#start()

	 */

	@Override

	public void start() {

		log.info("Starting service " + identify());

		if (started) {

			log.warn("Service " + this + "already started, check bean initializations!");

		}

		started = true;

	}

	/**

	 * {@inheritDoc}

	 * 

	 * @see org.springframework.context.Lifecycle#isRunning()

	 */

	@Override

	public boolean isRunning() {

		log.debug("called isRunning " + this);

		return false;

	}

	/**

	 * {@inheritDoc}

	 * 

	 * @see org.springframework.context.Lifecycle#stop()

	 */

	@Override

	public void stop() {

		log.info("Stopping service " + this);

	}

}

package eu.dnetlib.enabling.tools;

/**

 * A service locator provides a reference to a, possibly remote, service.

 * 

 * @author marko

 * 

 * @param <T>

 *            the type of the service to return

 */

public interface ServiceLocator<T> {

	/**

	 * locate an return a service of this type.

	 * 

	 * @return a service client instance

	 */

	T getService();

}

package eu.dnetlib.enabling.tools;

import java.util.ArrayList;

import java.util.List;

import javax.xml.ws.wsaddressing.W3CEndpointReference;

/**

 * This resolver chains a list of resolvers.

 * 

 * @author marko

 * 

 */

public class ServiceResolverChain implements ServiceResolver {

	/**

	 * service resolvers in decreasing order or priority.

	 */

	private List<ServiceResolver> resolvers = new ArrayList<ServiceResolver>();

	/**

	 * {@inheritDoc}

	 * 

	 * @see eu.dnetlib.enabling.tools.ServiceResolver#getService(java.lang.Class,

	 *      javax.xml.ws.wsaddressing.W3CEndpointReference)

	 */

	@Override

	public <T> T getService(final Class<T> clazz, final W3CEndpointReference epr) {

		for (ServiceResolver resolver : getResolvers()) {

			final T service = resolver.getService(clazz, epr);

			if (service != null)

				return service;

		}

		return null;

	}

	/** 

	 * {@inheritDoc}

	 * @see eu.dnetlib.enabling.tools.ServiceResolver#getResourceIdentifier(javax.xml.ws.wsaddressing.W3CEndpointReference)

	 */

	@Override

	public String getResourceIdentifier(final W3CEndpointReference epr) {

		for (ServiceResolver resolver : getResolvers()) {

			final String rsId = resolver.getResourceIdentifier(epr);

			if (rsId != null)

				return rsId;

		}

		return null;	

	}

	public List<ServiceResolver> getResolvers() {

		return resolvers;

	}

	public void setResolvers(final List<ServiceResolver> resolvers) {

		this.resolvers = resolvers;

	}

}

package eu.dnetlib.enabling.tools;

import java.util.HashMap;

import java.util.Map;

import javax.xml.ws.wsaddressing.W3CEndpointReference;

/**

 * This bean packages the minimum information for describing a service running instance.

 *

 * @author marko

 *

 */

public class ServiceRunningInstance<T> {

	/**

	 * service endpoint.

	 */

	private W3CEndpointReference epr;

	/**

	 * service resource id.

	 */

	private String serviceId;

	/**

	 * service endpoint url.

	 */

	private String url;

	/**

	 * arbitrary service properties stored in the profile.

	 */

	private Map<String, String> serviceProperties;

	/**

	 * Create a service running instance.

	 *

	 * @param epr service epr

	 * @param serviceId service profile resource id

	 * @param url service endpoint url

	 */

	public ServiceRunningInstance(final W3CEndpointReference epr, final String serviceId, final String url) {

		this(epr, serviceId, url, new HashMap<String, String>());

	}

	/**

	 * Create a service running instance.

	 *

	 * @param epr service epr

	 * @param serviceId service profile resource id

	 * @param url service endpoint url

	 * @param serviceProperties service property map

	 */

	public ServiceRunningInstance(final W3CEndpointReference epr, final String serviceId, final String url, final Map<String, String> serviceProperties) {

		super();

		this.epr = epr;

		this.serviceId = serviceId;

		this.url = url;

		this.serviceProperties = serviceProperties;

	}

	public W3CEndpointReference getEpr() {

		return epr;

	}

	public void setEpr(final W3CEndpointReference epr) {

		this.epr = epr;

	}

	public String getServiceId() {

		return serviceId;

	}

	public void setServiceId(final String serviceId) {

		this.serviceId = serviceId;

	}

	public Map<String, String> getServiceProperties() {

		return serviceProperties;

	}

	public void setServiceProperties(final Map<String, String> serviceProperties) {

		this.serviceProperties = serviceProperties;

	}

	public String getUrl() {

		return url;

	}

	public void setUrl(String url) {

		this.url = url;