org.geomajas.service

Interface DispatcherUrlService

@Api(allMethods=true)
public interface DispatcherUrlService

Service which allows you to get the URL of the dispatcher service, allowing you to build absolute URLs to services linked in as dispatched controllers.

Since:

1.8.0

Author:

Joachim Van der Auwera, Jan De Moerloose

Method Summary

Methods

Modifier and Type	Method and Description
String	getDispatcherUrl() Get the base URL for the dispatcher service.
String	getLocalDispatcherUrl() Get the local base URL for the dispatcher service.
String	localize(String externalUrl) Convert an external URL to a locally accessible URL.

Method Detail

getDispatcherUrl

String getDispatcherUrl()

Get the base URL for the dispatcher service.

Returns:

base URL. This URL is guaranteed to end with a slash (/).

getLocalDispatcherUrl

String getLocalDispatcherUrl()

Get the local base URL for the dispatcher service. A local URL can be resolved from the web application host, as opposed to the web client. This is useful for processing resources such as images on the server side, e.g. for printing or reporting.

Returns:

local base URL or null. If not null, this URL is guaranteed to end with a slash (/), e.g. 'http://localhost:8080/myApp/d/'

Since:

1.10.0

localize

String localize(String externalUrl)

Convert an external URL to a locally accessible URL. Just a utility method that replaces getDispatcherUrl() by getLocalDispatcherUrl() although implementations may perform more sophisticated localization.

Parameters:

externalUrl - external URL that maps to the dispatcher service

Returns:

URL that provides local access to the same resource

Since:

1.10.0