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

merged from trunk 

git-svn-id: http://svn.research-infrastructures.eu/public/d4science/gcube/branches/common/common-scope/1.0@73666 82a268e6-3cf1-43bd-a215-b396298e98cf
This commit is contained in:
fabio.simeoni 2013-04-19 11:42:35 +00:00
parent d989de4e64
commit 62c5427cca
6 changed files with 63 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
distro/README
View File

@ -29,8 +29,7 @@ Binaries can be downloaded from:
Documentation Documentation
------------- -------------
Documentation is available on-line from the Projects Documentation Wiki: Documentation is available on-line from the Projects Documentation Wiki:
https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries_Design_Model#Scope_Management https://gcube.wiki.gcube-system.org/gcube/index.php/Common-scope
Licensing Licensing
--------- ---------

6
distro/changelog.xml
View File

@ -2,10 +2,14 @@
<Changeset component="common-scope-1.0.0" date="2012-1-27"> <Changeset component="common-scope-1.0.0" date="2012-1-27">
<Change>First Release</Change> <Change>First Release</Change>
</Changeset> </Changeset>
<Changeset component="${build.finalName}" date="2013-01-11"> <Changeset component="common-scope-1.1.0" date="2013-01-11">
<Change>Scope can now be propagated in Callable and Runnable tasks via ScopedTasks</Change> <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>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 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> <Change>Scope maps can now be successfully looked up in VRE scopes (bug fix)</Change>
</Changeset> </Changeset>
<Changeset component="${build.finalName}" date="2013-01-27">
<Change>Replaced Google's reflections with common-configuration-scanner</Change>
<Change>Lowered log level on scope settings to DEBUG</Change>
</Changeset>
</ReleaseNotes> </ReleaseNotes>

29
pom.xml
View File

@ -11,7 +11,7 @@
<groupId>org.gcube.core</groupId> <groupId>org.gcube.core</groupId>
<artifactId>common-scope</artifactId> <artifactId>common-scope</artifactId>
<version>1.1.0-SNAPSHOT</version> <version>1.2.0-SNAPSHOT</version>
<name>Common Scope</name> <name>Common Scope</name>
<description>Scope-related APIs</description> <description>Scope-related APIs</description>
@ -25,50 +25,39 @@
<url>http://svn.d4science.research-infrastructures.eu/gcube/trunk/Common/${project.artifactId}</url> <url>http://svn.d4science.research-infrastructures.eu/gcube/trunk/Common/${project.artifactId}</url>
</scm> </scm>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.gcube.distribution</groupId>
<artifactId>maven-bom</artifactId>
<version>[1.0.0-SNAPSHOT,)</version>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>org.reflections</groupId> <groupId>org.gcube.core</groupId>
<artifactId>reflections</artifactId> <artifactId>common-configuration-scanner</artifactId>
<version>0.9.8</version> <version>1.0.0-SNAPSHOT</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.gcube.core</groupId> <groupId>org.gcube.core</groupId>
<artifactId>common-scope-maps</artifactId> <artifactId>common-scope-maps</artifactId>
<version>[1.0.0-SNAPSHOT,)</version> <version>[1.0.0-SNAPSHOT,2.0.0-SNAPSHOT)</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>
<dependency> <dependency>
<groupId>junit</groupId> <groupId>junit</groupId>
<artifactId>junit</artifactId> <artifactId>junit</artifactId>
<version>4.10</version> <version>4.11</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.slf4j</groupId> <groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId> <artifactId>slf4j-api</artifactId>
<version>1.6.4</version> <version>1.7.2</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.slf4j</groupId> <groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId> <artifactId>slf4j-simple</artifactId>
<version>1.6.4</version> <version>1.7.2</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>

4
src/main/java/org/gcube/common/scope/impl/DefaultScopeProvider.java
View File

