Package org.apereo.cas.configuration.model.core.web.tomcat

Class CasEmbeddedApacheTomcatRemoteUserValveProperties

java.lang.Object

org.apereo.cas.configuration.model.core.web.tomcat.CasEmbeddedApacheTomcatRemoteUserValveProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-webapp-tomcat")
public class CasEmbeddedApacheTomcatRemoteUserValveProperties
extends Object
implements Serializable

This is CasEmbeddedApacheTomcatRemoteUserValveProperties.

Since:

7.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CasEmbeddedApacheTomcatRemoteUserValveProperties()

Method Summary

Modifier and Type	Method	Description
String	getAllowedIpAddressRegex()	A regular expression (using java.util.regex) that the remote client's IP address is compared to.
String	getRemoteUserHeader()	The name of the remote-user header that should be passed onto the http servlet request.
CasEmbeddedApacheTomcatRemoteUserValveProperties	setAllowedIpAddressRegex(String allowedIpAddressRegex)	A regular expression (using java.util.regex) that the remote client's IP address is compared to.
CasEmbeddedApacheTomcatRemoteUserValveProperties	setRemoteUserHeader(String remoteUserHeader)	The name of the remote-user header that should be passed onto the http servlet request.

Methods inherited from class java.lang.Object

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

Constructor Details

CasEmbeddedApacheTomcatRemoteUserValveProperties

public CasEmbeddedApacheTomcatRemoteUserValveProperties()

Method Details

getRemoteUserHeader

public String getRemoteUserHeader()

The name of the remote-user header that should be passed onto the http servlet request. Leaving this setting as blank or undefined will deactivate the valve altogether. The header is typically passed down to tomcat via proxies, load balancers, etc.

getAllowedIpAddressRegex

public String getAllowedIpAddressRegex()

A regular expression (using java.util.regex) that the remote client's IP address is compared to. If this attribute is specified, the remote address MUST match for this request to be accepted. If this attribute is not specified, all requests will be accepted.

setRemoteUserHeader

public CasEmbeddedApacheTomcatRemoteUserValveProperties setRemoteUserHeader(String remoteUserHeader)

The name of the remote-user header that should be passed onto the http servlet request. Leaving this setting as blank or undefined will deactivate the valve altogether. The header is typically passed down to tomcat via proxies, load balancers, etc.

Returns:

this.

setAllowedIpAddressRegex

public CasEmbeddedApacheTomcatRemoteUserValveProperties setAllowedIpAddressRegex(String allowedIpAddressRegex)

A regular expression (using java.util.regex) that the remote client's IP address is compared to. If this attribute is specified, the remote address MUST match for this request to be accepted. If this attribute is not specified, all requests will be accepted.

Returns:

this.