ru.vyarus.guicey.gsp.info.model

Class GspApp

java.lang.Object

ru.vyarus.guicey.gsp.info.model.GspApp

public class GspApp
extends java.lang.Object

Information model for registered gsp application.

Since:

03.12.2019

Constructor Summary

Constructors

Constructor and Description
GspApp()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.Multimap<java.lang.String,java.lang.String>	getAssetExtensions()
com.google.common.collect.Multimap<java.lang.String,java.lang.String>	getAssets() Returned assets are sorted for resolution: registration order of packages is preserved in order to be able to override resources from previous registrations.
java.lang.String	getDefaultErrorPage()
java.util.Map<java.lang.Integer,java.lang.String>	getErrorPages() Default error page has -1 code.
java.lang.String	getFilesRegex()
java.util.List<HiddenViewPath>	getHiddenViewPaths() Hidden methods appear when sub url mapped to different rest prefix, making all root rest paths under the same prefix unreachable.
java.lang.String	getIndexFile()
java.lang.String	getMainAssetsLocation() Never starts with slash and always ends with slash.
java.lang.String	getMainRestPrefix()
java.lang.String	getMappingUrl()
java.lang.String	getName()
java.util.List<java.lang.String>	getRequiredRenderers()
java.lang.String	getRestRootUrl() May be used to construct full rest urls (relative to server root).
java.lang.String	getRootUrl()
java.lang.String	getSpaRegex()
java.util.Map<java.lang.String,java.lang.String>	getViewExtensions()
java.util.List<MappedViewPath>	getViewPaths()
java.util.Map<java.lang.String,java.lang.String>	getViews() When root mapping is not explicitly declared, its set to application name (so map will never be empty).
boolean	isHasDefaultFilesRegex()
boolean	isHasDefaultSpaRegex()
boolean	isMainContext()
boolean	isSpa()
void	setAssetExtensions(com.google.common.collect.Multimap<java.lang.String,java.lang.String> assetExtensions)
void	setAssets(com.google.common.collect.Multimap<java.lang.String,java.lang.String> assets)
void	setErrorPages(java.util.Map<java.lang.Integer,java.lang.String> errorPages)
void	setFilesRegex(java.lang.String filesRegex)
void	setHasDefaultFilesRegex(boolean hasDefaultFilesRegex)
void	setHasDefaultSpaRegex(boolean hasDefaultSpaRegex)
void	setHiddenViewPaths(java.util.List<HiddenViewPath> hiddenViewPaths)
void	setIndexFile(java.lang.String indexFile)
void	setMainAssetsLocation(java.lang.String mainAssetsLocation)
void	setMainContext(boolean mainContext)
void	setMappingUrl(java.lang.String mappingUrl)
void	setName(java.lang.String name)
void	setRequiredRenderers(java.util.List<java.lang.String> requiredRenderers)
void	setRestRootUrl(java.lang.String restRootUrl)
void	setRootUrl(java.lang.String rootUrl)
void	setSpa(boolean spa)
void	setSpaRegex(java.lang.String spaRegex)
void	setViewExtensions(java.util.Map<java.lang.String,java.lang.String> viewExtensions)
void	setViewPaths(java.util.List<MappedViewPath> viewPaths)
void	setViews(java.util.Map<java.lang.String,java.lang.String> views)

Methods inherited from class java.lang.Object

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

Constructor Detail

GspApp

public GspApp()

Method Detail

getName

public java.lang.String getName()

Returns:

application name

setName

public void setName(java.lang.String name)

isMainContext

public boolean isMainContext()

Returns:

true for main context, false for admin

setMainContext

public void setMainContext(boolean mainContext)

getMappingUrl

public java.lang.String getMappingUrl()

Returns:

application mapping url (relative to context)

setMappingUrl

public void setMappingUrl(java.lang.String mappingUrl)

getRootUrl

public java.lang.String getRootUrl()

Returns:

application mapping url prefixed with context (full url relative to server root)

setRootUrl

public void setRootUrl(java.lang.String rootUrl)

getRequiredRenderers

public java.util.List<java.lang.String> getRequiredRenderers()

Returns:

list of required renderers or empty list

setRequiredRenderers

public void setRequiredRenderers(java.util.List<java.lang.String> requiredRenderers)

getMainAssetsLocation

public java.lang.String getMainAssetsLocation()

Never starts with slash and always ends with slash.

