Spring Security provides a DelegatingSecurityContextRunnable

abstraction for Runnable that can be used for async and
scheduled tasks. The primary contract for task scheduling is
TaskScheduler and there's no such wrapper available at the moment.

The new DelegatingSecurityContextTaskScheduler class implements
TaskScheduler interface.

Fixes gh-6043
This commit is contained in:
Richard Valdivieso 2018-12-04 06:33:05 -05:00 committed by Rob Winch
parent 3230cd653c
commit cb0ea0241b
3 changed files with 168 additions and 0 deletions

View File

@ -0,0 +1,75 @@
/*
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.scheduling;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.Trigger;
import org.springframework.util.Assert;
import java.util.Date;
import java.util.concurrent.ScheduledFuture;
/**
* An implementation of {@link TaskScheduler} invoking it whenever the trigger
* indicates a next execution time.
*
* @author Richard Valdivieso
* @since 5.1
*/
public class DelegatingSecurityContextTaskScheduler implements TaskScheduler {
private final TaskScheduler taskScheduler;
/**
* Creates a new {@link DelegatingSecurityContextTaskScheduler}
*
* @param taskScheduler the {@link TaskScheduler}
*/
public DelegatingSecurityContextTaskScheduler(TaskScheduler taskScheduler) {
Assert.notNull(taskScheduler, "Task scheduler must not be null");
this.taskScheduler = taskScheduler;
}
@Override
public ScheduledFuture<?> schedule(Runnable task, Trigger trigger) {
return taskScheduler.schedule(task, trigger);
}
@Override
public ScheduledFuture<?> schedule(Runnable task, Date startTime) {
return taskScheduler.schedule(task, startTime);
}
@Override
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period) {
return taskScheduler.scheduleAtFixedRate(task, startTime, period);
}
@Override
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period) {
return taskScheduler.scheduleAtFixedRate(task, period);
}
@Override
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Date startTime, long delay) {
return taskScheduler.scheduleWithFixedDelay(task, startTime, delay);
}
@Override
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, long delay) {
return taskScheduler.scheduleWithFixedDelay(task, delay);
}
}

View File

@ -0,0 +1,92 @@
/*
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.scheduling;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.Trigger;
import java.time.Duration;
import java.time.Instant;
import java.util.Date;
import static org.mockito.Mockito.*;
/**
* Test An implementation of {@link TaskScheduler} invoking it whenever the trigger
* indicates a next execution time.
*
* @author Richard Valdivieso
* @since 5.1
*/
public class DelegatingSecurityContextTaskSchedulerTests {
@Mock
private TaskScheduler scheduler;
@Mock
private Runnable runnable;
@Mock
private Trigger trigger;
private DelegatingSecurityContextTaskScheduler delegatingSecurityContextTaskScheduler;
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
delegatingSecurityContextTaskScheduler = new DelegatingSecurityContextTaskScheduler(scheduler);
}
@After
public void cleanup() {
delegatingSecurityContextTaskScheduler = null;
}
@Test(expected = IllegalArgumentException.class)
public void testSchedulerIsNotNull() {
delegatingSecurityContextTaskScheduler = new DelegatingSecurityContextTaskScheduler(null);
}
@Test
public void testSchedulerWithRunnableAndTrigger() {
delegatingSecurityContextTaskScheduler.schedule(runnable, trigger);
verify(scheduler).schedule(any(Runnable.class), any(Trigger.class));
}
@Test
public void testSchedulerWithRunnableAndInstant() {
Instant date = Instant.now();
delegatingSecurityContextTaskScheduler.schedule(runnable, date);
verify(scheduler).schedule(any(Runnable.class), any(Date.class));
}
@Test
public void testScheduleAtFixedRateWithRunnableAndDate() {
Date date = new Date(1544751374L);
Duration duration = Duration.ofSeconds(4L);
delegatingSecurityContextTaskScheduler.scheduleAtFixedRate(runnable, date, 1000L);
verify(scheduler).scheduleAtFixedRate(isA(Runnable.class), isA(Date.class), eq(1000L));
}
@Test
public void testScheduleAtFixedRateWithRunnableAndLong() {
delegatingSecurityContextTaskScheduler.scheduleAtFixedRate(runnable, 1000L);
verify(scheduler).scheduleAtFixedRate(isA(Runnable.class), eq(1000L));
}
}

View File

@ -165,3 +165,4 @@ They are quite self-explanatory once you understand the previous code.
* DelegatingSecurityContextSchedulingTaskExecutor
* DelegatingSecurityContextAsyncTaskExecutor
* DelegatingSecurityContextTaskExecutor
* DelegatingSecurityContextTaskScheduler