Package de.innovationgate.webgate.api

Basic functionality of the WGAPI including most of the database-independent functionality.

See: Description

Interface Summary

Interface	Description
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
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
PortletItemStorageData	Interface to access the item storage data for one portlet for migration purposes
ResultSetIterator<T>	An interator with all features necessary to be used as a result set, including skipping support and result count retrieval
UserAccessFilter	A filter to reduce user access of logged in users.
WGACLCore	Interface that is implemented by concrete WGACL implementations.
WGACLEntry	Represents a single ACL entry
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.
WGContentEventListener	A listener for content events in a database
WGContentNavigator.IteratorCreator	Class capable of producing iterators for a content collection
WGDatabase.ConnectAction
WGDatabase.DatabaseAction	An interface defining an action that can be execute on certain database events.
WGDatabaseConnectListener	A listener that will get notified, when the database is connected to its backend.
WGDatabaseCore	Represents the core of a WGA database.
WGDatabaseCoreFeaturePageSequences
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
WGDatabaseEventListener	A listener to database events.
WGDatabaseRevisionSerializer	Deprecated Since database revisions are always instances of WGDatabaseRevision now having their own serialisation/deserialisation methods
WGDesignChangeListener	A listener for design change events, issued by a WGDesignProvider or a WGDatabase.
WGDesignProvider	A provider of design document cores to be used with a WGDatabase if the design of that database comes from another location.
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.
WGExtensionDataContainer	Interface for all entities that may hold extension data fields
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
WGFileConverter
WGFileMetaDataContext	A context object for WGFileMetaData, providing all necessary connections to the outside
WGHierarchicalDatabaseCoreListener	Listener for WGHierarchicalDatabase core events
WGHierarchicalDatabaseListener	Interface for listener for HDB content events
WGHierarchicalDatabaseListenerFactory	Interface for a factory to create HDB listener instances
WGHierarchicalDatabaseListenerV2	extends the WGHierarchicalDatabaseListener - methods for content move operations - name
WGHierarchicalDatabaseStartup	Interface for a process to be run at HDB instance startup
WGIteratingResultSetCore	A result set core that supports single iterating over results
WGLanguageChooser	An object implementing a language choosage functionality.
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 WGTransientPortlets
WGReconfigurableDatabaseCore	A database core receiving an interface for reconfiguring its WGDatabase instance.
WGReportingResultSetCore	A result set core able to report processing statistics after the query has been executed
WGResultSet	Generic interface for result sets that are returned by the WGAPI.
WGResultSetCore	Represents the result set of a database query holding contents.
WGTransaction	Interface for WGAPI transactions.
WGVirtualDesignProvider	Flag interface identifying that a design provider is virtual.

Class Summary

Class	Description
BinaryFieldData	Represents binary data on a field.
DefaultMimetypeDeterminationService	A default implementation that always returns octet stream
DefaultPageRightsFilter	Default page rights filter allowing all actions by itself, but also enforcing default tests
MetaInfo	Bean containing information about a document metadata field.
SearchDetails	All transient data of a document belonging to the query that was used to fetch it
WGAbstractResultSet	Common base class of WGAPI query result sets, defining shared functionality
WGAbstractResultSetIterator<T>	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.
WGACLEntryFlags	Class to parse the flags that are stored at each WGACLEntry and provide their data.
WGArea	Represents an area of the content database, containing content documents.
WGArea.AreaCache
WGAreaMap	Represents a Map of WGArea-Objects, where the mapping key for each area is its name.
WGCachedResultSet	Represents a query result set that can be cached.
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
WGConfigurableTypeDesignProvider	A base class for design providers with internal management of provided document types.
WGContent	Represents a content document of this content database.
WGContent.ContentCache
WGContentEvent	Represents an event that was triggered for a content document.
WGContentIterator	This class allows iterating over all contents stored in a content 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	Utility object to navigate the content hierarchy.
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.
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.AccessLevelPrivilege	Represents an ACL privilege for an ACL level
WGDatabaseEvent	Information about a database event.
WGDatabaseRevision	Represents a database revision and provides methods to operate with it, including comparision, serialisation and derserialisation
WGDesignChangeEvent	An event fired when a design provider or a database has changed it's design
WGDesignDocument	Superclass for WGAPI "design documents", i.e. documents that are not directly related to authoring and therefor not editable by pure authors/editors.
WGDesignResourceDocument	Documents representing real design resources
WGDocument	Parent class for all document objects in a WGA database.
WGDocument.Cache
WGDocument.FakeMetaDataContext	Fake md context when the metadata does not represent already stored md
WGDocumentCoreWrapper	A multi-use wrapper for document cores to enhance them with some specialized functionality
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
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.
WGFactory	Entry class to use the WGAPI in any program.
WGFileContainer	A file container, whose main duty is to carry file attachments.
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
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.
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
WGHierarchicalDatabaseJavaListenerFactory	listener factory for WGHierarchicalDatabase to lookup listener by java class name
WGHierarchyContentIterator	An iterator over all released contents of one language at a certain hierarchy position.
WGLanguage	A language definion.
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
WGPortletDefaultBean	Object representing a portlet registration on WGUserProfile
WGPortletRegistry	Base class for WebTML portlet registry implementations, defining shared functionality
WGRelationData	Contains data of a content relation.
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.
WGStandardResultSet	Represents the results of a query.
WGStandardResultSetIterator	Utility class for iterating over content keys to return WGContent documents
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.StructCache
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.
WGTMLModule	A TML module containing WebTML Source code.
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.
WGUpdateLogTimeComparator	A comparator implementation that compares objects of Type WGUpdateLog for their logtime.
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.

Enum Summary

Enum	Description
PageRightsFilter.Right
Privilege
WGHierarchicalDatabase.PostUpdateEventBehaviour	Behaviour regarding the post update event

Exception Summary

Exception	Description
WGAPIException	Root class for all exceptions thrown by the WGAPI.
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)
WGCancelledException	Thrown whenever an operation was cancelled by some automatic task or the user
WGClosedSessionException	Exception that is thrown whenever an operation is not possible because there is no open session on this database
WGConfigurationException	Thrown when a functionality cannot be used because it has not been configured properly.
WGContentStoreVersionException	Thrown when a feature is used that is not available on the used OpenWGA content store version
WGCreationException	Thrown for problems creating documents, that are no typical problems like duplicate keys, illegal state, arguments etc.
WGDeletedException	Exception thrown when some functionality is used on an entity object whose backend entity seemingly has already been deleted
WGDisabledException	Thrown when some backend service is disabled by configuration
WGDocumentDoesNotExistException	Thrown on WGDatabase.fetchDocumentListCache(WGDocumentListCache, int) to show that the searched document is marked "not available" in cache.
WGDuplicateKeyException	Thrown when an operation leads to a duplicate unique key.
WGException	Base class for all exceptions thrown by WGA products/libraries.
WGExpressionException	Thrown when a native expression caused an error while evaluating
WGHierarchicalDatabaseEventCanceledException	Thrown when a HDB event is canceled by a listener using WGHierarchicalDatabaseEvent.cancel(String, Throwable)
WGHierarchicalDatabaseEventException	thrown by WGHierarchicalDatabaseEvent to cancel() a process
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.
WGInvalidDatabaseException	Thrown whenever a WGA database cannot be opened because of invalid information
WGNotSupportedException	Thrown, when an operation is not supported on the database type.
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
WGRestrictionException	Thrown when an operation violates data restrictions
WGSystemException	thrown on unexpected wgapi errors
WGUnavailableException	Thrown when an error occured because of an unavailable backend service e.g. a database server
WGUnresolveableVirtualLinkException	Thrown when a virtual link target cannot be resolved
WGWrongRevisionException	Thrown when a revision is passed to a method that is no correct revision of the current database

Package de.innovationgate.webgate.api Description

Basic functionality of the WGAPI including most of the database-independent functionality. When you work with the WGAPI you will rarely access any other classes than these from this package.

Main entry point for working with the WGAPI is the class WGFactory which is a singleton that is aquired by it's static getInstance() method.

The WGFactory can open Databases by it's method openDatabase. The returned objects are of type WGDatabase. From there you can retrieve the data of WGA databases as descendants of WGDocument.