Index

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AAAS - Static variable in class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Paths

activate(IAquimaSessionActivationContext) - Method in interface com.blueriq.component.api.session.IAquimaSessionLifecycle

Activates the session.

activateSession(IAquimaSession) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Activates the given session.

ActivateSessionListener - Annotation Interface in com.blueriq.component.api.annotation

This annotation can be used on controller methods in order to automatically register a SessionListener on the current session before the controller method is invoked, and to automatically unregister the SessionListener after the controller method returns.

ACTUATOR - Static variable in class com.blueriq.component.api.BlueriqProfiles

add(ObjectModelCreation) - Method in class com.blueriq.component.api.externalflow.data.ArrayModel

add(ObjectModelCreation) - Method in interface com.blueriq.component.api.externalflow.data.creation.ArrayModelCreation

add(String) - Method in class com.blueriq.component.api.externalflow.data.ArrayModel

add(String) - Method in interface com.blueriq.component.api.externalflow.data.creation.ArrayModelCreation

add(Consumer<ObjectModelCreation>) - Method in class com.blueriq.component.api.externalflow.data.ArrayModel

add(Consumer<ObjectModelCreation>) - Method in interface com.blueriq.component.api.externalflow.data.creation.ArrayModelCreation

addAll(List<String>) - Method in class com.blueriq.component.api.externalflow.data.ArrayModel

addAll(List<String>) - Method in interface com.blueriq.component.api.externalflow.data.creation.ArrayModelCreation

addApplicationInfo(ApplicationID) - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

addBlueriqSessionInfoToMdc(IPortalSession) - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

addChildSession(String, IAquimaSession) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Adds the Aquima session and sets the unique session id, it will also be registered as a child session of the specified parent session

addListener(IKeyPattern, IKeyspaceEventListener) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyspaceMonitor

Registers the given listener for the given key pattern.

addListener(String, IKeyspaceEventListener) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyspaceMonitor

Registers the given listener for the given key.

addSession(IAquimaSession) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Adds the Aquima session.

addSessionInfo(HttpServletRequest, IPortalSession) - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

addTenantInfo(String) - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

addTestPath(String, Version) - Method in class com.blueriq.component.api.shortcut.Shortcut

addUserInfo(IUserData) - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

addUserIp(String) - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

AggregateCreateParams - Class in com.blueriq.component.api.aggregate

AggregateCreateParams() - Constructor for class com.blueriq.component.api.aggregate.AggregateCreateParams

AggregateCreateParams(IEntityInstance, String, String, IEntityInstance...) - Constructor for class com.blueriq.component.api.aggregate.AggregateCreateParams

AggregateDeleteParams - Class in com.blueriq.component.api.aggregate

AggregateDeleteParams(String, Long, Long) - Constructor for class com.blueriq.component.api.aggregate.AggregateDeleteParams

AggregateReadParams - Class in com.blueriq.component.api.aggregate

AggregateReadParams(String, Long, Long, IEntityInstance, String) - Constructor for class com.blueriq.component.api.aggregate.AggregateReadParams

AggregateService - Interface in com.blueriq.component.api.aggregate

Defines high level methods for aggregate manipulation.

AggregateUpdateParams - Class in com.blueriq.component.api.aggregate

AggregateUpdateParams(long, boolean, IEntityInstance, String, IEntityInstance...) - Constructor for class com.blueriq.component.api.aggregate.AggregateUpdateParams

ALWAYS - Enum constant in enum class com.blueriq.component.api.FlushMode

Indicates that the session should always be flushed.

ANONYMOUS_KEY - Static variable in interface com.blueriq.component.api.security.IAuthorisationManager

The key which identifies an anonymous user.

anyCharacter() - Method in interface com.blueriq.component.api.store.keyvalue.IKeyPatternBuilder

Appends a pattern element which matches any character, once.

anyString() - Method in interface com.blueriq.component.api.store.keyvalue.IKeyPatternBuilder

Appends a pattern element which matches any string.

ApplicationFinder - Interface in com.blueriq.component.api

This interface describes a method to find the application that matches some criteria that have been coded into the implementing classes.

AquimaActionHandler - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima action handlers.

AquimaActionHandlerFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima action handler factory.

AquimaApiRendererFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima api renderer factory.

AquimaAuthorizationAlgorithm - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima authorization algorithm.

AquimaBeanProvider - Interface in com.blueriq.component.api

A provider interface that allows injecting beans into various components that cannot be injected directly due to circular dependencies.

AquimaConnection - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are aquima connections.

AquimaConnectionManager - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima connection managers.

AquimaContentManagerFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is a IContentManagerFactory

AquimaDataSerializerFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima connection managers.

AquimaDataSource - Class in com.blueriq.component.api.datasource

Wraps a portalEngine data source and provides an extra unique prefix.

AquimaDataSource(String, IPortalEngineDsFactory) - Constructor for class com.blueriq.component.api.datasource.AquimaDataSource

Creates a AquimaDataSource object.

AquimaDataSource(String, IPortalEngineDsFactory, String, String) - Constructor for class com.blueriq.component.api.datasource.AquimaDataSource

Creates a AquimaDataSource object.

AquimaDocumentRenderer - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima document renderer.

AquimaDocumentXmlRenderer - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are document renderers This annotation can be used on custom converter classes in order to automatically register one to be used in document generation.

AquimaDomain - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are aquima domains.

AquimaDomainFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima domain factory.

AquimaExpander - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima container expanders (e.g. containers).

AquimaExpanderFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima container/render factory.

AquimaLicenseProvider - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima license providers.

AquimaMask - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima mask.

AquimaMaskFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima mask factory.

AquimaMatchTypeFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima match type factory.

AquimaMode - Enum Class in com.blueriq.component.api

Enum for setting the mode in which the server is running.

AquimaModuleScope - Annotation Interface in com.blueriq.component.api.annotation

Specifies that an Aquima Annotation is only valid for the specified Aquima modules.

AquimaPlugin - Annotation Interface in com.blueriq.component.api.annotation

Annotation for registering a plugin

AquimaPriorityAlgorithm - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima priority algorithm.

AquimaProcessExtensionFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima Process Extension Factoryy.

AquimaRendererFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima renderer factory.

AquimaResourceManager - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima resource managers.

AquimaRoutingAlgorithm - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima routing algorithm.

AquimaRuleFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima rule factory.

AquimaService - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are aquima services.

AquimaServiceFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima service factory.

AquimaSessionId - Annotation Interface in com.blueriq.component.api.annotation

An annotation used to identify a controller method parameter which represents an AquimaSession ID.

AquimaSoapMessageHandler - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are soap message handlers.

AquimaSoapMessageHandlerFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima soap handler factory.

AquimaTestApplication - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that extend ApplicationTemplate.

AquimaTimelineDao - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima timeline daos.

AquimaTraceDao - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima trace daos.

AquimaUserScopeDao - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are Aquima userscope dao's.

AquimaValidator - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima validator.

AquimaValidatorFactory - Annotation Interface in com.blueriq.component.api.annotation

Annotation for a class that is an Aquima validator factory.

AquimaWebConfiguration - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that contain the configuration for applications.

AquimaXmlRenderer - Annotation Interface in com.blueriq.component.api.annotation

Annotation for classes that are an XML renderer.

ArrayModel - Class in com.blueriq.component.api.externalflow.data

ArrayModel(ArrayNode) - Constructor for class com.blueriq.component.api.externalflow.data.ArrayModel

ArrayModelCreation - Interface in com.blueriq.component.api.externalflow.data.creation

This interface used by External Flow data contract mapping to fill an intermediate model with data which is transferred between a Host and Target service.

ATTR_TOKEN_REQUEST_PARAMETERS - Static variable in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProvider

Name of the attribute that is used to (internally) pass through the token request parameters

ATTRIBUTE_NAME - Static variable in class com.blueriq.component.api.shortcut.StoreTestPathActionHandler

AUDIT - Static variable in class com.blueriq.component.api.BlueriqProfiles

AUTHENTICATION - Static variable in class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Mappings

AuthenticationMapper - Interface in com.blueriq.component.api.externalflow.data.mapping

This interface should be implemented when a custom bean authentication provider is implemented and used in External Flows.

authenticationType() - Method in interface com.blueriq.component.api.externalflow.data.mapping.AuthenticationMapper

The supported authentication type for the custom authentication implementation e.q.

authorizationGrantType() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Registration

The authorization grant type

authorizationUri() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Provider

The authorization URI

AUTO - Enum constant in enum class com.blueriq.component.api.FlushMode

Indicates that the flush mode should automatically be determined based on context.

AutoWiringSpringBeanJobFactory - Class in com.blueriq.component.api.quartz

Creates job instances assuming that there is a prototype-scoped bean defined in the Spring Application Context for every job class defined in JobDetail instances.

AutoWiringSpringBeanJobFactory(ApplicationContext) - Constructor for class com.blueriq.component.api.quartz.AutoWiringSpringBeanJobFactory

B

BlueriqAuthentication - Interface in com.blueriq.component.api.security

Interface for custom authentication provider that allows the IAuthorisationManager to pick up roles, teams and properties and map them to IUserData without the need for custom code

BlueriqHttpSessionUtil - Class in com.aquima.web.util

Utility class for http session related alterations in the blueriq context.

BlueriqLogMdcUtil - Class in com.aquima.web.util

BlueriqProfiles - Class in com.blueriq.component.api

BlueriqProfiles() - Constructor for class com.blueriq.component.api.BlueriqProfiles

BlueriqServiceAccount - Interface in com.blueriq.component.api.security

Represents the service account of the current Runtime instance.

build() - Method in interface com.blueriq.component.api.store.keyvalue.IKeyPatternBuilder

Builds a key pattern from the elements appended so far.

C

canMap(Authentication) - Method in interface com.blueriq.component.api.externalflow.data.mapping.AuthenticationMapper

A function that determines if the Authentication implementation is supported by this AuthenticationMapper.

CASE_ENGINE - Static variable in class com.blueriq.component.api.BlueriqProfiles

