## Uses of Interface
org.appng.api.Environment

- Packages that use Environment
  Package | Description
  --- | ---
  org.appng.api | Base package for the appNG API
  org.appng.api.config |
  org.appng.api.messaging |
  org.appng.api.model | Provides an interface-based view to the domain model of appNG and some very basic interfaces.
  org.appng.api.support | Implementations of commonly used features like internationalization, permission- and parameter-processing etc.
  org.appng.api.support.environment | Responsible for implementing `Environment`.
  org.appng.api.support.field | Implementations of `FieldConverter` for the various `FieldType`s
  org.appng.camunda.bpm |
  org.appng.cli.commands.heartbeat |
  org.appng.core.controller | Contains the essential types for handling `ServletRequest`s and `HttpSession`s.
  org.appng.core.controller.filter | Contains the Servlet-`Filter`s used by appNG.
  org.appng.core.controller.handler | Contains the different `RequestHandler`-implementations
  org.appng.core.controller.messaging |
  org.appng.core.domain | The persistent domain objects.
  org.appng.core.model | The non-persistent domain model types.
  org.appng.core.service | The service layer.
  org.appng.search | Base package for the search component
  org.appng.search.searcher | Types used to provide search functionality
  org.appng.taglib | Contains the appNG JSP `Tag`s
  org.appng.taglib.search | Search-related `Tag`s
  org.appng.testsupport | Test-related types
  org.appng.testsupport.config |

