Rename expireAfter(:Session):Duraton to determineExpirationTimeout(:Session):Duration.

Rename getAction():ExpirationAction to getExpirationAction():ExpirationAction.

Edit Javadoc.

Resolves gh-5.
This commit is contained in:
John Blum
2018-10-23 14:58:38 -07:00
parent c569a3de5f
commit 9217b107f2
3 changed files with 13 additions and 13 deletions

View File

@@ -90,7 +90,7 @@ public class CustomSessionExpirationConfigurationIntegrationTests {
public void sessionExpirationPolicyConfigurationIsCorrect() {
assertThat(this.sessionExpirationPolicy).isInstanceOf(TestSessionExpirationPolicy.class);
assertThat(this.sessionExpirationPolicy.expireAfter(null)).isEqualTo(Duration.ofMinutes(10));
assertThat(this.sessionExpirationPolicy.determineExpirationTimeout(null)).isEqualTo(Duration.ofMinutes(10));
}
@Test
@@ -154,7 +154,7 @@ public class CustomSessionExpirationConfigurationIntegrationTests {
}
@Override
public Duration expireAfter(Session session) {
public Duration determineExpirationTimeout(Session session) {
return this.expirationTimeout;
}
}

View File

@@ -20,25 +20,25 @@ import java.time.Duration;
import org.apache.geode.cache.Region;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
import org.springframework.session.Session;
/**
* The {@link SessionExpirationPolicy} interface is a Strategy interface defining a contract for users to implement
* different {@link Session} expiration policies and rules.
* The {@link SessionExpirationPolicy} interface is a Strategy Interface defining a contract for users to implement
* custom application expiration policies and rules for {@link Session} management.
*
* Examples of different {@link Session} expiration strategies might include, but are not limited to:
* idle expiration timeout or fixed duration expiration timeouts, and so on.
* idle expiration timeouts, fixed duration expiration timeouts, Time-To-Live (TTL) expiration, and so on.
*
* @author John Blum
* @see java.time.Duration
* @see org.apache.geode.cache.Region
* @see org.springframework.session.Session
* @see org.springframework.session.data.gemfire.expiration.support.FixedTimeoutSessionExpirationPolicy
* @see org.springframework.session.data.gemfire.expiration.support.IdleTimeoutSessionExpirationPolicy
* @since 2.1.0
*/
@FunctionalInterface
@SuppressWarnings("unused")
public interface SessionExpirationPolicy {
/**
@@ -56,17 +56,17 @@ public interface SessionExpirationPolicy {
* @see java.time.Duration
*/
@Nullable
Duration expireAfter(Session session);
Duration determineExpirationTimeout(@NonNull Session session);
/**
* Defines the {@link ExpirationAction action} to take when the {@link Session} expires.
* Specifies the {@link ExpirationAction action} to take when the {@link Session} expires.
*
* Defaults to {@link ExpirationAction#INVALIDATE}.
*
* @return an {@link ExpirationAction} specifying the action to take when the {@link Session} expires.
* @see org.springframework.session.data.gemfire.expiration.SessionExpirationPolicy.ExpirationAction
*/
default ExpirationAction getAction() {
default ExpirationAction getExpirationAction() {
return ExpirationAction.INVALIDATE;
}

View File

@@ -48,12 +48,12 @@ public class SessionExpirationPolicyUnitTests {
@Test
public void expirationActionDefaultsToInvalidate() {
when(this.mockSessionExpirationPolicy.getAction()).thenCallRealMethod();
when(this.mockSessionExpirationPolicy.getExpirationAction()).thenCallRealMethod();
assertThat(this.mockSessionExpirationPolicy.getAction())
assertThat(this.mockSessionExpirationPolicy.getExpirationAction())
.isEqualTo(SessionExpirationPolicy.ExpirationAction.INVALIDATE);
verify(this.mockSessionExpirationPolicy, times(1)).getAction();
verify(this.mockSessionExpirationPolicy, times(1)).getExpirationAction();
}
@Test