Package com.skava.helper

Class AccessControlHelper

java.lang.Object

com.skava.helper.AccessControlHelper

public final class AccessControlHelper
extends Object

This class hold the set of methods for access control using the authorization component of skava framework.

Author:

Infosys Equinox

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVILEGE_FOR_CREATE_ADDRESS
static final String	PRIVILEGE_FOR_CREATE_USER_CONSENT
static final String	PRIVILEGE_FOR_CREATE_USER_NOTES
static final String	PRIVILEGE_FOR_DELETE_ADDRESS
static final String	PRIVILEGE_FOR_DELETE_CONSENT
static final String	PRIVILEGE_FOR_DELETE_USER
static final String	PRIVILEGE_FOR_DELETE_USER_CONSENT
static final String	PRIVILEGE_FOR_DELETE_USER_CUSTOMPROPERTIES
static final String	PRIVILEGE_FOR_DELETE_USER_NOTES
static final String	PRIVILEGE_FOR_GET_CONSENT
static final String	PRIVILEGE_FOR_GET_SECURITY_QUESTIONS
static final String	PRIVILEGE_FOR_GET_USER_CUSTOMPROPERTIES
static final String	PRIVILEGE_FOR_GET_USER_IDENTITIES
static final String	PRIVILEGE_FOR_GETALL_CONSENT
static final String	PRIVILEGE_FOR_GETALL_USER_CUSTOMPROPERTIES
static final String	PRIVILEGE_FOR_GETALL_USER_NOTES
static final String	PRIVILEGE_FOR_PATCH_CONSENT
static final String	PRIVILEGE_FOR_PATCH_UPDATE_USER
static final String	PRIVILEGE_FOR_PATCH_USER_CUSTOMPROPERTIES
static final String	PRIVILEGE_FOR_PATCH_USER_NOTIFICATION
static final String	PRIVILEGE_FOR_POST_CONSENT
static final String	PRIVILEGE_FOR_POST_USER_NOTIFICATION
static final String	PRIVILEGE_FOR_UPDATE_ADDRESS
static final String	PRIVILEGE_FOR_UPDATE_PA55WORD
static final String	PRIVILEGE_FOR_UPDATE_SECURITY_QUESTIONS
static final String	PRIVILEGE_FOR_VIEW_ADDRESS
static final String	PRIVILEGE_FOR_VIEW_ALL_ADDRESS
static final String	PRIVILEGE_FOR_VIEW_ALL_USER_CONSENT
static final String	PRIVILEGE_FOR_VIEW_ALL_USER_CONSENT_HISTORY
static final String	PRIVILEGE_FOR_VIEW_ALL_USERS
static final String	PRIVILEGE_FOR_VIEW_COLLECTIONS
static final String	PRIVILEGE_FOR_VIEW_USER
static final String	PRIVILEGE_FOR_VIEW_USER_PUBLIC_PROFILE
static final String	UNAUTHORIZED_ACCESS_EX	UNAUTHORIZED_ACCESS_EX
static final String	USER_SERVICE

Method Summary

Modifier and Type	Method	Description
static void	checkingRoles(com.skava.core.auth.AuthTokenHandler authTokenHandler, UserCommonServices userCommonServices, long userId, long collectionId, String locale)
static Long	getAdminOrUserId(com.skava.core.auth.AuthTokenHandler authTokenHandler)	This method will return admin userid if it is 0 then return userid
static boolean	hasSelfAccess(Long userIdFromToken, Long userId)	This method return the accessibility result of self access.
static void	preAuthorize(com.skava.core.auth.AuthTokenHandler authTokenHandler, UserCommonServices userCommonServices, String privilege, long userId, long collectionId, long businessId, String locale)	This method is used to check pre authorize by checking user id and privileges for business id.
static void	preAuthorize(com.skava.core.auth.AuthTokenHandler authTokenHandler, UserCommonServices userCommonServices, String privilege, long userId, long collectionId, String locale)	This method is used to check pre authorize by checking user id and privileges for business id.
static void	preAuthorize(com.skava.core.auth.AuthTokenHandler authTokenHandler, UserCommonServices userCommonServices, String privilege, String locale, long collectionId, long businessId)	This method is used to check pre authorize by checking user id and privileges for business id.
static void	preAuthorize(com.skava.core.auth.AuthTokenHandler authTokenHandler, UserCommonServices userCommonServices, String privilege, List<Long> userIds, long collectionId, long businessId, String locale)	This method is used to check pre authorize by checking user id and privileges for business id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

USER_SERVICE

public static final String USER_SERVICE

See Also:

• Constant Field Values

PRIVILEGE_FOR_PATCH_UPDATE_USER

public static final String PRIVILEGE_FOR_PATCH_UPDATE_USER

See Also:

• Constant Field Values

PRIVILEGE_FOR_VIEW_ALL_USERS

