gCubeSystem
/
common-scope
16
0
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity

merged from trunk for release of 1.1.0 in gCube 2.12 

git-svn-id: http://svn.research-infrastructures.eu/public/d4science/gcube/branches/common/common-scope/1.0@67131 82a268e6-3cf1-43bd-a215-b396298e98cf
This commit is contained in:
fabio.simeoni 2013-01-07 13:57:13 +00:00
parent 79ce48a995
commit 44eb64c69c
15 changed files with 479 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
.classpath
View File

@ -1,10 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="src" output="target/classes" path="src/main/java"/>
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources"/>
<classpathentry kind="src" output="target/test-classes" path="src/test/java"/>
<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/>
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER"/>
<classpathentry kind="src" output="target/classes" path="src/main/java">
<attributes>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="src" output="target/test-classes" path="src/test/java">
<attributes>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="output" path="target/classes"/>
</classpath>

8
distro/changelog.xml
View File

@ -1,5 +1,11 @@
<ReleaseNotes>
<Changeset component="${build.finalName}" date="">
<Changeset component="${build.finalName}" date="01/11/2012">
<Change>First Release</Change>
</Changeset>
<Changeset component="${build.finalName}" date="11/01/2013">
<Change>Scope can now be propagated in Callable and Runnable tasks via ScopedTasks</Change>
<Change>Scopes can now be manipulated through ScopeBean objects</Change>
<Change>Scope maps are now versioned and newer versions take precedence at startup</Change>
<Change>Scope maps can now be successfully looked up in VRE scopes (bug fix)</Change>
</Changeset>
</ReleaseNotes>

10
pom.xml
View File

@ -11,7 +11,7 @@
<groupId>org.gcube.core</groupId>
<artifactId>common-scope</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.1.0-SNAPSHOT</version>
<name>Common Scope</name>
<description>Scope-related APIs</description>
@ -33,6 +33,14 @@
<version>0.9.6</version>
</dependency>
<dependency>
<groupId>org.gcube.core</groupId>
<artifactId>common-scope-maps</artifactId>
<version>[1.0.0-SNAPSHOT,)</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>

18
src/main/java/org/gcube/common/scope/api/ServiceMap.java
View File

@ -1,7 +1,5 @@
package org.gcube.common.scope.api;
import java.util.List;
import org.gcube.common.scope.impl.ScopedServiceMap;
/**
@ -18,15 +16,25 @@ public interface ServiceMap {
public static final ServiceMap instance = new ScopedServiceMap();
/**
* Returns the endpoints of a given service.
* Returns the endpoint of a given service.
* @param service the service
* @return the endpoints, or <code>null</code> if the service is unknown.
* @return the endpoint
* @throws IllegalArgumentException if the service has no endpoint in the map
* @throws IllegalStateException if the service endpoint cannot be returned
*/
List<String> endpoint(String service);
String endpoint(String service);
/**
* Returns the associated scope.
* @return the scope
* @throws IllegalStateException if the scope of the map cannot be returned
*/
String scope();
/**
* Returns the release version of the map.
* @return the version
* @throws IllegalStateException if the version of the map cannot be returned
*/
String version();
}

21
src/main/java/org/gcube/common/scope/impl/DefaultServiceMap.java
View File

