Skip to content

Commit

Permalink
Updated javadoc on StatelessAuthenticationFilter#getAuthentication
Browse files Browse the repository at this point in the history
  • Loading branch information
Raf-atmire committed May 11, 2020
1 parent ece341e commit d7cbe8c
Showing 1 changed file with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,17 +101,17 @@ protected void doFilterInternal(HttpServletRequest req,
}

/**
* This method will return a Pair instance with an Authentication object as the left side of the pair and a Boolean
* for the right side of the pair which will indicate whether there was an error in the OnBehalfOf parsing or not
* The Authentication object will be attempted to be for the eperson with the uuid in the parameter. Incase
* this is able to be done properly, we'll be giving a pair back with the EPerson Authentication in the left side
* and a false boolean as the right side.
* This method returns an Authentication object
* This Authentication object will be attempted to be for the eperson with the uuid in the parameter. Incase
* this is able to be done properly, we'll be returning the EPerson Authentication.
* If the Authentication object returned is not null, we'll be logged in as this EPerson given through from the
* request. If the Boolean is true, we'll stop the execution and show a BadRequest error
* request.
* If something goes wrong, we'll throw an IllegalArgumentException, AccessDeniedException or AuthorizeException
* depending on what went wrong. This will be caught in the calling method and handled appropriately with the
* corresponding response codes
* @param request The current request
* @param res The current response
* @return A Pair instance with the Authentication object on the left side and the boolean
* indicating errors on the right side
* @return An Authentication object for the EPerson with the uuid in the parameter
* @throws IOException If something goes wrong
*/
private Authentication getAuthentication(HttpServletRequest request, HttpServletResponse res)
Expand Down

0 comments on commit d7cbe8c

Please sign in to comment.