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.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
CMSGateway()

Method Summary

Modifier and Type	Method	Description
AuthToken	checkAuthManager(jakarta.servlet.http.HttpServletRequest httpReq, ArgBlock httpParams, X509Certificate cert, String authMgrName)
void	disableAdminEnroll()
AuthCredentials	getAuthCreds(AuthManager authMgr, ArgBlock argBlock, X509Certificate clientCert)	construct a authentication credentials to pass into authentication manager.
CMSEngine	getCMSEngine()
boolean	getEnableAdminEnroll()
File	getLangFile(jakarta.servlet.http.HttpServletRequest req, File realpathFile, Locale[] locale)
Locale	getLocale(String lang)
protected CMSTemplate	getTemplate(String templateName, jakarta.servlet.http.HttpServletRequest httpReq, jakarta.servlet.ServletConfig servletConfig, CMSFileLoader fileLoader, Locale[] locale)	get a template
void	init()
boolean	modifiedSince(jakarta.servlet.http.HttpServletRequest req, long lastModified)	Get the If-Modified-Since header and compare it to the millisecond epoch value passed in.
void	renderTemplate(String templateName, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp, jakarta.servlet.ServletConfig servletConfig, CMSFileLoader fileLoader)
void	setCMSEngine(CMSEngine engine)
void	setEnableAdminEnroll(boolean enableAdminEnroll)
Hashtable<String,String>	toHashtable(jakarta.servlet.http.HttpServletRequest req)

Methods inherited from class 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

engine

protected CMSEngine engine

mFileLoader

protected CMSFileLoader mFileLoader

mEnableFileServing

protected boolean mEnableFileServing

mEnableAdminEnroll

protected boolean mEnableAdminEnroll

mConfig

protected ConfigStore mConfig

AUTHMGR_PARAM

protected static final String AUTHMGR_PARAM

See Also:

• Constant Field Values

Constructor Details

CMSGateway

public CMSGateway()

Method Details

getCMSEngine

public CMSEngine getCMSEngine()

setCMSEngine

public void setCMSEngine(CMSEngine engine)

init

public void init()
          throws Exception

Throws:

Exception

toHashtable

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

getEnableAdminEnroll

public boolean getEnableAdminEnroll()

setEnableAdminEnroll

public void setEnableAdminEnroll(boolean enableAdminEnroll)
                          throws EBaseException

Throws:

EBaseException

disableAdminEnroll

public void disableAdminEnroll()
                        throws EBaseException

Throws:

EBaseException

getAuthCreds

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

construct a authentication credentials to pass into authentication manager.

Throws:

EBaseException

checkAuthManager

public AuthToken checkAuthManager(jakarta.servlet.http.HttpServletRequest httpReq,
 ArgBlock httpParams,
 X509Certificate cert,
 String authMgrName)
                           throws EBaseException

Throws:

EBaseException

renderTemplate

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

Throws:

EBaseException

IOException

getLocale

public Locale getLocale(String lang)

getLangFile

public File getLangFile(jakarta.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 CMSTemplate getTemplate(String templateName,
 jakarta.servlet.http.HttpServletRequest httpReq,
 jakarta.servlet.ServletConfig servletConfig,
 CMSFileLoader fileLoader,
 Locale[] locale)
                           throws EBaseException,
IOException

get a template

Throws:

EBaseException

IOException

modifiedSince

public boolean modifiedSince(jakarta.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.