ScreenUrlInfo (Moqui Framework 3.0.0)

org.moqui.impl.screen.ScreenUrlInfo

@groovy.transform.CompileStatic
class ScreenUrlInfo
extends java.lang.Object

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`ScreenUrlInfo.UrlInstance`

Field Summary

Fields
Modifiers	Name	Description
`protected static org.slf4j.Logger`	`logger`

Properties Summary

Properties
Type	Name and description
`boolean`	`alwaysUseFullPath`
`boolean`	`beginTransaction`
`ExecutionContextFactoryImpl`	`ecfi`
`java.util.ArrayList<java.lang.String>`	`extraPathNameList` Everything in the path after the screen or transition, may be used to pass additional info
`java.lang.String`	`fileResourceContentType`
`java.util.ArrayList<java.lang.String>`	`fileResourcePathList` The path for a file resource (template or static), relative to the targetScreen.location
`ResourceReference`	`fileResourceRef` If the full path led to a file resource that is verified to exist, the URL goes here; the URL for access on the server, the client will get the resource from the url field as normal
`java.util.ArrayList<java.lang.String>`	`fromPathList`
`java.lang.String`	`fromScreenPath`
`ScreenDefinition`	`fromSd`
`java.util.ArrayList<java.lang.String>`	`fullPathNameList` The full path name list for the URL, including extraPathNameList
`int`	`lastStandalone` positive lastStandalone means how many to include from the end back, negative how many path elements to skip from the beginning
`java.lang.String`	`menuImage`
`java.lang.String`	`menuImageType`
`java.util.ArrayList<java.lang.String>`	`minimalPathNameList` The minimal path name list for the URL, basically without following the defaults
`java.lang.String`	`notExistsLastName`
`ScreenDefinition`	`notExistsLastSd`
`java.lang.String`	`notExistsNextLoc`
`java.util.HashMap<java.lang.String, ParameterItem>`	`pathParameterItems`
`java.util.Map<java.lang.String, java.lang.String>`	`pathParameterMap`
`java.lang.String`	`plainUrl`
`java.util.ArrayList<java.lang.String>`	`preTransitionPathNameList`
`int`	`renderPathDifference`
`boolean`	`requireEncryption`
`boolean`	`reusable`
`ScreenDefinition`	`rootSd`
`java.util.ArrayList<ScreenDefinition>`	`screenPathDefList` All screens found in the path list
`ScreenFacadeImpl`	`sfi`
`static char`	`slashChar`
`boolean`	`targetExists`
`ScreenDefinition`	`targetScreen` The last screen found in the path list
`java.lang.String`	`targetScreenRenderMode`
`java.lang.String`	`targetTransitionActualName`
`java.lang.String`	`targetTransitionExtension`
`java.lang.Integer`	`transactionTimeout`

Constructor Summary

