Class AuthAdminServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.netscape.cms.servlet.admin.AdminServlet

com.netscape.cms.servlet.admin.AuthAdminServlet

All Implemented Interfaces:

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

public class AuthAdminServlet
extends AdminServlet

A class representing an administration servlet for the Authentication Management subsystem. This servlet is responsible to serve configuration requests for the Auths Management subsystem.

Version:

$Revision$, $Date$

See Also:

• Serialized Form

Field Summary

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, logger, 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
static org.slf4j.Logger	logger
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
AuthAdminServlet()

Method Summary

Modifier and Type	Method	Description
String	getServletInfo()	Returns serlvet information.
void	init(javax.servlet.ServletConfig config)	Initializes this servlet.
void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)	Serves HTTP admin request.

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

Constructor Details

AuthAdminServlet

public AuthAdminServlet()

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 admin request.

Overrides:

service in class AdminServlet

Throws:

javax.servlet.ServletException

IOException