Class CMSAdminServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.netscape.cms.servlet.admin.AdminServlet

com.netscape.cms.servlet.admin.CMSAdminServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class CMSAdminServlet
extends AdminServlet

A class representings an administration servlet. This servlet is responsible to serve Certificate Server level administrative operations such as configuration parameter updates.

Version:

$Revision$, $Date$

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger

Fields inherited from class AdminServlet

auditor, AUTHZ_MGR_BASIC, AUTHZ_MGR_LDAP, AUTHZ_RES_NAME, AUTHZ_SRC_LDAP, AUTHZ_SRC_TYPE, AUTHZ_SRC_XML, CERT_ATTR, ERROR, mAclMethod, mAuthz, mConfig, mOp, mToken, PROP_ACL, PROP_AUTHZ_MGR, PROP_ID, RESTART, SUCCESS

Modifier and Type	Field	Description
protected Auditor	auditor
static final String	AUTHZ_MGR_BASIC
static final String	AUTHZ_MGR_LDAP
protected static String	AUTHZ_RES_NAME
static final String	AUTHZ_SRC_LDAP
static final String	AUTHZ_SRC_TYPE
static final String	AUTHZ_SRC_XML
static final String	CERT_ATTR
static int	ERROR
protected String	mAclMethod
protected AuthzSubsystem	mAuthz
protected EngineConfig	mConfig
protected String	mOp
protected AuthzToken	mToken
static final String	PROP_ACL
static final String	PROP_AUTHZ_MGR
static final String	PROP_ID
static int	RESTART
static int	SUCCESS

Constructor Summary

Constructors

Constructor	Description
CMSAdminServlet()	Constructs CA servlet.

Method Summary

Modifier and Type	Method	Description
String	getCertConfigNickname(String val)
String	getCertNickname(String nickName)
String	getNickname(String certType)
String	getServletInfo()	Returns serlvet information.
void	init(javax.servlet.ServletConfig config)	Initializes this servlet.
void	installCASigningCert(String fullName, String nickname, String tokenName)
void	installOCSPSigningCert(String fullName, String nickname, String tokenName)
boolean	isSubsystemInstalled(String subsystem)
void	issueImportCert(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)	Issue import certificate
void	modifyAgentGatewayCert(String nickName)
void	modifyCACert(javax.servlet.http.HttpServletRequest request, String value)
void	modifyCAGatewayCert(ICertificateAuthority ca, String nickName)
void	modifyEEGatewayCert(IRegistrationAuthority ra, String nickName)
void	modifyRADMCert(String nickName)
void	modifyServerCert(String nickname)
void	readEncryption(NameValuePairs params)
void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)	Serves HTTP request.
void	setCANewnickname(String tokenName, String nickname)
void	setOCSPNewnickname(String tokenName, String nickname)
void	setRootCertTrust(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)

Methods inherited from class AdminServlet

audit, audit, auditParams, auditSubjectID, authenticate, authorize, authorize, commit, convertStringArrayToNVPairs, getAuthCreds, getClassByNameAsExtendedPluginInfo, getConfig, getLocale, getParameter, listConfig, outputHttpParameters, sendResponse, setConfig, URLdecode

Modifier and Type	Method	Description
protected void	audit(LogEvent event)
protected void	audit(String msg)	Signed Audit Log This method is inherited by all extended admin servlets and is called to store messages to the signed audit log.
protected String	auditParams(javax.servlet.http.HttpServletRequest req)	Signed Audit Parameters This method is inherited by all extended admin servlets and is called to extract parameters from the HttpServletRequest and return a string of name;;value pairs separated by a '+' if more than one name;;value pair exists.
protected String	auditSubjectID()	Signed Audit Log Subject ID This method is inherited by all extended "CMSServlet"s, and is called to obtain the "SubjectID" for a signed audit log message.
protected void	authenticate(javax.servlet.http.HttpServletRequest req)	Authenticates to the identity scope with the given userid and password via identity manager.
boolean	authorize(IAuthToken token)	authorize a user based on its authentication credentials.
protected AuthzToken	authorize(javax.servlet.http.HttpServletRequest req)	Authorize must occur after Authenticate
protected void	commit(boolean createBackup)	FileConfigStore functionality The original config file is moved to ..
protected NameValuePairs	convertStringArrayToNVPairs(String[] s)
static AuthCredentials	getAuthCreds(AuthManager authMgr, X509Certificate clientCert)
protected static IExtendedPluginInfo	getClassByNameAsExtendedPluginInfo(String className)
protected void	getConfig(IConfigStore config, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)	Generic configuration store get operation.
protected Locale	getLocale(javax.servlet.http.HttpServletRequest req)	Retrieves locale based on the request.
protected String	getParameter(javax.servlet.http.HttpServletRequest req, String name)
protected void	listConfig(IConfigStore config, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)	Lists configuration store.
void	outputHttpParameters(javax.servlet.http.HttpServletRequest httpReq)
protected void	sendResponse(int returnCode, String errorMsg, NameValuePairs params, javax.servlet.http.HttpServletResponse resp)	Sends response.
protected void	setConfig(IConfigStore config, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)	Generic configuration store set operation.
protected String	URLdecode(String s)	URL decodes the given string.

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 Object

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

Field Details

logger

public static org.slf4j.Logger logger

Constructor Details

CMSAdminServlet

public CMSAdminServlet()

Constructs CA servlet.

Method Details

init

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

Initializes this servlet.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class AdminServlet

Throws:

javax.servlet.ServletException

getServletInfo

public String getServletInfo()

Returns serlvet information.

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

service

public void service(javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse resp)
             throws javax.servlet.ServletException,
IOException

Serves HTTP request.

Overrides:

service in class AdminServlet

Throws:

javax.servlet.ServletException

IOException

isSubsystemInstalled

public boolean isSubsystemInstalled(String subsystem)

readEncryption

public void readEncryption(NameValuePairs params)
                    throws EBaseException

Throws:

EBaseException

getCertNickname

public String getCertNickname(String nickName)

modifyCACert

public void modifyCACert(javax.servlet.http.HttpServletRequest request,
 String value)
                  throws EBaseException

Throws:

EBaseException

modifyServerCert

public void modifyServerCert(String nickname)
                      throws EBaseException

Throws:

EBaseException

getCertConfigNickname

public String getCertConfigNickname(String val)
                             throws EBaseException

Throws:

EBaseException

modifyRADMCert

public void modifyRADMCert(String nickName)

modifyAgentGatewayCert

public void modifyAgentGatewayCert(String nickName)

modifyEEGatewayCert

public void modifyEEGatewayCert(IRegistrationAuthority ra,
 String nickName)

modifyCAGatewayCert

public void modifyCAGatewayCert(ICertificateAuthority ca,
 String nickName)

setCANewnickname

public void setCANewnickname(String tokenName,
 String nickname)
                      throws EBaseException

Throws:

EBaseException

setOCSPNewnickname

public void setOCSPNewnickname(String tokenName,
 String nickname)
                        throws EBaseException

Throws:

EBaseException

issueImportCert

public void issueImportCert(javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse resp)
                     throws javax.servlet.ServletException,
IOException,
EBaseException

Issue import certificate

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_TRUSTED_PUBLIC_KEY used when "Certificate Setup Wizard" is used to import CA certs into the certificate database

Throws:

javax.servlet.ServletException - a servlet error has occurred

IOException - an input/output error has occurred

EBaseException - failed to issue an import certificate

installCASigningCert

public void installCASigningCert(String fullName,
 String nickname,
 String tokenName)
                          throws EBaseException

Throws:

EBaseException

installOCSPSigningCert

public void installOCSPSigningCert(String fullName,
 String nickname,
 String tokenName)
                            throws EBaseException

Throws:

EBaseException

getNickname

public String getNickname(String certType)
                   throws EBaseException

Throws:

EBaseException

setRootCertTrust

public void setRootCertTrust(javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse resp)
                      throws javax.servlet.ServletException,
IOException,
EBaseException

Throws:

javax.servlet.ServletException

IOException

EBaseException