de.innovationgate.webgate.api

Class WGHierarchicalDatabase

java.lang.Object

de.innovationgate.webgate.api.WGHierarchicalDatabase

public class WGHierarchicalDatabase
extends java.lang.Object

 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. Each WGContent is of type HDB-ContentType 
 and created in the default language of the database. All neccessary WGStructEntries are handled and created 
 by the hdb automatically. 
 
 A WGContent in the hdb can either be used as a storage or as a content. A storage has a special struct-entry 
 which is by default write/edit-protected with the role ($HDBAdmin). Therefore normal users cannot delete a 
 whole hdb structure. A storage contains contents and might contains substorages. When a storage is created the user
 should give an id for it. This id is used to create a unique id for the storage, based on the hierarchical storage
 structure. The unique id of a storage contains all parent storage ids concated by "."
 for e.g.: storageA
                  |- storageB
                            |- storageC   
 
 unique id of A is: "storageA"
 unique id of B is: "storageA.storageB"
 unique id of C is: "storageA.storageB.storageC"
 
 The unique id of a storage is set as unique name for the WGContent object, so the unique storage id can be used
 directly for e.g. in context expressions.
 
 A startup script can be defined with the publisher option "de.innovationgate.wgpublisher.WGACore.DBATTRIB_HDBInit" 
 This can be either a class name of a class which implements 
 WGHierarchicalDatabaseStartup or a name of a tmlsscript module within this db. 
 The startup script is executed when an hdb instance gets connected. 
 It can be used to create storages and define the initial db-structure. 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WGHierarchicalDatabase.PostUpdateEventBehaviour Behaviour regarding the post update event

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AREA_CONTENT Name of the area in which HDB content is to be stored
static java.lang.String	CONTENT_TYPE Name of the content type which HDB content pages belong to
static java.lang.String	DBATTRIB_HDB_USE_VERSIONING Attribute to control if HDB should use versioning when updating contents.
static java.lang.String	ITEMNAME_LISTENER_CLASS_OR_MODULE Item name in which the name of a HDB listener class or module for a content is stored
static java.lang.String	SESSIONPARAM_HDBPARAMETER Name under which the HDB event parameter is stored as attribute of the WGSessionContext
static java.lang.String	STORAGE_ADMIN_ROLE ACL Role name which is granted administrative HDB rights, like editing rights to HDB storage documents.
static java.lang.String	STORAGE_DELIMITER Character by which the name parts of HDB storage ids are divided

Method Summary

Methods

