Package com.netscape.cms.servlet.common

Class CMSGateway

  • public class CMSGateway
extends java.lang.Object
    This class is to hold some general method for servlets.
    Version:
    $Revision$, $Date$

    • Constructor Summary

      Constructors 
      Constructor Description
      CMSGateway()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static IAuthToken checkAuthManager​(javax.servlet.http.HttpServletRequest httpReq, IArgBlock httpParams, java.security.cert.X509Certificate cert, java.lang.String authMgrName)  
      static void disableAdminEnroll()  
      static AuthCredentials getAuthCreds​(AuthManager authMgr, IArgBlock argBlock, java.security.cert.X509Certificate clientCert)
      construct a authentication credentials to pass into authentication manager.
      static boolean getEnableAdminEnroll()  
      static java.io.File getLangFile​(javax.servlet.http.HttpServletRequest req, java.io.File realpathFile, java.util.Locale[] locale)  
      static java.util.Locale getLocale​(java.lang.String lang)  
      protected static CMSTemplate getTemplate​(java.lang.String templateName, javax.servlet.http.HttpServletRequest httpReq, javax.servlet.ServletConfig servletConfig, CMSFileLoader fileLoader, java.util.Locale[] locale)
      get a template
      static boolean modifiedSince​(javax.servlet.http.HttpServletRequest req, long lastModified)
      Get the If-Modified-Since header and compare it to the millisecond epoch value passed in.
      static void renderTemplate​(java.lang.String templateName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.ServletConfig servletConfig, CMSFileLoader fileLoader)  
      static void setEnableAdminEnroll​(boolean enableAdminEnroll)  
      static java.util.Hashtable<java.lang.String,​java.lang.String> toHashtable​(javax.servlet.http.HttpServletRequest req)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • logger

        public static org.slf4j.Logger logger

      • mEnableFileServing

        protected static boolean mEnableFileServing

    • Constructor Detail

      • CMSGateway

        public CMSGateway()

    • Method Detail

      • toHashtable

        public static java.util.Hashtable<java.lang.String,​java.lang.String> toHashtable​(javax.servlet.http.HttpServletRequest req)

      • getEnableAdminEnroll

        public static boolean getEnableAdminEnroll()

      • setEnableAdminEnroll

        public static void setEnableAdminEnroll​(boolean enableAdminEnroll)
                                 throws EBaseException
        Throws:
        EBaseException

      • checkAuthManager

        public static IAuthToken checkAuthManager​(javax.servlet.http.HttpServletRequest httpReq,
                                          IArgBlock httpParams,
                                          java.security.cert.X509Certificate cert,
                                          java.lang.String authMgrName)
                                   throws EBaseException
        Throws:
        EBaseException

      • renderTemplate

        public static void renderTemplate​(java.lang.String templateName,
                                  javax.servlet.http.HttpServletRequest req,
                                  javax.servlet.http.HttpServletResponse resp,
                                  javax.servlet.ServletConfig servletConfig,
                                  CMSFileLoader fileLoader)
                           throws EBaseException,
                                  java.io.IOException
        Throws:
        EBaseException
        java.io.IOException

      • getLocale

        public static java.util.Locale getLocale​(java.lang.String lang)

      • getLangFile

        public static java.io.File getLangFile​(javax.servlet.http.HttpServletRequest req,
                                       java.io.File realpathFile,
                                       java.util.Locale[] locale)
                                throws java.io.IOException
        Parameters:
        req - http servlet request
        realpathFile - the file to get.
        locale - array of at least one to be filled with locale found.
        Throws:
        java.io.IOException

      • getTemplate

        protected static CMSTemplate getTemplate​(java.lang.String templateName,
                                         javax.servlet.http.HttpServletRequest httpReq,
                                         javax.servlet.ServletConfig servletConfig,
                                         CMSFileLoader fileLoader,
                                         java.util.Locale[] locale)
                                  throws EBaseException,
                                         java.io.IOException
        get a template
        Throws:
        EBaseException
        java.io.IOException

      • modifiedSince

        public static boolean modifiedSince​(javax.servlet.http.HttpServletRequest req,
                                    long lastModified)
        Get the If-Modified-Since header and compare it to the millisecond epoch value passed in. If there is no header, or there is a problem parsing the value, or if the file has been modified this will return true, indicating the file has changed.
        Parameters:
        lastModified - The time value in milliseconds past the epoch to compare the If-Modified-Since header to.