Package | Description |
---|---|
de.innovationgate.webgate.api |
Basic functionality of the WGAPI including most of the database-independent functionality.
|
de.innovationgate.webgate.api.auth |
External authentication modules for WGAPI databases.
|
de.innovationgate.webgate.api.fake |
Fake implementations for WGAPI, used by some WGAPI database types if they do not support certain document types.
|
de.innovationgate.webgate.api.locking |
This base contains classes for enabling the WGAPI locking functionality, which is used to get exclusive access to documents and databases.
|
de.innovationgate.webgate.api.mail |
Interfaces for mail services needed in the WGAPI (f.e. for delivery of workflow notification mails)
|
de.innovationgate.webgate.api.query.rss | |
de.innovationgate.webgate.api.rss2 | |
de.innovationgate.webgate.api.schemadef |
Classes to create schema definitions for OpenWGA content stores
|
de.innovationgate.webgate.api.servers |
Base classes for database server functionalities in WGAPI
|
de.innovationgate.webgate.api.simple |
Generic implementations of content store templates from
de.innovationgate.webgate.api.templates |
de.innovationgate.webgate.api.templates |
Templates to create your own simple content/design/repository sources.
|
de.innovationgate.webgate.api.utils |
Utilities for WGAPI usage
|
de.innovationgate.webgate.api.workflow |
Workflow interfaces of the WGAPI including a database-independent workflow implementation, the "Straight Workflow".
|
Class and Description |
---|
BinaryFieldData
Represents binary data on a field.
|
BinaryFieldData.Retriever
An interface for the functionality that actually retrieves the input stream of binary field data
|
HttpClientFactory
Factory interface to create HttpClient instances used within WGA
|
MetaInfo
Bean containing information about a document metadata field.
|
MetaInfoProvider
implementing classes provide informations about metadata by MetaInfo beans
|
MimetypeDeterminationService
A service to determine the MIME type of a file by its filename
|
PageHierarchyNode
Interface that represents a node in the page hierarchy of a WGA Content Store.
|
PageRightsFilter
A filter to do custom determination of rights on pages
|
PageRightsFilter.Right |
PortletItemStorageData
Interface to access the item storage data for one portlet for migration purposes
|
Privilege |
SearchDetails
All transient data of a document belonging to the query that was used to fetch it
|
UserAccessFilter
A filter to reduce user access of logged in users.
|
WGAbstractResultSet
Common base class of WGAPI query result sets, defining shared functionality
|
WGAbstractResultSetIterator
Abstract base class for result set iterators, implementing shared functionality like prefetching which is neccessary for implicit filtering
|
WGACL
Represents the access control list of a database, that decides, which user has which rights.
|
WGACLCore
Interface that is implemented by concrete WGACL implementations.
|
WGACLEntry
Represents a single ACL entry
|
WGACLEntryFlags
Class to parse the flags that are stored at each WGACLEntry and provide their data.
|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGArea
Represents an area of the content database, containing content documents.
|
WGAreaMap
Represents a Map of WGArea-Objects, where the mapping key for each area is its name.
|
WGAuthorisationException
Thrown whenever a user tries to start an unauthorized action (e.g. create a content document).
|
WGBackendChangeListener
Interface for a listener of database changes that are picked up in the backend, i.e. that were not done via the current database instance.
|
WGBackendException
Thrown on errors in a wgapi backend module
(e.g. connection problems to sql server, errors in backend api)
|
WGCachedResultSet
Represents a query result set that can be cached.
|
WGClosedSessionException
Exception that is thrown whenever an operation is not possible because there is no open session on this database
|
WGColumnSet
A definition of field columns of content documents for various purposes.
|
WGColumnSet.ColumnMeta
Definition of a metadata field column, valid for usage in column sets
|
WGColumnSet.Term
A single term defining a column in the set
|
WGContent
Represents a content document of this content database.
|
WGContentEvent
Represents an event that was triggered for a content document.
|
WGContentEventListener
A listener for content events in a database
|
WGContentKey
Represents the complete unique key of a content document, consisting of the struct key of the connected struct entry, the language code and the content version.
|
WGContentList
List of content objects.
|
WGContentNavigator.Iterator |
WGContentNavigator.IteratorCreator
Class capable of producing iterators for a content collection
|
WGContentQueryResult
An internal representation of query results on content queries
|
WGContentType
Formerly referred to as "Doctype", this is a document describing a type of
content document.
|
WGCreationException
Thrown for problems creating documents, that are no typical problems like duplicate keys, illegal state, arguments etc.
|
WGCSSJSModule
Represents a Module containing various Non-WebTML-Code, e.g. for Web-Scripting- or Formatting-Languages
|
WGDatabase
Represents a WGA Database.
|
WGDatabase.AccessLevel
Represents an ACL Access Level
|
WGDatabase.ConnectAction |
WGDatabase.DatabaseAction
An interface defining an action that can be execute on certain database events.
|
WGDatabase.DocumentCollectionHierarchy |
WGDatabase.NoItemBehaviour
Defines a behaviour for WGDatabases how they should respond to requests
for nonexistent items
|
WGDatabase.ReconfigurationAccessor |
WGDatabase.WGDatabaseStatistics
Collects various statistics about this database.
|
WGDatabaseConnectListener
A listener that will get notified, when the database is connected to its backend.
|
WGDatabaseCore
Represents the core of a WGA database.
|
WGDatabaseEvent
Information about a database event.
|
WGDatabaseEventListener
A listener to database events.
|
WGDatabaseRevision
Represents a database revision and provides methods to operate with it, including comparision, serialisation and derserialisation
|
WGDatabaseRevisionSerializer
Deprecated.
Since database revisions are always instances of
WGDatabaseRevision now having their own serialisation/deserialisation methods |
WGDesignChangeEvent
An event fired when a design provider or a database has changed it's design
|
WGDesignChangeListener
A listener for design change events, issued by a WGDesignProvider or a WGDatabase.
|
WGDesignDocument
Superclass for WGAPI "design documents", i.e. documents that are not directly related to authoring and therefor not editable by pure authors/editors.
|
WGDesignProvider
A provider of design document cores to be used with a WGDatabase if the design of that database comes from another
location.
|
WGDesignResourceDocument
Documents representing real design resources
|
WGDocument
Parent class for all document objects in a WGA database.
|
WGDocument.Cache |
WGDocument.SaveAction
An interface defining an action that can be execute after the current
document was saved in the current session
|
WGDocumentCore
Represents the core of a WGA document.
|
WGDocumentKey
A class for parsing complete document keys and accessing the single information tokens.
|
WGDocumentListCache
A class that caches the document keys of a given list of documents and is able to rebuild the document lists from these cached keys
|
WGDuplicateKeyException
Thrown when an operation leads to a duplicate unique key.
|
WGEventScript
Represents the data of an event script that can be executed on a WGA event.
|
WGEventThread
Thread that invokes background events (database updates) on the WGAPI.
|
WGException
Base class for all exceptions thrown by WGA products/libraries.
|
WGExtensionDataContainer
Interface for all entities that may hold extension data fields
|
WGFactory
Entry class to use the WGAPI in any program.
|
WGFileAnnotations
Shared annotation data of file attachments and derivates
|
WGFileAnnotator
An annotator for attached files, to analyze them and add information to the files annotations
|
WGFileContainer
A file container, whose main duty is to carry file attachments.
|
WGFileConverter |
WGFileDerivateMetaData
Data bean for file derivate meta informations.
|
WGFileMetaData
Data bean for file meta informations, available since content store version 4.1.
|
WGFileMetaData.ManualDerivate
A file derivate that was created manually
|
WGFileMetaDataContext
A context object for
WGFileMetaData , providing all necessary connections to the outside |
WGHierarchicalDatabase
wraps a wga content store to use it as hierarchical database
simplifies creating content documents for data storage use
creation of ContentTypes, Languages, Areas is encapsulated
WGHierarchicalDatabase automatical create the following areas:
- HDB-Content (used for content)
- HDB-System (used for meta information about the db)
WGHierarchicalDatabase automatical create the following content types:
- HDB-ContentType with outer-layout HDB-Layout
The hdb structure contains WGContents.
|
WGHierarchicalDatabase.PostUpdateEventBehaviour
Behaviour regarding the post update event
|
WGHierarchicalDatabaseCoreListener
Listener for WGHierarchicalDatabase core events
|
WGHierarchicalDatabaseEvent
event which is fired by modify methods of WGHierarchicalDatabase
"pre..." - events are fired directly after the method call before any processing is done
"post..." - events are fired directly before the return statement of the correponding method after all processing is done
|
WGHierarchicalDatabaseEventException
thrown by WGHierarchicalDatabaseEvent to cancel() a process
|
WGHierarchicalDatabaseListener
Interface for listener for HDB content events
|
WGHierarchicalDatabaseListenerFactory
Interface for a factory to create HDB listener instances
|
WGHierarchicalDatabaseStartup
Interface for a process to be run at HDB instance startup
|
WGHierarchyContentIterator
An iterator over all released contents of one language at a certain hierarchy position.
|
WGIllegalArgumentException
checked exception for IllegalArgumentException.
|
WGIllegalDataException
Thrown when:
- Trying to retrieve data stored in a WGA database that is of illegal format and cannot be restored
- Trying to store data to a WGA database that this database type is not capable of storing
|
WGIllegalStateException
checked exception corresponding to IllegalStateException.
|
WGIteratingResultSetCore
A result set core that supports single iterating over results
|
WGLanguage
A language definion.
|
WGLanguageChooser
An object implementing a language choosage functionality.
|
WGNotSupportedException
Thrown, when an operation is not supported on the database type.
|
WGOperationKey
An key for an operation involving the backend database.
|
WGPageOrderSet
A column set used to define the order of document collections
The order is determined by the fields defined on the set in descending order
|
WGPageVisitor
An interface for the visitor pattern to visit all documents in a given content hierarchy.
|
WGPersonalisationDatabaseCore
This is a mixin interface for
WGDatabaseCore implementations that also provide storage of user profiles for personalisation. |
WGPortlet
Registration data of a WebTML portlet
|
WGPortletItemStorage
A service to store items for
WGTransientPortlet s |
WGPortletRegistry
Base class for WebTML portlet registry implementations, defining shared functionality
|
WGRelationData
Contains data of a content relation.
|
WGResultSet
Generic interface for result sets that are returned by the WGAPI.
|
WGResultSetCore
Represents the result set of a database query holding contents.
|
WGSchemaDocument
Denotes documents defining the content schema of the content store and their shared functionality, explicitly their data redirection to schema definitions
|
WGScriptModule
Represents a Module containing various Non-WebTML-Code, e.g. for Web-Scripting- or Formatting-Languages
This is a behaviourless subclass of WGCSSJSModule that should hide this - now misleading - class name.
|
WGSequence
A sequence service provided by the WGDatabase.
|
WGSessionContext
Contains all information about the current database session.
|
WGStructEntry
A struct entry that is used to build the site hierarchy, determine the
content types at the hierarchy nodes and the editing rights in the hierarchy.
|
WGStructEntry.ContentSet
The set of contents that belongs to one struct entry, divided up into different maps
|
WGStructEntryIterator
Iterator to iterate over struct entries.
|
WGStructEntryList
A list of struct entries.
|
WGStructEntryRetrievalIterator
Class to iterate over struct entries returned by hierarchy retrieeval methods of WGAPI backend.
|
WGSystemException
thrown on unexpected wgapi errors
|
WGTMLModule
A TML module containing WebTML Source code.
|
WGTransaction
Interface for WGAPI transactions.
|
WGTransientPortlet
Implementation for a transient portlet, registered only for a single request in memory, used by the
WGTransientPortletRegistry |
WGTransientPortletRegistry
A transient portlet registry which is able to store portlet items on the given profiles portlet item storage
|
WGUpdateLog
Object representing a modification of a document that took place, which may be an update or a deletion.
|
WGUserAccess
Represents basic user access information
|
WGUserDetails
Detail information about a logged in WGA user, consolidating information from an auth session and
- His primary name (which should be identical to what the WGSessionContext returns as user name)
- His known name aliases/variants
- His user groups
- His roles
- His e mail address (for workflow)
Not every database implementation supports creating this detail information.
|
WGUserProfile
A user profile, used to store information about and from a web user.
|
WGWrongRevisionException
Thrown when a revision is passed to a method that is no correct revision of the current database
|
Class and Description |
---|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGDatabase
Represents a WGA Database.
|
WGException
Base class for all exceptions thrown by WGA products/libraries.
|
WGQueryException
Thrown when a query results in an error, e.g. because of invalid query syntax
|
Class and Description |
---|
WGACLCore
Interface that is implemented by concrete WGACL implementations.
|
WGACLEntry
Represents a single ACL entry
|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGArea
Represents an area of the content database, containing content documents.
|
WGBackendException
Thrown on errors in a wgapi backend module
(e.g. connection problems to sql server, errors in backend api)
|
WGColumnSet
A definition of field columns of content documents for various purposes.
|
WGContentKey
Represents the complete unique key of a content document, consisting of the struct key of the connected struct entry, the language code and the content version.
|
WGContentType
Formerly referred to as "Doctype", this is a document describing a type of
content document.
|
WGDatabase
Represents a WGA Database.
|
WGDatabaseCore
Represents the core of a WGA database.
|
WGDatabaseCoreFeatureReturnHierarchyCount
Feature interface for
WGDatabaseCore for performant retrieval of struct entry count (without actually retrieving the struct data) at certain hierarchy positions |
WGDatabaseCoreFeatureSequenceProvider
Extension interface for database cores that provide sequence functionality
|
WGDatabaseRevision
Represents a database revision and provides methods to operate with it, including comparision, serialisation and derserialisation
|
WGDocument
Parent class for all document objects in a WGA database.
|
WGDocumentCore
Represents the core of a WGA document.
|
WGExpressionException
Thrown when a native expression caused an error while evaluating
|
WGExtensionDataContainer
Interface for all entities that may hold extension data fields
|
WGFileDerivateMetaData
Data bean for file derivate meta informations.
|
WGFileMetaData
Data bean for file meta informations, available since content store version 4.1.
|
WGIllegalArgumentException
checked exception for IllegalArgumentException.
|
WGInvalidDatabaseException
Thrown whenever a WGA database cannot be opened because of invalid information
|
WGLanguage
A language definion.
|
WGNotSupportedException
Thrown, when an operation is not supported on the database type.
|
WGPageOrderSet
A column set used to define the order of document collections
The order is determined by the fields defined on the set in descending order
|
WGPersonalisationDatabaseCore
This is a mixin interface for
WGDatabaseCore implementations that also provide storage of user profiles for personalisation. |
WGQueryException
Thrown when a query results in an error, e.g. because of invalid query syntax
|
WGRelationData
Contains data of a content relation.
|
WGResultSetCore
Represents the result set of a database query holding contents.
|
WGSessionContext
Contains all information about the current database session.
|
WGStructEntry
A struct entry that is used to build the site hierarchy, determine the
content types at the hierarchy nodes and the editing rights in the hierarchy.
|
WGSystemException
thrown on unexpected wgapi errors
|
WGUpdateLog
Object representing a modification of a document that took place, which may be an update or a deletion.
|
WGUserAccess
Represents basic user access information
|
WGWrongRevisionException
Thrown when a revision is passed to a method that is no correct revision of the current database
|
Class and Description |
---|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGException
Base class for all exceptions thrown by WGA products/libraries.
|
Class and Description |
---|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGException
Base class for all exceptions thrown by WGA products/libraries.
|
Class and Description |
---|
WGACLCore
Interface that is implemented by concrete WGACL implementations.
|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGArea
Represents an area of the content database, containing content documents.
|
WGBackendException
Thrown on errors in a wgapi backend module
(e.g. connection problems to sql server, errors in backend api)
|
WGColumnSet
A definition of field columns of content documents for various purposes.
|
WGContentKey
Represents the complete unique key of a content document, consisting of the struct key of the connected struct entry, the language code and the content version.
|
WGContentType
Formerly referred to as "Doctype", this is a document describing a type of
content document.
|
WGDatabase
Represents a WGA Database.
|
WGDatabaseCore
Represents the core of a WGA database.
|
WGDatabaseRevision
Represents a database revision and provides methods to operate with it, including comparision, serialisation and derserialisation
|
WGDocument
Parent class for all document objects in a WGA database.
|
WGDocumentCore
Represents the core of a WGA document.
|
WGExpressionException
Thrown when a native expression caused an error while evaluating
|
WGExtensionDataContainer
Interface for all entities that may hold extension data fields
|
WGFileDerivateMetaData
Data bean for file derivate meta informations.
|
WGIllegalArgumentException
checked exception for IllegalArgumentException.
|
WGIllegalDataException
Thrown when:
- Trying to retrieve data stored in a WGA database that is of illegal format and cannot be restored
- Trying to store data to a WGA database that this database type is not capable of storing
|
WGInvalidDatabaseException
Thrown whenever a WGA database cannot be opened because of invalid information
|
WGLanguage
A language definion.
|
WGNotSupportedException
Thrown, when an operation is not supported on the database type.
|
WGPageOrderSet
A column set used to define the order of document collections
The order is determined by the fields defined on the set in descending order
|
WGProcedureException
Thrown, when a database procedure causes an error.
|
WGQueryException
Thrown when a query results in an error, e.g. because of invalid query syntax
|
WGRelationData
Contains data of a content relation.
|
WGResultSetCore
Represents the result set of a database query holding contents.
|
WGSessionContext
Contains all information about the current database session.
|
WGStructEntry
A struct entry that is used to build the site hierarchy, determine the
content types at the hierarchy nodes and the editing rights in the hierarchy.
|
WGSystemException
thrown on unexpected wgapi errors
|
WGUserAccess
Represents basic user access information
|
Class and Description |
---|
WGDatabase
Represents a WGA Database.
|
WGDatabaseCore
Represents the core of a WGA database.
|
WGQueryException
Thrown when a query results in an error, e.g. because of invalid query syntax
|
Class and Description |
---|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGDocumentKey
A class for parsing complete document keys and accessing the single information tokens.
|
WGException
Base class for all exceptions thrown by WGA products/libraries.
|
Class and Description |
---|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGDatabase
Represents a WGA Database.
|
WGDatabaseCore
Represents the core of a WGA database.
|
WGException
Base class for all exceptions thrown by WGA products/libraries.
|
Class and Description |
---|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGDatabase
Represents a WGA Database.
|
WGDatabaseCore
Represents the core of a WGA database.
|
WGDocumentCore
Represents the core of a WGA document.
|
WGInvalidDatabaseException
Thrown whenever a WGA database cannot be opened because of invalid information
|
WGQueryException
Thrown when a query results in an error, e.g. because of invalid query syntax
|
Class and Description |
---|
WGACLCore
Interface that is implemented by concrete WGACL implementations.
|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGArea
Represents an area of the content database, containing content documents.
|
WGAuthorisationException
Thrown whenever a user tries to start an unauthorized action (e.g. create a content document).
|
WGBackendException
Thrown on errors in a wgapi backend module
(e.g. connection problems to sql server, errors in backend api)
|
WGColumnSet
A definition of field columns of content documents for various purposes.
|
WGContentKey
Represents the complete unique key of a content document, consisting of the struct key of the connected struct entry, the language code and the content version.
|
WGContentType
Formerly referred to as "Doctype", this is a document describing a type of
content document.
|
WGDatabase
Represents a WGA Database.
|
WGDatabaseCore
Represents the core of a WGA database.
|
WGDatabaseRevision
Represents a database revision and provides methods to operate with it, including comparision, serialisation and derserialisation
|
WGDocument
Parent class for all document objects in a WGA database.
|
WGDocumentCore
Represents the core of a WGA document.
|
WGExpressionException
Thrown when a native expression caused an error while evaluating
|
WGExtensionDataContainer
Interface for all entities that may hold extension data fields
|
WGFileDerivateMetaData
Data bean for file derivate meta informations.
|
WGFileMetaData
Data bean for file meta informations, available since content store version 4.1.
|
WGIllegalArgumentException
checked exception for IllegalArgumentException.
|
WGLanguage
A language definion.
|
WGNotSupportedException
Thrown, when an operation is not supported on the database type.
|
WGPageOrderSet
A column set used to define the order of document collections
The order is determined by the fields defined on the set in descending order
|
WGProcedureException
Thrown, when a database procedure causes an error.
|
WGRelationData
Contains data of a content relation.
|
WGResultSetCore
Represents the result set of a database query holding contents.
|
WGSessionContext
Contains all information about the current database session.
|
WGStructEntry
A struct entry that is used to build the site hierarchy, determine the
content types at the hierarchy nodes and the editing rights in the hierarchy.
|
WGSystemException
thrown on unexpected wgapi errors
|
WGUpdateLog
Object representing a modification of a document that took place, which may be an update or a deletion.
|
WGUserAccess
Represents basic user access information
|
WGWrongRevisionException
Thrown when a revision is passed to a method that is no correct revision of the current database
|
Class and Description |
---|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGDatabase
Represents a WGA Database.
|
Class and Description |
---|
WGAPIException
Root class for all exceptions thrown by the WGAPI.
|
WGContent
Represents a content document of this content database.
|
WGDatabase
Represents a WGA Database.
|