Modifier and Type	Method and Description
static void	addCoreListener(WGHierarchicalDatabaseCoreListener listener) Adds a HDB core listener
java.lang.String	assignContentUID(WGContent con, java.lang.String id) Issues an UID to a content document.
WGContent	createContent(WGContent parent) creates a child content of the given parent with a generated title
WGContent	createContent(WGContent parent, java.lang.String title) creates a child content of the given parent with the given title,
WGContent	createContent(WGContent parent, java.lang.String title, java.lang.Object parameter) creates a child content of the given parent with the given title, parameter is delivered within the contentCreatedEvent
static void	createInstance(WGDatabase database, WGHierarchicalDatabaseStartup startupImpl) creates a new hdb instance for the given WGDatabase
static void	createInstance(WGDatabase database, WGHierarchicalDatabaseStartup startupImpl, WGHierarchicalDatabaseListenerFactory listenerFactory) creates a new hdb instance for the given WGDatabase
WGContent	createStorage(java.lang.String id) creates a storage with the given id
WGContent	createStorage(java.lang.String id, java.lang.Object parameter) creates a storage with the given id
WGContent	createStorage(WGContent parent, java.lang.String id) creates a storage with the given id as child of the given parent storage
WGContent	createStorage(WGContent parent, java.lang.String id, java.lang.Object parameter) creates a storage with the given id as child of the given parent storage
java.lang.String	createStorageUID(WGContent parent, java.lang.String id)
void	deleteContent(java.lang.String key) deletes the content determined by the given key
void	deleteContent(java.lang.String key, java.lang.Object parameter) deletes the content determined by the given key
void	deleteContent(WGContent content) deletes the given content
void	deleteContent(WGContent content, java.lang.Object parameter) deletes the given content
void	deleteStorage(java.lang.String uid) deletes the storage with the given id
WGContent	getContent(java.lang.String key) returns currently published content object for the given key
WGContentType	getContentType() Retrieves the WGAPI Content Type that this HDB uses to construct contents
static WGHierarchicalDatabaseListenerFactory	getDefaultListenerFactory() Returns the default listener factory for all HDB instances
static WGHierarchicalDatabaseStartup	getDefaultStartupImpl() Returns the default startup implementation for all HDB instances
WGContent	getDummyContent() Returns a dummy content object for the current database in the language that the HDB uses
static WGHierarchicalDatabase	getInstance(java.lang.String dbKey) returns the requested hdb for the given dbKey, instance have to be create prior by using createInstance(...)
java.lang.String	getKey(WGContent content) returns a db wide unique key for the given content
WGLanguage	getLanguage() Returns the language that the HDB uses to create content
static WGHierarchicalDatabase	getOrCreateInstance(WGDatabase db) returns the requested hdb for the given db, instance is created if not existing using the default startup and listenerFactory implementations
WGContent	getOrCreateStorage(java.lang.String id) creates the storage with the given id if not exists
WGContent	getOrCreateStorage(java.lang.String id, java.lang.Object parameter) creates the storage with the given id if not exists
WGContent	getOrCreateStorage(WGContent parent, java.lang.String id) creates the storage with the given id as child of the given parent storage
WGContent	getOrCreateStorage(WGContent parent, java.lang.String id, java.lang.Object parameter) creates the storage with the given id as child of the given parent storage
WGContent	getOrCreateUIDContent(WGContent parent, java.lang.String id) creates the content with the given uid as child of the given parent document, if not yet existent
WGContent	getOrCreateUIDContent(WGContent parent, java.lang.String id, java.lang.Object parameter) creates the content with the given uid as child of the given parent document, if not yet existent
WGHierarchicalDatabase.PostUpdateEventBehaviour	getPostUpdateEventBehaviour() Returns the behaviour of this HDB instance regarding post update events
java.util.List	getRootDocuments() Returns all root documents in this Database
WGContent	getStorage(java.lang.String uid) returns the storage with the given uid
WGDatabase	getWrappedDB() Returns the WGDatabase object wrapped by this hdb
boolean	isHdbModelMode() Returns if this HDB instance is in HDBModel model.
boolean	isStorage(WGContent content) Determines if the given content document is a HDB storage
boolean	isUseVersioning() Determines if this HDB instance uses versioning.
void	moveContent(WGContent content, WGContent newParent) moves the given content under the given parent content pre- and post-move events are first fired on the old hierarchy and then on the new hierarchy if target parent is null the content will be moved to the db root
void	moveContent(WGContent content, WGContent newParent, java.lang.Object parameter) moves the given content under the given parent content pre- and post-move events are first fired on the old hierarchy and then on the new hierarchy if target parent is null the content will be moved to the db root
static void	removeCoreListener(WGHierarchicalDatabaseCoreListener listener) Removes a HDB core listener
static void	removeInstance(java.lang.String dbKey) removes an created instance
void	removeListener(WGContent content) removes the stored listener reference from the given storage or content
static void	setDefaultListenerFactory(WGHierarchicalDatabaseListenerFactory listenerFactory) Sets the default listener factory for all HDB instances
static void	setDefaultStartupImpl(WGHierarchicalDatabaseStartup startupImpl) Sets the default startup implementation for all HDB instances
void	setHdbModelMode(boolean hdbModelMode) Sets if this HDB instance is in HDBModel mode.
void	setListener(WGContent content, java.lang.String moduleOrClassname) sets the given module (tmlscriptmodule) or classname (implementation of WGHierarchicalContentListener) on the given storage or content
void	setPostUpdateEventBehaviour(WGHierarchicalDatabase.PostUpdateEventBehaviour postUpdateEventBehaviour) Sets a behaviour for post update events
void	setUseVersioning(boolean useVersioning) Sets if this HDB instance should use versioning.
void	updateContent(WGContent content) updates the given content within the listener, parameter will be null, leaves the title unchanged
void	updateContent(WGContent content, java.lang.Object parameter) updates the given content within the listener using parameter, leaves the title unchanged
WGContent	updateContent(WGContent content, java.lang.String title, java.lang.Object parameter) updates the title on the given content and optional further fields within the listener using parameter if versioning is enabled the post_update_event is executed on a draft copy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSIONPARAM_HDBPARAMETER