- - ### Uses of Environment in org.appng.api

    Methods in org.appng.api that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `Environment` | RequestSupport.`getEnvironment()` Returns the `Environment` for this `Request`.

    Methods in org.appng.api with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | ApplicationController.`addSite(Site site, Application application, Environment environment)` This method is called immediately after adding a `Application` from a `Site`, which has not been reloaded at this point.
    `DataContainer` | DataProvider.`getData(Site site, Application application, Environment environment, Options options, Request request, FieldProcessor fieldProcessor)` Retrieves some data from the application, wrapped in a `DataContainer`.
    `static String` | RequestUtil.`getHostIdentifier(javax.servlet.ServletRequest request, Environment env)` Deprecated. use `RequestUtil.getRequestIdentifier(Environment, ServletRequest)`
    `static PathInfo` | RequestUtil.`getPathInfo(Environment env, Site site, String servletPath)` Creates and returns a `PathInfo`-object based upon the given parameters.
    `static org.appng.api.RequestUtil.RequestIdentifier` | RequestUtil.`getRequestIdentifier(Environment env, javax.servlet.ServletRequest request)` Retrieves a name according to the mapping logic described in the class documentation above together with the matching scope to be applied.
    `static Site` | RequestUtil.`getSite(Environment env, javax.servlet.ServletRequest servletRequest)` Retrieves a `Site` using the mapping logic described in the class documentation above.
    `static Site` | RequestUtil.`getSiteByHost(Environment env, String host)` Retrieves a `Site` by its hostnames (primary and aliases).
    `static Site` | RequestUtil.`getSiteByName(Environment env, String name)` Retrieves a `Site` by its name.
    `static String` | RequestUtil.`getSiteName(Environment env, javax.servlet.ServletRequest request)` Deprecated. use `RequestUtil.getRequestIdentifier(Environment, ServletRequest)`
    `static Set<String>` | RequestUtil.`getSiteNames(Environment env)` Returns an immutable `Set` containing all the `Site` names.
    `void` | FormProcessProvider.`onFormSuccess(Environment environment, Site site, Application application, Writer writer, Form form, Map<String,Object> properties)` This method is being called after a Form has been successfully submitted.
    `void` | ActionProvider.`perform(Site site, Application application, Environment environment, Options options, Request request, T formBean, FieldProcessor fieldProcessor)` Performs an action on the given `formBean`
    `byte[]` | Webservice.`processRequest(Site site, Application application, Environment environment, Request request)` Processes the current `Request` and return some data.
    `boolean` | ApplicationController.`removeSite(Site site, Application application, Environment environment)` This method is called immediately after removing a `Application` from a `Site`, which has not been reloaded at this point.
    `void` | SoapService.`setEnvironment(Environment environment)` Sets the `Environment` to use when processing the request
    `boolean` | ApplicationController.`shutdown(Site site, Application application, Environment environment)` This method is called when a `Site` is being shutdown.
    `boolean` | ApplicationController.`start(Site site, Application application, Environment environment)` This method is called when a `Site` is being (re)loaded.
    `void` | FormValidator.`validate(Site site, Application application, Environment environment, Options options, Request request, FieldProcessor fieldProcessor)` This method validates the given `Request` and eventually adds some `Message`s to the `FieldProcessor` using one of its `addErrorMessage()`-methods.
    `static Site` | RequestUtil.`waitForSite(Environment env, String name)` Retrieves a `Site` by its name, waiting up to `Platform.Property#MAX_WAIT_TIME` milliseconds until it's state is `SiteState#STARTED`.

  - ### Uses of Environment in org.appng.api.config

    Methods in org.appng.api.config that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `Environment` | ApplicationConfig.`environment(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Site site)`

    Methods in org.appng.api.config with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `RequestFactoryBean` | ApplicationConfig.`request(Environment env, Site site, Application application, javax.servlet.http.HttpServletRequest request, org.springframework.core.convert.ConversionService conversionService, org.springframework.context.MessageSource messageSource)`
    `RestConfig.SiteAwareHandlerMethodArgumentResolver` | RestConfig.`siteAwareHandlerMethodArgumentResolver(Site site, Application application, Environment environment)`

  - ### Uses of Environment in org.appng.api.messaging

    Methods in org.appng.api.messaging that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `Environment` | Serializer.`getEnvironment()` Returns the `Environment` that was used when creating this serializer.

    Methods in org.appng.api.messaging with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `static Sender` | Messaging.`createMessageSender(Environment env, ExecutorService executor)` Creates and returns a new `Sender` and a corresponding `Receiver`.
    `static Sender` | Messaging.`createMessageSender(Environment env, ExecutorService executor, String nodeId, EventHandler<? extends Event> defaultHandler, Iterable<EventHandler<? extends Event>> handlers)` Creates and returns a new `Sender` and a corresponding `Receiver`.
    `static Sender` | Messaging.`getMessageSender(Environment env)` Retrieves the previously created `Sender` from the `Environment`.
    `static String` | Messaging.`getNodeId(Environment env)` Deprecated. use `Messaging.getNodeId()` instead
    `protected static Properties` | Messaging.`getPlatformConfig(Environment env)`
    `static boolean` | Messaging.`isEnabled(Environment env)`
    `void` | EventHandler.`onEvent(E event, Environment environment, Site site)` Handles the given `Event`, usually by calling it's `perform`-method.
    `abstract void` | Event.`perform(Environment environment, Site site)` Performs the event
    `static void` | Messaging.`shutdown(Environment env)` Shuts down the messaging system, i.e.

  - ### Uses of Environment in org.appng.api.model

    Methods in org.appng.api.model with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | Application.`getSessionParams(Site site, Environment environment)` Retrieves the session-parameters for for this `Application` within the given `Site` from the given `Environment`.
    `void` | Site.`sendRedirect(Environment env, String target)` sends a redirect with HTTP-Status 301 (moved permanently)
    `void` | Site.`sendRedirect(Environment env, String target, Integer statusCode)` redirects the request to the given target.

  - ### Uses of Environment in org.appng.api.support

    Methods in org.appng.api.support that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `Environment` | SiteAwareObjectInputStream.`getEnvironment()`
    `Environment` | ApplicationRequest.`getEnvironment()`

    Methods in org.appng.api.support with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `static Messages` | ElementHelper.`addMessages(Environment environment, Messages messages)` Returns the messages for the current session.
    `Messages` | ElementHelper.`getMessagesInternal(Environment other)`
    `String` | ElementHelper.`getOutputPrefix(Environment env)` Deprecated. use `ElementHelper.getOutputPrefix()`, since an `Environment` is wrapped here
    `boolean` | ElementHelper.`hasMessages(Environment environment)` Deprecated. use `ElementHelper.hasMessages()`, since an `Environment` is wrapped here
    `Messages` | ElementHelper.`removeMessages(Environment environment)`

    Constructors in org.appng.api.support with parameters of type Environment
    Constructor and Description
    `ElementHelper(Environment environment, Site site, Application application, ExpressionEvaluator expressionEvaluator)`
    `RequestFactoryBean(javax.servlet.http.HttpServletRequest httpServletRequest, Environment environment, Site site, Application app, org.springframework.core.convert.ConversionService conversionService, org.springframework.context.MessageSource messageSource)`
    `RequestSupportImpl(org.springframework.core.convert.ConversionService conversionService, Environment environment, org.springframework.context.MessageSource messageSource)`
    `SiteAwareObjectInputStream(InputStream is, Environment environment)`

  - ### Uses of Environment in org.appng.api.support.environment

    Classes in org.appng.api.support.environment that implement Environment
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DefaultEnvironment` This class implements `Environment`.

    Methods in org.appng.api.support.environment that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `Environment` | EnvironmentFactoryBean.`getObject()` Deprecated.

  - ### Uses of Environment in org.appng.api.support.field

    Methods in org.appng.api.support.field that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `Environment` | FieldConversionFactory.`getEnvironment()`

    Methods in org.appng.api.support.field with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `void` | FieldConversionFactory.`setEnvironment(Environment environment)`

  - ### Uses of Environment in org.appng.camunda.bpm

    Methods in org.appng.camunda.bpm with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `void` | TaskWrapper.`validate(Site site, Application application, Environment environment, Options options, Request request, FieldProcessor fp, org.camunda.bpm.engine.form.TaskFormData taskFormData, String requiredMessage)` Validates this `TaskWrapper`.

  - ### Uses of Environment in org.appng.cli.commands.heartbeat

    Methods in org.appng.cli.commands.heartbeat with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `void` | HeartBeat.HeartBeatEvent.`perform(Environment environment, Site site)`

  - ### Uses of Environment in org.appng.core.controller

    Methods in org.appng.core.controller that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `protected Environment` | Controller.`getEnvironment()`

    Methods in org.appng.core.controller with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `protected InitializerService` | PlatformStartup.`getService(Environment env)`
    `protected void` | PlatformStartup.`initPlatformContext(javax.servlet.ServletContext ctx, Environment env, Properties config, DatabaseConnection platformConnection)`

  - ### Uses of Environment in org.appng.core.controller.filter

    Methods in org.appng.core.controller.filter with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `static io.prometheus.client.CollectorRegistry` | MetricsFilter.`getRegistry(Environment env)`
    `void` | EnvironmentFilter.`requestDestroyed(javax.servlet.http.HttpServletRequest httpServletRequest, Environment env)`
    `void` | EnvironmentFilter.`requestInitialized(javax.servlet.http.HttpServletRequest httpServletRequest, Environment env)`
    `protected void` | EnvironmentFilter.`setDiagnosticContext(Environment env, javax.servlet.http.HttpServletRequest httpServletRequest, Site site)`

  - ### Uses of Environment in org.appng.core.controller.handler

    Methods in org.appng.core.controller.handler with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | ServiceRequestHandler.`callWebservice(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, ApplicationRequest applicationRequest, Environment env, Site site, ApplicationProvider application, String webserviceName)`
    `void` | ErrorPageHandler.`handle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Environment env, Site site, PathInfo pathInfo)`
    `void` | GuiHandler.`handle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Environment environment, Site site, PathInfo pathInfo)`
    `void` | MonitoringHandler.`handle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Environment env, Site site, PathInfo pathInfo)`
    `void` | RequestHandler.`handle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Environment environment, Site site, PathInfo pathInfo)` Handles the given `HttpServletRequest`,
    `void` | ServiceRequestHandler.`handle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Environment environment, Site site, PathInfo path)`
    `void` | StaticContentHandler.`handle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Environment environment, Site site, PathInfo pathInfo)`
    `void` | JspHandler.`handle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Environment environment, Site site, PathInfo pathInfo)`
    `protected void` | ServiceRequestHandler.`handleSoap(Site site, AccessibleApplication application, Environment environment, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse)`

  - ### Uses of Environment in org.appng.core.controller.messaging

    Methods in org.appng.core.controller.messaging with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `static Map<String,NodeEvent.NodeState>` | NodeEvent.`clusterState(Environment environment, String nodeId)`
    `void` | SiteStateEvent.`handleSiteState(Environment environment)`
    `void` | SiteStateEvent.`perform(Environment environment, Site site)`
    `void` | RequestNodeState.`perform(Environment environment, Site site)`
    `void` | StopSiteEvent.`perform(Environment environment, Site site)`
    `void` | NodeEvent.`perform(Environment environment, Site site)`
    `void` | ReloadSiteEvent.`perform(Environment env, Site site)`
    `void` | SiteDeletedEvent.`perform(Environment environment, Site site)`
    `void` | ReloadTemplateEvent.`perform(Environment environment, Site site)`
    `static Map<String,Site.SiteState>` | NodeEvent.`siteState(Environment env, String nodeId)`
    `void` | ReloadSiteEvent.`wait(Environment env, Site site, org.slf4j.Logger logger)`
    `void` | ReloadSiteEvent.`waitForClusterState(Environment env, Site site, org.slf4j.Logger logger)`

    Constructors in org.appng.core.controller.messaging with parameters of type Environment
    Constructor and Description
    `NodeEvent(Environment environment, String siteName)`
    `NodeEvent(Environment environment, String siteName, String nodeId)`

  - ### Uses of Environment in org.appng.core.domain

    Methods in org.appng.core.domain with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | ApplicationImpl.`getSessionParams(Site site, Environment environment)`
    `void` | SiteImpl.`sendRedirect(Environment env, String target)`
    `void` | SiteImpl.`sendRedirect(Environment env, String target, Integer statusCode)`
    `void` | SiteImpl.`sendRedirect(Environment env, String target, Integer statusCode, boolean keepOrigin)`
    `void` | SiteImpl.`setState(Site.SiteState state, Environment env)`

  - ### Uses of Environment in org.appng.core.model

    Methods in org.appng.core.model that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `Environment` | PlatformTransformer.`getEnvironment()`

    Methods in org.appng.core.model with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | ApplicationProvider.`getSessionParams(Site site, Environment environment)`
    `static void` | AbstractRequestProcessor.`initPlatform(Platform platform, Environment env, Path path)`
    `void` | PlatformTransformer.`setEnvironment(Environment environment)`
    `void` | ApplicationProvider.`setPlatformScope(boolean enabled, Environment env)`
    `void` | ApplicationProvider.`setPlatformScope(Environment env)`

  - ### Uses of Environment in org.appng.core.service

    Methods in org.appng.core.service with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `void` | CoreService.`cleanupSite(Environment env, SiteImpl site, boolean sendDeletedEvent)`
    `protected void` | CoreService.`createSite(SiteImpl site, Environment env)`
    `protected void` | CoreService.`deleteApplication(Environment environment, Request request, Integer applicationId, FieldProcessor fp, String applicationDeleteErrorWithCause, String applicationRemovedFromSite, String applicationErrorInvalid, String applicationroleDeleteError, String applicationroleErrorInvalid)`
    `protected String` | CoreService.`deleteResource(Environment env, Integer applicationId, Integer resourceId)`
    `void` | CoreService.`deleteSite(Environment env, SiteImpl site)`
    `protected void` | CoreService.`deleteSite(Environment env, SiteImpl site, FieldProcessor fp, Request request, String siteAliasDeleted, String siteDeleteError)` Deprecated.
    `static PlatformProperties` | PlatformProperties.`get(Environment env)`
    `File` | CoreService.`getApplicationFolder(Environment env, String applicationName)`
    `protected File` | CoreService.`getApplicationRootFolder(Environment environment)`
    `protected Properties` | CoreService.`getPlatformConfig(Environment environment)`
    `Runnable` | InitializerService.`getSiteLoader(SiteImpl siteToLoad, Environment env, boolean sendReloadEvent, FieldProcessor fp, boolean setThreadName)` Returns a `Runnable` that loads the given `Site`.
    `void` | InitializerService.`initPlatform(PlatformProperties platformConfig, Environment env, DatabaseConnection rootConnection, javax.servlet.ServletContext ctx, ExecutorService executor)` Deprecated.
    `void` | InitializerService.`initPlatform(PlatformProperties platformConfig, Environment env, DatabaseConnection rootConnection, javax.servlet.ServletContext ctx, ExecutorService messagingExecutor, ExecutorService startupExecutor)` Initializes and loads the platform, which includes logging some environment settings.
    `Properties` | InitializerService.`loadNodeProperties(Environment env)`
    `void` | InitializerService.`loadPlatform(PlatformProperties platformConfig, Environment env, String siteName, String target, ExecutorService messagingExecutor)` Deprecated.
    `void` | InitializerService.`loadPlatform(PlatformProperties platformConfig, Environment env, String siteName, String target, ExecutorService messagingExecutor, ExecutorService startupExecutor)` Loads the platform by loading every active `Site`.
    `PlatformProperties` | InitializerService.`loadPlatformProperties(Properties defaultOverrides, Environment env)`
    `void` | InitializerService.`loadSite(Environment env, SiteImpl siteToLoad, boolean sendReloadEvent, FieldProcessor fp)` Loads the given `Site`.
    `void` | InitializerService.`loadSite(Environment env, SiteImpl siteToLoad, FieldProcessor fp)` Loads the given `Site`.
    `void` | InitializerService.`loadSite(SiteImpl siteToLoad, Environment env, boolean sendReloadEvent, FieldProcessor fp, boolean setThreadName)`
    `void` | InitializerService.`loadSiteAsync(Environment env, SiteImpl siteToLoad, FieldProcessor fp)`
    `boolean` | CoreService.`login(Environment env, Principal principal)`
    `boolean` | CoreService.`login(Environment env, String digest, int digestMaxValidity)`
    `boolean` | CoreService.`login(Site site, Environment env, String username, String password)`
    `boolean` | CoreService.`loginByUserName(Environment env, String username)`
    `boolean` | CoreService.`loginGroup(Environment env, AuthSubject authSubject, String password, Integer groupId)`
    `boolean` | CoreService.`loginUserWithGroups(Environment env, String userName, String email, String realName, List<String> appNGGroups)`
    `void` | CoreService.`logoutSubject(Environment env)`
    `void` | InitializerService.`reloadPlatform(Properties config, Environment env, String siteName, String target, ExecutorService messagingExecutor)` Deprecated. will be removed with no replacement
    `void` | InitializerService.`shutDownSite(Environment env, Site site, boolean removeFromSiteMap)` Shuts down the given `Site`.
    `SiteImpl` | CoreService.`shutdownSite(Environment env, String siteName)`
    `SiteImpl` | CoreService.`shutdownSite(Environment env, String siteName, boolean removeFromSiteMap)`
    `protected boolean` | InitializerService.`startApplication(Environment env, SiteImpl site, ApplicationProvider application)`
    `protected void` | CoreService.`synchronizeApplicationResources(Environment env, Application application, boolean isFileBased)`

  - ### Uses of Environment in org.appng.search

    Methods in org.appng.search with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Document>` | SearchProvider.`doSearch(Environment env, Site site, Application application, org.apache.lucene.store.Directory directory, String term, String language, String[] parseFields, org.apache.lucene.analysis.Analyzer analyzer, String highlightWith, Map<String,String> parameters)` Performs the actual search

  - ### Uses of Environment in org.appng.search.searcher

    Methods in org.appng.search.searcher with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Document>` | StandardSearcher.`doSearch(Environment env, Site site, Application application, org.apache.lucene.store.Directory directory, String term, String language, String[] parseFields, org.apache.lucene.analysis.Analyzer analyzer, String highlightWith, Map<String,String> parameters)`

  - ### Uses of Environment in org.appng.taglib

    Methods in org.appng.taglib that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `protected Environment` | TagletAdapter.`getEnvironment()`

    Methods in org.appng.taglib with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `protected MultiSiteSupport` | TagletAdapter.`getMultiSiteSupport(javax.servlet.http.HttpServletRequest servletRequest, Environment environment)`
    `void` | MultiSiteSupport.`process(Environment env, String application, javax.servlet.http.HttpServletRequest servletRequest)`
    `void` | MultiSiteSupport.`process(Environment env, String application, String method, javax.servlet.http.HttpServletRequest servletRequest)`
    `protected MultiSiteSupport` | Permission.`processMultiSiteSupport(Environment env, javax.servlet.http.HttpServletRequest servletRequest)`

  - ### Uses of Environment in org.appng.taglib.search

    Methods in org.appng.taglib.search with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `protected Part` | Search.`processPart(Environment env, javax.servlet.http.HttpServletRequest servletRequest, Site site, SearchPart part, String term, org.apache.lucene.store.Directory directory, Integer maxTextLength, String fillWith)`

  - ### Uses of Environment in org.appng.testsupport

    Fields in org.appng.testsupport declared as Environment
    Modifier and Type | Field and Description
    --- | ---
    `protected Environment` | TestBase.`environment`

    Methods in org.appng.testsupport with parameters of type Environment
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | TestBase.SimpleApplication.`getSessionParams(Site site, Environment environment)`

  - ### Uses of Environment in org.appng.testsupport.config

    Methods in org.appng.testsupport.config that return Environment
    Modifier and Type | Method and Description
    --- | ---
    `Environment` | ApplicationTestConfig.`environment(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Site site)`

Copyright © 2011–2023 aiticon GmbH. All rights reserved.