mirror of
https://github.com/spring-projects/spring-security.git
synced 2026-02-25 06:34:59 +00:00
Update javadoc
Signed-off-by: Tran Ngoc Nhan <ngocnhan.tran1996@gmail.com>
This commit is contained in:
parent
21bef947b0
commit
e91b098c7c
@ -101,7 +101,11 @@ final class DefaultServiceAuthenticationDetails extends WebAuthenticationDetails
|
||||
/**
|
||||
* If present, removes the artifactParameterName and the corresponding value from the
|
||||
* query String.
|
||||
* @param request
|
||||
* @param request the current {@link HttpServletRequest} to obtain the
|
||||
* {@link #getServiceUrl()} from.
|
||||
* @param artifactPattern the {@link Pattern} that will be used to clean up the query
|
||||
* string from containing the artifact name and value. This can be created using
|
||||
* {@link #createArtifactPattern(String)}.
|
||||
* @return the query String minus the artifactParameterName and the corresponding
|
||||
* value.
|
||||
*/
|
||||
@ -122,8 +126,10 @@ final class DefaultServiceAuthenticationDetails extends WebAuthenticationDetails
|
||||
* Creates a {@link Pattern} that can be passed into the constructor. This allows the
|
||||
* {@link Pattern} to be reused for every instance of
|
||||
* {@link DefaultServiceAuthenticationDetails}.
|
||||
* @param artifactParameterName
|
||||
* @return
|
||||
* @param artifactParameterName the artifactParameterName that is removed from the
|
||||
* current URL. The result becomes the service url. Cannot be null and cannot be an
|
||||
* empty String.
|
||||
* @return a {@link Pattern}
|
||||
*/
|
||||
static Pattern createArtifactPattern(String artifactParameterName) {
|
||||
Assert.hasLength(artifactParameterName, "artifactParameterName is expected to have a length");
|
||||
|
||||
@ -208,7 +208,8 @@ public abstract class SecurityExpressionRoot<T extends @Nullable Object> impleme
|
||||
/**
|
||||
* Convenience method to access {@link Authentication#getPrincipal()} from
|
||||
* {@link #getAuthentication()}
|
||||
* @return
|
||||
* @return the <code>Principal</code> being authenticated or the authenticated
|
||||
* principal after authentication.
|
||||
*/
|
||||
public @Nullable Object getPrincipal() {
|
||||
return getAuthentication().getPrincipal();
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user