Package org.opennms.web.controller

Class NavBarController

  • All Implemented Interfaces:
    MenuProvider, OnmsHeaderProvider, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller
    public class NavBarController
extends org.springframework.web.servlet.mvc.AbstractController
implements org.springframework.beans.factory.InitializingBean, OnmsHeaderProvider, MenuProvider
    This controller uses Freemarker to render the view. This allows for the same code to be used to process calls via the OnmsHeaderProvider interface.
    Author:
    jwhite

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  NavBarController.ShouldDisplayEntryMethod
      Used to determine whether or not a particular NavBarEntry should be displayed.

    • Field Summary

      • Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

        HEADER_CACHE_CONTROL, METHOD_GET, METHOD_HEAD, METHOD_POST

      • Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

        logger

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void afterPropertiesSet()
      afterPropertiesSet
      java.lang.String getHeaderHtml​(javax.servlet.http.HttpServletRequest request)  
      java.util.List<MenuEntry> getMenu​(MenuContext context)  
      java.util.List<NavBarEntry> getNavBarItems()
      getNavBarItems
      protected org.springframework.web.servlet.ModelAndView handleRequestInternal​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      void setNavBarItems​(java.util.List<NavBarEntry> navBarItems)
      setNavBarItems

      • Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

        handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

      • Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

        applyCacheControl, applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, checkRequest, getCacheControl, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, prepareResponse, preventCaching, setAlwaysMustRevalidate, setCacheControl, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

      • Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

        getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

      • Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

        getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • NavBarController

        public NavBarController()

    • Method Detail

      • afterPropertiesSet

        public void afterPropertiesSet()
                        throws java.io.IOException

        afterPropertiesSet

        Specified by:
        afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
        Throws:
        java.io.IOException

      • handleRequestInternal

        protected org.springframework.web.servlet.ModelAndView handleRequestInternal​(javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws java.lang.Exception
        Specified by:
        handleRequestInternal in class org.springframework.web.servlet.mvc.AbstractController
        Throws:
        java.lang.Exception

      • getNavBarItems

        public java.util.List<NavBarEntry> getNavBarItems()

        getNavBarItems

        Returns:
        a List object.

      • setNavBarItems

        public void setNavBarItems​(java.util.List<NavBarEntry> navBarItems)

        setNavBarItems

        Parameters:
        navBarItems - a List object.

      • getHeaderHtml

        public java.lang.String getHeaderHtml​(javax.servlet.http.HttpServletRequest request)
                               throws java.lang.Exception
        Specified by:
        getHeaderHtml in interface OnmsHeaderProvider
        Throws:
        java.lang.Exception