Returns:

main assets classpath location

setMainAssetsLocation

public void setMainAssetsLocation(java.lang.String mainAssetsLocation)

getAssets

public com.google.common.collect.Multimap<java.lang.String,java.lang.String> getAssets()

Returned assets are sorted for resolution: registration order of packages is preserved in order to be able to override resources from previous registrations. In returned model registration order is reversed, so the latest registered package will be the first (simply to check it first - correctly handle overrides).

Contexts never starts with slash, but always ends (for proper matching). Root context is empty string. Classpath locations never starts with slash and always ends with slash.

Returns:

all application asset mappings (including extensions)

setAssets

public void setAssets(com.google.common.collect.Multimap<java.lang.String,java.lang.String> assets)

getViews

public java.util.Map<java.lang.String,java.lang.String> getViews()

When root mapping is not explicitly declared, its set to application name (so map will never be empty).

Contexts never starts with slash, but always ends (for proper matching). Root context is empty string. Rest prefixes never starts with slash and always ends with slash (for proper matching).

Returns:

all application view mappings (including extensions)

setViews

public void setViews(java.util.Map<java.lang.String,java.lang.String> views)

getMainRestPrefix

public java.lang.String getMainRestPrefix()

Returns:

main rest mapping prefix

getAssetExtensions

public com.google.common.collect.Multimap<java.lang.String,java.lang.String> getAssetExtensions()

Returns:

only extension asset declarations or empty map

setAssetExtensions

public void setAssetExtensions(com.google.common.collect.Multimap<java.lang.String,java.lang.String> assetExtensions)

getViewExtensions

public java.util.Map<java.lang.String,java.lang.String> getViewExtensions()

Returns:

only extension view rest mappings or empty map

setViewExtensions

public void setViewExtensions(java.util.Map<java.lang.String,java.lang.String> viewExtensions)

getRestRootUrl

public java.lang.String getRestRootUrl()

May be used to construct full rest urls (relative to server root).

Returns:

rest context mapping url or null when jetty not yet started

setRestRootUrl

public void setRestRootUrl(java.lang.String restRootUrl)

getIndexFile

public java.lang.String getIndexFile()

Returns:

configured index file (empty string by default, meaning index.html)

setIndexFile

public void setIndexFile(java.lang.String indexFile)

getFilesRegex

public java.lang.String getFilesRegex()

Returns:

asset (static resources) calls detection regexp

setFilesRegex

public void setFilesRegex(java.lang.String filesRegex)

isHasDefaultFilesRegex

public boolean isHasDefaultFilesRegex()

Returns:

true when default assets detection regexp used, false otherwise

setHasDefaultFilesRegex

public void setHasDefaultFilesRegex(boolean hasDefaultFilesRegex)

isSpa

public boolean isSpa()

Returns:

true when spa routing enabled (serve index page for all requested paths, except assets), false when disabled (default)

setSpa

public void setSpa(boolean spa)

getSpaRegex

public java.lang.String getSpaRegex()

Returns:

non spa route path recognition regexp

setSpaRegex

public void setSpaRegex(java.lang.String spaRegex)

isHasDefaultSpaRegex

public boolean isHasDefaultSpaRegex()

Returns:

true when defaul regexp used, false otherwise

setHasDefaultSpaRegex

public void setHasDefaultSpaRegex(boolean hasDefaultSpaRegex)

getErrorPages

public java.util.Map<java.lang.Integer,java.lang.String> getErrorPages()

Default error page has -1 code.

Returns:

configured error pages (mapping by code) or empty map if nothing configured

setErrorPages

public void setErrorPages(java.util.Map<java.lang.Integer,java.lang.String> errorPages)

getDefaultErrorPage

public java.lang.String getDefaultErrorPage()

Returns:

default error page (for all non mapped error codes) or null if not declared

getViewPaths

public java.util.List<MappedViewPath> getViewPaths()

Returns:

mapped view rest methods

setViewPaths

public void setViewPaths(java.util.List<MappedViewPath> viewPaths)

getHiddenViewPaths

public java.util.List<HiddenViewPath> getHiddenViewPaths()

Hidden methods appear when sub url mapped to different rest prefix, making all root rest paths under the same prefix unreachable.

Returns:

hidden view rest method

setHiddenViewPaths

public void setHiddenViewPaths(java.util.List<HiddenViewPath> hiddenViewPaths)