customExceptionHandler

IException​Handler

Configures a custom exception handler on the controller. The controller itself is an exception handler and is used as such across most of the application layers. Jspresso philosophy is to use unchecked exceptions in services, business rules, and so on, so that, whenever an exception occurs, it climbs the call stack up to an exception handler (usually one of the controller). Whenever a custom exception handler is configured, the exception handling is delegated to it, allowing the exceptions to be refined or handled differently than for the built-in case. The exception handler can either :

• return true if the exception was completely processed and does not need any further action.
• return false if the exception was either not or un-completely processed and needs to continue the built-in handling.

loginContextName

String

Configures the name of the JAAS login context to use to authenticate users. It must reference a valid JAAS context that is installed in the JVM, either through setting the java.security.auth.login.config system property or through server-specific configuration.

actionMonitoringPlugin

IAction​Monitoring​Plugin

Sets action monitoring plugin.

asyncActionsThreadGroup

Thread​Group

Sets async actions thread group.

carbonEntityCloneFactory

IEntity​Clone​Factory

Configures the entity clone factory used to carbon-copy entities. An entity carbon-copy is an technical copy of an entity, including id and version but excluding relationship properties. This mechanism is used by the controller when duplicating entities into the UOW to allow for memory state aware transactions. This property should only be used by the DI container. It will rarely be changed from built-in defaults unless you need to specify a custom implementation instance to be used.

collectionFactory

IComponent​Collection​Factory

Configures the factory responsible for creating entities (or components) collections that are held by domain relationship properties. This property should only be used by the DI container. It will rarely be changed from built-in defaults unless you need to specify a custom implementation instance to be used.

customTranslationPlugin

ITranslation​Plugin

Configures a custom translation plugin on the controller. The controller itself is a translation provider and is used as such across most of the application layers. The custom translation plugin is used to override the default static, bundle-based, i18n scheme.

entityFactory

IEntity​Factory

Configures the entity factory to use to create new entities. Backend controllers only accept instances of ControllerAwareProxyEntityFactory or a subclass. This is because the backend controller must keep track of created entities. Jspresso entity implementations also use the controller from which they were created behind the scene.

referenceTimeZoneId

String

Sets reference time zone id.

throwExceptionOnBadUsage

boolean

Configures the backend controller to throw or not an exception whenever a bad usage is detected like manually merging a dirty entity from an ongoing UOW.

translationProvider

ITranslation​Provider

Configures the translation provider used to compute internationalized messages and labels.

defaultTxFlushMode

String

