org.alfresco.module.vti.handler.alfresco

Interface UrlHelper

All Known Implementing Classes:

DefaultUrlHelper

public interface UrlHelper

Provides Sharepoint with URL help, e.g. retrieve base URL of Sharepoint server as exposed in the outside world.

Trailing slashes are never present so as to give consistency between different context paths, e.g. "/" and "/alfresco". Otherwise it would be necessary to check for trailing slashes before appending to the returned paths.

Author:

Matt Ward

Method Summary

Methods

Modifier and Type	Method and Description
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 getExternalBaseURL().
String	getExternalURLHostOnly() The base URL including the protocol scheme, host and port only without any path information.

Method Detail

getExternalBaseURL

String getExternalBaseURL()

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.

Returns:

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

getExternalURL

String getExternalURL(String pathWithinContext)

Creates a URL relative to the base URL as returned by 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
 

Parameters:

pathWithinContext -

Returns:

URL

getExternalURLHostOnly

String getExternalURLHostOnly()

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

    https://sp.example.com:7070
 

Returns:

URL