com.netscape.cms.servlet.base

Class DynamicVariablesServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.netscape.cms.servlet.base.CMSServlet

com.netscape.cms.servlet.base.DynamicVariablesServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class DynamicVariablesServlet
extends CMSServlet

Return some javascript to the request which contains the list of dynamic data in the CMS system.

This allows the requestor (browser) to make decisions about what to present in the UI, depending on how CMS is configured

Version:

$Revision$, $Date$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_ACCESS
static java.lang.String	PROP_AUTHMGR
static java.lang.String	PROP_AUTHORITY
static java.lang.String	PROP_CLIENTAUTH
static java.lang.String	PROP_CLONING

Fields inherited from class com.netscape.cms.servlet.base.CMSServlet

ADMIN_GROUP, AUTH_FAILURE, AUTHMGR_PARAM, AUTHZ_CONFIG_STORE, AUTHZ_MGR_BASIC, AUTHZ_MGR_LDAP, AUTHZ_SRC_LDAP, AUTHZ_SRC_TYPE, AUTHZ_SRC_XML, CA_AGENT_GROUP, CERT_ATTR, certAuthority, ERROR_MSG_TOKEN, ERROR_TEMPLATE, EXCEPTION_TEMPLATE, FAILURE, FINAL_ERROR_MSG, FULL_ENROLLMENT_REQUEST, FULL_ENROLLMENT_RESPONSE, FULL_RESPONSE, KRA_AGENT_GROUP, mAclMethod, mAuthority, mAuthz, mAuthzResourceName, mConfig, mDontSaveHttpParams, mFinalErrorMsg, mId, mLogCategory, mLogger, mOutputTemplatePath, mRenderResult, mRequestQueue, mSaveHttpHeaders, mServletConfig, mServletContext, mSignedAuditLogger, mTemplates, OCSP_AGENT_GROUP, PENDING_TEMPLATE, PFX_AUTH_TOKEN, PFX_HTTP_HEADER, PFX_HTTP_PARAM, PROP_ACL, PROP_AUTHORITYID, PROP_AUTHZ_MGR, PROP_ERROR_TEMPLATE, PROP_EXCEPTION_TEMPLATE, PROP_FINAL_ERROR_MSG, PROP_ID, PROP_PENDING_TEMPLATE, PROP_REJECTED_TEMPLATE, PROP_RESOURCEID, PROP_SUCCESS_TEMPLATE, PROP_SUCCESS_TEMPLATE_FILLER, PROP_SVC_PENDING_TEMPLATE, PROP_UNAUTHORIZED_TEMPLATE, RA_AGENT_GROUP, REJECTED_TEMPLATE, servletConfig, SIMPLE_ENROLLMENT_REQUEST, SIMPLE_ENROLLMENT_RESPONSE, SUCCESS, SUCCESS_TEMPLATE, SVC_PENDING_TEMPLATE, TEMPLATE_NAME, TRUSTED_RA_GROUP, UNAUTHORIZED_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
DynamicVariablesServlet()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getServletInfo() Returns serlvet information.
void	init(javax.servlet.ServletConfig sc) Reads the following variables from the servlet config: AuthMgr - the authentication manager to use to authenticate the request GetClientCert - whether to request client auth for this request authority - the authority (ca, ra, drm) to return to the client dynamicVariables - a string of the form: serverdate=serverdate(),subsystemname=subsystemname(), http=http(),authmgrs=authmgrs(),clacrlurl=clacrlurl() The dynamicVariables string is parsed by splitting on commas.
void	service(javax.servlet.http.HttpServletRequest httpReq, javax.servlet.http.HttpServletResponse httpResp)

Methods inherited from class com.netscape.cms.servlet.base.CMSServlet

areCertsFromCA, audit, auditGroupID, auditSubjectID, authenticate, authenticate, authenticate, authenticate, authorize, authorize, certIsRevoked, checkImportCertToNav, clientIsMSIE, clientIsNav, connectionIsSSL, doCMMFResponse, doFullResponse, formCRLEntry, generateSalt, getAuthCreds, getAuthMgr, getAuthToken, getCertRecord, getDontSaveHttpParams, getId, getLangFile, getLocale, getLocale, getRelPath, getSaveHttpHeaders, getSSLClientCertificate, getTemplate, getX509Certificate, hashPassword, importCertToNav, invalidateSSLSession, isCertFromCA, isClientCertRequired, isSystemCertificate, log, log, newCMSRequest, newFillerObject, outputArgBlockAsXML, outputError, outputError, outputError, outputHttpParameters, outputResult, outputXML, process, renderException, renderFinalError, renderResult, renderTemplate, saveAuthToken, saveHttpHeaders, saveHttpParams, setDefaultTemplates, toHashtable

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

PROP_ACCESS

public static final java.lang.String PROP_ACCESS

See Also:

Constant Field Values

PROP_AUTHMGR

public static final java.lang.String PROP_AUTHMGR

See Also:

Constant Field Values

PROP_CLIENTAUTH

public static final java.lang.String PROP_CLIENTAUTH

See Also:

Constant Field Values

PROP_AUTHORITY

public static final java.lang.String PROP_AUTHORITY

See Also:

Constant Field Values

PROP_CLONING

public static final java.lang.String PROP_CLONING

See Also:

Constant Field Values

Constructor Detail

DynamicVariablesServlet

public DynamicVariablesServlet()

Method Detail

getServletInfo

public java.lang.String getServletInfo()

Returns serlvet information.

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

init

public void init(javax.servlet.ServletConfig sc)
          throws javax.servlet.ServletException

Reads the following variables from the servlet config:

• AuthMgr - the authentication manager to use to authenticate the request
• GetClientCert - whether to request client auth for this request
• authority - the authority (ca, ra, drm) to return to the client
• dynamicVariables - a string of the form: serverdate=serverdate(),subsystemname=subsystemname(), http=http(),authmgrs=authmgrs(),clacrlurl=clacrlurl()

The dynamicVariables string is parsed by splitting on commas. When services, the HTTP request provides a piece of javascript code as follows.

Each sub expression "lhs=rhs()" forms a javascript statement of the form lhs=xxx; Where lhs is xxx is the result of 'evaluating' the rhs. The possible values for the rhs() function are:

• serverdate() - the timestamp of the server (used to ensure that the client clock is set correctly)
• subsystemname()
• http() - "true" or "false" - is this an http connection (as opposed to https)
• authmgrs() - a comma separated list of authentication managers
• clacrlurl() - the URL to get the CRL from, in the case of a Clone CA. This is defined in the CMS configuration parameter 'cloning.cloneMasterCrlUrl'

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class CMSServlet

Throws:

javax.servlet.ServletException

See Also:

Servlet.init(ServletConfig)

service

public void service(javax.servlet.http.HttpServletRequest httpReq,
                    javax.servlet.http.HttpServletResponse httpResp)
             throws javax.servlet.ServletException,
                    java.io.IOException

Overrides:

service in class CMSServlet

Throws:

javax.servlet.ServletException

java.io.IOException