Package com.aquima.web.util

Class MvcPathHelper

java.lang.Object

com.aquima.web.util.MvcPathHelper

All Implemented Interfaces:

PathHelper

Direct Known Subclasses:

MvcLinkHelper, MvcRedirectHelper

public abstract class MvcPathHelper
extends Object
implements PathHelper

Base class for path helpers for MVC UI. Subclasses should provide the base path as a parameter to the constructor.

Since:

10.0

Author:

Petru Galanton

Constructor Summary

Constructors

Constructor	Description
MvcPathHelper(org.springframework.web.util.UriComponentsBuilder base)

Method Summary

Modifier and Type	Method	Description
String	getDefaultPath()
String	getFunctionPath(String projectName, String version, String moduleName, String functionName)	Return the path to start a function.
String	getLogoutPage()	Returns the html page path for logout
String	getLogoutPath()	Returns the path to logout endpoint.
String	getMvcUiPath(String aquimaSessionId)	Returns the path to the main page of the MVC UI.
String	getNoAccessPath()	Returns the noaccess.html page path
String	getRestPath(String shortcutName, String serviceName)
String	getRestPath(String applicationName, String version, String serviceName)
String	getRestPathForShortcutTemplate(String serviceName)
String	getStartDefaultProjectPath()	Returns the path for starting the default project
String	getStartProjectPath(com.blueriq.component.api.IProjectReference project)	Returns the path for starting a project.
String	getStartShortcutPath(String shortcutName)

Methods inherited from class java.lang.Object

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

Constructor Detail

MvcPathHelper

public MvcPathHelper(org.springframework.web.util.UriComponentsBuilder base)

Method Detail

getLogoutPath

public final String getLogoutPath()

Returns the path to logout endpoint.

getLogoutPage

public final String getLogoutPage()

Returns the html page path for logout

getStartDefaultProjectPath

public final String getStartDefaultProjectPath()

Returns the path for starting the default project

getStartProjectPath

public final String getStartProjectPath(com.blueriq.component.api.IProjectReference project)

Returns the path for starting a project.

Parameters:

project - the project to start (not null)

getStartShortcutPath

public final String getStartShortcutPath(String shortcutName)

getMvcUiPath

public final String getMvcUiPath(String aquimaSessionId)

Returns the path to the main page of the MVC UI.

getDefaultPath

public final String getDefaultPath()

getNoAccessPath

public final String getNoAccessPath()

Returns the noaccess.html page path

getRestPath

public final String getRestPath(String applicationName,
                                String version,
                                String serviceName)

getRestPath

public final String getRestPath(String shortcutName,
                                String serviceName)

getRestPathForShortcutTemplate

public final String getRestPathForShortcutTemplate(String serviceName)

getFunctionPath

public final String getFunctionPath(String projectName,
                                    String version,
                                    String moduleName,
                                    String functionName)

Return the path to start a function. Gives the absolute path to the v2 function api

Parameters:

projectName - The full name of the project (thus including datasource prefix and optionally Studio repository)

version - The project version string

moduleName - The name of the module in the project that contains the function

functionName - The name of the function (flow)

Returns:

The absolute path to the v2 function api