# Uses of Package
org.appng.api

- Packages that use org.appng.api
  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.api.support.validation | This package contains all validation-related classes.
  org.appng.appngizer.controller |
  org.appng.camunda.bpm |
  org.appng.cli | Base package of the appNG Command Line Interface, containing some classes necessary for bootstrapping.
  org.appng.cli.commands | Base package for the various commands offered by the CLI
  org.appng.cli.commands.application | `ExecutableCliCommand`s for dealing with `Application`s
  org.appng.cli.commands.applicationrole | `ExecutableCliCommand`s for dealing with `Role`s
  org.appng.cli.commands.group | `ExecutableCliCommand`s for dealing with `Group`s
  org.appng.cli.commands.heartbeat |
  org.appng.cli.commands.permission | `ExecutableCliCommand`s for dealing with `Permission`s
  org.appng.cli.commands.platform |
  org.appng.cli.commands.property | `ExecutableCliCommand`s for dealing with `Properties`
  org.appng.cli.commands.repository | `ExecutableCliCommand`s for dealing with a `Repository`
  org.appng.cli.commands.site | `ExecutableCliCommand`s for dealing with `Site`s
  org.appng.cli.commands.subject | `ExecutableCliCommand`s for dealing with `Subject`s
  org.appng.cli.commands.template | `ExecutableCliCommand`s for dealing with templates
  org.appng.cli.prettytable | Utility classes for outputting tables
  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.security | Security related 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 |

- Classes in org.appng.api used by org.appng.api
  Class and Description
  ApplicationConfigProvider Provides the basic configuration of a `Application`, which is the `ApplicationInfo` parsed from the `application-info.xml` and all defined `PageDefinition`s, `Event`s, `Action`s, `Datasource`s and also the `ApplicationRootConfig`.
  BusinessException An `Exception` to be used inside business logic.
  DataContainer A container for the data returned by a `DataProvider`.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  FieldConverter A `FieldConverter` is responsible for converting a property of an bindclass-instance to its `String`-representation inside of a `Datafield` (see `FieldConverter.setString(FieldWrapper)`) a parameter from a `RequestContainer` to its object-representation (see `FieldConverter.setObject(FieldWrapper, RequestContainer)`)
  FieldConverter.DatafieldOwner A `DatafieldOwner` owns several `Datafield`s and also `Linkpanel`s.
  FieldProcessor A `FieldProcessor` keeps track of the `MetaData` and `Linkpanel`s defined in the `DataConfig` of a `Datasource`.
  FieldWrapper A `FieldWrapper` extends a `FieldDef` 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 size
  InvalidConfigurationException An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution. Some examples: a `Application` could not be found a `Resource` could not be found there was an error while reading a `Resource`, e.g.
  MessageParam A `MessageParam` provides a message key and optionally some message arguments which can be used when formatting a message with `MessageFormat.format(String, Object...)`.
  Option A single option which was created from a `BeanOption` of a `Bean` .
  Options `Options` are created from the `BeanOption`s of a `Bean` and contain several `Option`s.
  ParameterSupport Supports finding and replacing parameters inside a `String`.
  Path A `Path` provides informations about the `Site` to which the current `HttpServletRequest` belongs to.
  PathInfo Default `Path`-implementation
  PermissionOwner This is a container for a set of `Permission`s, making it easier for a `PermissionProcessor` to check those.
  PermissionProcessor Checks the `Permission`s owned by a `PermissionOwner`.
  Request A `Request` is the framework-internal representation of a `HttpServletRequest`, wrapping the afore mentioned and adding framework-specific methods.
  RequestDataBinder A `DataBinder` that uses a `Request` to bind its values to the target object. This class is especially useful inside a `Webservice`, as shown below:
  RequestSupport Provides commonly used methods for supporting request-processing and filling bindobjects.
  ScheduledJobResult A `ScheduledJobResult` can be provided by a `ScheduledJob`.
  ScheduledJobResult.ExecutionResult simple enum reflecting the results a `ScheduledJob` execution can have.
  Scope Enum type defining the possible scopes of an `Environment`-attribute.
  Taglet A `Taglet` can be used inside a JSP-Page to embed (static or dynamic) content that is retrieved from a `Application`. A `Taglet` 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 A `Webservice` 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 a `Taglet`, a `XMLTaglet` can be used inside a JSP-Page to embed (static or dynamic) content that is retrieved from a `Application`.

