Skip to content

Commit 41d95ac

Browse files
committed
Apply minor adjustments to AuthnRequest/LogoutRequest APIs and tests
These details were overlooked in the first place: getters of the input params should better be public and fields can be declared as final. The useless NameId setter in LogoutRequestParams was temporarily introduced during development but should have been reverted from the beginning, so it's gone now. Some tests were improved to provide more accurate assertions.
1 parent 11bb45d commit 41d95ac

File tree

4 files changed

+18
-25
lines changed

4 files changed

+18
-25
lines changed

core/src/main/java/com/onelogin/saml2/authn/AuthnRequestParams.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ public boolean isAllowCreate() {
160160
/**
161161
* @return the subject that should be authenticated
162162
*/
163-
protected String getNameIdValueReq() {
163+
public String getNameIdValueReq() {
164164
return nameIdValueReq;
165165
}
166166
}

core/src/main/java/com/onelogin/saml2/logout/LogoutRequest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ public LogoutRequest(Saml2Settings settings, HttpRequest request) {
242242
* @param settings
243243
* OneLogin_Saml2_Settings
244244
* @param params
245-
* a set of authentication request input parameters that shape the
245+
* a set of logout request input parameters that shape the
246246
* request to create
247247
*/
248248
public LogoutRequest(Saml2Settings settings, LogoutRequestParams params) {

core/src/main/java/com/onelogin/saml2/logout/LogoutRequestParams.java

+11-20
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,31 @@ public class LogoutRequestParams {
99
* SessionIndex. When the user is logged, this stored it from the AuthnStatement
1010
* of the SAML Response
1111
*/
12-
private String sessionIndex;
12+
private final String sessionIndex;
1313

1414
/**
1515
* NameID.
1616
*/
17-
private String nameId;
17+
private final String nameId;
1818

1919
/**
2020
* NameID Format.
2121
*/
22-
private String nameIdFormat;
22+
private final String nameIdFormat;
2323

2424
/**
2525
* nameId NameQualifier
2626
*/
27-
private String nameIdNameQualifier;
27+
private final String nameIdNameQualifier;
2828

2929
/**
3030
* nameId SP NameQualifier
3131
*/
32-
private String nameIdSPNameQualifier;
32+
private final String nameIdSPNameQualifier;
3333

3434
/** Create an empty set of logout request input parameters. */
3535
public LogoutRequestParams() {
36+
this(null, null);
3637
}
3738

3839
/**
@@ -118,45 +119,35 @@ protected LogoutRequestParams(LogoutRequestParams source) {
118119
/**
119120
* @return the name ID
120121
*/
121-
protected String getNameId() {
122+
public String getNameId() {
122123
return nameId;
123124
}
124125

125-
/**
126-
* Sets the name ID
127-
*
128-
* @param nameId
129-
* the name ID to set
130-
*/
131-
protected void setNameId(String nameId) {
132-
this.nameId = nameId;
133-
}
134-
135126
/**
136127
* @return the name ID format
137128
*/
138-
protected String getNameIdFormat() {
129+
public String getNameIdFormat() {
139130
return nameIdFormat;
140131
}
141132

142133
/**
143134
* @return the name ID name qualifier
144135
*/
145-
protected String getNameIdNameQualifier() {
136+
public String getNameIdNameQualifier() {
146137
return nameIdNameQualifier;
147138
}
148139

149140
/**
150141
* @return the name ID SP name qualifier
151142
*/
152-
protected String getNameIdSPNameQualifier() {
143+
public String getNameIdSPNameQualifier() {
153144
return nameIdSPNameQualifier;
154145
}
155146

156147
/**
157148
* @return the session index
158149
*/
159-
protected String getSessionIndex() {
150+
public String getSessionIndex() {
160151
return sessionIndex;
161152
}
162153
}

core/src/test/java/com/onelogin/saml2/test/logout/LogoutRequestTest.java

+5-3
Original file line numberDiff line numberDiff line change
@@ -1095,11 +1095,13 @@ private static HttpRequest newHttpRequest(String requestURL, String samlRequestE
10951095
@Test
10961096
public void testPostProcessXml() throws Exception {
10971097
Saml2Settings settings = new SettingsBuilder().fromFile("config/config.min.properties").build();
1098-
LogoutRequest logoutRequest = new LogoutRequest(settings) {
1098+
final LogoutRequestParams params = new LogoutRequestParams();
1099+
LogoutRequest logoutRequest = new LogoutRequest(settings, params) {
10991100
@Override
1100-
protected String postProcessXml(String logoutRequestXml, LogoutRequestParams params, Saml2Settings sett) {
1101-
assertEquals(logoutRequestXml, super.postProcessXml(logoutRequestXml, params, sett));
1101+
protected String postProcessXml(String logoutRequestXml, LogoutRequestParams par, Saml2Settings sett) {
1102+
assertEquals(logoutRequestXml, super.postProcessXml(logoutRequestXml, par, sett));
11021103
assertSame(settings, sett);
1104+
assertSame(params, par);
11031105
return "changed";
11041106
}
11051107
};

0 commit comments

Comments
 (0)