mike-jumper commented on a change in pull request #437: GUACAMOLE-769: Polish
the RADIUS challenge box
URL: https://github.com/apache/guacamole-client/pull/437#discussion_r312751870
##########
File path:
extensions/guacamole-auth-radius/src/main/java/org/apache/guacamole/auth/radius/AuthenticationProviderService.java
##########
@@ -67,18 +74,20 @@
private Provider<AuthenticatedUser> authenticatedUserProvider;
/**
- * Returns the expected credentials from a RADIUS challenge.
+ * Returns an object containing the challenge message and the expected
+ * credentials from a RADIUS challenge.
*
* @param challengePacket
* The AccessChallenge RadiusPacket received from the RADIUS
* server.
*
* @return
- * A CredentialsInfo object that represents fields that need to
- * be presented to the user in order to complete authentication.
- * One of these must be the RADIUS state.
+ * A GuacamoleRadiusChallenge object that contains the challenge
message
+ * sent by the RADIUS server and the expected credentials that should
+ * be requested of the user in order to continue authentication. One
+ * of the expected credentials *must* be the RADIUS state.
Review comment:
I see further down that `getRadiusChallenge()` is expected to return `null`
under some circumstances. If that is indeed the case, then the circumstances
for returning `null` should be documented here.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