CASE_ENGINE_CLIENT - Static variable in class com.blueriq.component.api.BlueriqProfiles

CASE_SQL_STORE - Static variable in class com.blueriq.component.api.BlueriqProfiles

cleanIdleSessions() - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Closes and removes idle (expired) sessions.

clearAuthorisation() - Method in interface com.blueriq.component.api.security.IAuthorisationManager

Clears the current authorisation, e.g no user is logged in.

clientAuthenticationMethod() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Registration

The client authentication method

clientId() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Registration

The client id

clientName() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Registration

The client name

clientRegistration() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters

A pair with the client registration and its name

clientSecret() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Registration

The client secret

close() - Method in interface com.blueriq.component.api.IAquimaSession

Closes this portal session.

close() - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore.IKeyIterator

closeSession(String) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Requests that an aquima session be closed and removed, including all its child sessions.

CMIS_CLIENT - Static variable in class com.blueriq.component.api.BlueriqProfiles

collectHeaders(List<String>, Map<String, String>, IServiceContext) - Method in interface com.blueriq.component.api.headers.ConnectionHeaderService

com.aquima.web.aaas.exception - package com.aquima.web.aaas.exception

com.aquima.web.boot.annotation - package com.aquima.web.boot.annotation

com.aquima.web.filter - package com.aquima.web.filter

com.aquima.web.util - package com.aquima.web.util

com.blueriq.component.api - package com.blueriq.component.api

com.blueriq.component.api.aggregate - package com.blueriq.component.api.aggregate

com.blueriq.component.api.annotation - package com.blueriq.component.api.annotation

com.blueriq.component.api.comments.dao - package com.blueriq.component.api.comments.dao

com.blueriq.component.api.comments.exception - package com.blueriq.component.api.comments.exception

com.blueriq.component.api.connection - package com.blueriq.component.api.connection

com.blueriq.component.api.datasource - package com.blueriq.component.api.datasource

com.blueriq.component.api.dcm - package com.blueriq.component.api.dcm

com.blueriq.component.api.documents - package com.blueriq.component.api.documents

com.blueriq.component.api.exception - package com.blueriq.component.api.exception

com.blueriq.component.api.externalflow.data - package com.blueriq.component.api.externalflow.data

com.blueriq.component.api.externalflow.data.contract - package com.blueriq.component.api.externalflow.data.contract

com.blueriq.component.api.externalflow.data.creation - package com.blueriq.component.api.externalflow.data.creation

com.blueriq.component.api.externalflow.data.mapping - package com.blueriq.component.api.externalflow.data.mapping

com.blueriq.component.api.externalflow.data.retrieval - package com.blueriq.component.api.externalflow.data.retrieval

com.blueriq.component.api.headers - package com.blueriq.component.api.headers

com.blueriq.component.api.i18n - package com.blueriq.component.api.i18n

com.blueriq.component.api.oauth2 - package com.blueriq.component.api.oauth2

com.blueriq.component.api.plugin - package com.blueriq.component.api.plugin

com.blueriq.component.api.properties - package com.blueriq.component.api.properties

com.blueriq.component.api.publisher.client.model - package com.blueriq.component.api.publisher.client.model

com.blueriq.component.api.publisher.client.repository - package com.blueriq.component.api.publisher.client.repository

com.blueriq.component.api.publisher.datasource - package com.blueriq.component.api.publisher.datasource

com.blueriq.component.api.quartz - package com.blueriq.component.api.quartz

com.blueriq.component.api.restsecurity - package com.blueriq.component.api.restsecurity

com.blueriq.component.api.scheduler - package com.blueriq.component.api.scheduler

com.blueriq.component.api.security - package com.blueriq.component.api.security

com.blueriq.component.api.session - package com.blueriq.component.api.session

com.blueriq.component.api.shortcut - package com.blueriq.component.api.shortcut

com.blueriq.component.api.shortcut.function - package com.blueriq.component.api.shortcut.function

com.blueriq.component.api.store - package com.blueriq.component.api.store

com.blueriq.component.api.store.externalflow - package com.blueriq.component.api.store.externalflow

com.blueriq.component.api.store.externalflow.data - package com.blueriq.component.api.store.externalflow.data

com.blueriq.component.api.store.externalflow.exception - package com.blueriq.component.api.store.externalflow.exception

com.blueriq.component.api.store.keyvalue - package com.blueriq.component.api.store.keyvalue

com.blueriq.component.api.store.keyvalue.exception - package com.blueriq.component.api.store.keyvalue.exception

com.blueriq.component.api.ui - package com.blueriq.component.api.ui

com.blueriq.component.api.ui.mvc - package com.blueriq.component.api.ui.mvc

com.blueriq.component.api.workunit - package com.blueriq.component.api.workunit

COMMENTS_SQL_STORE - Static variable in class com.blueriq.component.api.BlueriqProfiles

CommentsDataAccessException - Exception Class in com.blueriq.component.api.comments.exception

Exception used to notify that operation on comments dao failed due to data access problems.

CommentsDataAccessException(Throwable) - Constructor for exception class com.blueriq.component.api.comments.exception.CommentsDataAccessException

compareTo(ContractVersion) - Method in record class com.blueriq.component.api.externalflow.data.contract.ContractVersion

Compare ContractVersions on major and then minor version

ConnectionHeaderService - Interface in com.blueriq.component.api.headers

Service that collects headers for REST service client and SOAP service client connections, combining session headers and static headers while taking globally configured session headers and static headers, and the test path header into account

connectionName() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters

The name of the connection

connectionType() - Element in annotation interface com.blueriq.component.api.annotation.AquimaConnection

Returns the name of the connection type.

ContractVersion - Record Class in com.blueriq.component.api.externalflow.data.contract

Contract version for the external flow data models.

ContractVersion(int, int) - Constructor for record class com.blueriq.component.api.externalflow.data.contract.ContractVersion

Creates an instance of a ContractVersion record class.

createAggregate(IPortalContext, AggregateCreateParams, IAggregateDefinition) - Method in interface com.blueriq.component.api.aggregate.AggregateService

Creates an aggregate based on the information in the profile (accessible via the portal context), the parameters and the aggregate definition

createAnonymousUser() - Method in interface com.blueriq.component.api.security.IAuthorisationManager

This methods creates an anonymous user if this is required for the current authorisation method.

createArray(String) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

A function that creates a ArrayModelCreation and put is in the current ObjectModelCreation under the provided key.

