You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2016/08/16 08:35:12 UTC
svn commit: r1756489 - in /sling/trunk/contrib/extensions/bgservlets/engine:
./ src/main/java/org/apache/sling/bgservlets/
src/main/java/org/apache/sling/bgservlets/impl/
src/main/java/org/apache/sling/bgservlets/impl/storage/
src/test/java/org/apache/...
Author: cziegeler
Date: Tue Aug 16 08:35:12 2016
New Revision: 1756489
URL: http://svn.apache.org/viewvc?rev=1756489&view=rev
Log:
SLING-5964 : BackgroundServletStarterFilter is using deprecated filter registration properties
Modified:
sling/trunk/contrib/extensions/bgservlets/engine/pom.xml
sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/RuntimeState.java
sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilter.java
sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/ExecutionEngineImpl.java
sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/JobConsoleImpl.java
sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/storage/JobStorageImpl.java
sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilterTest.java
sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/storage/JobStorageImplTest.java
Modified: sling/trunk/contrib/extensions/bgservlets/engine/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/engine/pom.xml?rev=1756489&r1=1756488&r2=1756489&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/engine/pom.xml (original)
+++ sling/trunk/contrib/extensions/bgservlets/engine/pom.xml Tue Aug 16 08:35:12 2016
@@ -16,144 +16,138 @@
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.apache.sling</groupId>
- <artifactId>sling</artifactId>
- <version>22</version>
- <relativePath />
- </parent>
-
- <artifactId>org.apache.sling.bgservlets</artifactId>
- <version>1.0.7-SNAPSHOT</version>
- <packaging>bundle</packaging>
-
- <name>Apache Sling Background Servlets Engine</name>
- <description>
- Allows scripts and servlets to run as background tasks
- which can be suspended, resumed, stopped and restarted.
- </description>
-
- <scm>
- <connection>scm:svn:https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/bgservlets/engine</connection>
- <developerConnection>scm:svn:https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/bgservlets/engine</developerConnection>
- <url>http://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/bgservlets/engine</url>
- </scm>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.felix</groupId>
- <artifactId>maven-scr-plugin</artifactId>
- </plugin>
- <plugin>
- <groupId>org.apache.felix</groupId>
- <artifactId>maven-bundle-plugin</artifactId>
- <extensions>true</extensions>
- <configuration>
- <instructions>
- <Export-Package>org.apache.sling.bgservlets</Export-Package>
- <Private-Package>org.apache.sling.bgservlets.impl.*</Private-Package>
- <DynamicImport-Package>org.apache.felix.webconsole</DynamicImport-Package>
- <Sling-Nodetypes>SLING-INF/nodetypes/jobdata.cnd</Sling-Nodetypes>
- </instructions>
- </configuration>
- </plugin>
- </plugins>
- </build>
-
- <dependencies>
- <dependency>
- <groupId>org.osgi</groupId>
- <artifactId>org.osgi.core</artifactId>
- </dependency>
- <dependency>
- <groupId>org.osgi</groupId>
- <artifactId>org.osgi.compendium</artifactId>
- </dependency>
- <dependency>
- <groupId>org.apache.felix</groupId>
- <artifactId>org.apache.felix.scr.annotations</artifactId>
- </dependency>
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.api</artifactId>
- <version>2.8.0</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.engine</artifactId>
- <version>2.2.0</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.settings</artifactId>
- <version>1.0.0</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.commons.testing</artifactId>
- <version>2.0.6</version>
- <scope>test</scope>
- <exclusions>
- <exclusion>
- <groupId>junit</groupId>
- <artifactId>junit-dep</artifactId>
- </exclusion>
- </exclusions>
- </dependency>
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.commons.json</artifactId>
- <version>2.0.4-incubator</version>
- </dependency>
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.commons.osgi</artifactId>
- <version>2.1.0</version>
- </dependency>
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.jcr.api</artifactId>
- <version>2.0.6</version>
- </dependency>
- <dependency>
- <groupId>javax.servlet</groupId>
- <artifactId>servlet-api</artifactId>
- </dependency>
- <dependency>
- <groupId>javax.jcr</groupId>
- <artifactId>jcr</artifactId>
- <version>2.0</version>
- </dependency>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- </dependency>
- <dependency>
- <groupId>org.apache.felix</groupId>
- <artifactId>org.apache.felix.webconsole</artifactId>
- <version>3.0.0</version>
- </dependency>
- <dependency>
- <groupId>org.mockito</groupId>
- <artifactId>mockito-core</artifactId>
- <version>1.9.5</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>junit-addons</groupId>
- <artifactId>junit-addons</artifactId>
- <version>1.4</version>
- <scope>test</scope>
- </dependency>
- </dependencies>
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>sling</artifactId>
+ <version>28</version>
+ <relativePath />
+ </parent>
+
+ <artifactId>org.apache.sling.bgservlets</artifactId>
+ <version>1.0.7-SNAPSHOT</version>
+ <packaging>bundle</packaging>
+
+ <name>Apache Sling Background Servlets Engine</name>
+ <description>
+ Allows scripts and servlets to run as background tasks
+ which can be suspended, resumed, stopped and restarted.
+ </description>
+
+ <scm>
+ <connection>scm:svn:https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/bgservlets/engine</connection>
+ <developerConnection>scm:svn:https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/bgservlets/engine</developerConnection>
+ <url>http://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/bgservlets/engine</url>
+ </scm>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-scr-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <extensions>true</extensions>
+ <configuration>
+ <instructions>
+ <Import-Package>!org.apache.felix.webconsole,*</Import-Package>
+ <DynamicImport-Package>org.apache.felix.webconsole</DynamicImport-Package>
+ <Sling-Nodetypes>SLING-INF/nodetypes/jobdata.cnd</Sling-Nodetypes>
+ </instructions>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>osgi.core</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.api</artifactId>
+ <version>2.8.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.engine</artifactId>
+ <version>2.2.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.settings</artifactId>
+ <version>1.0.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.commons.json</artifactId>
+ <version>2.0.16</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.commons.osgi</artifactId>
+ <version>2.1.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.jcr.api</artifactId>
+ <version>2.0.6</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>servlet-api</artifactId>
+ <version>2.4</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>javax.jcr</groupId>
+ <artifactId>jcr</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-api</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>org.apache.felix.webconsole</artifactId>
+ <version>3.0.0</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <version>1.10.19</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.jmock</groupId>
+ <artifactId>jmock-junit4</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>junit-addons</groupId>
+ <artifactId>junit-addons</artifactId>
+ <version>1.4</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.commons.testing</artifactId>
+ <version>2.0.26</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
</project>
Modified: sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/RuntimeState.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/RuntimeState.java?rev=1756489&r1=1756488&r2=1756489&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/RuntimeState.java (original)
+++ sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/RuntimeState.java Tue Aug 16 08:35:12 2016
@@ -20,15 +20,18 @@ package org.apache.sling.bgservlets;
import java.util.Date;
+import org.osgi.annotation.versioning.ProviderType;
+
/** Interface used by a running job to exchange state
* information with the execution engine.
*/
+@ProviderType
public interface RuntimeState {
/** Set the progress message that is returned
* by {@link JobProgressInfo}
*/
void setProgressMessage(String str);
-
+
/** Set the ETA that is returned
* by {@link JobProgressInfo}
*/
Modified: sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilter.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilter.java?rev=1756489&r1=1756488&r2=1756489&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilter.java (original)
+++ sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilter.java Tue Aug 16 08:35:12 2016
@@ -21,6 +21,7 @@ package org.apache.sling.bgservlets.impl
import java.io.IOException;
import java.util.Arrays;
import java.util.HashSet;
+import java.util.Map;
import java.util.Set;
import javax.servlet.Filter;
@@ -32,6 +33,7 @@ import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
+import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
@@ -42,7 +44,6 @@ import org.apache.sling.bgservlets.Execu
import org.apache.sling.bgservlets.JobStorage;
import org.apache.sling.commons.osgi.PropertiesUtil;
import org.apache.sling.engine.SlingRequestProcessor;
-import org.osgi.service.component.ComponentContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -56,8 +57,8 @@ import org.slf4j.LoggerFactory;
description="%BackgroundServletStarterFilter.description")
@Service
@Properties( {
- @Property(name = "filter.scope", value = "request", propertyPrivate=true),
- @Property(name = "filter.order", intValue = -1000000000, propertyPrivate=true )})
+ @Property(name = "sling.filter.scope", value = "request", propertyPrivate=true),
+ @Property(name = "service.ranking", intValue = 1000000000, propertyPrivate=true )})
public class BackgroundServletStarterFilter implements Filter {
private final Logger log = LoggerFactory.getLogger(getClass());
@@ -73,7 +74,7 @@ public class BackgroundServletStarterFil
/** Default value of the "put in background" parameter */
public static final String DEFAULT_BG_PARAM = "sling:bg";
-
+
/** Name of the property that defines the request parameter name to
* use to start a servlet in the background.
*/
@@ -82,13 +83,13 @@ public class BackgroundServletStarterFil
/** Default list of HTTP method names that can trigger background requests */
public static final String [] DEFAULT_ALLOWED_METHODS = {"POST", "PUT", "DELETE"};
-
+
/** Name of the property that defines the list of allowed HTTP methods
* to trigger background jobs
*/
@Property()
public static final String PROP_ALLOWED_METHODS = "allowed.http.methods";
-
+
private Set<String> allowedHttpMethods;
/**
@@ -96,23 +97,24 @@ public class BackgroundServletStarterFil
*/
private String bgParamName;
- protected void activate(ComponentContext ctx) {
- bgParamName = PropertiesUtil.toString(ctx.getProperties().get(PROP_BG_PARAM), DEFAULT_BG_PARAM);
-
- final String [] cfgMethods = PropertiesUtil.toStringArray(ctx.getProperties().get(PROP_ALLOWED_METHODS), DEFAULT_ALLOWED_METHODS);
+ @Activate
+ protected void activate(Map<String, Object> props) {
+ bgParamName = PropertiesUtil.toString(props.get(PROP_BG_PARAM), DEFAULT_BG_PARAM);
+
+ final String [] cfgMethods = PropertiesUtil.toStringArray(props.get(PROP_ALLOWED_METHODS), DEFAULT_ALLOWED_METHODS);
allowedHttpMethods = new HashSet<String>();
allowedHttpMethods.addAll(Arrays.asList(cfgMethods));
-
+
if(allowedHttpMethods.isEmpty()) {
log.error("{} defines no allowed HTTP methods, background servlets cannot be started", PROP_ALLOWED_METHODS);
}
-
+
log.info(
- "Request parameter {} will run servlets in the background for HTTP methods {}",
+ "Request parameter {} will run servlets in the background for HTTP methods {}",
bgParamName,
allowedHttpMethods);
}
-
+
private boolean startBackgroundRequest(HttpServletRequest req) throws ServletException {
boolean result = Boolean.valueOf(req.getParameter(bgParamName));
if(result && ! allowedHttpMethods.contains(req.getMethod())) {
@@ -120,7 +122,8 @@ public class BackgroundServletStarterFil
}
return result;
}
-
+
+ @Override
public void doFilter(final ServletRequest sreq,
final ServletResponse sresp, final FilterChain chain)
throws IOException, ServletException {
@@ -170,9 +173,11 @@ public class BackgroundServletStarterFil
}
}
+ @Override
public void destroy() {
}
+ @Override
public void init(FilterConfig cfg) throws ServletException {
}
}
\ No newline at end of file
Modified: sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/ExecutionEngineImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/ExecutionEngineImpl.java?rev=1756489&r1=1756488&r2=1756489&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/ExecutionEngineImpl.java (original)
+++ sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/ExecutionEngineImpl.java Tue Aug 16 08:35:12 2016
@@ -29,14 +29,15 @@ import java.util.concurrent.RejectedExec
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
+import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingException;
import org.apache.sling.bgservlets.ExecutionEngine;
import org.apache.sling.bgservlets.JobStatus;
import org.apache.sling.bgservlets.Predicate;
-import org.osgi.service.component.ComponentContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -45,8 +46,8 @@ import org.slf4j.LoggerFactory;
* synergies with scheduler services
*/
@Component(
- metatype=true,
- label="%ExecutionEngineImpl.label",
+ metatype=true,
+ label="%ExecutionEngineImpl.label",
description="%ExecutionEngineImpl.description")
@Service
public class ExecutionEngineImpl implements ExecutionEngine {
@@ -54,7 +55,7 @@ public class ExecutionEngineImpl impleme
private final Logger log = LoggerFactory.getLogger(getClass());
private Executor executor;
private final Map<String, JobStatus> jobs = Collections.synchronizedMap(new HashMap<String, JobStatus>());
-
+
@Property(intValue=10)
public static final String PROP_CORE_POOL_SIZE = "core.pool.size";
private int corePoolSize;
@@ -62,7 +63,7 @@ public class ExecutionEngineImpl impleme
@Property(intValue=20)
public static final String PROP_MAX_POOL_SIZE = "max.pool.size";
private int maximumPoolSize;
-
+
@Property(intValue=30)
public static final String PROP_KEEP_ALIVE_TIME = "keep.alive.time.seconds";
private int keepAliveTimeSeconds;
@@ -77,6 +78,7 @@ public class ExecutionEngineImpl impleme
: null);
}
+ @Override
public void run() {
if (jobStatus != null) {
jobStatus.requestStateChange(JobStatus.State.RUNNING);
@@ -106,22 +108,24 @@ public class ExecutionEngineImpl impleme
super("Execution queue is full, cannot execute " + r);
}
}
-
- private int getIntegerProperty(ComponentContext ctx, String name) {
- final Integer value = (Integer)ctx.getProperties().get(name);
+
+ private int getIntegerProperty(Map<String, Object> props, String name) {
+ final Integer value = (Integer)props.get(name);
if(value == null) {
throw new IllegalStateException("Missing ComponentContext property: " + name);
}
return value.intValue();
}
- protected void activate(ComponentContext context) {
- corePoolSize = getIntegerProperty(context, PROP_CORE_POOL_SIZE);
- maximumPoolSize = getIntegerProperty(context, PROP_MAX_POOL_SIZE);
- keepAliveTimeSeconds = getIntegerProperty(context, PROP_KEEP_ALIVE_TIME);
+ @Activate
+ protected void activate(Map<String, Object> props) {
+ corePoolSize = getIntegerProperty(props, PROP_CORE_POOL_SIZE);
+ maximumPoolSize = getIntegerProperty(props, PROP_MAX_POOL_SIZE);
+ keepAliveTimeSeconds = getIntegerProperty(props, PROP_KEEP_ALIVE_TIME);
TimeUnit unit = TimeUnit.SECONDS;
BlockingQueue<Runnable> workQueue = new ArrayBlockingQueue<Runnable>(4);
RejectedExecutionHandler handler = new RejectedExecutionHandler() {
+ @Override
public void rejectedExecution(Runnable r,
ThreadPoolExecutor executor) {
onJobRejected(r);
@@ -133,7 +137,8 @@ public class ExecutionEngineImpl impleme
keepAliveTimeSeconds, unit, workQueue, handler);
}
- protected void deactivate(ComponentContext context) {
+ @Deactivate
+ protected void deactivate() {
// TODO how to shutdown executor?
executor = null;
@@ -149,6 +154,7 @@ public class ExecutionEngineImpl impleme
throw new QueueFullException(r);
}
+ @Override
public void queueForExecution(final Runnable inputJob) {
// Wrap job in our own Runnable to change its state as we execute it
final RunnableWrapper w = new RunnableWrapper(inputJob);
@@ -159,10 +165,12 @@ public class ExecutionEngineImpl impleme
executor.execute(w);
}
+ @Override
public JobStatus getJobStatus(String path) {
return jobs.get(path);
}
+ @Override
public Iterator<JobStatus> getMatchingJobStatus(Predicate<JobStatus> p) {
// TODO take predicate into account
// TODO sort by submission/execution time?
Modified: sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/JobConsoleImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/JobConsoleImpl.java?rev=1756489&r1=1756488&r2=1756489&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/JobConsoleImpl.java (original)
+++ sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/JobConsoleImpl.java Tue Aug 16 08:35:12 2016
@@ -19,6 +19,7 @@
package org.apache.sling.bgservlets.impl;
import java.util.Iterator;
+import java.util.Map;
import javax.jcr.Item;
import javax.jcr.Node;
@@ -40,7 +41,7 @@ import org.apache.sling.bgservlets.JobSt
import org.apache.sling.bgservlets.impl.storage.JobStorageException;
import org.apache.sling.bgservlets.impl.storage.NodeJobStatusFactory;
import org.apache.sling.bgservlets.impl.webconsole.JobConsolePlugin;
-import org.osgi.service.component.ComponentContext;
+import org.osgi.framework.BundleContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -53,18 +54,19 @@ import org.slf4j.LoggerFactory;
public class JobConsoleImpl implements JobConsole {
private final Logger log = LoggerFactory.getLogger(getClass());
-
+
public static final String JOB_QUERY = "select * from sling:bgJobData order by jcr:created desc";
@Reference
private ExecutionEngine executionEngine;
-
+
@Reference
private NodeJobStatusFactory jobStatusFactory;
-
+
@Property(boolValue=true)
private final static String PROP_CONSOLE_PLUGIN_ACTIVE = "console.plugin.active";
-
+
+ @Override
public Iterator<JobStatus> getJobStatus(Session session, boolean activeOnly) {
if(activeOnly) {
log.debug("activeOnly is set, getting jobs from ExecutionEngine");
@@ -78,23 +80,24 @@ public class JobConsoleImpl implements J
}
}
}
-
+
@Activate
- protected void activate(ComponentContext ctx) {
- final Object obj = ctx.getProperties().get(PROP_CONSOLE_PLUGIN_ACTIVE);
+ protected void activate(BundleContext ctx, Map<String, Object> props) {
+ final Object obj = props.get(PROP_CONSOLE_PLUGIN_ACTIVE);
final boolean pluginActive = (obj instanceof Boolean ? (Boolean)obj : true);
if(pluginActive) {
- JobConsolePlugin.initPlugin(ctx.getBundleContext(), this);
+ JobConsolePlugin.initPlugin(ctx, this);
} else {
log.info("{} is false, not activating JobConsolePlugin", PROP_CONSOLE_PLUGIN_ACTIVE);
}
}
-
+
@Deactivate
- protected void deactivate(ComponentContext ctx) {
+ protected void deactivate() {
JobConsolePlugin.destroyPlugin();
}
-
+
+ @Override
public JobStatus getJobStatus(Session session, String path) {
// Try ExecutionEngine first, persistent storage if not found
JobStatus result = executionEngine.getJobStatus(path);
@@ -116,16 +119,18 @@ public class JobConsoleImpl implements J
private Iterator<JobStatus> getEngineJobs() {
return executionEngine.getMatchingJobStatus(null);
}
-
+
private Iterator<JobStatus> getStoredJobs(Session s) throws RepositoryException {
final Query q = s.getWorkspace().getQueryManager().createQuery(JOB_QUERY, Query.SQL);
final NodeIterator it = q.execute().getNodes();
return new Iterator<JobStatus>() {
+ @Override
public boolean hasNext() {
return it.hasNext();
}
+ @Override
public JobStatus next() {
try {
return jobStatusFactory.getJobStatus(it.nextNode());
@@ -134,20 +139,23 @@ public class JobConsoleImpl implements J
}
}
+ @Override
public void remove() {
throw new UnsupportedOperationException();
}
-
+
};
}
-
+
+ @Override
public String getJobStatusPagePath(HttpServletRequest request, JobStatus jobStatus, String extension) {
if(!extension.startsWith(".")) {
extension = "." + extension;
}
return request.getContextPath() + jobStatus.getPath() + extension;
}
-
+
+ @Override
public String getJobStreamPath(HttpServletRequest request, JobStatus jobStatus) {
return request.getContextPath() + jobStatus.getStreamPath();
}
Modified: sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/storage/JobStorageImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/storage/JobStorageImpl.java?rev=1756489&r1=1756488&r2=1756489&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/storage/JobStorageImpl.java (original)
+++ sling/trunk/contrib/extensions/bgservlets/engine/src/main/java/org/apache/sling/bgservlets/impl/storage/JobStorageImpl.java Tue Aug 16 08:35:12 2016
@@ -22,12 +22,14 @@ import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
+import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
+import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
@@ -37,38 +39,38 @@ import org.apache.sling.bgservlets.JobDa
import org.apache.sling.bgservlets.JobStorage;
import org.apache.sling.bgservlets.impl.DeepNodeCreator;
import org.apache.sling.settings.SlingSettingsService;
-import org.osgi.service.component.ComponentContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** Default JobStorage implementation */
@Component(
- metatype=true,
- label="%JobStorage.label",
+ metatype=true,
+ label="%JobStorage.label",
description="%JobStorage.description")
@Service
public class JobStorageImpl implements JobStorage {
private Logger log = LoggerFactory.getLogger(getClass());
-
+
/** Configurable base path for storing job data */
@Property(value="/var/bg/jobs")
public static final String PROP_JOB_STORAGE_PATH = "job.storage.path";
-
+
/** Need Sling Settings to get the instance ID */
@Reference
private SlingSettingsService slingSettings;
-
+
public static final String PATH_FORMAT = "/yyyy/MM/dd/HH/mm";
public static final String JOB_NODETYPE = "nt:unstructured";
-
+
private String jobStoragePath;
private AtomicInteger counter = new AtomicInteger();
private static final DateFormat pathFormat = new SimpleDateFormat(PATH_FORMAT);
private String slingInstanceId;
-
- protected void activate(ComponentContext ctx) {
- jobStoragePath = (String)ctx.getProperties().get(PROP_JOB_STORAGE_PATH);
+
+ @Activate
+ protected void activate(Map<String, Object> props) {
+ jobStoragePath = (String)props.get(PROP_JOB_STORAGE_PATH);
if(jobStoragePath == null || jobStoragePath.length() == 0) {
throw new IllegalStateException("Missing " + PROP_JOB_STORAGE_PATH + " in ComponentContext");
}
@@ -81,8 +83,9 @@ public class JobStorageImpl implements J
slingInstanceId = slingSettings.getSlingId();
log.info("Jobs will be stored under {}/{}", jobStoragePath, slingInstanceId);
}
-
- public JobData createJobData(Session s) {
+
+ @Override
+ public JobData createJobData(Session s) {
try {
return getJobData(createNewJobNode(s));
} catch(Exception e) {
@@ -90,14 +93,15 @@ public class JobStorageImpl implements J
}
}
- public JobData getJobData(Node n) {
+ @Override
+ public JobData getJobData(Node n) {
try {
return new JobDataImpl(n);
} catch(Exception e) {
throw new JobStorageException("Unable to create JobDataImpl", e);
}
}
-
+
String getNextPath() {
final StringBuilder sb = new StringBuilder();
sb.append(jobStoragePath);
Modified: sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilterTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilterTest.java?rev=1756489&r1=1756488&r2=1756489&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilterTest.java (original)
+++ sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/BackgroundServletStarterFilterTest.java Tue Aug 16 08:35:12 2016
@@ -19,8 +19,8 @@
package org.apache.sling.bgservlets.impl;
import java.io.IOException;
-import java.util.Dictionary;
-import java.util.Hashtable;
+import java.util.HashMap;
+import java.util.Map;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
@@ -31,7 +31,6 @@ import org.jmock.Expectations;
import org.jmock.Mockery;
import org.junit.Before;
import org.junit.Test;
-import org.osgi.service.component.ComponentContext;
public class BackgroundServletStarterFilterTest {
private BackgroundServletStarterFilter filter;
@@ -39,11 +38,11 @@ public class BackgroundServletStarterFil
private SlingHttpServletRequest request;
private HttpServletResponse response;
private FilterChain chain;
-
+
@SuppressWarnings("serial")
static class BackgroundJobIsStarting extends RuntimeException {
}
-
+
@Before
public void setup() {
mockery = new Mockery();
@@ -51,27 +50,24 @@ public class BackgroundServletStarterFil
response = mockery.mock(HttpServletResponse.class);
chain = mockery.mock(FilterChain.class);
- final ComponentContext ctx = mockery.mock(ComponentContext.class);
- final Dictionary<String, Object> props = new Hashtable<String, Object>();
-
+ final Map<String, Object> props = new HashMap<String, Object>();
+
filter = new BackgroundServletStarterFilter();
-
+
mockery.checking(new Expectations() {{
allowing(request).getParameter("sling:bg");
will(returnValue("true"));
-
+
// If this method is called it means the BackgroundHttpServletRequest
// is being created to start a background job, that's all we need to know
allowing(request).getContextPath();
will(throwException(new BackgroundJobIsStarting()));
-
- allowing(ctx).getProperties();
- will(returnValue(props));
+
}});
-
- filter.activate(ctx);
+
+ filter.activate(props);
}
-
+
private void testWithMethod(final String method) throws IOException, ServletException {
mockery.checking(new Expectations() {{
allowing(request).getMethod();
@@ -79,12 +75,12 @@ public class BackgroundServletStarterFil
}});
filter.doFilter(request, response, chain);
}
-
+
@Test(expected=ServletException.class)
public void testGetRequest() throws IOException, ServletException {
testWithMethod("GET");
}
-
+
@Test(expected=BackgroundJobIsStarting.class)
public void testPostRequest() throws IOException, ServletException {
testWithMethod("POST");
Modified: sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/storage/JobStorageImplTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/storage/JobStorageImplTest.java?rev=1756489&r1=1756488&r2=1756489&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/storage/JobStorageImplTest.java (original)
+++ sling/trunk/contrib/extensions/bgservlets/engine/src/test/java/org/apache/sling/bgservlets/impl/storage/JobStorageImplTest.java Tue Aug 16 08:35:12 2016
@@ -18,18 +18,18 @@ package org.apache.sling.bgservlets.impl
import static org.junit.Assert.fail;
-import java.util.Hashtable;
+import java.util.HashMap;
+import java.util.Map;
import java.util.UUID;
import java.util.regex.Pattern;
-import junitx.util.PrivateAccessor;
-
import org.apache.sling.settings.SlingSettingsService;
import org.jmock.Expectations;
import org.jmock.Mockery;
import org.junit.Before;
import org.junit.Test;
-import org.osgi.service.component.ComponentContext;
+
+import junitx.util.PrivateAccessor;
public class JobStorageImplTest {
private JobStorageImpl storage;
@@ -39,32 +39,26 @@ public class JobStorageImplTest {
@Before
public void setup() throws NoSuchFieldException {
storage = new JobStorageImpl();
-
- final Hashtable<String, Object> props = new Hashtable<String, Object>();
+
+ final Map<String, Object> props = new HashMap<String, Object>();
props.put("job.storage.path", "/var/test");
-
- final ComponentContext ctx = mockery.mock(ComponentContext.class);
- mockery.checking(new Expectations() {{
- allowing(ctx).getProperties();
- will(returnValue(props));
- }});
-
+
final SlingSettingsService sss = mockery.mock(SlingSettingsService.class);
mockery.checking(new Expectations() {{
allowing(sss).getSlingId();
will(returnValue(instanceId));
}});
-
+
PrivateAccessor.setField(storage, "slingSettings", sss);
- storage.activate(ctx);
+ storage.activate(props);
}
-
+
private void assertPath(String regex, String actual) {
if(!Pattern.compile(regex).matcher(actual).matches()) {
fail("Path " + actual + " does not match expected regex " + regex);
}
}
-
+
@Test
public void testNextPath() {
for(int i=1 ; i<10; i++) {