public static final String PRIVILEGE_FOR_VIEW_ALL_USERS

See Also:

• Constant Field Values

PRIVILEGE_FOR_VIEW_USER

public static final String PRIVILEGE_FOR_VIEW_USER

See Also:

• Constant Field Values

PRIVILEGE_FOR_VIEW_USER_PUBLIC_PROFILE

public static final String PRIVILEGE_FOR_VIEW_USER_PUBLIC_PROFILE

See Also:

• Constant Field Values

PRIVILEGE_FOR_DELETE_USER

public static final String PRIVILEGE_FOR_DELETE_USER

See Also:

• Constant Field Values

PRIVILEGE_FOR_UPDATE_PA55WORD

public static final String PRIVILEGE_FOR_UPDATE_PA55WORD

See Also:

• Constant Field Values

PRIVILEGE_FOR_GET_SECURITY_QUESTIONS

public static final String PRIVILEGE_FOR_GET_SECURITY_QUESTIONS

See Also:

• Constant Field Values

PRIVILEGE_FOR_UPDATE_SECURITY_QUESTIONS

public static final String PRIVILEGE_FOR_UPDATE_SECURITY_QUESTIONS

See Also:

• Constant Field Values

PRIVILEGE_FOR_CREATE_ADDRESS

public static final String PRIVILEGE_FOR_CREATE_ADDRESS

See Also:

• Constant Field Values

PRIVILEGE_FOR_UPDATE_ADDRESS

public static final String PRIVILEGE_FOR_UPDATE_ADDRESS

See Also:

• Constant Field Values

PRIVILEGE_FOR_VIEW_ALL_ADDRESS

public static final String PRIVILEGE_FOR_VIEW_ALL_ADDRESS

See Also:

• Constant Field Values

PRIVILEGE_FOR_VIEW_ADDRESS

public static final String PRIVILEGE_FOR_VIEW_ADDRESS

See Also:

• Constant Field Values

PRIVILEGE_FOR_DELETE_ADDRESS

public static final String PRIVILEGE_FOR_DELETE_ADDRESS

See Also:

• Constant Field Values

PRIVILEGE_FOR_CREATE_USER_CONSENT

public static final String PRIVILEGE_FOR_CREATE_USER_CONSENT

See Also:

• Constant Field Values

PRIVILEGE_FOR_VIEW_ALL_USER_CONSENT

public static final String PRIVILEGE_FOR_VIEW_ALL_USER_CONSENT

See Also:

• Constant Field Values

PRIVILEGE_FOR_DELETE_USER_CONSENT

public static final String PRIVILEGE_FOR_DELETE_USER_CONSENT

See Also:

• Constant Field Values

PRIVILEGE_FOR_VIEW_ALL_USER_CONSENT_HISTORY

public static final String PRIVILEGE_FOR_VIEW_ALL_USER_CONSENT_HISTORY

See Also:

• Constant Field Values

PRIVILEGE_FOR_GETALL_USER_CUSTOMPROPERTIES

public static final String PRIVILEGE_FOR_GETALL_USER_CUSTOMPROPERTIES

See Also:

• Constant Field Values

PRIVILEGE_FOR_GET_USER_CUSTOMPROPERTIES

public static final String PRIVILEGE_FOR_GET_USER_CUSTOMPROPERTIES

See Also:

• Constant Field Values

PRIVILEGE_FOR_PATCH_USER_CUSTOMPROPERTIES

public static final String PRIVILEGE_FOR_PATCH_USER_CUSTOMPROPERTIES

See Also:

• Constant Field Values

PRIVILEGE_FOR_DELETE_USER_CUSTOMPROPERTIES

public static final String PRIVILEGE_FOR_DELETE_USER_CUSTOMPROPERTIES

See Also:

• Constant Field Values

PRIVILEGE_FOR_GET_USER_IDENTITIES

public static final String PRIVILEGE_FOR_GET_USER_IDENTITIES

See Also:

• Constant Field Values

PRIVILEGE_FOR_CREATE_USER_NOTES

public static final String PRIVILEGE_FOR_CREATE_USER_NOTES

See Also:

• Constant Field Values

PRIVILEGE_FOR_GETALL_USER_NOTES

public static final String PRIVILEGE_FOR_GETALL_USER_NOTES

See Also:

• Constant Field Values

PRIVILEGE_FOR_DELETE_USER_NOTES

public static final String PRIVILEGE_FOR_DELETE_USER_NOTES

See Also:

• Constant Field Values

PRIVILEGE_FOR_POST_USER_NOTIFICATION

public static final String PRIVILEGE_FOR_POST_USER_NOTIFICATION

See Also:

• Constant Field Values

PRIVILEGE_FOR_PATCH_USER_NOTIFICATION

public static final String PRIVILEGE_FOR_PATCH_USER_NOTIFICATION