createArray(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

createChildSession(IAquimaSessionsMap, String, ApplicationID, ModuleID, Channel, IUserData, String) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Creates a child portal session for the specified application and module and saves the session.

createChildSession(IAquimaSessionsMap, String, ApplicationID, String, IUserData, String) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Creates a portal session for the specified application.

createDataSource() - Method in interface com.blueriq.component.api.datasource.IPortalEngineDsFactory

This method returns the datasource.

createJobInstance(TriggerFiredBundle) - Method in class com.blueriq.component.api.quartz.AutoWiringSpringBeanJobFactory

createNonInteractiveSession(ApplicationID, IUserData) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Creates a portal session for the specified application and saves the session.

createObject(String) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

A function that creates a ObjectModelCreation and put is in the current ObjectModelCreation under the provided key.

createObject(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

createSession(IAquimaSessionsMap, ApplicationID, String, IUserData, String) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Creates a web portal session for the specified application and saves the session.

createVersionFromString(String, String) - Static method in class com.blueriq.component.api.plugin.PluginVersion

Csrf - Annotation Interface in com.blueriq.component.api.annotation

Controls CSRF behaviour for a controller method.

CUSTOMERDATA_CLIENT - Static variable in class com.blueriq.component.api.BlueriqProfiles

D

DASHBOARD - Static variable in class com.blueriq.component.api.BlueriqProfiles

DATAMAPPING_SIMULATOR - Static variable in class com.blueriq.component.api.BlueriqProfiles

DATASOURCE_PREFIX - Static variable in interface com.blueriq.component.api.publisher.datasource.PublisherDataSource

DATASOURCE_TYPE - Static variable in interface com.blueriq.component.api.publisher.datasource.PublisherDataSource

DataSourceProfile - Class in com.blueriq.component.api.datasource

The class defines the possible datasource profiles.

DCM_DASHBOARD - Static variable in class com.blueriq.component.api.BlueriqProfiles

Dcm2Condition - Class in com.blueriq.component.api.dcm

This condition can be used to check if this is a DCM 2.0 application running, which is the case for the runtime part when the case-engine-client profile is enabled, or for the case engine itself (with the case-engine profile enabled)

Dcm2Condition() - Constructor for class com.blueriq.component.api.dcm.Dcm2Condition

DCMLISTS_CLIENT - Static variable in class com.blueriq.component.api.BlueriqProfiles

DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_NUM_TESTS_PER_EVICTION_RUN - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_POOL_INITIAL_SIZE - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_POOL_MAX_IDLE - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_POOL_MAX_TOTAL - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_POOL_MAX_WAIT - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_POOL_MIN_IDLE - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_TEST_ON_BORROW - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_TEST_ON_RETURN - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_TEST_WHILE_IDLE - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_VALIDATION_QUERY - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

DEFAULT_VALIDATION_QUERY_TIMEOUT - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

delete(String) - Method in interface com.blueriq.component.api.store.externalflow.IExternalFlowStore

Removes the specified key.

delete(String) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Removes the specified key

DELETE - Enum constant in enum class com.blueriq.component.api.store.keyvalue.KeyspaceEvent

This event indicates a key has been deleted.

deleteAggregate(IPortalContext, AggregateDeleteParams) - Method in interface com.blueriq.component.api.aggregate.AggregateService

Deletes an aggregate based on the parameters provided

deleteAll(String...) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Removes the specified keys.

deserialize(byte[], Class<T>) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Deserializes the given byte array as an instance of the given class.

DEVELOPMENT - Enum constant in enum class com.blueriq.component.api.AquimaMode

DEVELOPMENT_TOOLS - Static variable in class com.blueriq.component.api.BlueriqProfiles

DevToolsExternalLogoutProvider - Interface in com.blueriq.component.api.security

Interface for custom external logouts which are performed by the Development Tools Component when logging out the current user.

DOCUMENT_RENDERER_CLIENT - Static variable in class com.blueriq.component.api.BlueriqProfiles

doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class com.aquima.web.filter.FilterDelegate

DuplicateSessionException - Exception Class in com.blueriq.component.api.exception

Exception thrown when two sessions with the same ID are registered in an IAquimaSessionsMap.

DuplicateSessionException(String) - Constructor for exception class com.blueriq.component.api.exception.DuplicateSessionException

DynamicShortcutReference - Class in com.blueriq.component.api.shortcut

DynamicShortcutReference(IShortcut, ApplicationID) - Constructor for class com.blueriq.component.api.shortcut.DynamicShortcutReference

E

elementClass() - Element in annotation interface com.blueriq.component.api.annotation.AquimaDocumentXmlRenderer

Returns the element class.

elementClass() - Element in annotation interface com.blueriq.component.api.annotation.AquimaXmlRenderer

Returns the element class.

EmptyDataSource - Class in com.blueriq.component.api.datasource

Empty datasource so that non configured datasource bean can return this instead of null which leads to problems with RefreshScope annotation

EmptyDataSource() - Constructor for class com.blueriq.component.api.datasource.EmptyDataSource

equals(Object) - Method in record class com.blueriq.component.api.externalflow.data.contract.ContractVersion

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class com.blueriq.component.api.plugin.PluginMetadata

equals(Object) - Method in class com.blueriq.component.api.plugin.PluginVersion

equals(Object) - Method in class com.blueriq.component.api.ProjectReference

equals(Object) - Method in class com.blueriq.component.api.shortcut.Shortcut

execute() - Method in interface com.blueriq.component.api.workunit.ITypedWorkUnit

Executes this work unit and returns the result.

execute() - Method in interface com.blueriq.component.api.workunit.IWorkUnit

Executes the work in this work unit.

executeAction(String, Map<String, ?>) - Method in interface com.blueriq.component.api.IAquimaSession

This method will invoke an action handler using the current portal session context.

executeInlineAction(IActionHandler, Map<String, ?>) - Method in interface com.blueriq.component.api.IAquimaSession

This method will invoke an action handler using the current portal session context.

expire(String, long, TimeUnit) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Sets the expiration time for the given key.

EXPIRED - Enum constant in enum class com.blueriq.component.api.store.keyvalue.KeyspaceEvent

This event indicates a key has expired.

EXTERNAL_DATASOURCE_PROFILE_NAME - Static variable in class com.blueriq.component.api.datasource.DataSourceProfile

EXTERNAL_FLOW - Static variable in class com.blueriq.component.api.BlueriqProfiles

ExternalFlowStoreException - Exception Class in com.blueriq.component.api.store.externalflow.exception

Exception thrown if the communication with external flow store fails for various reasons.

ExternalFlowStoreException(Throwable) - Constructor for exception class com.blueriq.component.api.store.externalflow.exception.ExternalFlowStoreException

Basic constructor with only the cause of the error.

ExternalLogout - Class in com.blueriq.component.api.security

ExternalLogout(String, String) - Constructor for class com.blueriq.component.api.security.ExternalLogout

ExternalLogoutProvider - Interface in com.blueriq.component.api.security

Interface for custom external logouts which are performed through the frontend API when logging out the current user.

F

fillModel(ObjectModelCreation, Authentication) - Method in interface com.blueriq.component.api.externalflow.data.mapping.AuthenticationMapper

This function is used fill the ObjectModelCreation with the required properties of the Authentication object.

FilterDelegate - Class in com.aquima.web.filter

Filter responsible for delegating requests to org.springframework.orm.hibernate5.support.OpenSessionInViewFilter

FilterDelegate(Filter) - Constructor for class com.aquima.web.filter.FilterDelegate

find(CommentSearchCriteria) - Method in interface com.blueriq.component.api.comments.dao.ICommentsDao

Search for comments, orderer by date descending.

flush() - Method in interface com.blueriq.component.api.IAquimaSessionsMap

When sessions are stored in an external session store, flushing the session manager causes all sessions that may have locally been cached to be written in the external session store and the cache to be cleared.

flushMode() - Element in annotation interface com.blueriq.component.api.annotation.AquimaSessionId

Indicates whether the session should be flushed to the external session store after the current request completes.

FlushMode - Enum Class in com.blueriq.component.api

Members of this enum are used to indicate to the IAquimaSessionsMap session manager the intent for a requested session.

forPermissions(String...) - Method in interface com.blueriq.component.api.security.PermissionAuthorizationManagerFactory

Factory method to create an AuthorizationManager which validate the Authentication against the provided permissions.

FunctionShortcut - Class in com.blueriq.component.api.shortcut.function

FunctionShortcut() - Constructor for class com.blueriq.component.api.shortcut.function.FunctionShortcut

G

generateNewWard() - Method in interface com.blueriq.component.api.ui.IPageWard

get(String) - Method in interface com.blueriq.component.api.store.externalflow.IExternalFlowStore

Returns the value specified fot the given key.

get(String, Class<T>) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Returns the value for the specified key

getAccessTime() - Method in interface com.blueriq.component.api.IAquimaSession

This method returns the date when this session was last accessed.

getAccessToken(Oauth2AccessTokenProviderParameters) - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProvider

Get an access token from the provider

getAggregateId() - Method in class com.blueriq.component.api.aggregate.AggregateDeleteParams

getAggregateId() - Method in class com.blueriq.component.api.aggregate.AggregateReadParams

getAggregateId() - Method in class com.blueriq.component.api.aggregate.AggregateUpdateParams

getAggregateType() - Method in class com.blueriq.component.api.aggregate.AggregateDeleteParams

getAggregateType() - Method in class com.blueriq.component.api.aggregate.AggregateReadParams

getAllParameters() - Method in interface com.blueriq.component.api.IProjectReference

This method returns all the parameters.

getAllParameters() - Method in class com.blueriq.component.api.ProjectReference

This method returns all the parameters set with with ProjectReference.setParameters(Map).

getApplication() - Method in interface com.blueriq.component.api.IProjectDetails

This method should not be used, but the other methods in this class.

getApplication(ApplicationID) - Method in interface com.blueriq.component.api.ApplicationFinder

getApplicationId() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getApplicationId() - Method in class com.blueriq.component.api.shortcut.DynamicShortcutReference

getApplicationId() - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

getApplicationId() - Method in interface com.blueriq.component.api.ui.IRenderContext

getAquimaEngineConfiguration() - Method in interface com.blueriq.component.api.session.IAquimaSessionActivationContext

getAquimaEngineFacade() - Method in interface com.blueriq.component.api.AquimaBeanProvider

getAquimaMode() - Method in interface com.blueriq.component.api.IAquimaEngineConfiguration

This method returns the method where the engine is running in.

getAquimaUi() - Method in interface com.blueriq.component.api.IAquimaSession

Returns the current web render engine.

getAquimaUi() - Method in interface com.blueriq.component.api.IProjectReference

getAquimaUi() - Method in class com.blueriq.component.api.ProjectReference

getAquimaUi(String) - Method in interface com.blueriq.component.api.IAquimaEngineConfiguration

This method returns the Aquima UI for the specified name.

getAquimaUi(String) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Returns the render engine by name.

getAquimaUiNames() - Method in interface com.blueriq.component.api.IAquimaEngineConfiguration

This method return a list with all the names of the registered Aquima User Interfaces.

getArtifactId() - Method in interface com.blueriq.component.api.plugin.IPluginMetadata

This method returns the artifactId.

getArtifactId() - Method in class com.blueriq.component.api.plugin.PluginMetadata

getAuthentication() - Static method in class com.blueriq.component.api.security.OAuth2Util

getAvailableAquimaUIs() - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Returns the list of the name of configured Aquima user interfaces.

getAvailableFlows() - Method in interface com.blueriq.component.api.IProjectDetails

getAvailableSessionIds() - Method in interface com.blueriq.component.api.IAquimaSessionsMap

This method returns all the available session ids.

getBoolean(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getBoolean(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getBranch() - Method in class com.blueriq.component.api.plugin.PluginVersion

This method returns the branch.

getBranch() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getBuildNumber() - Method in class com.blueriq.component.api.plugin.PluginVersion

This method returns the build number set by Hudson.

getChannel() - Method in interface com.blueriq.component.api.IProjectReference

getChannel() - Method in class com.blueriq.component.api.ProjectReference

getChannels() - Method in interface com.blueriq.component.api.IGeneralProjectDetails

getChildSessions(String) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Returns the child sessions of the specified parent session

getChildSessions(String, String) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Returns the child sessions of the specified parent session which were created on the specified page.

getClaim(String) - Method in interface com.blueriq.component.api.security.BlueriqAuthentication

getClaimNames() - Method in interface com.blueriq.component.api.security.BlueriqAuthentication

getComment() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getContent() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getCsrfToken() - Method in interface com.blueriq.component.api.IAquimaSession

This method returns the current CSRF token of this session.

getCurrentChannel() - Method in interface com.blueriq.component.api.IAquimaSession

This method returns the current channel.

getCurrentLanguage() - Method in interface com.blueriq.component.api.IAquimaSession

Returns the current selected language.

getCurrentPage() - Method in interface com.blueriq.component.api.IAquimaSession

Returns the current page.

getCurrentUser() - Method in interface com.blueriq.component.api.IAquimaSession

This method will return the current user.

getDefaultLanguage() - Method in interface com.blueriq.component.api.IProjectDetails

getDefaultLanguage() - Method in interface com.blueriq.component.api.ui.IRenderContext

getDefaultProjectRequest() - Method in interface com.blueriq.component.api.shortcut.IShortcutManager

This method returns the default project request for the default shortcut.

getDefaultShortcut() - Method in interface com.blueriq.component.api.shortcut.IShortcutManager

getDefaultVersion(String) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Returns the default version of the project.

getDescription() - Method in class com.blueriq.component.api.datasource.AquimaDataSource

getDescription() - Method in interface com.blueriq.component.api.plugin.IPluginMetadata

This method returns the description of the plugin.

getDescription() - Method in class com.blueriq.component.api.plugin.PluginMetadata

getDocumentXmlRenderers() - Method in interface com.blueriq.component.api.documents.IAnnotatedRendererStore

Returns the map of IXmlElement class names and corresponding XML document renderers.

getDriver() - Method in class com.blueriq.component.api.connection.SqlConnectionData

getEffectiveFlushMode(FlushMode, FlushMode) - Static method in enum class com.blueriq.component.api.FlushMode

When there is a choice between two flush modes to be used, this method determines the effective flush mode between the two choices, the one with the highest precedence.

getEncodedAccessToken() - Method in interface com.blueriq.component.api.security.OAuth2Authentication

The access token in encoded form.

getEnvironmentName() - Method in interface com.blueriq.component.api.publisher.client.repository.IPublishedProjectRepository

Returns the environmentName for which this repository can read projects from the publisher client database

getExportDate() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getFlow() - Method in interface com.blueriq.component.api.IProjectReference

getFlow() - Method in class com.blueriq.component.api.ProjectReference

getFunction() - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

getFunctionShortcut(String) - Method in interface com.blueriq.component.api.shortcut.function.IFunctionShortcutManager

getFunctionShortcuts() - Method in interface com.blueriq.component.api.shortcut.function.IFunctionShortcutManager

getGroupId() - Method in interface com.blueriq.component.api.plugin.IPluginMetadata

This method returns the groupId of the plugin.

getGroupId() - Method in class com.blueriq.component.api.plugin.PluginMetadata

getHttpErrorCode() - Method in exception class com.aquima.web.aaas.exception.WebServiceCallException

This method returns the http error code.

getId() - Method in interface com.blueriq.component.api.IProjectDetails

getImages(ICompositeElement, ILanguage, ApplicationID, IPortalContext) - Method in interface com.blueriq.component.api.documents.IDocumentImageProvider

This method is used to provide images to be used in a PDF document generated by the Blueriq Document Renderer.

getInstancesToStore() - Method in class com.blueriq.component.api.aggregate.AggregateCreateParams

getInstancesToStore() - Method in class com.blueriq.component.api.aggregate.AggregateUpdateParams

getInteger(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getInteger(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getInterceptor(String) - Method in interface com.blueriq.component.api.restsecurity.ISecureRestMessageInterceptorFactory

getJndi() - Method in class com.blueriq.component.api.connection.SqlConnectionData

getJndiDataSource() - Method in class com.blueriq.component.api.connection.SqlConnectionData

This method returns the datasource for the jndi name (if set).

getKey() - Method in interface com.blueriq.component.api.ui.IPageWard

getKeyPatternBuilder() - Method in interface com.blueriq.component.api.store.keyvalue.IKeyspaceMonitor

Returns a builder for creating key patterns.

getKeyPatternBuilder() - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Returns a builder for creating key patterns.

getLanguage() - Method in interface com.blueriq.component.api.ui.IRenderContext

getLanguageCode() - Method in exception class com.aquima.web.aaas.exception.WebServiceCallException

getLanguageCode() - Method in interface com.blueriq.component.api.IProjectReference

getLanguageCode() - Method in class com.blueriq.component.api.ProjectReference

getLanguages() - Method in interface com.blueriq.component.api.IGeneralProjectDetails

getLink(String) - Method in interface com.blueriq.component.api.ui.IAquimaUi

This method return the url link of aquima ui for the given session id.

getLocation() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getMainSessionIds() - Method in interface com.blueriq.component.api.IAquimaSessionsMap

This method returns only sessions that are not child sessions

getMajor() - Method in class com.blueriq.component.api.plugin.PluginVersion

This method returns the major number.

getMessage(String) - Method in interface com.blueriq.component.api.i18n.IMessageProvider

Returns the message with the given key in the default language.

getMessage(String, String) - Method in interface com.blueriq.component.api.i18n.IMessageProvider

Returns the message with the given key in the given language.

getMetadata() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getMinEvictableIdleTimeMillis() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any).

getMinor() - Method in class com.blueriq.component.api.plugin.PluginVersion

This method returns the minor number.

getModule() - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

getModuleId() - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

getMonitor() - Method in interface com.blueriq.component.api.IAquimaSession

This method will return a session monitor object containing information about this portal session.

getName() - Method in class com.blueriq.component.api.connection.SqlConnectionData

This method returns the name of the the connection

getName() - Method in interface com.blueriq.component.api.IAquimaSession

Returns the name of the session.

getName() - Method in interface com.blueriq.component.api.plugin.IPluginMetadata

This method returns the name of the plugin.

getName() - Method in class com.blueriq.component.api.plugin.PluginMetadata

getName() - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

getName() - Method in interface com.blueriq.component.api.shortcut.IShortcut

getName() - Method in class com.blueriq.component.api.shortcut.Shortcut

getName() - Method in interface com.blueriq.component.api.ui.IAquimaUi

This method should return the unique name for this Aquima user interface.

getNamespaceSeparator() - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Returns the string which is used to separate namespaces in the key-value store.

getNumTestsPerEvictionRun() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The number of objects to examine during each run of the idle object evictor thread (if any).

getObject(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getObject(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getObjectStream(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getObjectStream(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getPagename() - Method in interface com.blueriq.component.api.ui.IRenderContext

getPageUrl() - Method in interface com.blueriq.component.api.ui.IRenderContext

getPageWard() - Method in interface com.blueriq.component.api.ui.IRenderContext

getParameter(String) - Method in interface com.blueriq.component.api.IProjectReference

This method returns the request parameter value.

getParameter(String) - Method in class com.blueriq.component.api.ProjectReference

This method returns the request parameter set with ProjectReference.setParameters(Map).

getParameters() - Method in interface com.blueriq.component.api.IProjectReference

This method returns the request parameters without the standard request parameters ("project", "flow", "version", "languageCode", "ui", "theme", "channel").

getParameters() - Method in class com.blueriq.component.api.ProjectReference

This method returns the request parameters set with ProjectReference.setParameters(Map) without the standard request parameters ("project", "flow", "version", "languageCode", "ui", "theme", "channel").

getParameters() - Method in interface com.blueriq.component.api.ui.IRenderContext

getPassword() - Method in class com.blueriq.component.api.connection.SqlConnectionData

getPatch() - Method in class com.blueriq.component.api.plugin.PluginVersion

This method returns the patch (only for release version).

getPath(String) - Method in interface com.blueriq.component.api.ui.IAquimaUi

This method return the url path of aquima ui for the given session id.

getPoolInitialSize() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The initial number of connections that are created when the pool is started.

getPoolMaxIdle() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The maximum number of connections that can remain idle in the pool, without extra ones being released, or negative for no limit.

getPoolMaxTotal() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit.

getPoolMaxWait() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely.

getPoolMinIdle() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The minimum number of connections that can remain idle in the pool, without extra ones being created, or zero to create none.

getPortalEngine() - Method in interface com.blueriq.component.api.IAquimaEngineFacade

getPortalEngineDs() - Method in class com.blueriq.component.api.datasource.AquimaDataSource

getPortalSession() - Method in interface com.blueriq.component.api.IAquimaSession

This methods returns the portal session of this aquima session.

getPostRedirectParameter() - Method in class com.blueriq.component.api.security.ExternalLogout

getPrefix() - Method in class com.blueriq.component.api.datasource.AquimaDataSource

getProject() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getProject() - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

getProject(ApplicationID, Version) - Method in interface com.blueriq.component.api.publisher.client.repository.IPublishedProjectRepository

Returns the published project for the given ApplicationId and Version

getProject(String, String) - Method in interface com.blueriq.component.api.publisher.client.repository.IPublishedProjectRepository

Returns the published project for the given projectName and revision

getProjectDataSource(IAquimaConfiguration) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getProjectDetails() - Method in interface com.blueriq.component.api.IAquimaSession

This method returns the details about the application started running this session.

getProjectDetails(ApplicationID) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

This method returns the details about the application started running this session.

getProjectDetails(IShortcut, String) - Method in interface com.blueriq.component.api.IProjectDetailsProvider

Returns details about the application to be started by a shortcut

getProjectName() - Method in interface com.blueriq.component.api.IProjectReference

getProjectName() - Method in class com.blueriq.component.api.ProjectReference

getProjectNames() - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Returns the list with project names.

getProjectRequest(String) - Method in interface com.blueriq.component.api.shortcut.IShortcutManager

This method returns the project request for the specified shortcut.

getProjectRequest(String, boolean) - Method in interface com.blueriq.component.api.shortcut.IShortcutManager

This method returns the project request for the specified shortcut.

getProjectRevision() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getProjects() - Method in interface com.blueriq.component.api.publisher.client.repository.IPublishedProjectRepository

Returns a list of all published projects.

getProjectsIdentifyingData() - Method in interface com.blueriq.component.api.publisher.client.repository.IPublishedProjectRepository

Returns a list with IPublishedProject for all projects in the repository, containing only the project(name), exportDate, revision and version.

getProperties() - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getProperties() - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getProperties() - Method in class com.blueriq.component.api.plugin.PluginMetadata

This method returns the properties where this metadata is based on.

getRaw(String) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

This method reads the byte array stored at the given key and returns the raw byte array without deserializing it first.

getRequestWard() - Method in interface com.blueriq.component.api.IAquimaSession

Returns the current request ward for this session.

getResponseObject() - Method in exception class com.aquima.web.aaas.exception.WebServiceCallException

getRevision() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getRoles() - Method in interface com.blueriq.component.api.security.BlueriqAuthentication

getRootSession(String) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Retrieves the root session from the current session id.

getRuntimeKeyPrinter() - Method in interface com.blueriq.component.api.ui.IRenderContext

getSession() - Method in interface com.blueriq.component.api.ui.IRenderContext

getSession(String) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Returns the session with the specified id.

getSession(String, FlushMode) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Returns the session with the specified id.

getSessionId() - Method in exception class com.blueriq.component.api.exception.DuplicateSessionException

The session id that was already registered when trying to register a second session with the same id.

getSessionId() - Method in exception class com.blueriq.component.api.exception.UnknownSessionException

This method returns the session id that has not correspond to a valid session.

getSessionId() - Method in interface com.blueriq.component.api.IAquimaSession

This method return the sessionId of this session.

getSessionId() - Method in interface com.blueriq.component.api.ui.IRenderContext

getSessionScopeAttribute(String) - Method in interface com.blueriq.component.api.IAquimaSession

This method will return the value that has been added to the session scope for the specified attribute key.

getSessionTimeoutMillis() - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Returns the session timeout in milliseconds used by this session manager.

getShortcut(String) - Method in interface com.blueriq.component.api.shortcut.IShortcutManager

getShortcutNames() - Method in interface com.blueriq.component.api.shortcut.IShortcutManager

getShortcuts() - Method in interface com.blueriq.component.api.shortcut.IShortcutManager

getSourceContentType() - Method in interface com.blueriq.component.api.ui.IAquimaUi

This method returns the content type of the element source.

getSqlConnectionData(String) - Method in interface com.blueriq.component.api.connection.ISqlConnectionManager

getStartTime() - Method in interface com.blueriq.component.api.IAquimaSession

This method returns the time when this session was started/created.

getString() - Method in class com.blueriq.component.api.plugin.PluginVersion

This method returns the string representation of this version.

getString(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getString(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getStringArray(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getStringArray(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getStringList(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getStringList(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getStringStream(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

getStringStream(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

getTags() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getTargetAttributeAggregateId() - Method in class com.blueriq.component.api.aggregate.AggregateCreateParams

getTargetAttributeAggregateVersion() - Method in class com.blueriq.component.api.aggregate.AggregateCreateParams

getTargetAttributeAggregateVersion() - Method in class com.blueriq.component.api.aggregate.AggregateUpdateParams

getTargetInstance() - Method in class com.blueriq.component.api.aggregate.AggregateCreateParams

getTargetInstance() - Method in class com.blueriq.component.api.aggregate.AggregateReadParams

getTargetInstance() - Method in class com.blueriq.component.api.aggregate.AggregateUpdateParams

getTargetVersionAttribute() - Method in class com.blueriq.component.api.aggregate.AggregateReadParams

getTeams() - Method in interface com.blueriq.component.api.security.BlueriqAuthentication

getTenant() - Method in interface com.blueriq.component.api.security.TenantAwareOAuth2Authentication

getTestPath() - Method in interface com.blueriq.component.api.IAquimaSession

This method returns the testPath for the current session.

getTestPath() - Method in interface com.blueriq.component.api.IProjectReference

getTestPath() - Method in class com.blueriq.component.api.ProjectReference

getTestPath() - Method in class com.blueriq.component.api.shortcut.GetTestPathActionResult

GetTestPathActionHandler - Class in com.blueriq.component.api.shortcut

GetTestPathActionHandler() - Constructor for class com.blueriq.component.api.shortcut.GetTestPathActionHandler

GetTestPathActionResult - Class in com.blueriq.component.api.shortcut

GetTestPathActionResult(String) - Constructor for class com.blueriq.component.api.shortcut.GetTestPathActionResult

getTestPaths() - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

getTestPaths() - Method in interface com.blueriq.component.api.shortcut.IShortcut

getTestPaths() - Method in class com.blueriq.component.api.shortcut.Shortcut

getTestPathVersion(String) - Method in interface com.blueriq.component.api.shortcut.IShortcut

getTestPathVersion(String) - Method in class com.blueriq.component.api.shortcut.Shortcut

getTheme() - Method in interface com.blueriq.component.api.IAquimaSession

Returns the current theme.

getTheme() - Method in interface com.blueriq.component.api.IProjectReference

getTheme() - Method in class com.blueriq.component.api.ProjectReference

getTheme() - Method in interface com.blueriq.component.api.ui.IRenderContext

getThemes() - Method in interface com.blueriq.component.api.ui.IAquimaUi

This method returns the names of themes (css styles) for this AquimaUI.

getTimeBetweenEvictionRunsMillis() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The number of milliseconds to sleep between runs of the idle object evictor thread.

getType() - Method in class com.blueriq.component.api.datasource.AquimaDataSource

getUrl() - Method in class com.blueriq.component.api.connection.SqlConnectionData

getUrl() - Method in interface com.blueriq.component.api.plugin.IPluginMetadata

This method returns the url for more information about the plugin.

getUrl() - Method in class com.blueriq.component.api.plugin.PluginMetadata

getUrl() - Method in class com.blueriq.component.api.security.ExternalLogout

getUserData() - Method in interface com.blueriq.component.api.security.IAuthorisationManager

This method creates user data for the current user containing the roles of the current user.

getUsername() - Method in class com.blueriq.component.api.connection.SqlConnectionData

getUsername() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getValidationQuery() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The SQL query that will be used to validate connections from this pool before returning them to the caller.

getValidationQueryTimeout() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The timeout in seconds before connection validation queries fail.

getValueFormatDefinition(DataType) - Method in interface com.blueriq.component.api.IAquimaSession

This method returns the configured ValueFormatDefinition for the specified datatype.

getVersion() - Method in class com.blueriq.component.api.aggregate.AggregateDeleteParams

getVersion() - Method in class com.blueriq.component.api.aggregate.AggregateReadParams

getVersion() - Method in interface com.blueriq.component.api.IProjectReference

getVersion() - Method in interface com.blueriq.component.api.plugin.IPluginMetadata

This method returns the version the plugin.

getVersion() - Method in class com.blueriq.component.api.plugin.PluginMetadata

getVersion() - Method in class com.blueriq.component.api.ProjectReference

getVersion() - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

getVersions(String) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Returns the versions of the project.

getWard() - Method in interface com.blueriq.component.api.ui.IPageWard

getXmlExportResource() - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

getXmlPageRenderers() - Method in interface com.blueriq.component.api.documents.IAnnotatedRendererStore

Returns the map of IXmlElement class names and corresponding XML page renderers.

H

handle(IActionContext) - Method in class com.blueriq.component.api.shortcut.GetTestPathActionHandler

handle(IActionContext) - Method in class com.blueriq.component.api.shortcut.StoreTestPathActionHandler

handleEvent(PortalEvent) - Method in interface com.blueriq.component.api.IAquimaSession

This method will process the event passed, and continue the flow if needed.

has(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

has(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

hasCache() - Method in interface com.blueriq.component.api.ui.IAquimaUi

This method indicated if the web renderer has a cache (that can be reset).

hashCode() - Method in record class com.blueriq.component.api.externalflow.data.contract.ContractVersion

Returns a hash code value for this object.

hashCode() - Method in class com.blueriq.component.api.plugin.PluginMetadata

hashCode() - Method in class com.blueriq.component.api.plugin.PluginVersion

hashCode() - Method in class com.blueriq.component.api.ProjectReference

hashCode() - Method in class com.blueriq.component.api.shortcut.Shortcut

hasHigherPrecedence(FlushMode) - Method in enum class com.blueriq.component.api.FlushMode

Returns whether this flush mode has higher precendence than the other flush mode.

hasKey(String) - Method in interface com.blueriq.component.api.store.externalflow.IExternalFlowStore

Checks if the given key exists in the external flow store.

hasKey(String) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Checks if the given key exists in the key-value store.

hasPrivateAccess() - Method in interface com.blueriq.component.api.IProjectReference

This method indicates if the project reference is private or not

hasPrivateAccess() - Method in class com.blueriq.component.api.ProjectReference

hasResponseObject() - Method in exception class com.aquima.web.aaas.exception.WebServiceCallException

hasSession(String) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Returns an indicator whether the session actually exists.

HEADER_NAME - Static variable in class com.blueriq.component.api.shortcut.TestPathParameters

I

IAnnotatedRendererStore - Interface in com.blueriq.component.api.documents

Interface for services used to get Map of registered renderers.

IAquimaEngineConfiguration - Interface in com.blueriq.component.api

This interface defines is the main configuration for the Aquima Engine Facade.

IAquimaEngineFacade - Interface in com.blueriq.component.api

Interface for portal engines used in web based applications.

IAquimaSession - Interface in com.blueriq.component.api

Interface for portal sessions used in web based applications.

IAquimaSessionActivationContext - Interface in com.blueriq.component.api.session

Objects implementing the IAquimaSessionLifecycle or ISessionLifecycle interface may obtain their transitive dependencies from this context.

IAquimaSessionLifecycle - Interface in com.blueriq.component.api.session

Specifies the activation-passivation lifecycle for IAquimaSession instances.

IAquimaSessionsMap - Interface in com.blueriq.component.api

Session manager class for managing multiple portal sessions.

IAquimaUi - Interface in com.blueriq.component.api.ui

Interface for Aquima user interfaces.

IAuthorisationManager - Interface in com.blueriq.component.api.security

Interface for authorisation.

ICommentsDao - Interface in com.blueriq.component.api.comments.dao

Dao interface for storing comments.

IDocumentImageProvider - Interface in com.blueriq.component.api.documents

Register a Spring bean that implements this interface to provide images to be used in a PDF document generated by the Blueriq Document Renderer.

IDynamicShortcutResolver - Interface in com.blueriq.component.api.shortcut

Determines the application a shortcut should start

IExternalFlowStore - Interface in com.blueriq.component.api.store.externalflow

Abstraction for the external flow store.

IFunctionShortcutManager - Interface in com.blueriq.component.api.shortcut.function

IGeneralProjectDetails - Interface in com.blueriq.component.api

A lightweight object that provides details about a project without having to load the full project.

ignore() - Element in annotation interface com.blueriq.component.api.annotation.Csrf

Indicates whether CSRF verification should be skipped for this method.

IKeyPattern - Interface in com.blueriq.component.api.store.keyvalue

Represents a pattern for keys in a key-value store.

IKeyPatternBuilder - Interface in com.blueriq.component.api.store.keyvalue

A builder for creating key patterns that a given IKeyValueStore implementation understands.

IKeyspaceEventListener - Interface in com.blueriq.component.api.store.keyvalue

Objects that which to register with a IKeyspaceMonitor and be notified of keyspace events must implement this interface.

IKeyspaceMonitor - Interface in com.blueriq.component.api.store.keyvalue

A keyspace monitor is capable of "monitoring" the keys in a key-value store and notify listeners when a key is set, deleted or when a key expires.

IKeyValueStore - Interface in com.blueriq.component.api.store.keyvalue

Abstraction for key-value store systems.

IKeyValueStore.IKeyIterator - Interface in com.blueriq.component.api.store.keyvalue

An iterator over keys in a key-value store.

IMessageProvider - Interface in com.blueriq.component.api.i18n

Provides internationalized messages.

insert(String, String, String, Date, IMultilingualText, String) - Method in interface com.blueriq.component.api.comments.dao.ICommentsDao

Inserts a comment.

INVALID_SHORTCUT_DOMAIN - Static variable in class com.blueriq.component.api.shortcut.ShortcutErrorCodes

Indicates that a domain (value list) whose values are intended to represent shortcuts has a value that is not defined as a shortcut in the runtime.

IPageWard - Interface in com.blueriq.component.api.ui

A ward is a boundary which signals when one crosses it.

IPluginMetadata - Interface in com.blueriq.component.api.plugin

Interface for defining the metadata for plugins.

IPortalEngineDsFactory - Interface in com.blueriq.component.api.datasource

Factory for creating a data source which can be used to reload data sources.

IProjectDetails - Interface in com.blueriq.component.api

This interface represents the details about the current application.

IProjectDetailsProvider - Interface in com.blueriq.component.api

A interface implemented by objects that can provide details about a project.

IProjectReference - Interface in com.blueriq.component.api

Represents a project request to start which can be put on the session.

IPublishedProject - Interface in com.blueriq.component.api.publisher.client.model

Published Project Model.

IPublishedProjectRepository - Interface in com.blueriq.component.api.publisher.client.repository

IRenderContext - Interface in com.blueriq.component.api.ui

Interface for context class for rendering with Xslt and Json.

isAnonymous() - Method in interface com.blueriq.component.api.security.BlueriqAuthentication

isArray(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

isArray(String) - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

isAutomatic() - Method in interface com.blueriq.component.api.security.BlueriqAuthentication

isDecorator() - Element in annotation interface com.blueriq.component.api.annotation.AquimaTraceDao

True if the ITraceDao is a decorator class.

isDevtoolsEnabled() - Method in interface com.blueriq.component.api.IProjectReference

isDevtoolsEnabled() - Method in class com.blueriq.component.api.ProjectReference

isDynamicVersion() - Method in interface com.blueriq.component.api.shortcut.IShortcut

isDynamicVersion() - Method in class com.blueriq.component.api.shortcut.Shortcut

ISecureRestMessageInterceptorFactory - Interface in com.blueriq.component.api.restsecurity

Implementations of this interface are used by the REST service Client Service to optionally add a REST message security interceptor to be used before sending a REST request.

isEmpty() - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

isEmpty() - Method in interface com.blueriq.component.api.externalflow.data.retrieval.ObjectModelRetrieval

isExpectedSubmit(WebRequest, String) - Method in interface com.blueriq.component.api.ui.IPageWard

IShortcut - Interface in com.blueriq.component.api.shortcut

IShortcutManager - Interface in com.blueriq.component.api.shortcut

Manager that reads the configured shortcuts and can create ProjectRequests from it.

isJndi() - Method in class com.blueriq.component.api.connection.SqlConnectionData

This method returns true if the connection is configured via jndi,

isNewVersion() - Method in class com.blueriq.component.api.aggregate.AggregateUpdateParams

ISqlConnectionManager - Interface in com.blueriq.component.api.connection

Connection Manager that can return the Sql connection data that can be used by plugins.

isReadOnly() - Method in class com.blueriq.component.api.shortcut.GetTestPathActionHandler

isReadOnly() - Method in class com.blueriq.component.api.shortcut.StoreTestPathActionHandler

isReloading(HttpSession) - Static method in class com.aquima.web.util.BlueriqHttpSessionUtil

isSnapshot() - Method in class com.blueriq.component.api.plugin.PluginVersion

This method returns true if this version is a snapshot.

issuerUri() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Provider

The issuer URI

isTestOnBorrow() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The indication of whether objects will be validated before being borrowed from the pool.

isTestOnReturn() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The indication of whether objects will be validated before being returned to the pool.

isTestPathAvailable(String) - Method in interface com.blueriq.component.api.shortcut.IShortcut

isTestPathAvailable(String) - Method in class com.blueriq.component.api.shortcut.Shortcut

isTestWhileIdle() - Method in class com.blueriq.component.api.connection.SqlConnectionData

The indication of whether objects will be validated by the idle object evictor (if any).

ITypedWorkUnit<T> - Interface in com.blueriq.component.api.workunit

A work unit which can return a result.

IWorkUnit - Interface in com.blueriq.component.api.workunit

A work unit which can be submitted to an IWorkUnitExecutor for execution.

IWorkUnitExecutor - Interface in com.blueriq.component.api.workunit

An object which can execute a work unit within a specific context.

J

JNDI_DATASOURCE_PROFILE_NAME - Static variable in class com.blueriq.component.api.datasource.DataSourceProfile

jwkSetUri() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Provider

The JSON Web Key set URI

K

keepAlive(String) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Sets the timeout of the session with the given id to the specified timeout.

keyIterator(IKeyPattern) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Provides a means to enumerate all keys in the key-value store, optionally matching a pattern.

keys(IKeyPattern) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Returns all keys in the key-value store, optionally with a pattern to scope to a namespace.

KeyspaceEvent - Enum Class in com.blueriq.component.api.store.keyvalue

Defines the set of events for which IKeyspaceEventListeners can register with an IKeyspaceMonitor.

KEYVALUE_REDIS_STORE - Static variable in class com.blueriq.component.api.BlueriqProfiles

KeyValueStoreException - Exception Class in com.blueriq.component.api.store.keyvalue.exception

KeyValueStoreException(String) - Constructor for exception class com.blueriq.component.api.store.keyvalue.exception.KeyValueStoreException

Basic constructor with only a message explaining the cause of the error.

KeyValueStoreException(String, Throwable) - Constructor for exception class com.blueriq.component.api.store.keyvalue.exception.KeyValueStoreException

Constructor with both a message and an exception explaining the cause of the error.

KeyValueStoreException(Throwable) - Constructor for exception class com.blueriq.component.api.store.keyvalue.exception.KeyValueStoreException

Basic constructor with only the cause of the error.

L

literal(String) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyPatternBuilder

Appends the given literal string to the pattern.

LOG - Static variable in class com.blueriq.component.api.connection.SqlConnectionData

M

major() - Method in record class com.blueriq.component.api.externalflow.data.contract.ContractVersion

Returns the value of the major record component.

Mappings() - Constructor for class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Mappings

matches(ConditionContext, AnnotatedTypeMetadata) - Method in class com.blueriq.component.api.dcm.Dcm2Condition

minor() - Method in record class com.blueriq.component.api.externalflow.data.contract.ContractVersion

Returns the value of the minor record component.

MVC - Static variable in class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Mappings

MVC - Static variable in class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Paths

MvcUrlConfiguration - Class in com.blueriq.component.api.ui.mvc

MvcUrlConfiguration() - Constructor for class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration

MvcUrlConfiguration.Mappings - Class in com.blueriq.component.api.ui.mvc

MvcUrlConfiguration.Paths - Class in com.blueriq.component.api.ui.mvc

N

name() - Element in annotation interface com.blueriq.component.api.annotation.AquimaTimelineDao

Returns the optional name for the timeline dao.

name() - Element in annotation interface com.blueriq.component.api.annotation.AquimaTraceDao

Returns the optional name for the trace dao.

NEVER - Enum constant in enum class com.blueriq.component.api.FlushMode

Indicates that the session should never be flushed.

notifyAccess() - Method in interface com.blueriq.component.api.IAquimaSession

This method updates the last access date.

O

Oauth2AccessTokenProvider - Interface in com.blueriq.component.api.oauth2

This interface defines a method to retrieve an OAuth 2.0 access token, based on Oauth2AccessTokenProviderParameters.

Oauth2AccessTokenProviderParameters - Interface in com.blueriq.component.api.oauth2

This interface defines the parameters that can be used to obtain an access token through an Oauth2AccessTokenProvider.

Oauth2AccessTokenProviderParameters.Provider - Interface in com.blueriq.component.api.oauth2

Spring Security OAUth 2.0 client provider properties

Oauth2AccessTokenProviderParameters.Registration - Interface in com.blueriq.component.api.oauth2

Spring Security OAUth 2.0 client registration properties

OAuth2Authentication - Interface in com.blueriq.component.api.security

The base interface for all authentications performed using OAuth2

OAuth2Util - Class in com.blueriq.component.api.security

ObjectModel - Class in com.blueriq.component.api.externalflow.data

The ObjectModel is not thread-safe and should not be shared over multiple threads, unless the object is synchronized by the caller.

ObjectModel() - Constructor for class com.blueriq.component.api.externalflow.data.ObjectModel

ObjectModel(byte[]) - Constructor for class com.blueriq.component.api.externalflow.data.ObjectModel

Construct an object model using byte array containing json.

ObjectModel(JsonNode) - Constructor for class com.blueriq.component.api.externalflow.data.ObjectModel

ObjectModelCreation - Interface in com.blueriq.component.api.externalflow.data.creation

This interface used by External Flow data contract mapping to fill an intermediate model with data which is transferred between a Host and Target service.

ObjectModelRetrieval - Interface in com.blueriq.component.api.externalflow.data.retrieval

This interface used by External Flow data contract mapping to retrieve information from the intermediate model that is transferred between a Host and Target service.

ObjectModelStorage - Interface in com.blueriq.component.api.store.externalflow.data

onEvent(KeyspaceEvent, String) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyspaceEventListener

This method is called by the IKeyspaceMonitor to notify the listener of an event.

P

parameterName() - Element in annotation interface com.blueriq.component.api.annotation.AquimaSessionId

passivate() - Method in interface com.blueriq.component.api.session.IAquimaSessionLifecycle

Passivates the session.

passivateSession(IAquimaSession) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Passivates the given session.

Paths() - Constructor for class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Paths

pattern(IKeyPattern) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyPatternBuilder

Appends the given pattern.

PERFORMANCE_TEST - Static variable in class com.blueriq.component.api.BlueriqProfiles

PermissionAuthorizationManagerFactory - Interface in com.blueriq.component.api.security

Interface for a custom PermissionAuthorizationManagerFactory that creates an AuthorizationManager which validates the provided permissions against the GrantedAuthorities of an Authentication object.

PluginMetadata - Class in com.blueriq.component.api.plugin

Class for reading plugin meta data from a properties file.

PluginMetadata(String) - Constructor for class com.blueriq.component.api.plugin.PluginMetadata

Creates a new PluginMetadata instance for the plugin artifact by reading "[pluginArtifact].plugin" from the classpath.

PluginMetadata(Properties) - Constructor for class com.blueriq.component.api.plugin.PluginMetadata

Creates a new PluginMetadata instance for the plugin with the specified properties.

PluginVersion - Class in com.blueriq.component.api.plugin

Plugin version class for releases and snapshots.

PROCESS_SQL_STORE - Static variable in class com.blueriq.component.api.BlueriqProfiles

PRODUCTION - Enum constant in enum class com.blueriq.component.api.AquimaMode

ProjectReference - Class in com.blueriq.component.api

Mutable project reference implementation.

ProjectReference(IProjectReference) - Constructor for class com.blueriq.component.api.ProjectReference

Copy constructor

ProjectReference(String) - Constructor for class com.blueriq.component.api.ProjectReference

Constructs a new application request for the specified application/project.

PropertyService - Interface in com.blueriq.component.api.properties

Interface for a service that reads configuration properties in several formats

provider() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Registration

A pair with client provider and its name

PUBLISHER_CLIENT - Static variable in class com.blueriq.component.api.BlueriqProfiles

PUBLISHER_CLIENT_ARTIFACTORY - Static variable in class com.blueriq.component.api.BlueriqProfiles

PublisherDataSource - Interface in com.blueriq.component.api.publisher.datasource

put(String, boolean) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

put(String, boolean) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

put(String, int) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

put(String, int) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

put(String, String) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

put(String, String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

putIfAbsent(String, boolean) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

putIfAbsent(String, boolean) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

putIfAbsent(String, int) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

putIfAbsent(String, int) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

putIfAbsent(String, String) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

putIfAbsent(String, String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

putIfAbsent(String, Consumer<ObjectModelCreation>) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

A function that creates a ObjectModelCreation and put is in the current ObjectModelCreation under the provided key when it isn't already set.

putIfAbsent(String, Consumer<ObjectModelCreation>) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

putNull(String) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

putNull(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

putNullIfAbsent(String) - Method in interface com.blueriq.component.api.externalflow.data.creation.ObjectModelCreation

putNullIfAbsent(String) - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

R

readAggregate(IPortalContext, AggregateReadParams) - Method in interface com.blueriq.component.api.aggregate.AggregateService

Reads an existing aggregate and loads it into the profile.

readInteger(String) - Method in interface com.blueriq.component.api.properties.PropertyService

Returns the integer value for the given key

readInteger(String, int) - Method in interface com.blueriq.component.api.properties.PropertyService

Returns the integer value for the given key

readMap(String) - Method in interface com.blueriq.component.api.properties.PropertyService

Returns a map containing all configured key-value pairs for the given key

readMultiValueString(String) - Method in interface com.blueriq.component.api.properties.PropertyService

Returns the string values for the given key.

readString(String) - Method in interface com.blueriq.component.api.properties.PropertyService

Returns the string value for the given key

recompose() - Method in interface com.blueriq.component.api.IAquimaSession

This method recomposes the current page.

redirectUri() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Registration

The redirect URI

reload() - Method in class com.blueriq.component.api.datasource.AquimaDataSource

reloadProject(String) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Reloads the project definition.

reloadProjects() - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Reloads the all the project definitions.

reloadProjects(String, String...) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

Reloads the projects definition.

removeApplicationInfo() - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

removeListener(IKeyPattern, IKeyspaceEventListener) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyspaceMonitor

Unregisters the given listener from the given key pattern.

removeListener(String, IKeyspaceEventListener) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyspaceMonitor

Unregisters the given listener from the given key.

removeReloading(HttpSession) - Static method in class com.aquima.web.util.BlueriqHttpSessionUtil

removeSessionInfo() - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

removeTenantInfo() - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

removeUserInfo() - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

removeUserIp() - Static method in class com.aquima.web.util.BlueriqLogMdcUtil

renew() - Element in annotation interface com.blueriq.component.api.annotation.RequestWard

Indicates whether the request-ward should be renewed when this controller method is invoked.

renewCsrfToken() - Method in interface com.blueriq.component.api.IAquimaSession

This method generates a new CSRF token for this session and returns the new token.

renewRequestWard() - Method in interface com.blueriq.component.api.IAquimaSession

Generates and returns a new request ward for this session.

REPORTING_SQL_STORE - Static variable in class com.blueriq.component.api.BlueriqProfiles

RequestWard - Annotation Interface in com.blueriq.component.api.annotation

Controls request-ward behaviour for a controller method.

resetCache() - Method in interface com.blueriq.component.api.ui.IAquimaUi

This method may be called to reset the cache of this web render engine.

resolveShortcut(IShortcut, ApplicationID) - Method in interface com.blueriq.component.api.shortcut.IDynamicShortcutResolver

Determines the Application ID for the session of the external widget.

resolveShortcut(IShortcut, ApplicationID, String) - Method in interface com.blueriq.component.api.shortcut.IDynamicShortcutResolver

Determines the Application ID for the session of the external widget.

resolveVersion(String) - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

REST - Static variable in class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Mappings

REST - Static variable in class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Paths

RestApiContext - Annotation Interface in com.aquima.web.boot.annotation

This qualifier annotation indicates that the annotated element has some association with the application context of the /api/v1 servlet.

restoreSession(IAquimaSessionsMap, ApplicationID, ISessionState, String, IPortalMessageBus, IPortalEventBus) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

This method may be used to restore a session from binary data containing a saved session state.

restoreSession(IAquimaSessionsMap, ApplicationID, String, String, IPortalMessageBus, IPortalEventBus) - Method in interface com.blueriq.component.api.IAquimaEngineFacade

This method may be used to restore a session from an XML containing a saved session state.

retrieveAggregate(String, long) - Method in interface com.blueriq.component.api.aggregate.AggregateService

Retrieves a specific aggregate

retrieveExternalLogout() - Method in interface com.blueriq.component.api.security.DevToolsExternalLogoutProvider

Retrieves a logout object on which the user can use to log out from the external system

retrieveExternalLogout(Authentication, HttpServletRequest) - Method in interface com.blueriq.component.api.security.ExternalLogoutProvider

Retrieves a logout object on which the user can use to log out from the external system

REVISION_PREFIX - Static variable in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

The revision prefix used by the publisher to delimiter [major].

RunAsServiceAccount - Annotation Interface in com.blueriq.component.api.scheduler

Indicates that the annotated job should run as the Blueriq Service Account.

S

SCHEDULER_QUARTZ - Static variable in class com.blueriq.component.api.BlueriqProfiles

scope() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Registration

A set of authorization scopes

SECURITY_OPENID_CONNECT - Static variable in class com.blueriq.component.api.BlueriqProfiles

serialize(Serializable) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Serializes the given value, so it may be saved in raw byte-array for using IKeyValueStore.setRaw(String, byte[]).

ServerContext - Annotation Interface in com.blueriq.component.api.annotation

This qualifier annotation indicates that the annotated element has some association with the application context of the /server servlet.

serviceCallName() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters

The name of the service call

SessionStoreNotLicensedException - Exception Class in com.blueriq.component.api.store

Indicates a licensing problem for external session stores.

SessionStoreNotLicensedException(String) - Constructor for exception class com.blueriq.component.api.store.SessionStoreNotLicensedException

SessionStoreNotLicensedException(String, LicenseKey) - Constructor for exception class com.blueriq.component.api.store.SessionStoreNotLicensedException

SessionStoreNotLicensedException(String, Throwable) - Constructor for exception class com.blueriq.component.api.store.SessionStoreNotLicensedException

set(String, ObjectModelStorage) - Method in interface com.blueriq.component.api.store.externalflow.IExternalFlowStore

Saves a ObjectModelStorage object in the external flow store.

set(String, Serializable) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Saves a Serializable object in the key-value store.

set(String, Serializable, long, TimeUnit) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Saves a Serializable object in the key-value store with a specified expiration time.

SET - Enum constant in enum class com.blueriq.component.api.store.keyvalue.KeyspaceEvent

This event indicates a key has been set.

setAquimaMode(AquimaMode) - Method in interface com.blueriq.component.api.IAquimaEngineConfiguration

This methods sets the mode the engine is running in.

setAquimaUi(String) - Method in interface com.blueriq.component.api.IAquimaSession

Sets the current web renderer.

setAquimaUi(String) - Method in class com.blueriq.component.api.ProjectReference

setBranch(String) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setChannel(String) - Method in class com.blueriq.component.api.ProjectReference

setComment(String) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setContent(byte[]) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setDevtoolsEnabled(boolean) - Method in class com.blueriq.component.api.ProjectReference

setDynamicVersion(boolean) - Method in class com.blueriq.component.api.shortcut.Shortcut

setExportDate(Date) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setFlow(String) - Method in class com.blueriq.component.api.ProjectReference

setFunction(String) - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

setLanguage(String) - Method in interface com.blueriq.component.api.IAquimaSession

Sets the current language.

setLanguageCode(String) - Method in class com.blueriq.component.api.ProjectReference

setLocation(String) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setMetadata(byte[]) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setModule(String) - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

setName(String) - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

setPageWard(IPageWard) - Method in interface com.blueriq.component.api.ui.IRenderContext

setParameter(String, Object) - Method in interface com.blueriq.component.api.ui.IRenderContext

setParameters(Map<String, String[]>) - Method in class com.blueriq.component.api.ProjectReference

This method sets the (additional) parameters from the request (often an httpServletRequest).

setPrivateAccess(boolean) - Method in class com.blueriq.component.api.ProjectReference

setProject(String) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setProject(String) - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

setProjectName(String) - Method in class com.blueriq.component.api.ProjectReference

setRaw(String, byte[]) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Similar to IKeyValueStore.set(String, Serializable), except the byte array value is written in the key-value store as-is, without serializing it first.

setRaw(String, byte[], long, TimeUnit) - Method in interface com.blueriq.component.api.store.keyvalue.IKeyValueStore

Similar to IKeyValueStore.set(String, Serializable, long, TimeUnit), except the byte array value is written in the key-value store as-is, without serializing it first.

setReloading(HttpSession) - Static method in class com.aquima.web.util.BlueriqHttpSessionUtil

setRevision(String) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setSessionScopeAttribute(String, Serializable) - Method in interface com.blueriq.component.api.IAquimaSession

This method will set the value in the session scope under the specified key, and will return the value that might have been replaced by this action.

setTags(String) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setTestPath(String) - Method in class com.blueriq.component.api.ProjectReference

setTestPaths(Map<String, String>) - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

setTheme(String) - Method in interface com.blueriq.component.api.IAquimaSession

Sets the current theme.

setTheme(String) - Method in class com.blueriq.component.api.ProjectReference

setUsername(String) - Method in interface com.blueriq.component.api.publisher.client.model.IPublishedProject

setVersion(String) - Method in class com.blueriq.component.api.ProjectReference

setVersion(String) - Method in class com.blueriq.component.api.shortcut.function.FunctionShortcut

Shortcut - Class in com.blueriq.component.api.shortcut

Shortcut(IShortcut) - Constructor for class com.blueriq.component.api.shortcut.Shortcut

Shortcut(String, String) - Constructor for class com.blueriq.component.api.shortcut.Shortcut

ShortcutErrorCodes - Class in com.blueriq.component.api.shortcut

This class defines the various initialization errors related to shortcuts.

ShortcutErrorCodes() - Constructor for class com.blueriq.component.api.shortcut.ShortcutErrorCodes

shouldNotFilter(HttpServletRequest) - Method in class com.aquima.web.filter.FilterDelegate

SqlConnectionData - Class in com.blueriq.component.api.connection

Class used by the Configurable connection manager to allow plugins to use the connections.

SqlConnectionData(String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String) - Constructor for class com.blueriq.component.api.connection.SqlConnectionData

Constructs a new SqlConnection data.

START - Static variable in class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Mappings

START - Static variable in class com.blueriq.component.api.ui.mvc.MvcUrlConfiguration.Paths

startFlow(String) - Method in interface com.blueriq.component.api.IAquimaSession

This method will start the exposed flow with the specified name.

startFlow(String, boolean, Map<String, Serializable>) - Method in interface com.blueriq.component.api.IAquimaSession

This method starts a flow.

stopFlow(boolean) - Method in interface com.blueriq.component.api.IAquimaSession

This method will stop the current flow and commit or rollback any pending changes.

StoreTestPathActionHandler - Class in com.blueriq.component.api.shortcut

StoreTestPathActionHandler() - Constructor for class com.blueriq.component.api.shortcut.StoreTestPathActionHandler

submit(ITypedWorkUnit<T>) - Method in interface com.blueriq.component.api.workunit.IWorkUnitExecutor

Submits for work a unit of work which returns a result.

submit(IWorkUnit) - Method in interface com.blueriq.component.api.workunit.IWorkUnitExecutor

Submits for execution a unit of work.

SupportedContractVersions - Class in com.blueriq.component.api.externalflow.data.contract

List of supported ContractVersions that can be used to create external flow model data mappings with.

supportsContract(ContractVersion) - Method in interface com.blueriq.component.api.externalflow.data.mapping.AuthenticationMapper

A function that determines if the AuthenticationMapper know how to map the custom Authentication object for the provided ContractVersion.

T

TenantAwareOAuth2Authentication - Interface in com.blueriq.component.api.security

terminateSession(String) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

Closes and removes an aquima session, including all its child sessions.

TestPathParameters - Class in com.blueriq.component.api.shortcut

TIMELINE_EVENT_PUBLISHER_AMQP - Static variable in class com.blueriq.component.api.BlueriqProfiles

TIMELINE_SQL_STORE - Static variable in class com.blueriq.component.api.BlueriqProfiles

toAuthentication(ObjectModelRetrieval) - Method in interface com.blueriq.component.api.externalflow.data.mapping.AuthenticationMapper

This function uses data that is provided from the AuthenticationMapper.fillModel(ObjectModelCreation, Authentication) function to recreate the Authentication object.

toBytes() - Method in class com.blueriq.component.api.externalflow.data.ObjectModel

toBytes() - Method in interface com.blueriq.component.api.store.externalflow.data.ObjectModelStorage

A function that can be used to serialize the ObjectModelStorage to a byte array.

tokenRequestParameters() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters

A map with any additional token request parameters

tokenUri() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Provider

The token URI

toString() - Method in record class com.blueriq.component.api.externalflow.data.contract.ContractVersion

Returns a string representation of this record class.

toString() - Method in class com.blueriq.component.api.plugin.PluginMetadata

toString() - Method in class com.blueriq.component.api.plugin.PluginVersion

toString() - Method in class com.blueriq.component.api.ProjectReference

toUrl() - Method in class com.blueriq.component.api.ProjectReference

toUrl(Map<String, String[]>) - Method in interface com.blueriq.component.api.IProjectReference

This method returns the url to start this project reference.

toUrl(Map<String, String[]>) - Method in class com.blueriq.component.api.ProjectReference

TRACE_EVENT_PUBLISHER_AMQP - Static variable in class com.blueriq.component.api.BlueriqProfiles

TRACE_SQL_STORE - Static variable in class com.blueriq.component.api.BlueriqProfiles

U

UnknownSessionException - Exception Class in com.blueriq.component.api.exception

Exception that is used by the session manager when a session is request with an unknown id.

UnknownSessionException(String) - Constructor for exception class com.blueriq.component.api.exception.UnknownSessionException

Create an exception with the session id that does not correspond to a valid session.

updateAggregate(IPortalContext, AggregateUpdateParams, IAggregateDefinition) - Method in interface com.blueriq.component.api.aggregate.AggregateService

Updates an existing aggregate based on the information in the profile (accessible via the portal context) and the update parameters.

updateSession(IAquimaSession) - Method in interface com.blueriq.component.api.IAquimaSessionsMap

This method updates the session with the same id as the specified session.

userInfoAuthenticationMethod() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Provider

The user info authentication

userInfoUri() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Provider

The user info URI

userNameAttribute() - Method in interface com.blueriq.component.api.oauth2.Oauth2AccessTokenProviderParameters.Provider

The username attribute

V

V_1_0 - Static variable in class com.blueriq.component.api.externalflow.data.contract.SupportedContractVersions

Initial version of the versioned External Flow contract

validate() - Element in annotation interface com.blueriq.component.api.annotation.RequestWard

Indicates whether request-ward validation should be enabled for this method.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaActionHandler

Returns the name of the action handler.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaAuthorizationAlgorithm

Returns the name of the algorithm.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaConnection

Returns the name of the service.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaDomain

Returns the name of the domain.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaExpander

Returns the name of the expander (container).

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaMask

Returns the name of the mask.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaModuleScope

Returns the Aquima module names this annotation is valid for.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaPlugin

Returns the name of the plugin metadata file.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaPriorityAlgorithm

Returns the name of the algorithm.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaRoutingAlgorithm

Returns the name of the algorithm.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaService

Returns the name of the service.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaSessionId

The name of the request parameter (default: sessionId).

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaSoapMessageHandler

Returns the name of the action handler.

value() - Element in annotation interface com.blueriq.component.api.annotation.AquimaValidator

Returns the name of the validator.

valueOf(String) - Static method in enum class com.blueriq.component.api.AquimaMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.blueriq.component.api.FlushMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.blueriq.component.api.store.keyvalue.KeyspaceEvent

Returns the enum constant of this class with the specified name.

valueOfProperties(Properties) - Static method in class com.blueriq.component.api.plugin.PluginVersion

This method constructs a PluginVersion based on the specified properties.

valueOfRelease(int, int) - Static method in class com.blueriq.component.api.plugin.PluginVersion

This method creates a new Release Plugin version without a patch.

valueOfRelease(int, int, String) - Static method in class com.blueriq.component.api.plugin.PluginVersion

This method creates a new Release Plugin version with a patch.

valueOfSnapshot(int, int, long) - Static method in class com.blueriq.component.api.plugin.PluginVersion

This method creates a new Snapshot Plugin version with a build number.

valueOfSnapshot(int, int, String, long) - Static method in class com.blueriq.component.api.plugin.PluginVersion

This method creates a new Snapshot Plugin version with a build number.

valueOfSnapshot(int, long) - Static method in class com.blueriq.component.api.plugin.PluginVersion

This method creates a new Snapshot Plugin version with a build number.

valueOfSnapshot(int, String, long) - Static method in class com.blueriq.component.api.plugin.PluginVersion

This method creates a new Snapshot Plugin version with a build number.

values() - Static method in enum class com.blueriq.component.api.AquimaMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.blueriq.component.api.FlushMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.blueriq.component.api.store.keyvalue.KeyspaceEvent

Returns an array containing the constants of this enum class, in the order they are declared.

W

WebServiceCallException - Exception Class in com.aquima.web.aaas.exception

Exception that is thrown by a webservice call (Rest or Soap) to the client.

WebServiceCallException(String, ValidationResponseObject, String, int) - Constructor for exception class com.aquima.web.aaas.exception.WebServiceCallException

WebServiceCallException(String, Throwable) - Constructor for exception class com.aquima.web.aaas.exception.WebServiceCallException

Construct a webservice call with a message and a cause.

WebServiceCallException(String, Throwable, int) - Constructor for exception class com.aquima.web.aaas.exception.WebServiceCallException

Construct a webservice call with a message and a cause.

writeSource(ICompositeElement, IRenderContext, Writer) - Method in interface com.blueriq.component.api.ui.IAquimaUi

This method may be used to write an elements source to a writer.

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form