com.onlyoffice.manager.url

Interface UrlManager

All Known Implementing Classes:

DefaultUrlManager

public interface UrlManager

Method Summary

Modifier and Type	Method and Description
String	getCallbackUrl(String fileId) Returns the URL to the callback handler.
String	getCreateUrl(String fileId) Returns the URL to create a new file with the ID specified in the request.
String	getDocumentServerApiUrl() Returns the URL to the Document Server API.
String	getDocumentServerApiUrl(String shardKey) Returns the URL to the Document Server API with shardKey.
String	getDocumentServerPreloaderApiUrl() Returns the URL to the Document Server Preloader API.
String	getDocumentServerUrl() Returns the URL to the Document Server.
String	getFileUrl(String fileId) Returns the URL to download a file with the ID specified in the request.
String	getGobackUrl(String fileId) Returns the URL to the location folder of a file with the ID specified in the request.
String	getInnerDocumentServerUrl() Returns the inner URL to the Document Server.
String	getServiceUrl(RequestedService requestedService) Returns the URL to the service using the requested service properties specified in the request.
String	getTestConvertUrl(String url) Returns the URL to the test file.
String	replaceToDocumentServerUrl(String url) Replaces the internal URL from the Document Server with the Document Server URL.
String	replaceToInnerDocumentServerUrl(String url) Replaces the URL to the Document Server with the internal one.
String	sanitizeUrl(String url) Removes the trailing slash from the URL if it exists.

Method Detail

getDocumentServerUrl

String getDocumentServerUrl()

Returns the URL to the Document Server.

Returns:

The URL to the Document Server.

getInnerDocumentServerUrl

String getInnerDocumentServerUrl()

Returns the inner URL to the Document Server.

Returns:

The inner URL to the Document Server.

getDocumentServerApiUrl

String getDocumentServerApiUrl()

Returns the URL to the Document Server API.

Returns:

The URL to the Document Server API.

getDocumentServerApiUrl

String getDocumentServerApiUrl(String shardKey)

Returns the URL to the Document Server API with shardKey.

Parameters:

shardKey - The shardKey parameter for insert to the URL query string.

Returns:

The URL to the Document Server API with shardKey.

getDocumentServerPreloaderApiUrl

String getDocumentServerPreloaderApiUrl()

Returns the URL to the Document Server Preloader API.

Returns:

The URL to the Document Server Preloader API.

getFileUrl

String getFileUrl(String fileId)

Returns the URL to download a file with the ID specified in the request.

Parameters:

fileId - The file ID.

Returns:

The URL to download a file.

getCallbackUrl

String getCallbackUrl(String fileId)

Returns the URL to the callback handler.

Parameters:

fileId - The file ID.

Returns:

The URL to the callback handler.

getGobackUrl

String getGobackUrl(String fileId)

Returns the URL to the location folder of a file with the ID specified in the request.

Parameters:

fileId - The file ID.

Returns:

The URL to the file location folder.

getCreateUrl

String getCreateUrl(String fileId)

Returns the URL to create a new file with the ID specified in the request.

Parameters:

fileId - The file ID.

Returns:

The URL to create a new file.

getServiceUrl

String getServiceUrl(RequestedService requestedService)

Returns the URL to the service using the requested service properties specified in the request.

Parameters:

requestedService - The requested service.

Returns:

The URL to ONLYOFFICE service.

sanitizeUrl

String sanitizeUrl(String url)

Removes the trailing slash from the URL if it exists.

Parameters:

url - The URL to the Document Server.

Returns:

The URL without the trailing slash.

replaceToDocumentServerUrl

String replaceToDocumentServerUrl(String url)

Replaces the internal URL from the Document Server with the Document Server URL.

Parameters:

url - The internal URL from the Document Server.

Returns:

The URL start with Document Server URL.

replaceToInnerDocumentServerUrl

String replaceToInnerDocumentServerUrl(String url)

Replaces the URL to the Document Server with the internal one.

Parameters:

url - The URL to the Document Server.

Returns:

The internal URL.

getTestConvertUrl

String getTestConvertUrl(String url)

Returns the URL to the test file.

Parameters:

url - The URL to the integration Product.

Returns:

The URL to the test file.