Package org.appng.api

Base package for the appNG API

Interface Summary

Interface	Description
ActionProvider<T>	An ActionProvider usually performs a CRUD-action on a domain object.
ApplicationConfigProvider	Provides the basic configuration of a Application, which is the ApplicationInfo parsed from the application-info.xml and all defined PageDefinitions, Events, Actions, Datasources and also the ApplicationRootConfig.
ApplicationController	Provides methods to startup and shutdown a Application.
AttachmentWebservice	Enhancement of a Webservice which is used to provide a file as an attachment.
DataProvider	An DataProvider usually retrieves some data from the persistence layer and returns it as a DataContainer.
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 Linkpanels defined in the DataConfig of a Datasource.
FormProcessProvider	When using the appNG-Taglibrary to define a HTLM-form inside a JSP, a FormProcessProvider is used to handle the submitted data.
FormValidator	Interface that can be implemented by an ActionProvider or the formBean that is used by an ActionProvider .
GlobalTaglet	A GlobalTaglet is a specialized kind of a Taglet.
GlobalXMLTaglet	A GlobalXMLTaglet is a specialized kind of a XMLTaglet.
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 BeanOptions of a Bean and contain several Options.
PageProcessor	Interface that optionally can be implemented by a Taglet GlobalTaglet XMLTaglet GlobalXMLTaglet If PageProcessor.processPage() returns false, the rest of the JSP-page will be skipped.
ParameterSupport	Supports finding and replacing parameters inside a String.
Path	A Path provides informations about the Site to which the current HttpServletRequest belongs to.
PermissionProcessor	Checks the Permissions owned by a PermissionOwner.
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.
ScheduledJob	A ScheduledJob is a (periodically or manually triggered) task that can be defined by an Application.
SoapService	This interface has to be implemented for creating SOAP-webservices based on JAXB and Spring-WS.
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.
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.

Class Summary

Class	Description
DataContainer	A container for the data returned by a DataProvider.
FieldConverter.DatafieldOwner	A DatafieldOwner owns several Datafields and also Linkpanels.
FieldConverter.FieldDefOwner	/** A DatafieldOwner owns several FieldDefs and also Linkpanels.
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)).
FormDataBinder<T>	A DataBinder that uses a Form to bind its values to the target object.
PathInfo	Default Path-implementation
PermissionOwner	This is a container for a set of Permissions, making it easier for a PermissionProcessor to check those.
Platform	Utility class providing platform-wide used constants.
RequestDataBinder<T>	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:
RequestUtil	Utility-class for retrieving Sites by name,host or ServletRequest and also creating a Path -object based on a ServletRequest.
ScheduledJobResult	A ScheduledJobResult can be provided by a ScheduledJob.
Session	Utility-class providing constants used for accessing an Session.Environment-attribute with Scope.SESSION.
Session.Environment
SiteProperties	Utility-class providing constants for the names of a Site's Properties.
SoapClient	A simple SOAP-client for JAXB-based webservices.
ValidationMessages	Utility class providing constants for the message-keys used in validation-annotations.
XPathProcessor	An XPathProcessor is used the create a Document from an URL or InputStream and then to extract NodeLists, Nodes, Elements, Attributes etc.

Enum Summary

Enum	Description
FileUpload.Unit	the unit to use for validating uploads by their size
ScheduledJobResult.ExecutionResult	simple enum reflecting the results a ScheduledJob execution can have.
Scope	Enum type defining the possible scopes of an Environment-attribute.
VHostMode	Enum type for the host-configuration of appNG.

Exception Summary

Exception	Description
ApplicationException	A RuntimeException to be used inside business logic.
BusinessException	An Exception to be used inside business logic.
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.
ProcessingException	A checked exception that is thrown by CallableAction and CallableDataSource, to indicate an error occurred while assembling the PageReference.

Annotation Types Summary

Annotation Type	Description
FileUpload	Used to validate the size, filetype(s) and amount of a (Collection) of) FormUpload(s).
NotBlank	Checks whether the annotated element is not null and not blank by combining @NotNull and @Size(min = 1).