public static final java.lang.String SESSIONPARAM_HDBPARAMETER

Name under which the HDB event parameter is stored as attribute of the WGSessionContext

See Also:

Constant Field Values

AREA_CONTENT

public static final java.lang.String AREA_CONTENT

Name of the area in which HDB content is to be stored

See Also:

Constant Field Values

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

Name of the content type which HDB content pages belong to

See Also:

Constant Field Values

STORAGE_ADMIN_ROLE

public static final java.lang.String STORAGE_ADMIN_ROLE

ACL Role name which is granted administrative HDB rights, like editing rights to HDB storage documents.

See Also:

Constant Field Values

DBATTRIB_HDB_USE_VERSIONING

public static final java.lang.String DBATTRIB_HDB_USE_VERSIONING

Attribute to control if HDB should use versioning when updating contents. Defaults to false. Set to true to enable this.

See Also:

Constant Field Values

ITEMNAME_LISTENER_CLASS_OR_MODULE

public static final java.lang.String ITEMNAME_LISTENER_CLASS_OR_MODULE

Item name in which the name of a HDB listener class or module for a content is stored

See Also:

Constant Field Values

STORAGE_DELIMITER

public static final java.lang.String STORAGE_DELIMITER

Character by which the name parts of HDB storage ids are divided

See Also:

Constant Field Values

Method Detail

createInstance

public static void createInstance(WGDatabase database,
                  WGHierarchicalDatabaseStartup startupImpl)
                           throws WGAPIException

creates a new hdb instance for the given WGDatabase

Parameters:

database - WGDatabase to use as backendstorage

startupImpl - StartupScript to execute, can be 'null'

Throws:

WGAPIException

createInstance

public static void createInstance(WGDatabase database,
                  WGHierarchicalDatabaseStartup startupImpl,
                  WGHierarchicalDatabaseListenerFactory listenerFactory)
                           throws WGAPIException

creates a new hdb instance for the given WGDatabase

Parameters:

database - WGDatabase to use as backendstorage

startupImpl - StartupScript to execute, can be 'null'

listenerFactory - WGHierarchicalDatabaseListenerFactory implementation to use for listener creation

Throws:

WGAPIException

removeInstance

public static void removeInstance(java.lang.String dbKey)

removes an created instance

Parameters:

dbKey -

getInstance

public static WGHierarchicalDatabase getInstance(java.lang.String dbKey)
                                          throws WGAPIException

returns the requested hdb for the given dbKey, instance have to be create prior by using createInstance(...)

Parameters:

dbKey -

Returns:

WGHierarchicalDatabase

Throws:

WGAPIException

getOrCreateInstance

public static WGHierarchicalDatabase getOrCreateInstance(WGDatabase db)
                                                  throws WGAPIException

returns the requested hdb for the given db, instance is created if not existing using the default startup and listenerFactory implementations

Parameters:

db - WGDatabase to use as backendstorage

Throws:

WGAPIException

isStorage

public boolean isStorage(WGContent content)
                  throws WGAPIException

Determines if the given content document is a HDB storage

Parameters:

content - The content document

Throws:

WGAPIException

getContentType

public WGContentType getContentType()
                             throws WGAPIException

Retrieves the WGAPI Content Type that this HDB uses to construct contents

Throws:

WGAPIException

getLanguage

public WGLanguage getLanguage()
                       throws WGAPIException

Returns the language that the HDB uses to create content

Throws:

WGAPIException

getDummyContent

public WGContent getDummyContent()
                          throws WGAPIException

Returns a dummy content object for the current database in the language that the HDB uses

Throws:

WGAPIException

getWrappedDB