- Classes in org.appng.api used by org.appng.api.config
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

- Classes in org.appng.api used by org.appng.api.messaging
  Class and Description
  BusinessException An `Exception` to be used inside business logic.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  InvalidConfigurationException An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution. Some examples: a `Application` could not be found a `Resource` could not be found there was an error while reading a `Resource`, e.g.

- Classes in org.appng.api used by org.appng.api.model
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

- Classes in org.appng.api used by org.appng.api.support
  Class and Description
  ApplicationConfigProvider Provides the basic configuration of a `Application`, which is the `ApplicationInfo` parsed from the `application-info.xml` and all defined `PageDefinition`s, `Event`s, `Action`s, `Datasource`s and also the `ApplicationRootConfig`.
  BusinessException An `Exception` to be used inside business logic.
  DataContainer A container for the data returned by a `DataProvider`.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  FieldConverter A `FieldConverter` is responsible for converting a property of an bindclass-instance to its `String`-representation inside of a `Datafield` (see `FieldConverter.setString(FieldWrapper)`) a parameter from a `RequestContainer` to its object-representation (see `FieldConverter.setObject(FieldWrapper, RequestContainer)`)
  FieldProcessor A `FieldProcessor` keeps track of the `MetaData` and `Linkpanel`s defined in the `DataConfig` of a `Datasource`.
  InvalidConfigurationException An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution. Some examples: a `Application` could not be found a `Resource` could not be found there was an error while reading a `Resource`, e.g.
  MessageParam A `MessageParam` provides a message key and optionally some message arguments which can be used when formatting a message with `MessageFormat.format(String, Object...)`.
  Option A single option which was created from a `BeanOption` of a `Bean` .
  Options `Options` are created from the `BeanOption`s of a `Bean` and contain several `Option`s.
  ParameterSupport Supports finding and replacing parameters inside a `String`.
  Path A `Path` provides informations about the `Site` to which the current `HttpServletRequest` belongs to.
  PermissionOwner This is a container for a set of `Permission`s, making it easier for a `PermissionProcessor` to check those.
  PermissionProcessor Checks the `Permission`s owned by a `PermissionOwner`.
  ProcessingException A checked exception that is thrown by `CallableAction` and `CallableDataSource`, to indicate an error occurred while assembling the `PageReference`.
  Request A `Request` is the framework-internal representation of a `HttpServletRequest`, wrapping the afore mentioned and adding framework-specific methods.
  RequestSupport Provides commonly used methods for supporting request-processing and filling bindobjects.
  ResultService Provides methods to transform a bindobject to a `Result` and a `Page` of bindobjects to a `Resultset`.
  ValidationProvider Provides some validation-related methods.

- Classes in org.appng.api used by org.appng.api.support.environment
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  Scope Enum type defining the possible scopes of an `Environment`-attribute.

- Classes in org.appng.api used by org.appng.api.support.field
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  FieldConverter A `FieldConverter` is responsible for converting a property of an bindclass-instance to its `String`-representation inside of a `Datafield` (see `FieldConverter.setString(FieldWrapper)`) a parameter from a `RequestContainer` to its object-representation (see `FieldConverter.setObject(FieldWrapper, RequestContainer)`)
  FieldConverter.DatafieldOwner A `DatafieldOwner` owns several `Datafield`s and also `Linkpanel`s.
  FieldWrapper A `FieldWrapper` extends a `FieldDef` 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 and Description
  FieldProcessor A `FieldProcessor` keeps track of the `MetaData` and `Linkpanel`s defined in the `DataConfig` of a `Datasource`.
  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 and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.camunda.bpm
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  FieldProcessor A `FieldProcessor` keeps track of the `MetaData` and `Linkpanel`s defined in the `DataConfig` of a `Datasource`.
  Options `Options` are created from the `BeanOption`s of a `Bean` and contain several `Option`s.
  Request A `Request` is the framework-internal representation of a `HttpServletRequest`, wrapping the afore mentioned and adding framework-specific methods.

