Uses of Package
org.appng.api
-
Classes in org.appng.api used by org.appng.api Class Description ApplicationConfigProvider Provides the basic configuration of aApplication
, which is theApplicationInfo
parsed from theapplication-info.xml
and all definedPageDefinition
s,Event
s,Action
s,Datasource
s and also theApplicationRootConfig
.BusinessException AnException
to be used inside business logic.DataContainer A container for the data returned by aDataProvider
.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.FieldConverter AFieldConverter
is responsible for converting a property of an bindclass-instance to itsString
-representation inside of aDatafield
(seeFieldConverter.setString(FieldWrapper)
) a parameter from aRequestContainer
to its object-representation (seeFieldConverter.setObject(FieldWrapper, RequestContainer)
)FieldConverter.DatafieldOwner FieldProcessor AFieldProcessor
keeps track of theMetaData
andLinkpanel
s defined in theDataConfig
of aDatasource
.FieldWrapper AFieldWrapper
extends aFieldDef
and adds the ability to read and set the field's string-representation (FieldWrapper.getStringValue()
/FieldWrapper.setStringValue(String)
) and also the object-representation (FieldWrapper.getObject()
/FieldWrapper.setObject(Object)
).FileUpload.Unit the unit to use for validating uploads by their sizeInvalidConfigurationException AnInvalidConfigurationException
is a checked exception thrown by the platform whenever something goes wrong duringApplication
-execution.
Some examples: aApplication
could not be found aResource
could not be found there was an error while reading aResource
, e.g.MessageParam AMessageParam
provides a message key and optionally some message arguments which can be used when formatting a message withMessageFormat.format(String, Object...)
.Option A single option which was created from aBeanOption
of aBean
.Options ParameterSupport Supports finding and replacing parameters inside aString
.Path PathInfo DefaultPath
-implementationPermissionOwner This is a container for a set ofPermission
s, making it easier for aPermissionProcessor
to check those.PermissionProcessor Checks thePermission
s owned by aPermissionOwner
.Request ARequest
is the framework-internal representation of aHttpServletRequest
, wrapping the afore mentioned and adding framework-specific methods.RequestDataBinder ADataBinder
that uses aRequest
to bind its values to the target object.
This class is especially useful inside aWebservice
, as shown below:RequestSupport Provides commonly used methods for supporting request-processing and filling bindobjects.ScheduledJobResult AScheduledJobResult
can be provided by aScheduledJob
.ScheduledJobResult.ExecutionResult simple enum reflecting the results aScheduledJob
execution can have.Scope Enum type defining the possible scopes of anEnvironment
-attribute.Taglet ATaglet
can be used inside a JSP-Page to embed (static or dynamic) content that is retrieved from aApplication
.
ATaglet
is used as follows (method
refers to bean name of the implementing class):ValidationProvider Provides some validation-related methods.VHostMode Enum type for the host-configuration of appNG.Webservice AWebservice
usually returns some text-based data like XML, JSON or even plain text, which can directly be displayed/processed by the client.XMLTaglet Similar to aTaglet
, aXMLTaglet
can be used inside a JSP-Page to embed (static or dynamic) content that is retrieved from aApplication
. -
Classes in org.appng.api used by org.appng.api.config Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
. -
Classes in org.appng.api used by org.appng.api.messaging Class Description BusinessException AnException
to be used inside business logic.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.InvalidConfigurationException AnInvalidConfigurationException
is a checked exception thrown by the platform whenever something goes wrong duringApplication
-execution.
Some examples: aApplication
could not be found aResource
could not be found there was an error while reading aResource
, e.g. -
Classes in org.appng.api used by org.appng.api.model Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
. -
Classes in org.appng.api used by org.appng.api.support Class Description ApplicationConfigProvider Provides the basic configuration of aApplication
, which is theApplicationInfo
parsed from theapplication-info.xml
and all definedPageDefinition
s,Event
s,Action
s,Datasource
s and also theApplicationRootConfig
.BusinessException AnException
to be used inside business logic.DataContainer A container for the data returned by aDataProvider
.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.FieldConverter AFieldConverter
is responsible for converting a property of an bindclass-instance to itsString
-representation inside of aDatafield
(seeFieldConverter.setString(FieldWrapper)
) a parameter from aRequestContainer
to its object-representation (seeFieldConverter.setObject(FieldWrapper, RequestContainer)
)FieldProcessor AFieldProcessor
keeps track of theMetaData
andLinkpanel
s defined in theDataConfig
of aDatasource
.InvalidConfigurationException AnInvalidConfigurationException
is a checked exception thrown by the platform whenever something goes wrong duringApplication
-execution.
Some examples: aApplication
could not be found aResource
could not be found there was an error while reading aResource
, e.g.MessageParam AMessageParam
provides a message key and optionally some message arguments which can be used when formatting a message withMessageFormat.format(String, Object...)
.Option A single option which was created from aBeanOption
of aBean
.Options ParameterSupport Supports finding and replacing parameters inside aString
.Path PermissionOwner This is a container for a set ofPermission
s, making it easier for aPermissionProcessor
to check those.PermissionProcessor Checks thePermission
s owned by aPermissionOwner
.ProcessingException A checked exception that is thrown byCallableAction
andCallableDataSource
, to indicate an error occurred while assembling thePageReference
.Request ARequest
is the framework-internal representation of aHttpServletRequest
, wrapping the afore mentioned and adding framework-specific methods.RequestSupport Provides commonly used methods for supporting request-processing and filling bindobjects.ResultService ValidationProvider Provides some validation-related methods. -
Classes in org.appng.api used by org.appng.api.support.environment Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.Scope Enum type defining the possible scopes of anEnvironment
-attribute. -
Classes in org.appng.api used by org.appng.api.support.field Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.FieldConverter AFieldConverter
is responsible for converting a property of an bindclass-instance to itsString
-representation inside of aDatafield
(seeFieldConverter.setString(FieldWrapper)
) a parameter from aRequestContainer
to its object-representation (seeFieldConverter.setObject(FieldWrapper, RequestContainer)
)FieldConverter.DatafieldOwner FieldWrapper AFieldWrapper
extends aFieldDef
and adds the ability to read and set the field's string-representation (FieldWrapper.getStringValue()
/FieldWrapper.setStringValue(String)
) and also the object-representation (FieldWrapper.getObject()
/FieldWrapper.setObject(Object)
). -
Classes in org.appng.api used by org.appng.api.support.validation Class Description FieldProcessor AFieldProcessor
keeps track of theMetaData
andLinkpanel
s defined in theDataConfig
of aDatasource
.FileUpload Used to validate the size, filetype(s) and amount of a (Collection
) of)FormUpload
(s).ValidationProvider Provides some validation-related methods. -
Classes in org.appng.api used by org.appng.appngizer.controller Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.camunda.bpm Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.FieldProcessor AFieldProcessor
keeps track of theMetaData
andLinkpanel
s defined in theDataConfig
of aDatasource
.Options Request ARequest
is the framework-internal representation of aHttpServletRequest
, wrapping the afore mentioned and adding framework-specific methods. -
Classes in org.appng.api used by org.appng.cli Class Description BusinessException AnException
to be used inside business logic.MessageParam AMessageParam
provides a message key and optionally some message arguments which can be used when formatting a message withMessageFormat.format(String, Object...)
. -
Classes in org.appng.api used by org.appng.cli.commands Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.application Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.applicationrole Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.group Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.heartbeat Class Description BusinessException AnException
to be used inside business logic.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.InvalidConfigurationException AnInvalidConfigurationException
is a checked exception thrown by the platform whenever something goes wrong duringApplication
-execution.
Some examples: aApplication
could not be found aResource
could not be found there was an error while reading aResource
, e.g. -
Classes in org.appng.api used by org.appng.cli.commands.permission Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.platform Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.property Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.repository Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.site Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.subject Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.commands.template Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.cli.prettytable Class Description BusinessException AnException
to be used inside business logic. -
Classes in org.appng.api used by org.appng.core.controller Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
. -
Classes in org.appng.api used by org.appng.core.controller.handler Class Description BusinessException AnException
to be used inside business logic.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.PathInfo DefaultPath
-implementation -
Classes in org.appng.api used by org.appng.core.controller.messaging Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.InvalidConfigurationException AnInvalidConfigurationException
is a checked exception thrown by the platform whenever something goes wrong duringApplication
-execution.
Some examples: aApplication
could not be found aResource
could not be found there was an error while reading aResource
, e.g. -
Classes in org.appng.api used by org.appng.core.domain Class Description BusinessException AnException
to be used inside business logic.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
. -
Classes in org.appng.api used by org.appng.core.model Class Description ApplicationConfigProvider Provides the basic configuration of aApplication
, which is theApplicationInfo
parsed from theapplication-info.xml
and all definedPageDefinition
s,Event
s,Action
s,Datasource
s and also theApplicationRootConfig
.BusinessException AnException
to be used inside business logic.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.InvalidConfigurationException AnInvalidConfigurationException
is a checked exception thrown by the platform whenever something goes wrong duringApplication
-execution.
Some examples: aApplication
could not be found aResource
could not be found there was an error while reading aResource
, e.g.Path PathInfo DefaultPath
-implementationProcessingException A checked exception that is thrown byCallableAction
andCallableDataSource
, to indicate an error occurred while assembling thePageReference
.XPathProcessor -
Classes in org.appng.api used by org.appng.core.service Class Description BusinessException AnException
to be used inside business logic.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.FieldProcessor AFieldProcessor
keeps track of theMetaData
andLinkpanel
s defined in theDataConfig
of aDatasource
.InvalidConfigurationException AnInvalidConfigurationException
is a checked exception thrown by the platform whenever something goes wrong duringApplication
-execution.
Some examples: aApplication
could not be found aResource
could not be found there was an error while reading aResource
, e.g.Request ARequest
is the framework-internal representation of aHttpServletRequest
, wrapping the afore mentioned and adding framework-specific methods. -
Classes in org.appng.api used by org.appng.search Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
. -
Classes in org.appng.api used by org.appng.search.searcher Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
. -
Classes in org.appng.api used by org.appng.taglib Class Description BusinessException AnException
to be used inside business logic.Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.Request ARequest
is the framework-internal representation of aHttpServletRequest
, wrapping the afore mentioned and adding framework-specific methods. -
Classes in org.appng.api used by org.appng.taglib.search Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
. -
Classes in org.appng.api used by org.appng.testsupport Class Description Environment TheEnvironment
is able to set, read and remove attributes of a certainScope
.InvalidConfigurationException AnInvalidConfigurationException
is a checked exception thrown by the platform whenever something goes wrong duringApplication
-execution.
Some examples: aApplication
could not be found aResource
could not be found there was an error while reading aResource
, e.g.Path ProcessingException A checked exception that is thrown byCallableAction
andCallableDataSource
, to indicate an error occurred while assembling thePageReference
.