Package com.broadleafcommerce.tenant.service

Class ApplicationSecurityUtil

java.lang.Object

com.broadleafcommerce.tenant.service.ApplicationSecurityUtil

public class ApplicationSecurityUtil
extends Object

Utility methods to read a user's available applications.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_ACCESS_KEY
static final String	APPLICATION_ID_KEY
static final String	TENANT_ACCESS_KEY

Constructor Summary

Constructors

Constructor	Description
ApplicationSecurityUtil(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils	getAuthenticationUtils()
boolean	hasAccessToApplication(String applicationId)	Return true if the user has access to the application ID supplied, else false.
boolean	hasFullApplicationAccess()	Returns whether this user has all application access.
protected Set<String>	readApplicationIds()
Collection<String>	readUserAccessibleApplicationIds()	Read the IDs of the applications this user has access to.

Methods inherited from class java.lang.Object

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

Field Details

TENANT_ACCESS_KEY

public static final String TENANT_ACCESS_KEY

See Also:

• Constant Field Values

APPLICATION_ACCESS_KEY

public static final String APPLICATION_ACCESS_KEY

See Also:

• Constant Field Values

APPLICATION_ID_KEY

public static final String APPLICATION_ID_KEY

See Also:

• Constant Field Values

Constructor Details

ApplicationSecurityUtil

public ApplicationSecurityUtil(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)

Method Details

hasAccessToApplication

public boolean hasAccessToApplication(String applicationId)

Return true if the user has access to the application ID supplied, else false.

Parameters:

applicationId - The application id

Returns:

true if the user has access to the application ID, else false.

readUserAccessibleApplicationIds

public Collection<String> readUserAccessibleApplicationIds()

Read the IDs of the applications this user has access to.

Returns:

The applications the user has access to.

hasFullApplicationAccess

public boolean hasFullApplicationAccess()

Returns whether this user has all application access. All application access is denoted by an absence of application restrictions.

Returns:

true if the user has access to all applications, else false.

readApplicationIds

protected Set<String> readApplicationIds()

getAuthenticationUtils

protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils getAuthenticationUtils()