IndexServlet (pki-javadoc)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - com.netscape.cms.servlet.base.CMSServlet
    - - com.netscape.cms.servlet.base.IndexServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
```
public class IndexServlet
extends CMSServlet
```
This is the servlet that builds the index page in various ports.

Version:

$Revision$, $Date$

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String PROP_TEMPLATE
- Fields inherited from class com.netscape.cms.servlet.base.CMSServlet
  ADMIN_GROUP, AUTH_FAILURE, AUTHMGR_PARAM, 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, logger, mAclMethod, mAuthMgr, mAuthority, mAuthz, mAuthzResourceName, mConfig, mDontSaveHttpParams, mFinalErrorMsg, mGetClientCert, mId, mLogCategory, mOutputTemplatePath, mRenderResult, mRequestQueue, mSaveHttpHeaders, mServletConfig, mServletContext, mTemplates, OCSP_AGENT_GROUP, PENDING_TEMPLATE, PFX_AUTH_TOKEN, PFX_HTTP_HEADER, PFX_HTTP_PARAM, PROP_ACL, PROP_AUTHMGR, PROP_AUTHORITY, PROP_AUTHORITYID, PROP_AUTHZ_MGR, PROP_CLIENTAUTH, 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, signedAuditLogger, SIMPLE_ENROLLMENT_REQUEST, SIMPLE_ENROLLMENT_RESPONSE, SUCCESS, SUCCESS_TEMPLATE, SVC_PENDING_TEMPLATE, TEMPLATE_NAME, TRUSTED_RA_GROUP, UNAUTHORIZED_TEMPLATE

Constructor Summary

Constructors
Constructor Description

IndexServlet()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getServletInfo()`	Returns serlvet information.
`void`	`init(javax.servlet.ServletConfig sc)`
`CMSRequest`	`newCMSRequest()`	Create a new CMSRequest object.
`void`	`process(CMSRequest cmsReq)`	Serves HTTP request.

Methods inherited from class com.netscape.cms.servlet.base.CMSServlet
areCertsFromCA, audit, 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, getSSLClientCertificate, getTemplate, getX509Certificate, hashPassword, importCertToNav, invalidateSSLSession, isCertFromCA, isClientCertRequired, isSystemCertificate, newFillerObject, outputArgBlockAsXML, outputError, outputError, outputError, outputHttpParameters, outputResult, outputXML, renderException, renderFinalError, renderResult, renderTemplate, saveAuthToken, saveHttpHeaders, saveHttpParams, service, 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_TEMPLATE
```
public static final java.lang.String PROP_TEMPLATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IndexServlet
```
public IndexServlet()
```
- Method Detail
  - init
```
public void init(javax.servlet.ServletConfig sc)
          throws javax.servlet.ServletException
```
    Specified by:
    
    init in interface javax.servlet.Servlet
    
    Overrides:
    
    init in class CMSServlet
    
    Throws:
    
    javax.servlet.ServletException
  - newCMSRequest
```
public CMSRequest newCMSRequest()
```
    Description copied from class: CMSServlet
    
    Create a new CMSRequest object. This should be overriden by servlets implementing different types of request
    
    Overrides:
    
    newCMSRequest in class CMSServlet
    
    Returns:
    
    a new CMSRequest object
  - getServletInfo
```
public java.lang.String getServletInfo()
```
    Returns serlvet information.
    
    Specified by:
    
    getServletInfo in interface javax.servlet.Servlet
    
    Overrides:
    
    getServletInfo in class javax.servlet.GenericServlet
  - process
```
public void process(CMSRequest cmsReq)
             throws EBaseException
```
    Serves HTTP request.
    
    Overrides:
    
    process in class CMSServlet
    
    Throws:
    
    EBaseException - if the servlet was unable to satisfactorily process the request