org.alfresco.module.vti.web.ws

Class AbstractEndpoint

java.lang.Object

org.alfresco.module.vti.web.VtiUtilBase

org.alfresco.module.vti.web.ws.AbstractEndpoint

All Implemented Interfaces:

VtiEndpoint

Direct Known Subclasses:

AbstractListEndpoint, AbstractMeetingEndpoint, AbstractVersionEndpoint, AbstractWorkspaceEndpoint, AddUserCollectionToRoleEndpoint, CanCreateDwsUrlEndpoint, CheckInFileEndpoint, CheckOutFileEndpoint, CreateDwsEndpoint, CreateFolderEndpoint, DeleteDwsEndpoint, DeleteFolderEndpoint, GetDwsDataEndpoint, GetDwsMetaDataEndpoint, GetListTemplatesEndpoint, GetMeetingsInformationEndpoint, GetMeetingWorkspacesEndpoint, GetUserLoginFromEmailEndpoint, GetWebCollectionEndpoint, GetWebEndpoint, IsClaimsModeEndpoint, RemoveDwsUserEndpoint, RenameDwsEndpoint, SetAttendeeResponseEndpoint, UndoCheckOutFileEndpoint, UpdateDwsDataEndpoint, WebUrlFromPageUrlEndpoint

public abstract class AbstractEndpoint
extends VtiUtilBase
implements VtiEndpoint

Abstract base class for all the VtiEndpoint realizations.

Author:

Stas Sokolovsky

Field Summary

Fields

Modifier and Type	Field and Description
static String	DWS
protected String	name
protected String	namespace
protected static String	soapPart
protected static String	soapUri
protected static String	soapUriPrefix

Constructor Summary

Constructors

Constructor and Description
AbstractEndpoint()

Method Summary

Modifier and Type	Method and Description
protected org.dom4j.Element	buildResultTag(VtiSoapResponse soapResponse)
static String	buildXPath(String prefix, String searchPath) Build XPath
String	generateXml(AssigneeBean assigneeBean) Convert AssigneeBean type to the correct xml presentation
String	generateXml(DocumentBean documentBean) Convert DocumentBean type to the correct xml presentation
String	generateXml(DwsBean dwsBean) Convert DwsBean type to the correct xml presentation
String	generateXml(DwsData dwsData) Convert DwsData type to the correct xml presentation
String	generateXml(DwsMetadata dwsMetadata) Convert DwsMetadata type to the correct xml presentation
String	generateXml(LinkBean linkBean) Convert LinkBean type to the correct xml presentation
String	generateXml(ListInfoBean listInfoBean) Convert ListInfoBean type to the correct xml presentation
String	generateXml(MemberBean memberBean) Convert MemberBean type to the correct xml presentation
String	generateXml(SchemaBean schemaBean) Convert SchemaBean type to the correct xml presentation
String	generateXml(SchemaFieldBean schemaFieldBean) Convert SchemaFieldBean type to the correct xml presentation
String	generateXml(TaskBean taskBean) Convert TaskBean type to the correct xml presentation
String	generateXml(UserBean userBean) Convert UserBean type to the correct xml presentation
static String	getContext(VtiSoapRequest request) Return current context
static String	getDwsForCreationFromUri(VtiSoapRequest request) Get current DWS name for DWS creation from requested URI
static String	getDwsFromUri(VtiSoapRequest request) Get current DWS name from requested URI
String	getFileName(VtiSoapRequest soapRequest, org.jaxen.XPath fileNamePath) Get the (relative) file name that was requested.
String	getHost(VtiSoapRequest request) Return current host
protected String	getMessage(String name) TODO Fix up the message files so we can get rid of this nasty hack!
String	getName()
String	getNamespace()
String	getResponseTagName()
String	getResultTagName()
UrlHelper	getUrlHelper()
void	setName(String name) Endpoint name setter
void	setNamespace(String namespace) Endpoint namespace setter
void	setUrlHelper(UrlHelper urlHelper) Provide the endpoint with a UrlHelper.

Methods inherited from class org.alfresco.module.vti.web.VtiUtilBase

endTag, processTag, singleTag, singleTag, startTag, startTag

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.ws.VtiEndpoint

execute

Field Detail

