org.alfresco.web.app.servlet

Class BaseServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.alfresco.web.app.servlet.BaseServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Direct Known Subclasses:

AjaxServlet, BaseDownloadContentServlet, BaseTemplateContentServlet, CommandServlet, DownloadRawContentServlet, ExternalAccessServlet, UploadContentServlet, UploadFileServlet

public abstract class BaseServlet
extends HttpServlet

Base servlet class containing useful constant values and common methods for Alfresco servlets.

Author:

Kevin Roast

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseServlet.PathRefInfo Simple structure class for returning both a NodeRef and Filename String

Field Summary

Fields

Modifier and Type	Field and Description
static String	FACES_SERVLET
static String	KEY_ROOT_PATH
static String	KEY_STORE

Constructor Summary

Constructors

Constructor and Description
BaseServlet()

Method Summary

Modifier and Type	Method and Description
boolean	checkAccess(HttpServletRequest req, HttpServletResponse res, org.alfresco.service.cmr.repository.NodeRef nodeRef, String permission, boolean allowLogIn) Check the user has the given permission on the given node.
static ServiceRegistry	getServiceRegistry(ServletContext sc) Return the ServiceRegistry helper instance
static void	redirectToLoginPage(HttpServletRequest req, HttpServletResponse res, ServletContext sc) Redirect to the Login page - saving the current URL which can be redirected back later once the user has successfully completed the authentication process.
static void	redirectToLoginPage(HttpServletRequest req, HttpServletResponse res, ServletContext sc, boolean sendRedirect) Redirect to the Login page - saving the current URL which can be redirected back later once the user has successfully completed the authentication process.
static BaseServlet.PathRefInfo	resolveNamePath(ServletContext sc, String path) Resolve a name based into a NodeRef and Filename string
static org.alfresco.service.cmr.repository.NodeRef	resolveWebDAVPath(FacesContext context, String[] args) Resolves the given path elements to a NodeRef in the current repository
static org.alfresco.service.cmr.repository.NodeRef	resolveWebDAVPath(FacesContext context, String[] args, boolean decode) Resolves the given path elements to a NodeRef in the current repository
static org.alfresco.service.cmr.repository.NodeRef	resolveWebDAVPath(ServletContext context, String[] args) Resolves the given path elements to a NodeRef in the current repository
static org.alfresco.service.cmr.repository.NodeRef	resolveWebDAVPath(ServletContext context, String[] args, boolean decode) Resolves the given path elements to a NodeRef in the current repository
AuthenticationStatus	servletAuthenticate(HttpServletRequest req, HttpServletResponse res) Perform an authentication for the servlet request URI.
AuthenticationStatus	servletAuthenticate(HttpServletRequest req, HttpServletResponse res, boolean redirectToLoginPage) Perform an authentication for the servlet request URI.
static void	setNoCacheHeaders(HttpServletResponse res) Apply the headers required to disallow caching of the response in the browser
static boolean	validRedirectJSP(String jsp) Returns true if the specified JSP file is valid for a redirect after login.

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, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

FACES_SERVLET

public static final String FACES_SERVLET

See Also:

Constant Field Values

KEY_STORE

public static final String KEY_STORE

See Also:

Constant Field Values

KEY_ROOT_PATH

public static final String KEY_ROOT_PATH

See Also:

Constant Field Values

Constructor Detail

BaseServlet

public BaseServlet()

Method Detail

getServiceRegistry

public static ServiceRegistry getServiceRegistry(ServletContext sc)

Return the ServiceRegistry helper instance

Parameters:

sc - ServletContext

Returns:

ServiceRegistry

servletAuthenticate

public AuthenticationStatus servletAuthenticate(HttpServletRequest req,
                                                HttpServletResponse res)
                                         throws IOException

Perform an authentication for the servlet request URI. Processing any "ticket" or "guest" URL arguments.

Returns:

AuthenticationStatus

Throws:

IOException

servletAuthenticate

public AuthenticationStatus servletAuthenticate(HttpServletRequest req,
                                                HttpServletResponse res,
                                                boolean redirectToLoginPage)
                                         throws IOException