See Also:

• Constant Field Values

PRIVILEGE_FOR_POST_CONSENT

public static final String PRIVILEGE_FOR_POST_CONSENT

See Also:

• Constant Field Values

PRIVILEGE_FOR_GET_CONSENT

public static final String PRIVILEGE_FOR_GET_CONSENT

See Also:

• Constant Field Values

PRIVILEGE_FOR_GETALL_CONSENT

public static final String PRIVILEGE_FOR_GETALL_CONSENT

See Also:

• Constant Field Values

PRIVILEGE_FOR_PATCH_CONSENT

public static final String PRIVILEGE_FOR_PATCH_CONSENT

See Also:

• Constant Field Values

PRIVILEGE_FOR_DELETE_CONSENT

public static final String PRIVILEGE_FOR_DELETE_CONSENT

See Also:

• Constant Field Values

PRIVILEGE_FOR_VIEW_COLLECTIONS

public static final String PRIVILEGE_FOR_VIEW_COLLECTIONS

See Also:

• Constant Field Values

UNAUTHORIZED_ACCESS_EX

public static final String UNAUTHORIZED_ACCESS_EX

UNAUTHORIZED_ACCESS_EX

See Also:

• Constant Field Values

Method Details

hasSelfAccess

public static boolean hasSelfAccess(Long userIdFromToken,
 Long userId)

This method return the accessibility result of self access. It checks whether the token userid and userid from request remains same.

Parameters:

userIdFromToken - a Long object. Indicates the token user id.

userId - a Long object. Indicates the requested user id.

Returns:

A Boolean object. Hold the result of access validation.

preAuthorize

public static void preAuthorize(com.skava.core.auth.AuthTokenHandler authTokenHandler,
 UserCommonServices userCommonServices,
 String privilege,
 List<Long> userIds,
 long collectionId,
 long businessId,
 String locale)

This method is used to check pre authorize by checking user id and privileges for business id.

Parameters:

authTokenHandler - Holds AuthTokenHandler object for getting userid from token and check privileges for business id

userCommonServices - a UserCommonServices object for loading message source.

privilege - a String object. Indicates the privilege of the user.

userIds - a List of Long objects. Indicates the user ids.

collectionId - a Long object. Indicates the collection id.

businessId - a Long object. Indicates the business id.

locale - a String object. Indicates the locale object.

preAuthorize

public static void preAuthorize(com.skava.core.auth.AuthTokenHandler authTokenHandler,
 UserCommonServices userCommonServices,
 String privilege,
 long userId,
 long collectionId,
 long businessId,
 String locale)

This method is used to check pre authorize by checking user id and privileges for business id.

Parameters:

authTokenHandler - Holds AuthTokenHandler object for getting userid from token and check privileges for business id

userCommonServices - a UserCommonServices object for loading message source.

privilege - a String object. Indicates the privilege of the user.

userId - a List of Long objects. Indicates the user id.

collectionId - a Long object. Indicates the collection id.

businessId - a Long object. Indicates the business id.

locale - a String object. Indicates the locale object.

checkingRoles

public static void checkingRoles(com.skava.core.auth.AuthTokenHandler authTokenHandler,
 UserCommonServices userCommonServices,
 long userId,
 long collectionId,
 String locale)

preAuthorize

public static void preAuthorize(com.skava.core.auth.AuthTokenHandler authTokenHandler,
 UserCommonServices userCommonServices,
 String privilege,
 long userId,
 long collectionId,
 String locale)

This method is used to check pre authorize by checking user id and privileges for business id.

Parameters:

authTokenHandler - Holds AuthTokenHandler object for getting userid from token and check privileges for business id

userCommonServices - a UserCommonServices object for loading message source.

privilege - a String object. Indicates the privilege of the user.

userId - a List of Long objects. Indicates the user id.

collectionId - a Long object. Indicates the collection id.

locale - a String object. Indicates the locale object.

preAuthorize

public static void preAuthorize(com.skava.core.auth.AuthTokenHandler authTokenHandler,
 UserCommonServices userCommonServices,
 String privilege,
 String locale,
 long collectionId,
 long businessId)

This method is used to check pre authorize by checking user id and privileges for business id.

Parameters:

authTokenHandler - Holds AuthTokenHandler object for getting userid from token and check privileges for business id

userCommonServices - a UserCommonServices object for loading message source.

privilege - a String object. Indicates the privilege of the user.

locale - a String object. Indicates the locale object.

collectionId - a Long object. Indicates the collection id.

businessId - a Long object. Indicates the business id.

getAdminOrUserId

public static Long getAdminOrUserId(com.skava.core.auth.AuthTokenHandler authTokenHandler)

This method will return admin userid if it is 0 then return userid

Parameters:

authTokenHandler - authTokenHandler

Returns:

long adminid or userid