@ -1,7 +1,6 @@
package org.gcube.common.scope.impl;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import javax.xml.bind.annotation.XmlAttribute;
@ -22,8 +21,11 @@ public class DefaultServiceMap implements ServiceMap {
@XmlAttribute
private String scope;
@XmlAttribute
private String version;
@XmlJavaTypeAdapter(ServiceMapAdapter.class)
Map<String,List<String>> services = new LinkedHashMap<String,List<String>>();
Map<String,String> services = new LinkedHashMap<String,String>();
@Override
public String scope() {
@ -31,8 +33,19 @@ public class DefaultServiceMap implements ServiceMap {
}
@Override
public List<String> endpoint(String service) {
return services.get(service);
public String version() {
return version;
}
@Override
public String endpoint(String service) {
String endpoint = services.get(service);
if (endpoint==null)
throw new IllegalArgumentException("unknown service "+service);
return endpoint;
}

139
src/main/java/org/gcube/common/scope/impl/ScopeBean.java Normal file
View File

@ -0,0 +1,139 @@
package org.gcube.common.scope.impl;
/**
* A object model of a scope.
*
* @author Fabio Simeoni
*
*/
public class ScopeBean {
/**
* Scope separators used in linear syntax.
*/
protected static String separator = "/";
/**
* Scope types *
*/
public static enum Type implements Comparable<Type> {VRE,VO,INFRASTRUCTURE}
/**
* The name of the scope.
*/
private String name;
/**
* The type of the scope.
*/
private Type type;
/**
* The enclosing scope, if any.
*/
private ScopeBean enclosingScope;
/**
* Returns the name of the scope.
* @return the name
*/
public String name() {
return name;
}
/**
* Returns <code>true</code> if the scope has a given {@link Type}.
* @param type the type
* @return <code>true</code> if the scope has the given type, <code>false</code> otherwise
*/
public boolean is(Type type) {
return this.type.equals(type);
}
/**
* Returns the {@link Type} of the scope.
* @return the type
*/
public Type type() {
return type;
}
/**
* Returns the enclosing scope, if any.
* @return the enclosing scope, or <code>null</code> if the scope is top-level
*/
public ScopeBean enclosingScope() {
return enclosingScope;
}
public ScopeBean(String scope) throws IllegalArgumentException {
String[] components=scope.split(separator);
if (components.length<2 || components.length>4)
throw new IllegalArgumentException("scope "+scope+" is malformed");
if(components.length>3) {
this.name=components[3];
this.enclosingScope = new ScopeBean(separator+components[1]+separator+components[2]);
this.type=Type.VRE;
}
else if (components.length>2) {
this.name=components[2];
this.enclosingScope=new ScopeBean(separator+components[1]);
this.type=Type.VO;
}
else {
this.name=components[1];
this.type=Type.INFRASTRUCTURE;
}
}
/**
* Returns the linear expression of the scope.
*/
public String toString() {
return is(Type.INFRASTRUCTURE)?separator+name():
enclosingScope().toString()+separator+name();
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((enclosingScope == null) ? 0 : enclosingScope.hashCode());
result = prime * result + ((name == null) ? 0 : name.hashCode());
result = prime * result + ((type == null) ? 0 : type.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
ScopeBean other = (ScopeBean) obj;
if (enclosingScope == null) {
if (other.enclosingScope != null)
return false;
} else if (!enclosingScope.equals(other.enclosingScope))
return false;
if (name == null) {
if (other.name != null)
return false;
} else if (!name.equals(other.name))
return false;
if (type != other.type)
return false;
return true;
}
}

40
src/main/java/org/gcube/common/scope/impl/ScopedServiceMap.java
View File

@ -1,6 +1,7 @@
package org.gcube.common.scope.impl;
import java.util.List;
import static org.gcube.common.scope.impl.ScopeBean.Type.*;
import java.util.Map;
import org.gcube.common.scope.api.ScopeProvider;
@ -8,10 +9,10 @@ import org.gcube.common.scope.api.ServiceMap;
/**
* A {@link ServiceMap} that forwards requests to {@link ServiceMap}s associated
* with the scope of callers.
* with the current scope.
* <p>
* At construction time, it configures itself with all the service maps found
* the classpath (excluding URLs available to primordial and extension
* in the classpath (excluding URLs available to primordial and extension
* classloader). Recognises service maps as resources whose names match a
* {@link ServiceMapScanner#mapConfigPattern}.
*
@ -29,18 +30,39 @@ public class ScopedServiceMap implements ServiceMap {
@Override
public String scope() {
return ScopeProvider.instance.get();
return currentMap().scope();
}
@Override
public String version() {
return currentMap().version();
}
@Override
public List<String> endpoint(String service) {
public String endpoint(String service) throws IllegalArgumentException,IllegalStateException {
String currentScope = scope();
return currentMap().endpoint(service);
}
//helper
private ServiceMap currentMap() {
String currentScope = ScopeProvider.instance.get();
if (currentScope==null)
throw new IllegalStateException("current scope is undefined");
ScopeBean bean = new ScopeBean(currentScope);
if(bean.is(VRE))
currentScope = bean.enclosingScope().toString();
ServiceMap map = maps.get(currentScope);
return map == null ? null : map.endpoint(service);
if (map==null)
throw new IllegalStateException("a map for "+currentScope+" is undefined");
return map;
}
}

70
src/main/java/org/gcube/common/scope/impl/ScopedTasks.java Normal file
View File

@ -0,0 +1,70 @@
package org.gcube.common.scope.impl;
import java.util.concurrent.Callable;
import org.gcube.common.scope.api.ScopeProvider;
/**
* Utility to bind the execution of standard tasks to the current scope.
*
* @author Fabio Simeoni
*
*/
public class ScopedTasks {
/**
* Binds a {@link Callable} task to the current scope.
* @param task the task
* @return an equivalent {@link Callable} task bound to the current scope
*/
static public <V> Callable<V> bind(final Callable<V> task) {
final String callScope = ScopeProvider.instance.get();
return new Callable<V>() {
@Override
public V call() throws Exception {
//bind underlying thread to callscope
ScopeProvider.instance.set(callScope);
try {
return task.call();
}
finally {
ScopeProvider.instance.reset();
}
}
};
}
/**
* Binds a {@link Runnable} task to the current scope.
* @param task the task
* @return an equivalent {@link Runnable} task bound to the current scope
*/
static public <V> Runnable bind(final Runnable task) {
final String callScope = ScopeProvider.instance.get();
return new Runnable() {
@Override
public void run() {
//bind underlying thread to callscope
ScopeProvider.instance.set(callScope);
try {
task.run();
}
finally {
ScopeProvider.instance.reset();
}
}
};
}
}

19
src/main/java/org/gcube/common/scope/impl/ServiceMapAdapter.java
View File

@ -1,7 +1,6 @@
package org.gcube.common.scope.impl;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
@ -17,7 +16,7 @@ import javax.xml.bind.annotation.adapters.XmlAdapter;
* @author Fabio Simeoni
*
*/
public class ServiceMapAdapter extends XmlAdapter<ServiceMapAdapter.ValueServiceMap,Map<String,List<String>>> {
public class ServiceMapAdapter extends XmlAdapter<ServiceMapAdapter.ValueServiceMap,Map<String,String>> {
@XmlRootElement(name="services")
static class ValueServiceMap {
@ -32,25 +31,25 @@ public class ServiceMapAdapter extends XmlAdapter<ServiceMapAdapter.ValueService
@XmlAttribute
private String name;
@XmlElement(name="endpoint")
private List<String> endpoints;
@XmlAttribute
private String endpoint;
}
@Override
public Map<String, List<String>> unmarshal(ValueServiceMap valueMap) throws Exception {
Map<String, List<String>> map = new LinkedHashMap<String,List<String>>();
public Map<String,String> unmarshal(ValueServiceMap valueMap) throws Exception {
Map<String, String> map = new LinkedHashMap<String,String>();
for (ServiceEntry service : valueMap.services)
map.put(service.name,service.endpoints);
map.put(service.name,service.endpoint);
return map;
}
@Override
public ValueServiceMap marshal(Map<String, List<String>> map) throws Exception {
public ValueServiceMap marshal(Map<String, String> map) throws Exception {
ValueServiceMap valueMap = new ValueServiceMap();
for (Map.Entry<String,List<String>> e : map.entrySet()) {
for (Map.Entry<String,String> e : map.entrySet()) {
ServiceEntry entry = new ServiceEntry();
entry.name=e.getKey();
entry.endpoints = e.getValue();
entry.endpoint = e.getValue();
}
return valueMap;
}

16
src/main/java/org/gcube/common/scope/impl/ServiceMapScanner.java
View File

@ -55,10 +55,20 @@ class ServiceMapScanner {
.compile(mapConfigPattern))) {
URL url = Thread.currentThread().getContextClassLoader()
.getResource(resource);
log.trace("loading {} ", url);
log.info("loading {} ", url);
DefaultServiceMap map = (DefaultServiceMap) um.unmarshal(url);
maps.put(map.scope(), map);
}
ServiceMap current = maps.get(map.scope());
if (current!=null && current.version()!=null)
if (current.version().compareToIgnoreCase(map.version())==1) {
log.warn("discarding {} because older (v.{}) than one previously loaded (v.{}) for {} ", new Object[]{url, map.version(), current.version(), map.scope()});
continue;
}
else
log.info("overwriting older map (v.{}) with newer map (v.{}) for {} ", new Object[]{current.version(), map.version(), map.scope()});
maps.put(map.scope(), map);
}
} catch (Exception e) {
throw new RuntimeException("could not load service maps", e);
}

38
src/test/java/org/gcube/common/scope/BeanTest.java Normal file
View File

@ -0,0 +1,38 @@
package org.gcube.common.scope;
import static org.junit.Assert.*;
import org.gcube.common.scope.impl.ScopeBean;
import org.gcube.common.scope.impl.ScopeBean.Type;
import org.junit.Test;
public class BeanTest {
@Test
public void beansAreParsedCorrectly() {
String infra ="/infra";
ScopeBean infraBean = new ScopeBean(infra);
assertEquals("infra",infraBean.name());
assertTrue(infraBean.is(Type.INFRASTRUCTURE));
assertNull(infraBean.enclosingScope());
assertEquals(infra,infraBean.toString());
assertEquals(infraBean,new ScopeBean(infra));
String vo =infra+"/vo";
ScopeBean vobean = new ScopeBean(vo);
assertEquals("vo",vobean.name());
assertTrue(vobean.is(Type.VO));
assertEquals(infraBean,vobean.enclosingScope());
assertEquals(vo,vobean.toString());
String vre = vo+"/vre";
ScopeBean vrebean = new ScopeBean(vre);
assertEquals("vre",vrebean.name());
assertTrue(vrebean.is(Type.VRE));
assertEquals(vobean,vrebean.enclosingScope());
assertEquals(vre,vrebean.toString());
}
}

63
src/test/java/org/gcube/common/scope/BindingTest.java Normal file
View File

@ -0,0 +1,63 @@
package org.gcube.common.scope;
import static org.junit.Assert.*;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import org.gcube.common.scope.api.ScopeProvider;
import org.gcube.common.scope.impl.ScopedTasks;
import org.junit.Test;
public class BindingTest {
private ExecutorService executor = Executors.newSingleThreadExecutor();
@Test
public void callablesAreBound() throws Exception {
final String callScope = "somescope";
ScopeProvider.instance.set(callScope);
Callable<Void> unbound = new Callable<Void>() {
@Override
public Void call() throws Exception {
assertEquals("task thread is not bound to call scope, but to "+ScopeProvider.instance.get(),callScope,ScopeProvider.instance.get());
return null;
}
};
Callable<Void> bound = ScopedTasks.bind(unbound);
String newScope = "newscope";
//scope in current thread changes
ScopeProvider.instance.set(newScope);
//task is submittted
executor.submit(bound).get();
//resetting task
assertEquals("call thread does not retain its latest scope",newScope,ScopeProvider.instance.get());
//reset call scope
ScopeProvider.instance.reset();
Callable<Void> cleanupTest = new Callable<Void>() {
@Override
public Void call() throws Exception {
assertNull(ScopeProvider.instance.get());
return null;
}
};
executor.submit(cleanupTest).get();
}
}

42
src/test/java/org/gcube/common/scope/ServiceMapTest.java
View File

@ -3,8 +3,6 @@ package org.gcube.common.scope;
import static org.junit.Assert.*;
import java.io.StringReader;
import java.util.Arrays;
import java.util.List;
import javax.xml.bind.JAXBContext;
@ -16,36 +14,48 @@ import org.junit.Test;
public class ServiceMapTest {
private static String map = "<service-map scope='scope'>" + "<services>"
+ "<service name='service1'>"
+ "<endpoint>http://acme.org:8000/service1</endpoint>"
+ "<endpoint>http://acme2.org:8000/service1</endpoint>"
+ "</service>" + "<service name='service2'>"
+ "<endpoint>http://acme3.org:8000/service2</endpoint>"
+ "<endpoint>http://acme4.org:8000/service2</endpoint>"
+ "</service>" + "</services>" + "</service-map>";
@Test
public void serviceMapsBindCorrectly() throws Exception {
String map =
"<service-map scope='scope' version='1.0'>"
+ "<services>"
+ "<service name='service1' endpoint='http://acme.org:8000/service1' />"
+ "<service name='service2' endpoint='http://acme2.org:8000/service2' />"
+ "</services>"
+ "</service-map>";
JAXBContext context = JAXBContext.newInstance(DefaultServiceMap.class);
DefaultServiceMap serviceMap = (DefaultServiceMap) context
.createUnmarshaller().unmarshal(new StringReader(map));
assertEquals("scope", serviceMap.scope());
List<String> expected = Arrays.asList("http://acme.org:8000/service1","http://acme2.org:8000/service1");
assertEquals(expected, serviceMap.endpoint("service1"));
expected = Arrays.asList("http://acme3.org:8000/service2","http://acme4.org:8000/service2");
assertEquals(expected, serviceMap.endpoint("service2"));
assertEquals("1.0", serviceMap.version());
assertEquals("http://acme.org:8000/service1", serviceMap.endpoint("service1"));
assertEquals("http://acme2.org:8000/service2", serviceMap.endpoint("service2"));
}
@Test
public void serviceMapsDiscoveredCorrectly() throws Exception {
ScopeProvider.instance.set("scope");
ScopeProvider.instance.set("/infra/vo");
assertNotNull(ServiceMap.instance.endpoint("service1"));
assertEquals("2.3",ServiceMap.instance.version());
}
@Test
public void serviceMapsCanBeLookedupInVREScope() throws Exception {
ScopeProvider.instance.set("/infra/vo/vre");
assertNotNull(ServiceMap.instance.endpoint("service1"));

6
src/test/resources/oldermap.servicemap Normal file
View File

@ -0,0 +1,6 @@
<service-map scope='/infra/vo' version="1.4">
<services>
<service name='service1' endpoint='http://acme.org:8000/service1' />
<service name='service2' endpoint='http://acme2.org:8000/service2' />
</services>
</service-map>

7
src/test/resources/testmap.servicemap
View File

@ -1 +1,6 @@
<service-map scope='scope'><services><service name='service1'><endpoint>http://acme.org:8000/service1</endpoint><endpoint>http://acme2.org:8000/service1</endpoint></service><service name='service2'><endpoint>http://acme3.org:8000/service2</endpoint><endpoint>http://acme4.org:8000/service2</endpoint></service></services></service-map>
<service-map scope='/infra/vo' version="2.3">
<services>
<service name='service1' endpoint='http://acme.org:8000/service1' />
<service name='service2' endpoint='http://acme2.org:8000/service2' />
</services>
</service-map>