DWS

public static final String DWS

See Also:

Constant Field Values

soapPart

protected static String soapPart

soapUriPrefix

protected static String soapUriPrefix

soapUri

protected static String soapUri

name

protected String name

namespace

protected String namespace

Constructor Detail

AbstractEndpoint

public AbstractEndpoint()

Method Detail

setName

public void setName(String name)

Endpoint name setter

Parameters:

name -

setNamespace

public void setNamespace(String namespace)

Endpoint namespace setter

Parameters:

namespace -

setUrlHelper

public void setUrlHelper(UrlHelper urlHelper)

Provide the endpoint with a UrlHelper.

Parameters:

urlHelper -

getName

public String getName()

Specified by:

getName in interface VtiEndpoint

Returns:

the name of the endpoint

See Also:

VtiEndpoint.getName()

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface VtiEndpoint

Returns:

the namespace of the endpoint

See Also:

VtiEndpoint.getNamespace()

getUrlHelper

public UrlHelper getUrlHelper()

Specified by:

getUrlHelper in interface VtiEndpoint

getResponseTagName

public String getResponseTagName()

Specified by:

getResponseTagName in interface VtiEndpoint

Returns:

the response tag name

getResultTagName

public String getResultTagName()

Specified by:

getResultTagName in interface VtiEndpoint

Returns:

the result tag name

buildXPath

public static String buildXPath(String prefix,
                                String searchPath)

Build XPath

Parameters:

prefix - prefix

searchPath - source path

getContext

public static String getContext(VtiSoapRequest request)

Return current context

Parameters:

request - Vti Soap Request (VtiSoapRequest)

getHost

public String getHost(VtiSoapRequest request)

Return current host

Parameters:

request - Vti Soap Request (VtiSoapRequest)

getDwsFromUri

public static String getDwsFromUri(VtiSoapRequest request)

Get current DWS name from requested URI

Parameters:

request - Vti Soap Request (VtiSoapRequest)

getFileName

public String getFileName(VtiSoapRequest soapRequest,
                          org.jaxen.XPath fileNamePath)
                   throws Exception

Get the (relative) file name that was requested.

Throws:

Exception

getDwsForCreationFromUri

public static String getDwsForCreationFromUri(VtiSoapRequest request)

Get current DWS name for DWS creation from requested URI

Parameters:

request - Vti Soap Request (VtiSoapRequest)

generateXml

public String generateXml(AssigneeBean assigneeBean)

Convert AssigneeBean type to the correct xml presentation

Parameters:

assigneeBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(DocumentBean documentBean)

Convert DocumentBean type to the correct xml presentation

Parameters:

documentBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(DwsBean dwsBean)

Convert DwsBean type to the correct xml presentation

Parameters:

dwsBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(DwsData dwsData)

Convert DwsData type to the correct xml presentation

Parameters:

dwsData - object to convert

Returns:

xml presentation

generateXml

public String generateXml(DwsMetadata dwsMetadata)

Convert DwsMetadata type to the correct xml presentation

Parameters:

dwsMetadata - object to convert

Returns:

xml presentation

generateXml

public String generateXml(LinkBean linkBean)

Convert LinkBean type to the correct xml presentation

Parameters:

linkBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(ListInfoBean listInfoBean)

Convert ListInfoBean type to the correct xml presentation

Parameters:

listInfoBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(MemberBean memberBean)

Convert MemberBean type to the correct xml presentation

Parameters:

memberBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(SchemaBean schemaBean)

Convert SchemaBean type to the correct xml presentation

Parameters:

schemaBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(SchemaFieldBean schemaFieldBean)

Convert SchemaFieldBean type to the correct xml presentation

Parameters:

schemaFieldBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(TaskBean taskBean)

Convert TaskBean type to the correct xml presentation

Parameters:

taskBean - object to convert

Returns:

xml presentation

generateXml

public String generateXml(UserBean userBean)

Convert UserBean type to the correct xml presentation

Parameters:

userBean - object to convert

Returns:

xml presentation

buildResultTag

protected org.dom4j.Element buildResultTag(VtiSoapResponse soapResponse)

getMessage

protected String getMessage(String name)

TODO Fix up the message files so we can get rid of this nasty hack!