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
final String	getDefaultPath()
final String	getLogoutPage()	Returns the html page path for logout
final String	getLogoutPath()	Returns the path to logout endpoint.
final String	getMvcUiPath(String aquimaSessionId)	Returns the path to the main page of the MVC UI.
final String	getNoAccessPath()	Returns the noaccess.html page path
final String	getStartDefaultProjectPath()	Returns the path for starting the default project
final String	getStartProjectPath(com.blueriq.component.api.IProjectReference project)	Returns the path for starting a project.
final String	getStartShortcutPath(String shortcutName)

Methods inherited from class java.lang.Object

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

Constructor Details

MvcPathHelper

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

Method Details

getLogoutPath

public final String getLogoutPath()

Returns the path to logout endpoint.

Returns:

the path to logout endpoint.

getLogoutPage

public final String getLogoutPage()

Returns the html page path for logout

Returns:

the html page path for logout

getStartDefaultProjectPath

public final String getStartDefaultProjectPath()

Returns the path for starting the default project

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)

Returns:

the path for starting a project.

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.

Parameters:

aquimaSessionId - the session id

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

Returns:

the noaccess.html page path