1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomcat.util.descriptor.web;
import java.io.Serial;
import java.io.Serializable;
import org.apache.tomcat.util.buf.UDecoder;
/**
* Representation of a login configuration element for a web application, as represented in a
* <code><login-config></code> element in the deployment descriptor.
*/
public class LoginConfig extends XmlEncodingBase implements Serializable {
@Serial
private static final long serialVersionUID = 2L;
// ----------------------------------------------------------- Constructors
/**
* Construct a new LoginConfig with default properties.
*/
public LoginConfig() {
super();
}
/**
* Construct a new LoginConfig with the specified properties.
*
* @param authMethod The authentication method
* @param realmName The realm name
* @param loginPage The login page URI
* @param errorPage The error page URI
*/
public LoginConfig(String authMethod, String realmName, String loginPage, String errorPage) {
super();
setAuthMethod(authMethod);
setRealmName(realmName);
setLoginPage(loginPage);
setErrorPage(errorPage);
}
// ------------------------------------------------------------- Properties
/**
* The authentication method to use for application login. Must be BASIC, DIGEST, FORM, or CLIENT-CERT.
*/
private String authMethod = null;
public String getAuthMethod() {
return this.authMethod;
}
public void setAuthMethod(String authMethod) {
this.authMethod = authMethod;
}
/**
* The context-relative URI of the error page for form login.
*/
private String errorPage = null;
public String getErrorPage() {
return this.errorPage;
}
public void setErrorPage(String errorPage) {
this.errorPage = UDecoder.URLDecode(errorPage, getCharset());
}
/**
* The context-relative URI of the login page for form login.
*/
private String loginPage = null;
public String getLoginPage() {
return this.loginPage;
}
public void setLoginPage(String loginPage) {
this.loginPage = UDecoder.URLDecode(loginPage, getCharset());
}
/**
* The realm name used when challenging the user for authentication credentials.
*/
private String realmName = null;
public String getRealmName() {
return this.realmName;
}
public void setRealmName(String realmName) {
this.realmName = realmName;
}
// --------------------------------------------------------- Public Methods
/**
* Return a String representation of this object.
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder("LoginConfig[");
sb.append("authMethod=");
sb.append(authMethod);
if (realmName != null) {
sb.append(", realmName=");
sb.append(realmName);
}
if (loginPage != null) {
sb.append(", loginPage=");
sb.append(loginPage);
}
if (errorPage != null) {
sb.append(", errorPage=");
sb.append(errorPage);
}
sb.append(']');
return sb.toString();
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((authMethod == null) ? 0 : authMethod.hashCode());
result = prime * result + ((errorPage == null) ? 0 : errorPage.hashCode());
result = prime * result + ((loginPage == null) ? 0 : loginPage.hashCode());
result = prime * result + ((realmName == null) ? 0 : realmName.hashCode());
return result;
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof LoginConfig other)) {
return false;
}
if (authMethod == null) {
if (other.authMethod != null) {
return false;
}
} else if (!authMethod.equals(other.authMethod)) {
return false;
}
if (errorPage == null) {
if (other.errorPage != null) {
return false;
}
} else if (!errorPage.equals(other.errorPage)) {
return false;
}
if (loginPage == null) {
if (other.loginPage != null) {
return false;
}
} else if (!loginPage.equals(other.loginPage)) {
return false;
}
if (realmName == null) {
return other.realmName == null;
} else {
return realmName.equals(other.realmName);
}
}
}
|