Constructors
Constructor and description
`protected ScreenUrlInfo ()`
`ScreenUrlInfo (ScreenRenderImpl sri, java.lang.String url)` Stub mode for ScreenUrlInfo, represent a plain URL and not a screen URL
`ScreenUrlInfo (ScreenFacadeImpl sfi, java.lang.String url)`
`ScreenUrlInfo (ScreenFacadeImpl sfi, ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`ScreenUrlInfo`	`addParameter(java.lang.Object name, java.lang.Object value)`
	`ScreenUrlInfo`	`addParameters(java.util.Map manualParameters)`
	`void`	`checkExists()`
	`static java.util.ArrayList<java.lang.String>`	`cleanupPathNameList(java.util.ArrayList<java.lang.String> inputPathNameList, java.util.Map inlineParameters)`
	`ScreenUrlInfo`	`cloneUrlInfo()`
	`void`	`copyUrlInfoInto(ScreenUrlInfo sui)`
	`java.lang.String`	`getBaseUrl(ScreenRenderImpl sri)`
	`java.util.ArrayList<java.lang.String>`	`getExtraPathNameList()`
	`boolean`	`getInCurrentScreenPath(java.util.List<java.lang.String> currentPathNameList)`
	`UrlInstance`	`getInstance(ScreenRenderImpl sri, java.lang.Boolean expandAliasTransition)`
	`java.lang.String`	`getMinimalPathUrlWithBase(java.lang.String baseUrl)`
	`ScreenDefinition`	`getParentScreen()`
	`java.util.Map`	`getPathParameterMap()`
	`java.util.ArrayList<java.lang.String>`	`getPreTransitionPathNameList()`
	`java.lang.String`	`getScreenPathUrlWithBase(java.lang.String baseUrl)`
	`static ScreenUrlInfo`	`getScreenUrlInfo(ScreenRenderImpl sri, java.lang.String url)` Stub mode for ScreenUrlInfo, represent a plain URL and not a screen URL
	`static ScreenUrlInfo`	`getScreenUrlInfo(ScreenFacadeImpl sfi, java.lang.String url)`
	`static ScreenUrlInfo`	`getScreenUrlInfo(ScreenFacadeImpl sfi, ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)`
	`static ScreenUrlInfo`	`getScreenUrlInfo(ScreenRenderImpl sri, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)`
	`static ScreenUrlInfo`	`getScreenUrlInfo(ScreenFacadeImpl sfi, javax.servlet.http.HttpServletRequest request)`
	`java.lang.String`	`getUrlWithBase(java.lang.String baseUrl)`
	`void`	`initUrl()`
	`boolean`	`isPermitted(ExecutionContext ec, TransitionItem transitionItem)`
	`boolean`	`isPermitted(ExecutionContext ec, TransitionItem transitionItem, ArtifactExecutionInfo.AuthzAction actionEnum)`
	`static java.lang.String`	`makeCacheKey(ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)`
	`static int`	`parseLastStandalone(java.lang.String lastStandalone, int defLs)`
	`static java.util.ArrayList<java.lang.String>`	`parseSubScreenPath(ScreenDefinition rootSd, ScreenDefinition fromSd, java.util.List<java.lang.String> fromPathList, java.lang.String screenPath, java.util.Map inlineParameters, ScreenFacadeImpl sfi)`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected static final org.slf4j.Logger logger
- Property Detail
  - boolean alwaysUseFullPath
  - boolean beginTransaction
  - ExecutionContextFactoryImpl ecfi
  - java.util.ArrayList<java.lang.String> extraPathNameList
    
    Everything in the path after the screen or transition, may be used to pass additional info
  - java.lang.String fileResourceContentType
  - java.util.ArrayList<java.lang.String> fileResourcePathList
    
    The path for a file resource (template or static), relative to the targetScreen.location
  - ResourceReference fileResourceRef
    
    If the full path led to a file resource that is verified to exist, the URL goes here; the URL for access on the server, the client will get the resource from the url field as normal
  - java.util.ArrayList<java.lang.String> fromPathList
  - java.lang.String fromScreenPath
  - ScreenDefinition fromSd
  - java.util.ArrayList<java.lang.String> fullPathNameList
    
    The full path name list for the URL, including extraPathNameList
  - int lastStandalone
    
    positive lastStandalone means how many to include from the end back, negative how many path elements to skip from the beginning
  - java.lang.String menuImage
  - java.lang.String menuImageType
  - java.util.ArrayList<java.lang.String> minimalPathNameList
    
    The minimal path name list for the URL, basically without following the defaults
  - java.lang.String notExistsLastName
  - ScreenDefinition notExistsLastSd
  - java.lang.String notExistsNextLoc
  - java.util.HashMap<java.lang.String, ParameterItem> pathParameterItems
  - java.util.Map<java.lang.String, java.lang.String> pathParameterMap
  - java.lang.String plainUrl
  - java.util.ArrayList<java.lang.String> preTransitionPathNameList
  - int renderPathDifference
  - boolean requireEncryption
  - boolean reusable
  - ScreenDefinition rootSd
  - java.util.ArrayList<ScreenDefinition> screenPathDefList
    
    All screens found in the path list
  - ScreenFacadeImpl sfi
  - static final char slashChar
  - boolean targetExists
  - ScreenDefinition targetScreen
    
    The last screen found in the path list
  - java.lang.String targetScreenRenderMode
  - java.lang.String targetTransitionActualName
  - java.lang.String targetTransitionExtension
  - java.lang.Integer transactionTimeout
- Constructor Detail
  - protected ScreenUrlInfo()
  - ScreenUrlInfo(ScreenRenderImpl sri, java.lang.String url)
    
    Stub mode for ScreenUrlInfo, represent a plain URL and not a screen URL
  - ScreenUrlInfo(ScreenFacadeImpl sfi, java.lang.String url)
  - ScreenUrlInfo(ScreenFacadeImpl sfi, ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)
- Method Detail
  - ScreenUrlInfo addParameter(java.lang.Object name, java.lang.Object value)
  - ScreenUrlInfo addParameters(java.util.Map manualParameters)
  - void checkExists()
  - static java.util.ArrayList<java.lang.String> cleanupPathNameList(java.util.ArrayList<java.lang.String> inputPathNameList, java.util.Map inlineParameters)
  - ScreenUrlInfo cloneUrlInfo()
  - void copyUrlInfoInto(ScreenUrlInfo sui)
  - java.lang.String getBaseUrl(ScreenRenderImpl sri)
  - java.util.ArrayList<java.lang.String> getExtraPathNameList()
  - boolean getInCurrentScreenPath(java.util.List<java.lang.String> currentPathNameList)
  - UrlInstance getInstance(ScreenRenderImpl sri, java.lang.Boolean expandAliasTransition)
  - java.lang.String getMinimalPathUrlWithBase(java.lang.String baseUrl)
  - ScreenDefinition getParentScreen()
  - java.util.Map getPathParameterMap()
  - java.util.ArrayList<java.lang.String> getPreTransitionPathNameList()
  - java.lang.String getScreenPathUrlWithBase(java.lang.String baseUrl)
  - static ScreenUrlInfo getScreenUrlInfo(ScreenRenderImpl sri, java.lang.String url)
    
    Stub mode for ScreenUrlInfo, represent a plain URL and not a screen URL
  - static ScreenUrlInfo getScreenUrlInfo(ScreenFacadeImpl sfi, java.lang.String url)
  - static ScreenUrlInfo getScreenUrlInfo(ScreenFacadeImpl sfi, ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)
  - static ScreenUrlInfo getScreenUrlInfo(ScreenRenderImpl sri, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)
  - static ScreenUrlInfo getScreenUrlInfo(ScreenFacadeImpl sfi, javax.servlet.http.HttpServletRequest request)
  - java.lang.String getUrlWithBase(java.lang.String baseUrl)
  - void initUrl()
  - boolean isPermitted(ExecutionContext ec, TransitionItem transitionItem)
  - boolean isPermitted(ExecutionContext ec, TransitionItem transitionItem, ArtifactExecutionInfo.AuthzAction actionEnum)
  - static java.lang.String makeCacheKey(ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)
  - static int parseLastStandalone(java.lang.String lastStandalone, int defLs)
  - static java.util.ArrayList<java.lang.String> parseSubScreenPath(ScreenDefinition rootSd, ScreenDefinition fromSd, java.util.List<java.lang.String> fromPathList, java.lang.String screenPath, java.util.Map inlineParameters, ScreenFacadeImpl sfi)
  - @java.lang.Override java.lang.String toString()

Groovy Documentation

[Groovy] Class ScreenUrlInfo

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final org.slf4j.Logger logger

Property Detail

boolean alwaysUseFullPath

boolean beginTransaction

ExecutionContextFactoryImpl ecfi

java.util.ArrayList<java.lang.String> extraPathNameList

java.lang.String fileResourceContentType

java.util.ArrayList<java.lang.String> fileResourcePathList

ResourceReference fileResourceRef

java.util.ArrayList<java.lang.String> fromPathList

java.lang.String fromScreenPath

ScreenDefinition fromSd

java.util.ArrayList<java.lang.String> fullPathNameList

int lastStandalone

java.lang.String menuImage

java.lang.String menuImageType

java.util.ArrayList<java.lang.String> minimalPathNameList

java.lang.String notExistsLastName

ScreenDefinition notExistsLastSd

java.lang.String notExistsNextLoc

java.util.HashMap<java.lang.String, ParameterItem> pathParameterItems

java.util.Map<java.lang.String, java.lang.String> pathParameterMap

java.lang.String plainUrl

java.util.ArrayList<java.lang.String> preTransitionPathNameList

int renderPathDifference

boolean requireEncryption

boolean reusable

ScreenDefinition rootSd

java.util.ArrayList<ScreenDefinition> screenPathDefList

ScreenFacadeImpl sfi

static final char slashChar

boolean targetExists

ScreenDefinition targetScreen

java.lang.String targetScreenRenderMode

java.lang.String targetTransitionActualName

java.lang.String targetTransitionExtension

java.lang.Integer transactionTimeout

Constructor Detail

protected ScreenUrlInfo()

ScreenUrlInfo(ScreenRenderImpl sri, java.lang.String url)

ScreenUrlInfo(ScreenFacadeImpl sfi, java.lang.String url)

ScreenUrlInfo(ScreenFacadeImpl sfi, ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)

Method Detail

ScreenUrlInfo addParameter(java.lang.Object name, java.lang.Object value)

ScreenUrlInfo addParameters(java.util.Map manualParameters)

void checkExists()

static java.util.ArrayList<java.lang.String> cleanupPathNameList(java.util.ArrayList<java.lang.String> inputPathNameList, java.util.Map inlineParameters)

ScreenUrlInfo cloneUrlInfo()

void copyUrlInfoInto(ScreenUrlInfo sui)

java.lang.String getBaseUrl(ScreenRenderImpl sri)

java.util.ArrayList<java.lang.String> getExtraPathNameList()

boolean getInCurrentScreenPath(java.util.List<java.lang.String> currentPathNameList)

UrlInstance getInstance(ScreenRenderImpl sri, java.lang.Boolean expandAliasTransition)

java.lang.String getMinimalPathUrlWithBase(java.lang.String baseUrl)

ScreenDefinition getParentScreen()

java.util.Map getPathParameterMap()

java.util.ArrayList<java.lang.String> getPreTransitionPathNameList()

java.lang.String getScreenPathUrlWithBase(java.lang.String baseUrl)

static ScreenUrlInfo getScreenUrlInfo(ScreenRenderImpl sri, java.lang.String url)

static ScreenUrlInfo getScreenUrlInfo(ScreenFacadeImpl sfi, java.lang.String url)

static ScreenUrlInfo getScreenUrlInfo(ScreenFacadeImpl sfi, ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)

static ScreenUrlInfo getScreenUrlInfo(ScreenRenderImpl sri, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)

static ScreenUrlInfo getScreenUrlInfo(ScreenFacadeImpl sfi, javax.servlet.http.HttpServletRequest request)

java.lang.String getUrlWithBase(java.lang.String baseUrl)

void initUrl()

boolean isPermitted(ExecutionContext ec, TransitionItem transitionItem)

boolean isPermitted(ExecutionContext ec, TransitionItem transitionItem, ArtifactExecutionInfo.AuthzAction actionEnum)

static java.lang.String makeCacheKey(ScreenDefinition rootSd, ScreenDefinition fromScreenDef, java.util.ArrayList<java.lang.String> fpnl, java.lang.String subscreenPath, int lastStandalone)

static int parseLastStandalone(java.lang.String lastStandalone, int defLs)

static java.util.ArrayList<java.lang.String> parseSubScreenPath(ScreenDefinition rootSd, ScreenDefinition fromSd, java.util.List<java.lang.String> fromPathList, java.lang.String screenPath, java.util.Map inlineParameters, ScreenFacadeImpl sfi)

@java.lang.Override java.lang.String toString()