public WGDatabase getWrappedDB()

Returns the WGDatabase object wrapped by this hdb

createContent

public WGContent createContent(WGContent parent,
                      java.lang.String title,
                      java.lang.Object parameter)
                        throws WGAPIException,
                               WGHierarchicalDatabaseEventException

creates a child content of the given parent with the given title, parameter is delivered within the contentCreatedEvent

Parameters:

parent - either a storage or a content

title - if 'null' a title is generated

parameter - can be retrieved in the event listener by event.getParameter()

Returns:

WGContent - in versioning mode this content is not published yet

Throws:

WGAPIException

WGHierarchicalDatabaseEventException - - if a listener cancel the process

createContent

public WGContent createContent(WGContent parent,
                      java.lang.String title)
                        throws WGAPIException,
                               WGHierarchicalDatabaseEventException

creates a child content of the given parent with the given title,

Parameters:

parent - either a storage or a content

title - if 'null' a title is generated

Returns:

WGContent

Throws:

WGAPIException

WGHierarchicalDatabaseEventException - - if a listener cancel the process

createContent

public WGContent createContent(WGContent parent)
                        throws WGAPIException,
                               WGHierarchicalDatabaseEventException

creates a child content of the given parent with a generated title

Parameters:

parent - either a storage or a content

Returns:

WGContent

Throws:

WGAPIException

WGHierarchicalDatabaseEventException - - if a listener cancel the process

deleteContent

public void deleteContent(WGContent content,
                 java.lang.Object parameter)
                   throws WGAPIException,
                          WGHierarchicalDatabaseEventException

deletes the given content

Parameters:

content - WGContent

parameter - can be retrieved in the event listener by event.getParameter()

Throws:

WGAPIException

WGHierarchicalDatabaseEventException - - if a listener cancel the process

deleteContent

public void deleteContent(WGContent content)
                   throws WGAPIException,
                          WGHierarchicalDatabaseEventException

deletes the given content

Parameters:

content - WGContent

Throws:

WGAPIException

WGHierarchicalDatabaseEventException

updateContent

public WGContent updateContent(WGContent content,
                      java.lang.String title,
                      java.lang.Object parameter)
                        throws WGAPIException,
                               WGHierarchicalDatabaseEventException

updates the title on the given content and optional further fields within the listener using parameter if versioning is enabled the post_update_event is executed on a draft copy

Parameters:

content - the content to update

title - the new value for the title, 'null' will leave the title unchanged

parameter - can be retrieved in the event listener by event.getParameter()

Returns:

WGContent a saved and published content object, if versioning is enabled the previous content has been archived

Throws:

WGAPIException

WGHierarchicalDatabaseEventException - if a listener has canceled the process

moveContent

public void moveContent(WGContent content,
               WGContent newParent,
               java.lang.Object parameter)
                 throws WGHierarchicalDatabaseEventException,
                        WGAPIException

moves the given content under the given parent content pre- and post-move events are first fired on the old hierarchy and then on the new hierarchy if target parent is null the content will be moved to the db root

Parameters:

content - the content to move

newParent - the new parent to move the content to

parameter - can be retrieved in the event listener by event.getParameter()

Throws:

WGHierarchicalDatabaseEventException - if a listener has canceled the process

WGAPIException

moveContent

public void moveContent(WGContent content,
               WGContent newParent)
                 throws WGHierarchicalDatabaseEventException,
                        WGAPIException

moves the given content under the given parent content pre- and post-move events are first fired on the old hierarchy and then on the new hierarchy if target parent is null the content will be moved to the db root

Parameters:

content - the content to move

newParent - the new parent to move the content to

Throws:

WGHierarchicalDatabaseEventException - if a listener has canceled the process

WGAPIException

updateContent

public void updateContent(WGContent content)
                   throws WGAPIException,
                          WGHierarchicalDatabaseEventException

updates the given content within the listener, parameter will be null, leaves the title unchanged

Parameters:

content - the content to update

Throws:

WGAPIException

WGHierarchicalDatabaseEventException - if a listener has canceled the process

updateContent

public void updateContent(WGContent content,
                 java.lang.Object parameter)
                   throws WGAPIException,
                          WGHierarchicalDatabaseEventException

updates the given content within the listener using parameter, leaves the title unchanged

Parameters:

content - the content to update

parameter - can be retrieved in the event listener by event.getParameter()

Throws:

WGAPIException

WGHierarchicalDatabaseEventException - if a listener has canceled the process

deleteContent

public void deleteContent(java.lang.String key)
                   throws WGAPIException,
                          WGHierarchicalDatabaseEventException

deletes the content determined by the given key

Parameters:

key - determined by getKey(WGContent)

Throws:

WGAPIException

WGHierarchicalDatabaseEventException - if a listener has canceled the process

deleteContent

public void deleteContent(java.lang.String key,
                 java.lang.Object parameter)
                   throws WGAPIException,
                          WGHierarchicalDatabaseEventException

deletes the content determined by the given key

Parameters:

key - determined by getKey(WGContent)

parameter - can be retrieved in the event listener by event.getParameter()

Throws:

WGHierarchicalDatabaseEventException - if a listener has canceled the process

WGAPIException

getContent

public WGContent getContent(java.lang.String key)
                     throws WGAPIException

returns currently published content object for the given key

Parameters:

key - determined by getKey(WGContent)

Returns:

WGContent

Throws:

WGAPIException

getKey

public java.lang.String getKey(WGContent content)
                        throws WGAPIException

returns a db wide unique key for the given content

Parameters:

content -

Returns:

key

Throws:

WGAPIException

setListener

public void setListener(WGContent content,
               java.lang.String moduleOrClassname)
                 throws WGAPIException

sets the given module (tmlscriptmodule) or classname (implementation of WGHierarchicalContentListener) on the given storage or content

Parameters:

content -

moduleOrClassname -

Throws:

WGAPIException

removeListener

public void removeListener(WGContent content)
                    throws WGAPIException

removes the stored listener reference from the given storage or content

Parameters:

content -

Throws:

WGAPIException

createStorage

public WGContent createStorage(java.lang.String id,
                      java.lang.Object parameter)
                        throws WGAPIException

creates a storage with the given id

Parameters:

id -

parameter -

Returns:

WGContent

Throws:

WGAPIException

WGDuplicateKeyException - if storage already exists

createStorage

public WGContent createStorage(java.lang.String id)
                        throws WGAPIException

creates a storage with the given id

Parameters:

id -

Returns:

WGContent

Throws:

WGAPIException

WGDuplicateKeyException - if storage already exists

createStorage

public WGContent createStorage(WGContent parent,
                      java.lang.String id,
                      java.lang.Object parameter)
                        throws WGAPIException

creates a storage with the given id as child of the given parent storage

Parameters:

parent - - parent storage

id -

parameter -

Returns:

WGContent

Throws:

WGAPIException

WGDuplicateKeyException - if storage already exists

createStorage

public WGContent createStorage(WGContent parent,
                      java.lang.String id)
                        throws WGAPIException

creates a storage with the given id as child of the given parent storage

Parameters:

parent - - parent storage

id -

Returns:

WGContent

Throws:

WGAPIException

WGDuplicateKeyException - if storage already exists

getStorage

public WGContent getStorage(java.lang.String uid)
                     throws WGAPIException

returns the storage with the given uid

Parameters:

uid -

Returns:

WGContent 'null' if storage does not exist

Throws:

WGAPIException

getOrCreateStorage

public WGContent getOrCreateStorage(java.lang.String id,
                           java.lang.Object parameter)
                             throws WGAPIException

creates the storage with the given id if not exists

Parameters:

id -

parameter -

Returns:

WGContent

Throws:

WGAPIException

getOrCreateStorage

public WGContent getOrCreateStorage(java.lang.String id)
                             throws WGAPIException

creates the storage with the given id if not exists

Parameters:

id -

Returns:

WGContent

Throws:

WGAPIException

getOrCreateStorage

public WGContent getOrCreateStorage(WGContent parent,
                           java.lang.String id,
                           java.lang.Object parameter)
                             throws WGAPIException

creates the storage with the given id as child of the given parent storage

