Package org.broadleafcommerce.openadmin.server.security.service.navigation

Class AdminNavigationServiceImpl

java.lang.Object

org.broadleafcommerce.openadmin.server.security.service.navigation.AdminNavigationServiceImpl

All Implemented Interfaces:

AdminNavigationService

@Service("blAdminNavigationService")
public class AdminNavigationServiceImpl
extends Object
implements AdminNavigationService

This service is used to build the left hand navigation for the admin

Author:

elbertbautista

Field Summary

Fields

Modifier and Type	Field	Description
protected List<SectionAuthorization>	additionalSectionAuthorizations
protected AdminNavigationDao	adminNavigationDao
protected AdminNavigationServiceExtensionManager	extensionManager

Constructor Summary

Constructors

Constructor	Description
AdminNavigationServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected List<AdminSection>	buildAuthorizedSectionsList(AdminUser adminUser, AdminModule module)
AdminMenu	buildMenu(AdminUser adminUser)
boolean	checkPermissions(Set<String> authorizedPermissionNames, String permissionName)
AdminSection	findAdminSectionByClassAndSectionId(Class<?> clazz, String sectionId)	In some cases, a single class is served by more than one section.
AdminSection	findAdminSectionByClassAndSectionId(String className, String sectionId)	In some cases, a single class is served by more than one section.
AdminSection	findAdminSectionBySectionKey(String sectionKey)
AdminSection	findAdminSectionByURI(String uri)
List<AdminSection>	findAllAdminSections()	Gets all of the AdminSections in the system, sorted by the AdminSection.getDisplayOrder()
AdminSection	findBaseAdminSectionByClass(String clazz)
List<SectionAuthorization>	getAdditionalSectionAuthorizations()
String	getClassNameForSection(String sectionKey)	Gets the fully qualified ceiling entity classname for this section.
List<SectionCrumb>	getSectionCrumbs(String crumbList)	Utility method for parsing a delimitted section crumb list (usually the "sectionCrumbs" parameter on the HttpServletRequest).
protected String	guessClassFromInterfaces(String clazz)
boolean	isUserAuthorizedToViewModule(AdminUser adminUser, AdminModule module)
boolean	isUserAuthorizedToViewSection(AdminUser adminUser, AdminSection section)
protected String	parseForAllPermission(String currentPermission)
protected void	populateAdminMenu(AdminUser adminUser, AdminMenu adminMenu, List<AdminModule> modules)
void	remove(AdminSection adminSection)
AdminSection	save(AdminSection adminSection)
void	setAdditionalSectionAuthorizations(List<SectionAuthorization> additionalSectionAuthorizations)

Methods inherited from class java.lang.Object

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

Field Details

adminNavigationDao

protected AdminNavigationDao adminNavigationDao

additionalSectionAuthorizations

protected List<SectionAuthorization> additionalSectionAuthorizations

extensionManager

protected AdminNavigationServiceExtensionManager extensionManager

Constructor Details

AdminNavigationServiceImpl

public AdminNavigationServiceImpl()

Method Details

save

@Transactional("blTransactionManager")
public AdminSection save(AdminSection adminSection)

Specified by:

save in interface AdminNavigationService

remove

public void remove(AdminSection adminSection)

Specified by:

remove in interface AdminNavigationService

buildMenu

public AdminMenu buildMenu(AdminUser adminUser)

Specified by:

buildMenu in interface AdminNavigationService

isUserAuthorizedToViewModule

public boolean isUserAuthorizedToViewModule(AdminUser adminUser,
 AdminModule module)

Specified by:

isUserAuthorizedToViewModule in interface AdminNavigationService

findAdminSectionByURI

public AdminSection findAdminSectionByURI(String uri)

Specified by:

findAdminSectionByURI in interface AdminNavigationService

findAdminSectionByClassAndSectionId

public AdminSection findAdminSectionByClassAndSectionId(String className,
 String sectionId)

Description copied from interface: AdminNavigationService

In some cases, a single class is served by more than one section.

Specified by:

findAdminSectionByClassAndSectionId in interface AdminNavigationService

Returns:

findAdminSectionByClassAndSectionId

public AdminSection findAdminSectionByClassAndSectionId(Class<?> clazz,
 String sectionId)

Description copied from interface: AdminNavigationService

In some cases, a single class is served by more than one section.

Specified by:

findAdminSectionByClassAndSectionId in interface AdminNavigationService

Returns:

findAdminSectionBySectionKey

public AdminSection findAdminSectionBySectionKey(String sectionKey)

Specified by:

findAdminSectionBySectionKey in interface AdminNavigationService

findBaseAdminSectionByClass

public AdminSection findBaseAdminSectionByClass(String clazz)

Specified by:

findBaseAdminSectionByClass in interface AdminNavigationService

guessClassFromInterfaces

protected String guessClassFromInterfaces(String clazz)

isUserAuthorizedToViewSection

public boolean isUserAuthorizedToViewSection(AdminUser adminUser,
 AdminSection section)

Specified by:

isUserAuthorizedToViewSection in interface AdminNavigationService

findAllAdminSections

public List<AdminSection> findAllAdminSections()

Description copied from interface: AdminNavigationService

Gets all of the AdminSections in the system, sorted by the AdminSection.getDisplayOrder()

Specified by:

findAllAdminSections in interface AdminNavigationService

Returns:

the list of all AdminSections sorted by AdminSection.getDisplayOrder()

checkPermissions

public boolean checkPermissions(Set<String> authorizedPermissionNames,
 String permissionName)

Specified by:

checkPermissions in interface AdminNavigationService

getAdditionalSectionAuthorizations

public List<SectionAuthorization> getAdditionalSectionAuthorizations()

setAdditionalSectionAuthorizations

public void setAdditionalSectionAuthorizations(List<SectionAuthorization> additionalSectionAuthorizations)

getClassNameForSection

public String getClassNameForSection(String sectionKey)

Description copied from interface: AdminNavigationService

Gets the fully qualified ceiling entity classname for this section. If this section is not explicitly defined in the database, will return the value passed into this function. For example, if there is a mapping from "/myentity" to "com.mycompany.myentity", both "http://localhost/myentity" and "http://localhost/com.mycompany.myentity" are valid request paths.

Specified by:

getClassNameForSection in interface AdminNavigationService

Returns:

the className for this sectionKey if found in the database or the sectionKey if not

getSectionCrumbs

public List<SectionCrumb> getSectionCrumbs(String crumbList)

Description copied from interface: AdminNavigationService

Utility method for parsing a delimitted section crumb list (usually the "sectionCrumbs" parameter on the HttpServletRequest). Should return a list of SectionCrumb instances used to identify the different, currently active admin sections.

Specified by:

getSectionCrumbs in interface AdminNavigationService

Parameters:

crumbList - delimitted string of section identifiers

Returns:

currently active admin sections in the order specified in the crumbList param

parseForAllPermission

protected String parseForAllPermission(String currentPermission)

populateAdminMenu

protected void populateAdminMenu(AdminUser adminUser,
 AdminMenu adminMenu,
 List<AdminModule> modules)

buildAuthorizedSectionsList

protected List<AdminSection> buildAuthorizedSectionsList(AdminUser adminUser,
 AdminModule module)