Uses of Interface
org.appng.api.Environment
-
Packages that use Environment Package Description org.appng.api Base package for the appNG APIorg.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 implementingEnvironment
.org.appng.api.support.field Implementations ofFieldConverter
for the variousFieldType
sorg.appng.camunda.bpm org.appng.cli.commands.heartbeat org.appng.core.controller Contains the essential types for handlingServletRequest
s andHttpSession
s.org.appng.core.controller.handler Contains the differentRequestHandler
-implementationsorg.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 componentorg.appng.search.searcher Types used to provide search functionalityorg.appng.taglib Contains the appNG JSPTag
sorg.appng.taglib.search Search-relatedTag
sorg.appng.testsupport Test-related types -
-
Uses of Environment in org.appng.api
Methods in org.appng.api that return Environment Modifier and Type Method Description Environment
RequestSupport. getEnvironment()
Returns theEnvironment
for thisRequest
.Methods in org.appng.api with parameters of type Environment Modifier and Type Method Description boolean
ApplicationController. addSite(Site site, Application application, Environment environment)
This method is called immediately after adding aApplication
from aSite
, 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 aDataContainer
.static PathInfo
RequestUtil. getPathInfo(Environment env, Site site, String servletPath)
Creates and returns aPathInfo
-object based upon the given parameters.static Site
RequestUtil. getSite(Environment env, javax.servlet.ServletRequest servletRequest)
Retrieves aSite
by its name.static Site
RequestUtil. getSiteByName(Environment env, String name)
Retrieves aSite
by its name.static String
RequestUtil. getSiteName(Environment env, javax.servlet.ServletRequest request)
Retrieves aSite
's name for the givenServletRequest
, using the givenEnvironment
to retrieve theVHostMode
.static Set<String>
RequestUtil. getSiteNames(Environment env)
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 givenformBean
byte[]
Webservice. processRequest(Site site, Application application, Environment environment, Request request)
Processes the currentRequest
and return some data.boolean
ApplicationController. removeSite(Site site, Application application, Environment environment)
This method is called immediately after removing aApplication
from aSite
, which has not been reloaded at this point.void
SoapService. setEnvironment(Environment environment)
Sets theEnvironment
to use when processing the requestboolean
ApplicationController. shutdown(Site site, Application application, Environment environment)
This method is called when aSite
is being shutdown.boolean
ApplicationController. start(Site site, Application application, Environment environment)
This method is called when aSite
is being (re)loaded.void
FormValidator. validate(Site site, Application application, Environment environment, Options options, Request request, FieldProcessor fieldProcessor)
This method validates the givenRequest
and eventually adds someMessage
s to theFieldProcessor
using one of itsaddErrorMessage()
-methods.static Site
RequestUtil. waitForSite(Environment env, String name)
Retrieves aSite
by its name, waiting up toPlatform.Property#MAX_WAIT_TIME
milliseconds until it's state isSiteState#STARTED
. -
Uses of Environment in org.appng.api.config
Methods in org.appng.api.config that return Environment Modifier and Type Method Description Environment
ApplicationConfig. environment(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Methods in org.appng.api.config with parameters of type Environment Modifier and Type Method Description RequestFactoryBean
ApplicationConfig. request(Environment env, 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 Description Environment
Serializer. getEnvironment()
Returns theEnvironment
that was used when creating this serializer.Methods in org.appng.api.messaging with parameters of type Environment Modifier and Type Method Description static Sender
Messaging. createMessageSender(Environment env, ExecutorService executor)
static Sender
Messaging. createMessageSender(Environment env, ExecutorService executor, String nodeId, EventHandler<? extends Event> defaultHandler, Iterable<EventHandler<? extends Event>> handlers)
static Sender
Messaging. getMessageSender(Environment env)
Retrieves the previously createdSender
from theEnvironment
.static String
Messaging. getNodeId(Environment env)
Determines the node id for this node.protected static Properties
Messaging. getPlatformConfig(Environment env)
static boolean
Messaging. isEnabled(Environment env)
void
EventHandler. onEvent(E event, Environment environment, Site site)
Handles the givenEvent
, usually by calling it'sperform
-method.abstract void
Event. perform(Environment environment, Site site)
Performs the eventstatic 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 Description Map<String,String>
Application. getSessionParams(Site site, Environment environment)
Retrieves the session-parameters for for thisApplication
within the givenSite
from the givenEnvironment
.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
Fields in org.appng.api.support declared as Environment Modifier and Type Field Description protected Environment
AdapterBase. environment
protected Environment
AdapterBase. environment
Methods in org.appng.api.support that return Environment Modifier and Type Method Description Environment
ApplicationRequest. getEnvironment()
Environment
SiteAwareObjectInputStream. getEnvironment()
Methods in org.appng.api.support with parameters of type Environment Modifier and Type Method Description static Messages
ElementHelper. addMessages(Environment environment, Messages messages)
Adds some messages to the current session.Messages
ElementHelper. getMessages(Environment environment)
Returns the messages for the current session.String
ElementHelper. getOutputPrefix(Environment env)
boolean
ElementHelper. hasMessages(Environment environment)
Messages
ElementHelper. removeMessages(Environment environment)
Removes the messages from the current session.Constructors in org.appng.api.support with parameters of type Environment Constructor Description RequestFactoryBean(javax.servlet.http.HttpServletRequest httpServletRequest, Environment environment, 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 Description class
DefaultEnvironment
This class implementsEnvironment
. -
Uses of Environment in org.appng.api.support.field
Methods in org.appng.api.support.field that return Environment Modifier and Type Method Description Environment
FieldConversionFactory. getEnvironment()
Methods in org.appng.api.support.field with parameters of type Environment Modifier and Type Method 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 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 thisTaskWrapper
. -
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 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 Description protected Environment
Controller. getEnvironment(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse)
Methods in org.appng.core.controller with parameters of type Environment Modifier and Type Method Description protected InitializerService
PlatformStartup. getService(Environment env)
protected void
PlatformStartup. initPlatformContext(javax.servlet.ServletContext ctx, Environment env, Properties config, DatabaseConnection platformConnection)
protected void
SessionListener. 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 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
JspHandler. 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 givenHttpServletRequest
,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)
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 Description void
SiteStateEvent. handleSiteState(Environment environment)
void
NodeEvent. perform(Environment environment, Site site)
void
ReloadSiteEvent. perform(Environment environment, Site site)
void
ReloadTemplateEvent. perform(Environment environment, Site site)
void
RequestNodeState. perform(Environment environment, Site site)
void
SiteDeletedEvent. perform(Environment environment, Site site)
void
SiteStateEvent. perform(Environment environment, Site site)
void
StopSiteEvent. perform(Environment environment, Site site)
Constructors in org.appng.core.controller.messaging with parameters of type Environment Constructor Description NodeEvent(Environment environment, String siteName)
-
Uses of Environment in org.appng.core.domain
Methods in org.appng.core.domain with parameters of type Environment Modifier and Type Method 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 Description Environment
PlatformTransformer. getEnvironment()
Methods in org.appng.core.model with parameters of type Environment Modifier and Type Method 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)
-
Uses of Environment in org.appng.core.service
Methods in org.appng.core.service with parameters of type Environment Modifier and Type Method 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)
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)
Properties
CoreService. initNodeConfig(Environment env)
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, ExecutorService startupExecutor)
Loads the platform by loading every activeSite
.PlatformProperties
InitializerService. loadPlatformProperties(Properties defaultOverrides, Environment env)
void
InitializerService. loadSite(Environment env, SiteImpl siteToLoad, boolean sendReloadEvent, FieldProcessor fp)
Loads the givenSite
.void
InitializerService. loadSite(Environment env, SiteImpl siteToLoad, FieldProcessor fp)
Loads the givenSite
.void
InitializerService. loadSite(SiteImpl siteToLoad, Environment env, boolean sendReloadEvent, FieldProcessor fp, boolean setThreadName)
boolean
CoreService. login(Environment env, String digest, int digestMaxValidity)
boolean
CoreService. login(Environment env, Principal principal)
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)
SiteImpl
CoreService. shutdownSite(Environment env, String siteName)
SiteImpl
CoreService. shutdownSite(Environment env, String siteName, boolean removeFromSiteMap)
void
InitializerService. shutDownSite(Environment env, Site site, boolean removeFromSiteMap)
Shuts down the givenSite
.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 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 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 Description protected Environment
TagletAdapter. getEnvironment()
Methods in org.appng.taglib with parameters of type Environment Modifier and Type Method Description protected MultiSiteSupport
TagletAdapter. getMultiSiteSupport(javax.servlet.http.HttpServletRequest servletRequest, Environment environment)
void
MultiSiteSupport. process(Environment env, String application, String method, javax.servlet.http.HttpServletRequest servletRequest)
void
MultiSiteSupport. process(Environment env, String application, 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 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 Description protected Environment
TestBase. environment
Methods in org.appng.testsupport with parameters of type Environment Modifier and Type Method Description Map<String,String>
TestBase.SimpleApplication. getSessionParams(Site site, Environment environment)
-