Sets the default Hibernate flush mode to apply to the Hibernate session when it is bound to a transaction. Defaults to {@link FlushMode#COMMIT}.

hibernateSessionFactory

Session​Factory

Sets the hibernateSessionFactory.

actionMap

Action​Map

Configures an application-wide action map that will be installed in the main application frame. These actions are available at any time from the UI and thus, do not depend on the active workspace. General purpose actions like "Change password" action should be installed here.

clientPreferencesStore

IPreferences​Store

Sets the clientPreferenceStore.

exitAction

IDisplayable​Action

Configures the exit action to be executed whenever the user wants to quit the application. The default installed exit action first checks for started module(s) dirty state(s), then notifies user of pending persistent changes. When no flush is needed or the user bypasses them, the actual exit is performed.

frameHeight

Integer

Sets the preferred application frame height. How this dimension is leveraged depends on the UI channel.

helpActionMap

Action​Map

Configures the help action map. The help action map should contain actions that are related to helping the user (online help, reference manual, tutorial, version dialog...).

The help action map is visually distinguished from the regular application action map. For instance elp actions can be represented in a menu that is right-aligned in the menu bar.

i18nName

String

Sets i 18 n name.

loginAction

IAction

Configures an action to be executed just after the user has successfully logged-in but before any UI initialization has begun. An example of such an action would be constructing a map of dynamic user right based on some arbitrary data store so that the UI construction can actually depend on these extracted values.

mvcBinder

IMvc​Binder

Configures the MVC binder used to apply model-view bindings. There is hardly any reason for the developer to change the default binder but it can be customized here.

navigationActionMap

Action​Map

Configures the navigation action map. The navigation action map should contain actions that are related to navigating the modules and workspace history, e.g. previous, next, home, and so on.

onModuleExitAction

IAction

Configures an action to be executed each time a module of the application is exited. The action is executed in the context of the module the user exits. Default frontend controller configuration installs an action that checks current module dirty state.

secondaryActionMap

Action​Map

Assigns the view secondary action map. Same rules as the primary action map apply except that actions in this map should be visually distinguished from the main action map, e.g. placed in another toolbar.

viewFactory

IView​Factory​<​E​,F​,G​>​

Configures the view factory used to create views from view descriptors. Using a custom view factory is typically needed for extending Jspresso to use custom view descriptors / UI components. Of course, there is a view factory concrete type per UI channel.

workspacesMenuIconImageUrl

String

Sets the icon image URL that is used as the workspace menu icon. Supported URL protocols include :

• all JVM supported protocols
• the jar:/ pseudo URL protocol
• the classpath:/ pseudo URL protocol

description

String

statusInfo

String

{@inheritDoc}

clipboardContent

String

{@inheritDoc}

clipboardContent

String

Not supported in mobile environment.

{@inheritDoc}

clipboardContent

String

{@inheritDoc}

statusInfo

String

{@inheritDoc}

description

String

Configures the key used to translate actual internationalized workspace description. The resulting translation will generally be leveraged as a toolTip on the UI side but its use may be extended for online help.

headerDescription

String

Configures the key used to translate actual internationalized workspace header description. The resulting translation will generally be leveraged as a text header on the UI side.

i18nPageHeaderDescription

String

Sets i 18 n page header description.

iconPreferredHeight

int

Sets the icon preferred width.

iconProvider

Icon​Provider

Since a workspace is represented as a tree view of modules, this property can be used to customize an icon image URL provider on the created tree view (see BasicTreeViewDescriptor.iconImageURLProvider). However, the workspace built-in icon image URL provider ( WorkspaceIconImageURLProvider) will setup sensible defaults so that it unlikely has to be changed.

modules

List​<​Module​>​

Installs a list of module(s) into this workspace. Each module may own sub-modules that form a (potentially complex and dynamic) hierarchy, that is visually rendered as a tree view.

pageHeaderDescription

String

Configures the key used to translate actual internationalized workspace page header description. The resulting translation will generally be leveraged as a textual section that explains the workspace goal.

startExpanded

boolean

Sets expanded.

description

String

Configures the key used to translate actual internationalized module description. The resulting translation will generally be leveraged as a toolTip on the UI side but its use may be extended for online help.

entryAction

IAction

Configures an action to be executed every time the module becomes the current selected module (either through a user explicit navigation or a programmatic selection). The action will execute in the context of the current workspace, this module being the current selected module.

grantedRoles

Collection​<​String​>​

Assigns the roles that are authorized to start this module. It supports "!" prefix to negate the role(s). Whenever the user is not granted sufficient privileges, the module is simply not installed in the workspace. Setting the collection of granted roles to null (default value) disables role based authorization on this module.

Some specific modules that are component/entity model based i.e. Bean(Collection)Module also inherit their authorizations from their model.

icon

Icon

Sets the icon.

iconPreferredHeight

int

Sets the icon preferred width.

name

String

Configures the key used to translate actual internationalized module name. The resulting translation will be leveraged as the module label on the UI side.

permId

String

Sets the permanent identifier to this application element. Permanent identifiers are used by different framework parts, like dynamic security or record/replay controllers to uniquely identify an application element. Permanent identifiers are generated by the SJS build based on the element id but must be explicitly set if Spring XML is used.

startupAction

IAction

Configures an action to be executed the first time the module is "started" by the user. The action will execute in the context of the current workspace, this module being the current selected module. It will help initializing module values, notify user, ....

detailViewIncluded

boolean

This property allows to automatically include the detail view in a tab of the main collection module view. A complementary action list is installed to navigate between module objects. Default value is false. *

elementViewDescriptor

IView​Descriptor

This property is not used by the module itself, but by built-in actions that maybe registered on this module. One of these actions is AddBeanAsSubModuleAction.

This property indicates the view to use whenever the user requests a "form-like" view on a collection element. Naturally the configured element view descriptor must be backed by a model matching the type of the module managed beans.

navigateModuleObjectsActionList

Action​List

Sets navigate module objects action list.

criteriaFactory

Object

Sets criteria factory. Depending on the persistence layer used, it should be an instance of :

• org.jspresso.framework.model.persistence.hibernate.criterion.ICriteriaFactory
• org.jspresso.framework.model.persistence.mongo.criterion.IQueryFactory

displayPageIndex

Integer

Delegates to filter.

{@inheritDoc}

filterComponentDescriptor

IComponent​Descriptor​<​IComponent​>​

This property allows to configure a custom filter model descriptor. If not set, which is the default value, the filter model is built out of the element component descriptor (QBE filter model).

filterViewDescriptor

IView​Descriptor

This property allows to refine the default filter view to re-arrange the filter fields. Custom filter view descriptors assigned here must not be assigned a model descriptor since they will be at runtime. This is because the filter component descriptor must be reworked - to adapt comparable field structures for instance.

findOnType

Boolean

Whenever setting findOnType to true, the module will trigger the query each time a field is typed-in in the module filter view. This brings continuous autocomplete feature on the filter module.

page

Integer

Delegates to filter.

{@inheritDoc}

paginationViewDescriptor

Basic​View​Descriptor

Configures the sub view used to navigate between the pages.

queryComponentDescriptorFactory

IQuery​Component​Descriptor​Factory

Sets the queryComponentDescriptorFactory.

queryExtraViewDescriptorFactory

IQuery​Extra​View​Descriptor​Factory

Sets the queryExtraViewDescriptorFactory.

recordCount

Integer

Delegates to filter.

{@inheritDoc}

stickyResults

List​<​?​>​

Delegates to filter. {@inheritDoc}

elementViewDescriptor

IView​Descriptor

Mobile filterable bean collection module views only support page views as element views descriptors.

{@inheritDoc}

paginationViewDescriptor

Basic​View​Descriptor

Not supported in mobile environment.

{@inheritDoc}

queryModuleFilterAction

IDisplayable​Action

Sets query module filter action.

elementViewDescriptor

IView​Descriptor

Mobile bean collection module views only support page views as element views descriptors.

{@inheritDoc}

componentDescriptor

IComponent​Descriptor​<​Object​>​

Configures the type of bean this module manages. A bunch of default values are inferred from this component descriptor. For instance, icon image URL or even granted roles can be inferred from the configured component descriptor. The latter means that bean modules based on forbidden entities will automatically be excluded from the workspace of the logged-in user.

However, when not set, the component descriptor it self can be inferred from the configured projected view descriptor model.

projectedViewDescriptor

IView​Descriptor

Mobile bean module only support page views as projected views descriptors.

{@inheritDoc}

collectionBased

boolean

Sets the collectionBased.

accessorFactory

IAccessor​Factory

Configures the accessor factory to use to access the underlying model property.

openOnTrue

boolean

This property allows to revert the standard behaviour of the gate, i.e. close when it should normally have opened and the other way around.

propertyName

String

Configures the boolean property name to use. Unless the openOnTrue property is set to false, the state of the gate will follow the boolean property value. It supports "!" prefix to negate the property value. It also supports non-boolean properties. In that case, the test is performed against the property != null condition.

openingValues

Collection​<​String​>​

Configures the enumeration values for which the gate is to be open, unless the openOnTrue property is set to false.

regexpPattern

String

Configures the regular expression to match the property value against. The gate will open if the property value matches the regex unless the openOnTrue property has been set to false.

accessorFactory

IAccessor​Factory

Configures the accessor factory to use to access the underlying model properties.

grantedRoles

Collection​<​String​>​

Configures the roles for which the gate is installed. It supports "!" prefix to negate the role(s).

openOnTrue

boolean

This property allows to revert the standard behaviour of the gate, i.e. close when it should normally have opened and the other way around.

grantedRoles

Collection​<​String​>​

Configures the roles for which the gate is open. It supports "!" prefix to negate the role(s). If at least one of the role is satisfied, then the gate is open.