Package org.craftercms.security.utils
Class SecurityUtils
java.lang.Object
org.craftercms.security.utils.SecurityUtils
Contains security utility methods.
- Author:
- Alfonso Vásquez
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic Authentication
getAuthentication
(javax.servlet.http.HttpServletRequest request) Returns the authentication attribute from the specified request.static Authentication
Returns the authentication attribute from the current request.static org.craftercms.profile.api.Profile
Returns the profile from authentication attribute from the current request.static org.craftercms.profile.api.Profile
getProfile
(javax.servlet.http.HttpServletRequest request) Returns the profile from authentication attribute from the specified request.static Long
getProfileLastModifiedCookie
(javax.servlet.http.HttpServletRequest request) Returns the last modified timestamp cookie from the request.static String
getTicketCookie
(javax.servlet.http.HttpServletRequest request) Returns the ticket cookie value from the request.static void
removeAuthentication
(javax.servlet.http.HttpServletRequest request) Removes the authentication attribute from the specified request.static void
Removes the authentication attribute from the current request.static void
setAuthentication
(javax.servlet.http.HttpServletRequest request, Authentication authentication) Sets the authentication attribute in the specified request.static void
setCurrentAuthentication
(Authentication authentication) Sets the authentication attribute in the current request.
-
Field Details
-
AUTHENTICATION_EXCEPTION_SESSION_ATTRIBUTE
- See Also:
-
BAD_CREDENTIALS_EXCEPTION_SESSION_ATTRIBUTE
- See Also:
-
ACCESS_DENIED_EXCEPTION_SESSION_ATTRIBUTE
- See Also:
-
TICKET_COOKIE_NAME
- See Also:
-
PROFILE_LAST_MODIFIED_COOKIE_NAME
- See Also:
-
TENANT_REQUEST_ATTRIBUTE_NAME
- See Also:
-
AUTHENTICATION_REQUEST_ATTRIBUTE_NAME
- See Also:
-
-
Method Details
-
getTicketCookie
Returns the ticket cookie value from the request.- Parameters:
request
- the request where to retrieve the ticket from- Returns:
- the ticket
-
getProfileLastModifiedCookie
Returns the last modified timestamp cookie from the request.- Parameters:
request
- the request where to retrieve the last modified timestamp from- Returns:
- the last modified timestamp of the authenticated profile
-
getCurrentAuthentication
Returns the authentication attribute from the current request.- Returns:
- the authentication object
-
setCurrentAuthentication
Sets the authentication attribute in the current request.- Parameters:
authentication
- the authentication object to set as request attribute
-
removeCurrentAuthentication
public static void removeCurrentAuthentication()Removes the authentication attribute from the current request. -
getAuthentication
Returns the authentication attribute from the specified request.- Parameters:
request
- the request where to get the attribute from- Returns:
- the authentication object
-
setAuthentication
public static void setAuthentication(javax.servlet.http.HttpServletRequest request, Authentication authentication) Sets the authentication attribute in the specified request.- Parameters:
request
- the request where to add the attribute toauthentication
- the authentication object to set as request attribute
-
removeAuthentication
public static void removeAuthentication(javax.servlet.http.HttpServletRequest request) Removes the authentication attribute from the specified request.- Parameters:
request
- the request where to remove the attribute from
-
getCurrentProfile
public static org.craftercms.profile.api.Profile getCurrentProfile()Returns the profile from authentication attribute from the current request.- Returns:
- the profile object, or null if there's no authentication
-
getProfile
public static org.craftercms.profile.api.Profile getProfile(javax.servlet.http.HttpServletRequest request) Returns the profile from authentication attribute from the specified request.- Returns:
- the profile object, or null if there's no authentication
-