Class BaseController

  • All Implemented Interfaces:
    org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller
    Direct Known Subclasses:
    BaseActionController, BaseFormXmlController, BasePopupController

    public abstract class BaseController
    extends org.springframework.web.servlet.mvc.AbstractController
    Base class for all of the TeamCity web controllers
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected SBuildServer myServer
      Initialized if controller is created with constructor: BaseController(jetbrains.buildServer.serverSide.SBuildServer)
      • 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 Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract org.springframework.web.servlet.ModelAndView doHandle​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Performs actual request processing
      protected java.lang.String getJspFromRequest​(javax.servlet.http.HttpServletRequest request)  
      protected ActionMessages getOrCreateMessages​(javax.servlet.http.HttpServletRequest request)
      Returns messages storage associated with specified HTTP request
      org.springframework.web.servlet.ModelAndView handleRequest​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)  
      org.springframework.web.servlet.ModelAndView handleRequestInternal​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Calls doHandle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method and performs processing of some common exceptions.
      static boolean isGet​(javax.servlet.http.HttpServletRequest request)  
      protected boolean isPost​(javax.servlet.http.HttpServletRequest request)  
      protected org.springframework.web.servlet.ModelAndView redirectTo​(java.lang.String url, javax.servlet.http.HttpServletResponse response)  
      void setExceptionResolvers​(java.util.List<org.springframework.web.servlet.HandlerExceptionResolver> exceptionResolvers)
      Initialized by spring
      protected org.springframework.web.servlet.ModelAndView simpleView​(java.lang.String message)
      Creates simple view which will display the specified message.
      • Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

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

        applyCacheControl, applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, checkRequest, getAllowHeader, getCacheControl, getCacheSeconds, getSupportedMethods, getVaryByRequestHeaders, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, prepareResponse, preventCaching, setAlwaysMustRevalidate, setCacheControl, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader, setVaryByRequestHeaders
      • 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, obtainApplicationContext, requiredContextClass, setApplicationContext
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BaseController

        protected BaseController​(@NotNull
                                 SBuildServer server)
        Constructor.
        Parameters:
        server - SBuildServer instance
      • BaseController

        protected BaseController()
        Constructor
    • Method Detail

      • setExceptionResolvers

        @Autowired
        public void setExceptionResolvers​(java.util.List<org.springframework.web.servlet.HandlerExceptionResolver> exceptionResolvers)
        Initialized by spring
      • handleRequest

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

        public final org.springframework.web.servlet.ModelAndView handleRequestInternal​(javax.servlet.http.HttpServletRequest request,
                                                                                        javax.servlet.http.HttpServletResponse response)
                                                                                 throws java.lang.Exception
        Calls doHandle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method and performs processing of some common exceptions. Every page will also be provided with the following set of additional properties:
        • server - SBuildServer instance
        • serverSummary - ServerSummary
        • currentUser - currently logged in user (SUser instance)
        • pageUrl - URL corresponding to the processed HTTP request
        Specified by:
        handleRequestInternal in class org.springframework.web.servlet.mvc.AbstractController
        Parameters:
        request - HTTP request
        response - HTTP response
        Returns:
        model and view components
        Throws:
        java.lang.Exception - exception
      • doHandle

        @Nullable
        protected abstract org.springframework.web.servlet.ModelAndView doHandle​(@NotNull
                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                 @NotNull
                                                                                 javax.servlet.http.HttpServletResponse response)
                                                                          throws java.lang.Exception
        Performs actual request processing
        Parameters:
        request - HTTP request
        response - HTTP response
        Returns:
        model and view components
        Throws:
        java.lang.Exception - exception
      • getOrCreateMessages

        @NotNull
        protected ActionMessages getOrCreateMessages​(@NotNull
                                                     javax.servlet.http.HttpServletRequest request)
        Returns messages storage associated with specified HTTP request
        Parameters:
        request - HTTP request
        Returns:
        messages storage
      • simpleView

        @NotNull
        protected org.springframework.web.servlet.ModelAndView simpleView​(@NotNull
                                                                          java.lang.String message)
        Creates simple view which will display the specified message.
        Parameters:
        message - message to display
        Returns:
        simple view which will display the specified message
      • getJspFromRequest

        @Nullable
        protected java.lang.String getJspFromRequest​(@NotNull
                                                     javax.servlet.http.HttpServletRequest request)
      • isPost

        protected boolean isPost​(@NotNull
                                 javax.servlet.http.HttpServletRequest request)
      • isGet

        public static boolean isGet​(@NotNull
                                    javax.servlet.http.HttpServletRequest request)
      • redirectTo

        @Nullable
        protected org.springframework.web.servlet.ModelAndView redirectTo​(@NotNull
                                                                          java.lang.String url,
                                                                          @NotNull
                                                                          javax.servlet.http.HttpServletResponse response)