Class CMSGateway

java.lang.Object

com.netscape.cms.servlet.common.CMSGateway

public class CMSGateway
extends Object

This class is to hold some general method for servlets.

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AUTHMGR_PARAM
static final String	CERT_ATTR
static org.slf4j.Logger	logger
protected static boolean	mEnableFileServing
protected static CMSFileLoader	mFileLoader
static final String	PROP_CMSGATEWAY

Constructor Summary

Constructors

Constructor	Description
CMSGateway()

Method Summary

Modifier and Type	Method	Description
static IAuthToken	checkAuthManager(javax.servlet.http.HttpServletRequest httpReq, IArgBlock httpParams, X509Certificate cert, String authMgrName)
static void	disableAdminEnroll()
static AuthCredentials	getAuthCreds(AuthManager authMgr, IArgBlock argBlock, X509Certificate clientCert)	construct a authentication credentials to pass into authentication manager.
static boolean	getEnableAdminEnroll()
static File	getLangFile(javax.servlet.http.HttpServletRequest req, File realpathFile, Locale[] locale)
static Locale	getLocale(String lang)
protected static CMSTemplate	getTemplate(String templateName, javax.servlet.http.HttpServletRequest httpReq, javax.servlet.ServletConfig servletConfig, CMSFileLoader fileLoader, 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(String templateName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, javax.servlet.ServletConfig servletConfig, CMSFileLoader fileLoader)
static void	setEnableAdminEnroll(boolean enableAdminEnroll)
static Hashtable<String,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 Details

logger

public static org.slf4j.Logger logger

PROP_CMSGATEWAY

public static final String PROP_CMSGATEWAY

See Also:

• Constant Field Values

CERT_ATTR

public static final String CERT_ATTR

See Also:

• Constant Field Values

mFileLoader

protected static CMSFileLoader mFileLoader

mEnableFileServing

protected static boolean mEnableFileServing

AUTHMGR_PARAM

protected static final String AUTHMGR_PARAM

See Also:

• Constant Field Values

Constructor Details

CMSGateway

public CMSGateway()

Method Details

toHashtable

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

getEnableAdminEnroll

public static boolean getEnableAdminEnroll()

setEnableAdminEnroll

public static void setEnableAdminEnroll(boolean enableAdminEnroll)
                                 throws EBaseException

Throws:

EBaseException

disableAdminEnroll

public static void disableAdminEnroll()
                               throws EBaseException

Throws:

EBaseException

getAuthCreds

public static AuthCredentials getAuthCreds(AuthManager authMgr,
 IArgBlock argBlock,
 X509Certificate clientCert)
                                    throws EBaseException

construct a authentication credentials to pass into authentication manager.

Throws:

EBaseException

checkAuthManager

public static IAuthToken checkAuthManager(javax.servlet.http.HttpServletRequest httpReq,
 IArgBlock httpParams,
 X509Certificate cert,
 String authMgrName)
                                   throws EBaseException

Throws:

EBaseException

renderTemplate

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

Throws:

EBaseException

IOException

getLocale

public static Locale getLocale(String lang)

getLangFile

public static File getLangFile(javax.servlet.http.HttpServletRequest req,
 File realpathFile,
 Locale[] locale)
                        throws IOException

Parameters:

req - http servlet request

realpathFile - the file to get.

locale - array of at least one to be filled with locale found.

Throws:

IOException

getTemplate

protected static CMSTemplate getTemplate(String templateName,
 javax.servlet.http.HttpServletRequest httpReq,
 javax.servlet.ServletConfig servletConfig,
 CMSFileLoader fileLoader,
 Locale[] locale)
                                  throws EBaseException,
IOException

get a template

Throws:

EBaseException

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.