org.alfresco.module.vti.handler.alfresco

Class DefaultUrlHelper

java.lang.Object

org.alfresco.module.vti.handler.alfresco.DefaultUrlHelper

All Implemented Interfaces:

UrlHelper, org.springframework.beans.factory.InitializingBean

public class DefaultUrlHelper
extends Object
implements UrlHelper, org.springframework.beans.factory.InitializingBean

The default implementation of UrlHelper.

Author:

Matt Ward

Constructor Summary

Constructors

Constructor and Description
DefaultUrlHelper()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet() Must be called after setting properties and before using provided services.
String	getExternalBaseURL() The base URL exposed to clients, regardless of where Sharepoint is deployed.
String	getExternalURL(String pathWithinContext) Creates a URL relative to the base URL as returned by UrlHelper.getExternalBaseURL().
String	getExternalURLHostOnly() The base URL including the protocol scheme, host and port only without any path information.
protected String	makeExternalHostURL()
void	setExternalContextPath(String externalContextPath)
void	setExternalHost(String externalHost)
void	setExternalPort(int externalPort)
void	setExternalProtocol(String externalProtocol)
void	setLocalHostNameProvider(LocalHostNameProvider localHostNameProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUrlHelper

public DefaultUrlHelper()

Method Detail

makeExternalHostURL

protected String makeExternalHostURL()

getExternalURL

public String getExternalURL(String pathWithinContext)

Description copied from interface: UrlHelper

Creates a URL relative to the base URL as returned by UrlHelper.getExternalBaseURL(). For example if the base URL is

    https://sp.example.com:7070/sharepointContext
 

and pathWithinContext is

    myfolder/mydocument.txt
 

then the returned URL will be

    https://sp.example.com:7070/sharepointContext/myfolder/mydocument.txt
 

Specified by:

getExternalURL in interface UrlHelper

Returns:

URL

getExternalBaseURL

public String getExternalBaseURL()

Description copied from interface: UrlHelper

The base URL exposed to clients, regardless of where Sharepoint is deployed. For example Sharepoint may have been deployed via a reverse proxy and the external URL will reflect the endpoint mapped by the proxy, rather than the internal IP address of the Sharepoint server.

Specified by:

getExternalBaseURL in interface UrlHelper

Returns:

Base URL, e.g. https://sp.example.com:7070/sharepointContext

getExternalURLHostOnly

public String getExternalURLHostOnly()

Description copied from interface: UrlHelper

The base URL including the protocol scheme, host and port only without any path information. For example

    https://sp.example.com:7070
 

Specified by:

getExternalURLHostOnly in interface UrlHelper

Returns:

URL

setLocalHostNameProvider

public void setLocalHostNameProvider(LocalHostNameProvider localHostNameProvider)

setExternalProtocol

public void setExternalProtocol(String externalProtocol)

setExternalHost

public void setExternalHost(String externalHost)

setExternalPort

public void setExternalPort(int externalPort)

setExternalContextPath

public void setExternalContextPath(String externalContextPath)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Must be called after setting properties and before using provided services.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception