Skip navigation links
com.stellent.cis.web.servlets
Class SCSBaseAuthenticatedServlet
java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
com.stellent.cis.web.servlets.SCSBaseAuthenticatedServlet
- All Implemented Interfaces:
- java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
- Direct Known Subclasses:
- SCSDynamicConverterServlet, SCSDynamicURLServlet, SCSFileDownloadServlet
-
public class SCSBaseAuthenticatedServlet
- extends javax.servlet.http.HttpServlet
Base class for servlets requiring a valid context to execute.
- See Also:
- Serialized Form
Methods inherited from class javax.servlet.http.HttpServlet |
doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service |
Methods inherited from class javax.servlet.GenericServlet |
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
USER_ATTRIBUTE
public static final java.lang.String USER_ATTRIBUTE
-
- See Also:
- Constant Field Values
PRINCIPAL_LOOKUP_ALLOWED
public static final java.lang.String PRINCIPAL_LOOKUP_ALLOWED
-
- See Also:
- Constant Field Values
PRINCIPAL_LOOKUP_SCOPE
public static final java.lang.String PRINCIPAL_LOOKUP_SCOPE
-
- See Also:
- Constant Field Values
PRINCIPAL_LOOKUP_NAME
public static final java.lang.String PRINCIPAL_LOOKUP_NAME
-
- See Also:
- Constant Field Values
GET_USER_PRINCIPAL_ENABLED
public static final java.lang.String GET_USER_PRINCIPAL_ENABLED
-
- See Also:
- Constant Field Values
CONTEXT_PATH
public static final java.lang.String CONTEXT_PATH
-
- See Also:
- Constant Field Values
s_validScopes
protected static java.util.List s_validScopes
m_log
protected org.apache.commons.logging.Log m_log
m_defaultUser
protected java.lang.String m_defaultUser
m_principalLookupAllowed
protected boolean m_principalLookupAllowed
m_principalLookupName
protected java.lang.String m_principalLookupName
m_principalLookupScope
protected java.lang.String m_principalLookupScope
m_getUserPrincipalEnabled
protected boolean m_getUserPrincipalEnabled
m_contextPath
protected java.lang.String m_contextPath
m_commandFacade
protected ICommandFacade m_commandFacade
m_cisApplication
protected ICISApplication m_cisApplication
SCSBaseAuthenticatedServlet
public SCSBaseAuthenticatedServlet()
init
public void init(javax.servlet.ServletConfig servletConfig)
throws javax.servlet.ServletException
-
- Specified by:
init
in interface javax.servlet.Servlet
- Overrides:
init
in class javax.servlet.GenericServlet
-
- Throws:
javax.servlet.ServletException
getDefaultUser
public java.lang.String getDefaultUser()
-
- Returns:
- the default user to use if no user ID is found
setDefaultUser
public void setDefaultUser(java.lang.String defaultUser)
isPrincipalLookupAllowed
public boolean isPrincipalLookupAllowed()
-
- Returns:
- true if the servlet is allowed to lookup a user principal
setPrincipalLookupAllowed
public void setPrincipalLookupAllowed(boolean principalLookupAllowed)
- Set the principal lookup flag
-
- Parameters:
principalLookupAllowed
- if true lookups for principal are allowed
getPrincipalLookupName
public java.lang.String getPrincipalLookupName()
-
- Returns:
- the name of the attribute that holds the principal name
setPrincipalLookupName
public void setPrincipalLookupName(java.lang.String principalLookupName)
getPrincipalLookupScope
public java.lang.String getPrincipalLookupScope()
-
- Returns:
- the principal lookup scope (application, session, or request)
setPrincipalLookupScope
public void setPrincipalLookupScope(java.lang.String principalLookupScope)
isGetUserPrincipalEnabled
public boolean isGetUserPrincipalEnabled()
-
- Returns:
- if true then the getUserPrincipal () call is enabled
setGetUserPrincipalEnabled
public void setGetUserPrincipalEnabled(boolean getUserPrincipalEnabled)
getCisApplication
public ICISApplication getCisApplication()
setCisApplication
public void setCisApplication(ICISApplication cisApplication)
getContext
protected ISCSContext getContext(javax.servlet.http.HttpServletRequest request,
java.lang.String adapterName)
throws CommandException
- Get the context for the request
-
- Returns:
- the context object populated with the current user and adapter
- Throws:
CommandException
lookupObject
protected java.lang.Object lookupObject(javax.servlet.http.HttpServletRequest request,
java.lang.String name)
- Lookup an object according to the levels allowed
-
- Parameters:
request
-
name
-
- Returns:
getCommandFacade
protected ICommandFacade getCommandFacade()
getActiveApi
protected SCSActiveAPI getActiveApi()
getUcpmApi
protected IUCPMAPI getUcpmApi()
isEmpty
protected static boolean isEmpty(java.lang.String string)
- Determine in if the string is empty
-
- Parameters:
string
- the string to test
- Returns:
- true if the string is null or empty
Skip navigation links
Copyright © 1996, 2010, Oracle and/or its affiliates. All rights reserved.