Perform an authentication for the servlet request URI. Processing any "ticket" or "guest" URL arguments.

Returns:

AuthenticationStatus

Throws:

IOException

checkAccess

public boolean checkAccess(HttpServletRequest req,
                           HttpServletResponse res,
                           org.alfresco.service.cmr.repository.NodeRef nodeRef,
                           String permission,
                           boolean allowLogIn)
                    throws IOException,
                           ServletException

Check the user has the given permission on the given node. If they do not either force a log on if this is a guest user or forward to an error page.

Parameters:

req - the request

res - the response

nodeRef - the node in question

allowLogIn - Indicates whether guest users without access to the node should be redirected to the log in page. If false, a status 403 forbidden page is displayed instead.

Returns:

true, if the user has access

Throws:

IOException - Signals that an I/O exception has occurred.

ServletException - On other errors

redirectToLoginPage

public static void redirectToLoginPage(HttpServletRequest req,
                                       HttpServletResponse res,
                                       ServletContext sc)
                                throws IOException

Redirect to the Login page - saving the current URL which can be redirected back later once the user has successfully completed the authentication process.

Throws:

IOException

redirectToLoginPage

public static void redirectToLoginPage(HttpServletRequest req,
                                       HttpServletResponse res,
                                       ServletContext sc,
                                       boolean sendRedirect)
                                throws IOException

Redirect to the Login page - saving the current URL which can be redirected back later once the user has successfully completed the authentication process.

Parameters:

sendRedirect - allow a redirect status code to be set? If false redirect will be via markup rather than status code (to allow the status code to be used for handshake responses etc.

Throws:

IOException

setNoCacheHeaders

public static void setNoCacheHeaders(HttpServletResponse res)

Apply the headers required to disallow caching of the response in the browser

validRedirectJSP

public static boolean validRedirectJSP(String jsp)

Returns true if the specified JSP file is valid for a redirect after login. Only a specific sub-set of the available JSPs are valid to jump directly too after a clean login attempt - e.g. those that do not require JSF bean context setup. This is a limitation of the JSP architecture. The ExternalAccessServlet provides a mechanism to setup the JSF bean context directly for some specific cases.

Parameters:

jsp - Filename of JSP to check, for example "/jsp/browse/browse.jsp"

Returns:

true if the JSP is in the list of valid direct URLs, false otherwise

resolveWebDAVPath

public static org.alfresco.service.cmr.repository.NodeRef resolveWebDAVPath(FacesContext context,
                                                                            String[] args)

Resolves the given path elements to a NodeRef in the current repository

Parameters:

context - Faces context

args - The elements of the path to lookup

resolveWebDAVPath

public static org.alfresco.service.cmr.repository.NodeRef resolveWebDAVPath(FacesContext context,
                                                                            String[] args,
                                                                            boolean decode)

Resolves the given path elements to a NodeRef in the current repository

Parameters:

context - Faces context

args - The elements of the path to lookup

decode - True to decode the arg from UTF-8 format, false for no decoding

resolveWebDAVPath

public static org.alfresco.service.cmr.repository.NodeRef resolveWebDAVPath(ServletContext context,
                                                                            String[] args)

Resolves the given path elements to a NodeRef in the current repository

Parameters:

context - ServletContext context

args - The elements of the path to lookup

resolveWebDAVPath

public static org.alfresco.service.cmr.repository.NodeRef resolveWebDAVPath(ServletContext context,
                                                                            String[] args,
                                                                            boolean decode)

Resolves the given path elements to a NodeRef in the current repository

Parameters:

context - ServletContext context

args - The elements of the path to lookup

decode - True to decode the arg from UTF-8 format, false for no decoding

resolveNamePath

public static final BaseServlet.PathRefInfo resolveNamePath(ServletContext sc,
                                                            String path)

Resolve a name based into a NodeRef and Filename string

Parameters:

sc - ServletContext

path - 'cm:name' based path using the '/' character as a separator

Returns:

PathRefInfo structure containing the resolved NodeRef and filename

Throws:

IllegalArgumentException