@ -35,14 +35,14 @@ public class DefaultScopeProvider implements ScopeProvider {
@Override @Override
public void set(String scope) { public void set(String scope) {
if (scope!=null) if (scope!=null)
log.info("setting scope {} in thread {}",scope,Thread.currentThread().getId()); log.debug("setting scope {} in thread {}",scope,Thread.currentThread().getId());
scopes.set(scope); scopes.set(scope);
} }
@Override @Override
public void reset() { public void reset() {
log.info("resetting scope in thread {}",Thread.currentThread().getId()); log.debug("resetting scope in thread {}",Thread.currentThread().getId());
scopes.remove(); scopes.remove();
} }

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

@ -2,77 +2,81 @@ package org.gcube.common.scope.impl;
import java.net.URL; import java.net.URL;
import java.util.HashMap; import java.util.HashMap;
import java.util.HashSet;
import java.util.Map; import java.util.Map;
import java.util.regex.Pattern; import java.util.Set;
import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBContext;
import javax.xml.bind.Unmarshaller; import javax.xml.bind.Unmarshaller;
import org.gcube.common.scan.ClasspathScanner;
import org.gcube.common.scan.ClasspathScannerFactory;
import org.gcube.common.scan.matchers.NameMatcher;
import org.gcube.common.scan.resources.ClasspathResource;
import org.gcube.common.scope.api.ServiceMap; import org.gcube.common.scope.api.ServiceMap;
import org.reflections.Reflections;
import org.reflections.scanners.ResourcesScanner;
import org.reflections.util.ClasspathHelper;
import org.reflections.util.ConfigurationBuilder;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
/** /**
* Scans the classpath for {@link ServiceMap}s. * Scans the classpath for {@link ServiceMap}s.
*
* @author Fabio Simeoni * @author Fabio Simeoni
* *
*/ */
class ServiceMapScanner { class ServiceMapScanner {
private static Logger log = LoggerFactory.getLogger(ServiceMapScanner.class); private static Logger log = LoggerFactory.getLogger(ServiceMapScanner.class);
/** /**
* The path used to find service map configuration files. * The path used to find service map configuration files.
*/ */
static final String mapConfigPattern = ".*\\.servicemap"; static final String mapConfigPattern = ".*\\.servicemap";
/** /**
* Scans the classpath for {@link ServiceMap}s. * Scans the classpath for {@link ServiceMap}s.
*/ */
static Map<String, ServiceMap> maps() { static Map<String, ServiceMap> maps() {
Map<String, ServiceMap> maps = new HashMap<String, ServiceMap>(); Map<String, ServiceMap> maps = new HashMap<String, ServiceMap>();
try {
JAXBContext context = JAXBContext try {
.newInstance(DefaultServiceMap.class);
Unmarshaller um = context.createUnmarshaller();
// we include urls specified in manifest files, which is required Set<String> resources = getMapNames();
// when we run tests in surefire's forked-mode
ConfigurationBuilder builder = new ConfigurationBuilder().setUrls(
ClasspathHelper.forManifest(Utils.urlsToScan())).setScanners(
new ResourcesScanner());
Reflections reflections = new Reflections(builder); JAXBContext context = JAXBContext.newInstance(DefaultServiceMap.class);
Unmarshaller um = context.createUnmarshaller();
for (String resource : reflections.getResources(Pattern for (String resource : resources) {
.compile(mapConfigPattern))) {
URL url = Thread.currentThread().getContextClassLoader() URL url = Thread.currentThread().getContextClassLoader().getResource(resource);
.getResource(resource); log.info("loading {} ", url);
log.info("loading {} ", url); DefaultServiceMap map = (DefaultServiceMap) um.unmarshal(url);
DefaultServiceMap map = (DefaultServiceMap) um.unmarshal(url);
ServiceMap current = maps.get(map.scope());
ServiceMap current = maps.get(map.scope()); if (current != null && current.version() != null)
if (current!=null && current.version()!=null) if (current.version().compareToIgnoreCase(map.version()) == 1) {
if (current.version().compareToIgnoreCase(map.version())==1) { log.warn("discarding {} because older (v.{}) than one previously loaded (v.{}) for {} ",
log.warn("discarding {} because older (v.{}) than one previously loaded (v.{}) for {} ", new Object[]{url, map.version(), current.version(), map.scope()}); new Object[] { url, map.version(), current.version(), map.scope() });
continue; continue;
} } else
else log.info("overwriting older map (v.{}) with newer map (v.{}) for {} ",
log.info("overwriting older map (v.{}) with newer map (v.{}) for {} ", new Object[]{current.version(), map.version(), map.scope()}); new Object[] { current.version(), map.version(), map.scope() });
maps.put(map.scope(), map); maps.put(map.scope(), map);
}
} catch (Exception e) {
throw new RuntimeException("could not load service maps", e);
} }
} catch (Exception e) {
return maps; throw new RuntimeException("could not load service maps", e);
} }
return maps;
}
private static Set<String> getMapNames() {
ClasspathScanner scanner = ClasspathScannerFactory.scanner();
Set<String> names = new HashSet<String>();
for (ClasspathResource r : scanner.scan(new NameMatcher(mapConfigPattern)))
names.add(r.name());
return names;
}
} }

41
src/main/java/org/gcube/common/scope/impl/Utils.java
View File

@ -1,41 +0,0 @@
package org.gcube.common.scope.impl;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Set;
import com.google.common.collect.Sets;
/**
* Classpath discovery utils.
*
* @author Fabio Simeoni
*
*/
public class Utils {
// helper: we use reflections' code but exclude extension and primordial
// classloaders
// whose URLs we do not want to include. especially because these may have
// non-standard URLs
// that would need to be excluded individually from standard scanning,
// or reflections will show (but ignore) a horrible error in the logs. and
// we do no know how to predict what we will
// find on any given machine
static Set<URL> urlsToScan() {
final Set<URL> result = Sets.newHashSet();
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
while (classLoader != null && classLoader.getParent() != null) {
if (classLoader instanceof URLClassLoader) {
URL[] urls = ((URLClassLoader) classLoader).getURLs();
if (urls != null) {
result.addAll(Sets.<URL> newHashSet(urls));
}
}
classLoader = classLoader.getParent();
}
return result;
}
}