diff --git a/README.md b/README.md index b77766c..7000b21 100644 --- a/README.md +++ b/README.md @@ -665,7 +665,7 @@ The `SingleSignOutFilter` can affect character encoding. This becomes most obvio | `relayStateParameterName` | Defaults to `RelayState` | No | `eagerlyCreateSessions` | Defaults to `true` | No | `artifactParameterOverPost` | Defaults to `false` | No -| `logoutPath` | The path which is expected to receive logout callback requests from the CAS server. This is necessary if your app needs access to the raw input stream when handling form posts. If not configured, the default behavior will check every form post for a logout parameter. | No +| `logoutCallbackPath` | The path which is expected to receive logout callback requests from the CAS server. This is necessary if your app needs access to the raw input stream when handling form posts. If not configured, the default behavior will check every form post for a logout parameter. | No | `casServerUrlPrefix` | URL to root of CAS Web application context. | Yes diff --git a/cas-client-core/src/main/java/org/jasig/cas/client/configuration/ConfigurationKeys.java b/cas-client-core/src/main/java/org/jasig/cas/client/configuration/ConfigurationKeys.java index 682dffb..d9b6ea6 100644 --- a/cas-client-core/src/main/java/org/jasig/cas/client/configuration/ConfigurationKeys.java +++ b/cas-client-core/src/main/java/org/jasig/cas/client/configuration/ConfigurationKeys.java @@ -78,5 +78,5 @@ public interface ConfigurationKeys { ConfigurationKey> TICKET_VALIDATOR_CLASS = new ConfigurationKey>("ticketValidatorClass", null); ConfigurationKey PROXY_CALLBACK_URL = new ConfigurationKey("proxyCallbackUrl", null); ConfigurationKey RELAY_STATE_PARAMETER_NAME = new ConfigurationKey("relayStateParameterName", "RelayState"); - ConfigurationKey LOGOUT_PATH = new ConfigurationKey("logoutPath", null); + ConfigurationKey LOGOUT_CALLBACK_PATH = new ConfigurationKey("logoutCallbackPath", null); } diff --git a/cas-client-core/src/main/java/org/jasig/cas/client/session/SingleSignOutFilter.java b/cas-client-core/src/main/java/org/jasig/cas/client/session/SingleSignOutFilter.java index 87f2895..ae511ba 100644 --- a/cas-client-core/src/main/java/org/jasig/cas/client/session/SingleSignOutFilter.java +++ b/cas-client-core/src/main/java/org/jasig/cas/client/session/SingleSignOutFilter.java @@ -48,7 +48,7 @@ public final class SingleSignOutFilter extends AbstractConfigurationFilter { setLogoutParameterName(getString(ConfigurationKeys.LOGOUT_PARAMETER_NAME)); setRelayStateParameterName(getString(ConfigurationKeys.RELAY_STATE_PARAMETER_NAME)); setCasServerUrlPrefix(getString(ConfigurationKeys.CAS_SERVER_URL_PREFIX)); - setLogoutPath(getString(ConfigurationKeys.LOGOUT_PATH)); + setLogoutCallbackPath(getString(ConfigurationKeys.LOGOUT_CALLBACK_PATH)); HANDLER.setArtifactParameterOverPost(getBoolean(ConfigurationKeys.ARTIFACT_PARAMETER_OVER_POST)); HANDLER.setEagerlyCreateSessions(getBoolean(ConfigurationKeys.EAGERLY_CREATE_SESSIONS)); } @@ -72,8 +72,8 @@ public final class SingleSignOutFilter extends AbstractConfigurationFilter { HANDLER.setCasServerUrlPrefix(casServerUrlPrefix); } - public void setLogoutPath(String logoutPath) { - HANDLER.setLogoutPath(logoutPath); + public void setLogoutCallbackPath(String logoutCallbackPath) { + HANDLER.setLogoutCallbackPath(logoutCallbackPath); } public void setSessionMappingStorage(final SessionMappingStorage storage) { diff --git a/cas-client-core/src/main/java/org/jasig/cas/client/session/SingleSignOutHandler.java b/cas-client-core/src/main/java/org/jasig/cas/client/session/SingleSignOutHandler.java index e1803c5..e1b15bc 100644 --- a/cas-client-core/src/main/java/org/jasig/cas/client/session/SingleSignOutHandler.java +++ b/cas-client-core/src/main/java/org/jasig/cas/client/session/SingleSignOutHandler.java @@ -66,8 +66,8 @@ public final class SingleSignOutHandler { /** The prefix url of the CAS server */ private String casServerUrlPrefix = ""; - /** The logout path configured at the CAS server, if there is one */ - private String logoutPath; + /** The logout callback path configured at the CAS server, if there is one */ + private String logoutCallbackPath; private boolean artifactParameterOverPost = false; @@ -111,10 +111,10 @@ public final class SingleSignOutHandler { } /** - * @param logoutPath The logout path configured at the CAS server. + * @param logoutCallbackPath The logout callback path configured at the CAS server. */ - public void setLogoutPath(String logoutPath) { - this.logoutPath = logoutPath; + public void setLogoutCallbackPath(String logoutCallbackPath) { + this.logoutCallbackPath = logoutCallbackPath; } /** @@ -185,7 +185,7 @@ public final class SingleSignOutHandler { } private boolean pathEligibleForLogout(HttpServletRequest request) { - return logoutPath == null || logoutPath.equals(getPath(request)); + return logoutCallbackPath == null || logoutCallbackPath.equals(getPath(request)); } private String getPath(HttpServletRequest request) { diff --git a/cas-client-core/src/test/java/org/jasig/cas/client/session/SingleSignOutHandlerTests.java b/cas-client-core/src/test/java/org/jasig/cas/client/session/SingleSignOutHandlerTests.java index 109fd4b..e80e31d 100644 --- a/cas-client-core/src/test/java/org/jasig/cas/client/session/SingleSignOutHandlerTests.java +++ b/cas-client-core/src/test/java/org/jasig/cas/client/session/SingleSignOutHandlerTests.java @@ -123,7 +123,7 @@ public final class SingleSignOutHandlerTests { @Test public void backChannelLogoutDoesNotRunIfPathIsNotEligibleForLogout() { - handler.setLogoutPath("/logout"); + handler.setLogoutCallbackPath("/logout"); request.setServletPath("/not-a-logout"); final MockHttpSession session = doBackChannelLogout(); assertTrue(handler.process(request, response)); @@ -132,7 +132,7 @@ public final class SingleSignOutHandlerTests { @Test public void backChannelLogoutRunsIfPathEqualsLogoutPath() { - handler.setLogoutPath("/logout"); + handler.setLogoutCallbackPath("/logout"); request.setServletPath("/logout"); final MockHttpSession session = doBackChannelLogout(); assertFalse(handler.process(request, response)); diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/SingleSignOutValve.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/SingleSignOutValve.java index c752052..ac6f26b 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/SingleSignOutValve.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/SingleSignOutValve.java @@ -60,8 +60,8 @@ public class SingleSignOutValve extends AbstractLifecycleValve implements Sessio this.handler.setCasServerUrlPrefix(casServerUrlPrefix); } - public void setLogoutPath(String logoutPath) { - this.handler.setLogoutPath(logoutPath); + public void setLogoutCallbackPath(String logoutCallbackPath) { + this.handler.setLogoutCallbackPath(logoutCallbackPath); } public void setSessionMappingStorage(final SessionMappingStorage storage) { diff --git a/cas-client-integration-tomcat-v7/src/main/java/org/jasig/cas/client/tomcat/v7/SingleSignOutValve.java b/cas-client-integration-tomcat-v7/src/main/java/org/jasig/cas/client/tomcat/v7/SingleSignOutValve.java index 364db7b..77711bc 100644 --- a/cas-client-integration-tomcat-v7/src/main/java/org/jasig/cas/client/tomcat/v7/SingleSignOutValve.java +++ b/cas-client-integration-tomcat-v7/src/main/java/org/jasig/cas/client/tomcat/v7/SingleSignOutValve.java @@ -64,8 +64,8 @@ public class SingleSignOutValve extends ValveBase implements SessionListener { this.handler.setCasServerUrlPrefix(casServerUrlPrefix); } - public void setLogoutPath(String logoutPath) { - this.handler.setLogoutPath(logoutPath); + public void setLogoutCallbackPath(String logoutCallbackPath) { + this.handler.setLogoutCallbackPath(logoutCallbackPath); } public void setSessionMappingStorage(final SessionMappingStorage storage) { diff --git a/cas-client-integration-tomcat-v8/src/main/java/org/jasig/cas/client/tomcat/v8/SingleSignOutValve.java b/cas-client-integration-tomcat-v8/src/main/java/org/jasig/cas/client/tomcat/v8/SingleSignOutValve.java index e4dcee4..e7196f5 100644 --- a/cas-client-integration-tomcat-v8/src/main/java/org/jasig/cas/client/tomcat/v8/SingleSignOutValve.java +++ b/cas-client-integration-tomcat-v8/src/main/java/org/jasig/cas/client/tomcat/v8/SingleSignOutValve.java @@ -64,8 +64,8 @@ public class SingleSignOutValve extends ValveBase implements SessionListener { this.handler.setCasServerUrlPrefix(casServerUrlPrefix); } - public void setLogoutPath(String logoutPath) { - this.handler.setLogoutPath(logoutPath); + public void setLogoutCallbackPath(String logoutCallbackPath) { + this.handler.setLogoutCallbackPath(logoutCallbackPath); } public void setSessionMappingStorage(final SessionMappingStorage storage) { diff --git a/cas-client-integration-tomcat-v85/src/main/java/org/jasig/cas/client/tomcat/v85/SingleSignOutValve.java b/cas-client-integration-tomcat-v85/src/main/java/org/jasig/cas/client/tomcat/v85/SingleSignOutValve.java index 1dd127d..ccbdcc5 100644 --- a/cas-client-integration-tomcat-v85/src/main/java/org/jasig/cas/client/tomcat/v85/SingleSignOutValve.java +++ b/cas-client-integration-tomcat-v85/src/main/java/org/jasig/cas/client/tomcat/v85/SingleSignOutValve.java @@ -64,8 +64,8 @@ public class SingleSignOutValve extends ValveBase implements SessionListener { this.handler.setCasServerUrlPrefix(casServerUrlPrefix); } - public void setLogoutPath(String logoutPath) { - this.handler.setLogoutPath(logoutPath); + public void setLogoutCallbackPath(String logoutCallbackPath) { + this.handler.setLogoutCallbackPath(logoutCallbackPath); } public void setSessionMappingStorage(final SessionMappingStorage storage) {