org.alfresco.module.vti.web.fp

Class AbstractMethod

java.lang.Object

org.alfresco.module.vti.web.fp.AbstractMethod

All Implemented Interfaces:

VtiMethod

Direct Known Subclasses:

CheckinDocumentMethod, CheckoutDocumentMethod, CreateUrlDirectories, CreateUrlDirectory, FileOpenDialog, GetDocsMetaInfoMethod, GetDocumentMethod, ListDocumentsMethod, MoveDocumentMethod, NotImplementedVtiMethod, OpenServiceMethod, PutDocumentMethod, RemoveDocumentsMethod, SaveFormDialog, ServerVersionMethod, UncheckoutDocumentMethod, UrlToWebUrlMethod

public abstract class AbstractMethod
extends Object
implements VtiMethod

Abstract base class for all the Vti method handling classes. Base realization of VtiMethod.

Author:

Michael Shavnev

Field Summary

Fields

Modifier and Type	Field and Description
protected UrlHelper	urlHelper
protected MethodHandler	vtiHandler

Constructor Summary

Constructors

Constructor and Description
AbstractMethod()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doExecute(VtiFpRequest request, VtiFpResponse response) Target method that will be executed in child classes
void	execute(VtiFpRequest request, VtiFpResponse response) Executes the vti method
protected WebDAVLockService	getLockService() Access to the WebDAVLockService.
protected static String	getPathWithoutContext(String alfrescoContext, HttpServletRequest m_request) Returns the path, excluding the Servlet Context (if present)
UrlHelper	getUrlHelper()
MethodHandler	getVtiHandler()
protected void	processDocMetaInfo(DocMetaInfo docMetaInfo, VtiFpRequest request, VtiFpResponse response) Create response for DocMetaInfo
void	setLockService(WebDAVLockService lockService) Provides instances of this class with the WebDAVLockService.
void	setUrlHelper(UrlHelper urlHelper)
void	setVtiHandler(MethodHandler vtiHandler)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.module.vti.web.fp.VtiMethod

getName

Field Detail

vtiHandler

protected MethodHandler vtiHandler

urlHelper

protected UrlHelper urlHelper

Constructor Detail

AbstractMethod

public AbstractMethod()

Method Detail

getVtiHandler

public MethodHandler getVtiHandler()

Returns:

the vtiHandler

setVtiHandler

public void setVtiHandler(MethodHandler vtiHandler)

Parameters:

vtiHandler - the vtiHandler to set

getUrlHelper

public UrlHelper getUrlHelper()

Returns:

the urlHelper

setUrlHelper

public void setUrlHelper(UrlHelper urlHelper)

Parameters:

urlHelper - the urlHelper to set

execute

public final void execute(VtiFpRequest request,
                          VtiFpResponse response)

Description copied from interface: VtiMethod

Executes the vti method

Specified by:

execute in interface VtiMethod

Parameters:

request - HttpServletRequest

response - HttpServletResponse

See Also:

VtiMethod.execute(org.alfresco.module.vti.web.fp.VtiFpRequest, org.alfresco.module.vti.web.fp.VtiFpResponse)

doExecute

protected abstract void doExecute(VtiFpRequest request,
                                  VtiFpResponse response)
                           throws VtiMethodException,
                                  IOException

Target method that will be executed in child classes

Parameters:

request - Vti Frontpage request (VtiFpRequest)

response - Vti Frontpage response (VtiFpResponse)

Throws:

VtiMethodException

IOException

processDocMetaInfo

protected void processDocMetaInfo(DocMetaInfo docMetaInfo,
                                  VtiFpRequest request,
                                  VtiFpResponse response)
                           throws VtiMethodException,
                                  IOException

Create response for DocMetaInfo

Parameters:

docMetaInfo - Document Meta Information

request - Vti Frontpage request

response - Vti Frontpage response

Throws:

VtiMethodException

IOException

getPathWithoutContext

protected static String getPathWithoutContext(String alfrescoContext,
                                              HttpServletRequest m_request)

Returns the path, excluding the Servlet Context (if present)

See Also:

WebDAVMethod.getPath()

getLockService

protected WebDAVLockService getLockService()

Access to the WebDAVLockService.

Returns:

the lockService

setLockService

public void setLockService(WebDAVLockService lockService)

Provides instances of this class with the WebDAVLockService.

Parameters:

lockService - the lockService to set