Tomcat 10.1.19 · org.apache.tomcat.util.descriptor.web.LoginConfig

Modifier and Type	Field and Description
private String	authMethod The authentication method to use for application login.
private String	errorPage The context-relative URI of the error page for form login.
private String	loginPage The context-relative URI of the login page for form login.
private String	realmName The realm name used when challenging the user for authentication credentials.
private static final long	serialVersionUID

Access	Constructor and Description
public	LoginConfig() Construct a new LoginConfig with default properties.
public	LoginConfig(String The authentication method authMethod, String The realm name realmName, String The login page URI loginPage, String The error page URI errorPage) Construct a new LoginConfig with the specified properties.

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getAuthMethod()
public String	getErrorPage()
public String	getLoginPage()
public String	getRealmName()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setAuthMethod(String authMethod)
public void	setErrorPage(String errorPage)
public void	setLoginPage(String loginPage)
public void	setRealmName(String realmName)
public String	toString() Overrides java.lang.Object.toString. Return a String representation of this object.

Field Detail

authMethod	back to summary
private String authMethod The authentication method to use for application login. Must be BASIC, DIGEST, FORM, or CLIENT-CERT.

errorPage	back to summary
private String errorPage The context-relative URI of the error page for form login.

loginPage	back to summary
private String loginPage The context-relative URI of the login page for form login.

realmName	back to summary
private String realmName The realm name used when challenging the user for authentication credentials.

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

LoginConfig	back to summary
public LoginConfig() Construct a new LoginConfig with default properties.

LoginConfig	back to summary
public LoginConfig(String authMethod, String realmName, String loginPage, String errorPage) Construct a new LoginConfig with the specified properties. Parameters authMethod:String The authentication method realmName:String The realm name loginPage:String The login page URI errorPage:String The error page URI

LoginConfig

back to summary

public LoginConfig(String authMethod, String realmName, String loginPage, String errorPage)

Construct a new LoginConfig with the specified properties.

Parameters

authMethod:String: The authentication method
realmName:String: The realm name
loginPage:String: The login page URI
errorPage:String: The error page URI

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAuthMethod	back to summary
public String getAuthMethod()

getErrorPage	back to summary
public String getErrorPage()

getLoginPage	back to summary
public String getLoginPage()

getRealmName	back to summary
public String getRealmName()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

setAuthMethod	back to summary
public void setAuthMethod(String authMethod)

setErrorPage	back to summary
public void setErrorPage(String errorPage)

setLoginPage	back to summary
public void setLoginPage(String loginPage)

setRealmName	back to summary
public void setRealmName(String realmName)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a String representation of this object. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return a String representation of this object.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

public Class LoginConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail