Module cloud.piranha.core.api

Package cloud.piranha.core.api

Record Class WebXmlLoginConfig

java.lang.Object

java.lang.Record

cloud.piranha.core.api.WebXmlLoginConfig

Record Components:

authMethod - the auth method.

realmName - the realm name.

formLoginPage - the form login page.

formErrorPage - the form error page.

public record WebXmlLoginConfig(String authMethod, String realmName, String formLoginPage, String formErrorPage)
extends Record

A login-config inside of web.xml/web-fragment.xml.

Author:

Manfred Riem ([email protected])

Constructor Summary

Constructors

Constructor	Description
WebXmlLoginConfig(String authMethod, String realmName, String formLoginPage, String formErrorPage)	Creates an instance of a WebXmlLoginConfig record class.

Method Summary

Modifier and Type	Method	Description
String	authMethod()	Returns the value of the authMethod record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	formErrorPage()	Returns the value of the formErrorPage record component.
String	formLoginPage()	Returns the value of the formLoginPage record component.
final int	hashCode()	Returns a hash code value for this object.
String	realmName()	Returns the value of the realmName record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WebXmlLoginConfig

public WebXmlLoginConfig(String authMethod,
 String realmName,
 String formLoginPage,
 String formErrorPage)

Creates an instance of a WebXmlLoginConfig record class.

Parameters:

authMethod - the value for the authMethod record component

realmName - the value for the realmName record component

formLoginPage - the value for the formLoginPage record component

formErrorPage - the value for the formErrorPage record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

authMethod

public String authMethod()

Returns the value of the authMethod record component.

Returns:

the value of the authMethod record component

realmName

public String realmName()

Returns the value of the realmName record component.

Returns:

the value of the realmName record component

formLoginPage

public String formLoginPage()

Returns the value of the formLoginPage record component.

Returns:

the value of the formLoginPage record component

formErrorPage

public String formErrorPage()

Returns the value of the formErrorPage record component.

Returns:

the value of the formErrorPage record component