- Classes in org.appng.api used by org.appng.cli
  Class and Description
  BusinessException An `Exception` to be used inside business logic.
  MessageParam A `MessageParam` provides a message key and optionally some message arguments which can be used when formatting a message with `MessageFormat.format(String, Object...)`.

- Classes in org.appng.api used by org.appng.cli.commands
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.application
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.applicationrole
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.group
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.heartbeat
  Class and Description
  BusinessException An `Exception` to be used inside business logic.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  InvalidConfigurationException An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution. Some examples: a `Application` could not be found a `Resource` could not be found there was an error while reading a `Resource`, e.g.

- Classes in org.appng.api used by org.appng.cli.commands.permission
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.platform
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.property
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.repository
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.site
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.subject
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.commands.template
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.cli.prettytable
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.core.controller
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

- Classes in org.appng.api used by org.appng.core.controller.filter
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

- Classes in org.appng.api used by org.appng.core.controller.handler
  Class and Description
  BusinessException An `Exception` to be used inside business logic.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  PathInfo Default `Path`-implementation

- Classes in org.appng.api used by org.appng.core.controller.messaging
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  InvalidConfigurationException An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution. Some examples: a `Application` could not be found a `Resource` could not be found there was an error while reading a `Resource`, e.g.

- Classes in org.appng.api used by org.appng.core.domain
  Class and Description
  BusinessException An `Exception` to be used inside business logic.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

- Classes in org.appng.api used by org.appng.core.model
  Class and Description
  ApplicationConfigProvider Provides the basic configuration of a `Application`, which is the `ApplicationInfo` parsed from the `application-info.xml` and all defined `PageDefinition`s, `Event`s, `Action`s, `Datasource`s and also the `ApplicationRootConfig`.
  BusinessException An `Exception` to be used inside business logic.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  InvalidConfigurationException An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution. Some examples: a `Application` could not be found a `Resource` could not be found there was an error while reading a `Resource`, e.g.
  ParameterSupport Supports finding and replacing parameters inside a `String`.
  Path A `Path` provides informations about the `Site` to which the current `HttpServletRequest` belongs to.
  PathInfo Default `Path`-implementation
  ProcessingException A checked exception that is thrown by `CallableAction` and `CallableDataSource`, to indicate an error occurred while assembling the `PageReference`.
  XPathProcessor An `XPathProcessor` is used the create a `Document` from an `URL` or `InputStream` and then to extract `NodeList`s, `Node`s, `Element`s, `Attr`ibutes etc.

- Classes in org.appng.api used by org.appng.core.security
  Class and Description
  BusinessException An `Exception` to be used inside business logic.

- Classes in org.appng.api used by org.appng.core.service
  Class and Description
  BusinessException An `Exception` to be used inside business logic.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  FieldProcessor A `FieldProcessor` keeps track of the `MetaData` and `Linkpanel`s defined in the `DataConfig` of a `Datasource`.
  InvalidConfigurationException An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution. Some examples: a `Application` could not be found a `Resource` could not be found there was an error while reading a `Resource`, e.g.
  Request A `Request` is the framework-internal representation of a `HttpServletRequest`, wrapping the afore mentioned and adding framework-specific methods.

- Classes in org.appng.api used by org.appng.search
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

- Classes in org.appng.api used by org.appng.search.searcher
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

- Classes in org.appng.api used by org.appng.taglib
  Class and Description
  BusinessException An `Exception` to be used inside business logic.
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  Request A `Request` is the framework-internal representation of a `HttpServletRequest`, wrapping the afore mentioned and adding framework-specific methods.

- Classes in org.appng.api used by org.appng.taglib.search
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

- Classes in org.appng.api used by org.appng.testsupport
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.
  InvalidConfigurationException An `InvalidConfigurationException` is a checked exception thrown by the platform whenever something goes wrong during `Application`-execution. Some examples: a `Application` could not be found a `Resource` could not be found there was an error while reading a `Resource`, e.g.
  Path A `Path` provides informations about the `Site` to which the current `HttpServletRequest` belongs to.
  ProcessingException A checked exception that is thrown by `CallableAction` and `CallableDataSource`, to indicate an error occurred while assembling the `PageReference`.

- Classes in org.appng.api used by org.appng.testsupport.config
  Class and Description
  Environment The `Environment` is able to set, read and remove attributes of a certain `Scope`.

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