Parameters:

parent - the parent storage

id -

parameter -

Returns:

WGContent

Throws:

WGAPIException

getOrCreateStorage

public WGContent getOrCreateStorage(WGContent parent,
                           java.lang.String id)
                             throws WGAPIException

creates the storage with the given id as child of the given parent storage

Parameters:

parent - the parent storage

id -

Returns:

WGContent

Throws:

WGAPIException

getOrCreateUIDContent

public WGContent getOrCreateUIDContent(WGContent parent,
                              java.lang.String id,
                              java.lang.Object parameter)
                                throws WGAPIException

creates the content with the given uid as child of the given parent document, if not yet existent

Parameters:

parent - the parent document

id - The uid of the content

parameter - An optional parameter for HDB listeners

Returns:

WGContent The newly created or existent content with the given id

Throws:

WGAPIException

getOrCreateUIDContent

public WGContent getOrCreateUIDContent(WGContent parent,
                              java.lang.String id)
                                throws WGAPIException

creates the content with the given uid as child of the given parent document, if not yet existent

Parameters:

parent - the parent document

id - The uid of the content

Returns:

WGContent The newly created or existent content with the given id

Throws:

WGAPIException

deleteStorage

public void deleteStorage(java.lang.String uid)
                   throws WGAPIException

deletes the storage with the given id

Parameters:

uid -

Throws:

WGAPIException

createStorageUID

public java.lang.String createStorageUID(WGContent parent,
                                java.lang.String id)
                                  throws WGAPIException

Throws:

WGAPIException

assignContentUID

public java.lang.String assignContentUID(WGContent con,
                                java.lang.String id)
                                  throws WGAPIException

Issues an UID to a content document. This makes the uid functionality of storages available for contents. Use this method after creating but before saving a content to issue it a UID. The UID is set as unique name of the content.

Parameters:

con - The content that should be issued a UID

id - The local id of this content

Returns:

The UID that was issued to this content.

Throws:

WGAPIException

getRootDocuments

public java.util.List getRootDocuments()
                                throws WGAPIException

Returns all root documents in this Database

Throws:

WGAPIException

getDefaultListenerFactory

public static WGHierarchicalDatabaseListenerFactory getDefaultListenerFactory()

Returns the default listener factory for all HDB instances

setDefaultListenerFactory

public static void setDefaultListenerFactory(WGHierarchicalDatabaseListenerFactory listenerFactory)

Sets the default listener factory for all HDB instances

getDefaultStartupImpl

public static WGHierarchicalDatabaseStartup getDefaultStartupImpl()

Returns the default startup implementation for all HDB instances

setDefaultStartupImpl

public static void setDefaultStartupImpl(WGHierarchicalDatabaseStartup startupImpl)

Sets the default startup implementation for all HDB instances

addCoreListener

public static void addCoreListener(WGHierarchicalDatabaseCoreListener listener)

Adds a HDB core listener

removeCoreListener

public static void removeCoreListener(WGHierarchicalDatabaseCoreListener listener)

Removes a HDB core listener

getPostUpdateEventBehaviour

public WGHierarchicalDatabase.PostUpdateEventBehaviour getPostUpdateEventBehaviour()

Returns the behaviour of this HDB instance regarding post update events

setPostUpdateEventBehaviour

public void setPostUpdateEventBehaviour(WGHierarchicalDatabase.PostUpdateEventBehaviour postUpdateEventBehaviour)

Sets a behaviour for post update events

isUseVersioning

public boolean isUseVersioning()

Determines if this HDB instance uses versioning. If true then new documents will begin in draft state, updates to documents will be performed in new versions

setUseVersioning

public void setUseVersioning(boolean useVersioning)

Sets if this HDB instance should use versioning. If true then new documents will begin in draft state, updates to documents will be performed in new versions.

isHdbModelMode

public boolean isHdbModelMode()

Returns if this HDB instance is in HDBModel model. This influences the order in which events are executed.

setHdbModelMode

public void setHdbModelMode(boolean hdbModelMode)

Sets if this HDB instance is in HDBModel mode. This will influence the order of executed events.