Package org.apereo.cas.configuration.model.core.logout

Class LogoutProperties

java.lang.Object

org.apereo.cas.configuration.model.core.logout.LogoutProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-core-logout",
                automated=true)
public class LogoutProperties
extends Object
implements Serializable

This is LogoutProperties.

Since:

5.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LogoutProperties()

Method Summary

Modifier and Type	Method	Description
List<String>	getRedirectParameter()	The target destination to which CAS should redirect after logout is indicated and extracted by a parameter name of your choosing here.
String	getRedirectUrl()	A url to which CAS must immediately redirect after all logout operations have completed.
boolean	isConfirmLogout()	Before logout, allow the option to confirm on the web interface.
boolean	isFollowServiceRedirects()	Whether CAS should be allowed to redirect to an alternative location after logout.
LogoutProperties	setConfirmLogout(boolean confirmLogout)	Before logout, allow the option to confirm on the web interface.
LogoutProperties	setFollowServiceRedirects(boolean followServiceRedirects)	Whether CAS should be allowed to redirect to an alternative location after logout.
LogoutProperties	setRedirectParameter(List<String> redirectParameter)	The target destination to which CAS should redirect after logout is indicated and extracted by a parameter name of your choosing here.
LogoutProperties	setRedirectUrl(String redirectUrl)	A url to which CAS must immediately redirect after all logout operations have completed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LogoutProperties

public LogoutProperties()

Method Details

getRedirectParameter

public List<String> getRedirectParameter()

The target destination to which CAS should redirect after logout is indicated and extracted by a parameter name of your choosing here. If none specified, the default will be used as service.

isFollowServiceRedirects

public boolean isFollowServiceRedirects()

Whether CAS should be allowed to redirect to an alternative location after logout.

isConfirmLogout

public boolean isConfirmLogout()

Before logout, allow the option to confirm on the web interface.

getRedirectUrl

public String getRedirectUrl()

A url to which CAS must immediately redirect after all logout operations have completed. Typically useful in scenarios where CAS is acting as a proxy and needs to redirect to an external identity provider's logout endpoint in order to remove a session, etc.

setRedirectParameter

public LogoutProperties setRedirectParameter(List<String> redirectParameter)

The target destination to which CAS should redirect after logout is indicated and extracted by a parameter name of your choosing here. If none specified, the default will be used as service.

Returns:

this.

setFollowServiceRedirects

public LogoutProperties setFollowServiceRedirects(boolean followServiceRedirects)

Whether CAS should be allowed to redirect to an alternative location after logout.

Returns:

this.

setConfirmLogout

public LogoutProperties setConfirmLogout(boolean confirmLogout)

Before logout, allow the option to confirm on the web interface.

Returns:

this.

setRedirectUrl

public LogoutProperties setRedirectUrl(String redirectUrl)

A url to which CAS must immediately redirect after all logout operations have completed. Typically useful in scenarios where CAS is acting as a proxy and needs to redirect to an external identity provider's logout endpoint in order to remove a session, etc.

Returns:

this.