io.committed.invest.core.services

Interface UiUrlService

public interface UiUrlService

A service to provide the URL for a ui plugin from which it can be downloaded from the server

This is an interface to be implemented at the allow different server implementation to host UI's files on specific context paths.

Method Summary

Modifier and Type	Method and Description
String	getContextPath() Gets the context path common to all plugins on this server.
String	getContextRelativePath(InvestUiExtension extension) Gets the path to the extension relative to the getContextPath()
default String	getFullPath(InvestUiExtension extension) Gets the full path to the plugins files.
boolean	isPathForExtensionRoot(String path) Checks it a path maps to the root directory of a plugin.

Method Detail

getFullPath

default String getFullPath(InvestUiExtension extension)

Gets the full path to the plugins files.

This may be relative or absolution (depending on server configuration).

For example /ui/my-ui-plugin

Parameters:

extension - the extension

Returns:

the full path

getContextRelativePath

String getContextRelativePath(InvestUiExtension extension)

Gets the path to the extension relative to the getContextPath()

Foe xample '/my-ui-plugin.

Parameters:

extension - the extension

Returns:

the context relative path

getContextPath

String getContextPath()

Gets the context path common to all plugins on this server.

For example "/ui"

Returns:

the context path

isPathForExtensionRoot

boolean isPathForExtensionRoot(String path)

Checks it a path maps to the root directory of a plugin.

The alternative is that is links to a file (index.html) within that directory.

Parameters:

path - the path

Returns:

true if its the root of plugin