de.innovationgate.webgate.api.templates

Class SimpleContentSource

java.lang.Object

de.innovationgate.webgate.api.templates.SimpleContentSource

All Implemented Interfaces:

WGDatabaseCore

Direct Known Subclasses:

BeanAdapter, QueryableSource, SimpleRSS

public abstract class SimpleContentSource
extends java.lang.Object
implements WGDatabaseCore

Template class to implement a simple content source with a subset of WGAPI features. The Simple Content Source manages either JavaBeans or java.util.Map objects as content. While JavaBeans are queried for their properties as Items, Maps serve their mapped values as Items. Data objects are stored in so-called "folders". The SCS defines itself what folders are available. The WGAPI will abstract this folders to Areas. Data objects additionally need a data key, under which they will get stored inside the folder. Each key needs to be unique inside the folder. The keys can be generated by the SCS implementation or entered from outside while creating contents. The method init that needs to be implemented should return an object of type ContentSourceSpecs. This object contains flags in which the implementation will tell the template what features to activate. Methods returning multiple contents should return them as objects of type java.util.Map. The returned Map keys should match the data keys of the available data objects. The data objects can be put as Map values if they are immediately available. However the Map values can also be left empty, if they are not. In that case the data objects will be retrieved lazily by calling method getContent.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPTION_LANGUAGE
static java.lang.String	DUMMY_AREA

Constructor Summary

Constructors

Constructor and Description
SimpleContentSource()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	beginTransaction() Called when a transaction should begin.
void	beginUpdate() Notifies the backend database that the session will update data from now on.
abstract java.util.Map	browse(java.lang.String folder) Browses the given folder for contents.
java.lang.Object	calculateKey(java.lang.String folder, java.lang.Object _bean) Method to calculate the key to a newly created data object.
java.lang.Object	callBackendService(java.lang.String serviceName, java.lang.Object[] params) Calls a backend service whose support is optional.
void	cleanup()
void	clearSessionCache() Is called when the cache of the current WGAPI session is cleared.
void	close() Called when a database implementation is completely closed and all cached data of it is dropped.
void	closeSession() Called when a database session is closed, i.e. the current thread/user stops working with this database for the logged in user.
boolean	commitTransaction() Called when a running transaction should get submitted Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.
java.lang.String	convertFileNameForAttaching(java.lang.String name) Returns a file name like it would be converted when a file of this name got attached to a document.
abstract java.lang.Object	convertToKey(java.lang.String key, java.lang.String folder) Converts the string representation of a data key to it's real data type.
abstract java.lang.Object	createContent(java.lang.String folder) Creates a new content object in the given folder
WGDocumentCore	createContent(WGStructEntry structEntry, WGLanguage language, java.lang.String title, int version) Called to create a content document.
WGDocumentCore	createCopy(WGDocumentCore original) Create a copy of the given doc core.
WGDocumentCore	createDesignDocument(int type, java.lang.String name, java.lang.String mediaKey) Create a design document of the given type and keys.
WGDocumentCore	createStructEntry(java.lang.Object key, WGDocument reference, WGContentType contentType) Creates a struct entry.
WGDocumentCore	createUserProfile(java.lang.String name, int type)
BeanWrapper	createWrapper(BeanKey key, java.lang.Object bean, boolean saved) Creates a wrapper for the given content object that implements WGDocumentCore for it
abstract void	destroy() Callback method, that gets called when the SCS is closed completely.
java.lang.Object	execProcedure(java.lang.String procName, java.util.List args)
java.lang.String	extractFolder(java.lang.String type, java.lang.String query, java.util.Map parameters) Helps to retrieve the folder for query results based on the given query parameters.
WGDocumentCore	fastAccess(int type, java.lang.Object key) Called for fast re-retrieval of a document core, if that core on first instantiation specified a fast access key.
abstract java.util.Map	find(java.lang.String type, java.lang.String query, java.util.Map parameters) Used to implement querying behaviour to the SCS implementation.
WGACLCore	getACL() Retrieves the ACL if implementation supports WGDatabase.FEATURE_ACL_MANAGEABLE
java.util.List	getAllContent(WGStructEntry structEntry, boolean includeArchived) Retrieves a list of all content unter the specified struct entry.
java.util.List	getAllContentKeys(boolean includeArchived) Retrieves all content keys of all contents in this database as list.
java.lang.Class[]	getAllowedCredentialClasses()
java.util.Iterator<WGDocumentCore>	getChildEntries(WGStructEntry structEntry, WGPageOrderSet order) Retrieves all child struct entries for the provided struct entry.
abstract java.lang.Object	getContent(java.lang.String folder, java.lang.Object key) Implement to retrieve a single data object by key information.
WGDocumentCore	getContentByKey(WGContentKey key) Retrieves the content for the provided content key.
WGDocumentCore	getContentByName(java.lang.String strName, java.lang.String strLanguage) Retrieves a content by it's unique name for the given language.
int	getContentCount(WGStructEntry entry) Returns the number of total contents on this struct entry, including those that are not visible to the user.
int	getContentStorePatchLevel() Returns the patch level of the storage format of this WGA Content Store.
double	getContentStoreVersion() Returns the version of WGA Content Store that this backend represents.
java.lang.Class	getDedicatedWorkflowEngine() Retrieves the class of a dedicated workflow engine for this implementation.
java.util.Set	getDeletions(java.util.Set contentKeys)
WGDocumentCore	getDesignObject(int type, java.lang.String name, java.lang.String strMediaKey) Retrieves a design object by it's doc class and unique name.
java.util.List	getDesignObjects(int type) Retrieves all design objects of the given doc class.
WGDocumentCore	getDummyContent(java.lang.String language) Creates a "dummy content" object, that is used, when rendering WebTML without a content context.
java.lang.Object	getExtensionData(java.lang.String name) Retrieves the value of an extension data field stored in this database.
java.util.List<java.lang.String>	getExtensionDataNames() Retrieves names of all extension data fields stored in this database.
abstract java.lang.String[]	getFolders() Implement to return the available folders
java.util.List<WGRelationData>	getIncomingRelations(java.lang.Object structKey, java.lang.String language, java.lang.String contentClass, java.lang.String relName, java.lang.String relGroupName, java.lang.Boolean includeUnreleased, WGColumnSet order) Must Return the relations that point to the given released content document
abstract java.util.Date	getLastModified() Implement to return a last modified date.
java.lang.Object	getNativeObject() Retrieves the native backend object for this database if there is any.
WGDocumentCore	getParentEntry(WGStructEntry entry) Retrieves the parent struct enty for the given entry.
java.util.Date	getRevision() Returns an revision indicator of the last change done to this database This may be a anything that indicates the revision of the current database, like some java.util.Date or a sequence number.
java.util.Date	getRevisionDate(java.lang.Comparable lastChanged) Returns a date object corresponding to the given revision indicator Use this method to get concrete dates for the revisions returned by WGDatabaseCore.getRevision().
java.util.List	getRoles() Returns the roles that this database complies.
java.util.Iterator<WGDocumentCore>	getRootEntries(WGArea area, WGPageOrderSet pageOrder) Retrieves the root entries (i.e. entries without parents) of the given area.
ContentSourceSpecs	getSpecs() Returns the specs that the init-Method returned for this SCS implementation.
WGDocumentCore	getStructEntryByKey(java.lang.Object key) Retrieves a struct entry for the given struct key
WGDocumentCore	getStructEntryByName(java.lang.String strName) Returns a struct entry by it's unique name
abstract java.lang.String	getTitle() Retrieves a descriptive database title.
abstract java.lang.String	getTypeName() Returns a description of this core implementation type.
java.util.List	getUpdatedDocumentsSince(java.util.Date cutoff)
java.util.List	getUpdateLogs(java.lang.Comparable cutoff) Retrieves list of update logs - i.e. the operations done on documents - since a cutoff revision in ascending order of operation times.
WGDocumentCore	getUserProfile(java.lang.String name)
boolean	hasFeature(java.lang.String feature) Returns information on specific features, that this database implements.
abstract ContentSourceSpecs	init(WGDatabase db, java.lang.String path) Implement to initialize the SCS implementation when the database gets opened.
abstract boolean	insertContent(java.lang.String folder, java.lang.Object key, java.lang.Object bean) Implement functionality to insert a new data object to a folder
boolean	isBackendServiceSupported(java.lang.String serviceName) Returns if a backend service is supported
boolean	isContentTypeUsed(WGContentType ct) Tests if the given content type is still in usage, i.e. if there are struct entries referencing it
boolean	isLanguageUsed(WGLanguage lang) Tests if the given language is still in usage, i.e. if there are contents referencing it
boolean	isMemberOfUserList(java.util.List userList) Determines if the currently logged in user is a member of the given user/group/role list.
abstract int	login(java.lang.String user, java.lang.String pwd) Implement to specify login behaviour for users opening single sessions.
abstract void	logout() Called when a user session is closed to cleanup resources of it
boolean	moveStructEntry(WGStructEntry entry, WGDocument newParent) Moves a struct entry to a new parent document, either another struct entry of an area.
WGUserAccess	open(WGDatabase db, java.lang.String path, java.lang.String user, java.lang.String pwd, boolean prepareOnly) Opens a database initially.
WGUserAccess	openSession(AuthenticationSession authSession, java.lang.Object pwd, boolean master) Opens a session for the given user/thread.
java.lang.Object	parseStructKey(java.lang.String key) Parses the string representation of a struct key (as used in URLs) to the implementation specific format.
WGResultSetCore	query(java.lang.String type, java.lang.String query, java.util.Map parameters) Queries the database for content.
java.util.List	queryUserProfileNames(java.lang.String type, java.lang.String query, java.util.Map params)
void	refresh() Is called when a database refresh is performed The core should perform necessary cleanups of cached data and held resources If the database supports WGAPI transactions it should reduce the impact of this method to the current session while in a transaction
abstract void	removeContent(java.lang.String folder, java.lang.Object key) Implement behaviour to remove a data object from a folder
void	removeExtensionData(java.lang.String name) Removes an extension data field from this database
boolean	resultIsFalse(java.lang.Object result, WGDocument doc) Tests, if an native expression result equals false in the native expression language.
boolean	resultIsTrue(java.lang.Object result, WGDocument doc) Tests, if an native expression result equals true in the native expression language.
boolean	rollbackTransaction() Called when a started transaction should be rolled back.
void	setCurrentSession(WGSessionContext context) Method to inject the current session context to the core.
abstract boolean	updateContent(java.lang.String folder, java.lang.Object key, java.lang.Object bean) Implement behaviour to update the database backend with new data for a data object
void	writeExtensionData(java.lang.String name, java.lang.Object value) Writes an extension data field to in this database.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.innovationgate.webgate.api.WGDatabaseCore

getServerName

Field Detail

DUMMY_AREA

public static final java.lang.String DUMMY_AREA

See Also:

Constant Field Values

COPTION_LANGUAGE

public static final java.lang.String COPTION_LANGUAGE

See Also:

Constant Field Values

Constructor Detail

SimpleContentSource

public SimpleContentSource()

Method Detail

open

public WGUserAccess open(WGDatabase db,
                java.lang.String path,
                java.lang.String user,
                java.lang.String pwd,
                boolean prepareOnly)
                  throws WGAPIException

Description copied from interface: WGDatabaseCore

Opens a database initially. It is ensured, that this method is to be called before any work on this database core is done. The implementation should also open a database session implicitly.

Specified by:

open in interface WGDatabaseCore

Parameters:

db - The WGDatabase object, that will wrap this database core.

path - The path of the database, that should be opened. Interpretation of the path is up to the specific database core

user - The user name for opening the initial session.

pwd - The password for the given username

prepareOnly - Flag if the database should only be prepared for opening

Returns:

The access level for the opened database under the current user session. Use constants WGDatabase.ACCESSLEVEL_.... as return. Return WGDatabase.ACCESSLEVEL_NOTLOGGEDIN, if the opening failed due to wrong path information or login.

Throws:

WGAPIException

openSession

public WGUserAccess openSession(AuthenticationSession authSession,
                       java.lang.Object pwd,
                       boolean master)
                         throws WGAPIException

Description copied from interface: WGDatabaseCore

Opens a session for the given user/thread. Sessions are specific to single java threads and cannot be used across threads. It is ensured, that this method is to be called after each call of closeSession, before work on this database core starts again in the current thread.

Specified by:

openSession in interface WGDatabaseCore

Parameters:

authSession - The authentication session of the current user. If there is no authentication module configured this is of type BackendAuthSession

pwd - The credentials that the user gave for authenticating

master - States, that the used login is the master login

Returns:

The access object, containing the access level of the current user session. Use constants WGDatabase.ACCESSLEVEL_.... as return. Returns WGDatabase.ACCESSLEVEL_NOTLOGGEDIN, if the opening failed due to wrong login.

Throws:

WGAPIException

login

public abstract int login(java.lang.String user,
        java.lang.String pwd)
                   throws WGAPIException

Implement to specify login behaviour for users opening single sessions.

Parameters:

user - login username

pwd - login password

Returns:

A constant WGDatabase.ACCESSLEVEL_... to determine what access the user has on the database, WGDatabase.ACCESSLEVEL_NOTLOGGEDIN if the login should fail

Throws:

WGAPIException

logout

public abstract void logout()
                     throws WGAPIException

Called when a user session is closed to cleanup resources of it

Throws:

WGAPIException

close

public void close()
           throws WGAPIException

Description copied from interface: WGDatabaseCore

Called when a database implementation is completely closed and all cached data of it is dropped. Should release all resources.

Specified by:

close in interface WGDatabaseCore

Throws:

WGAPIException

closeSession

public void closeSession()
                  throws WGAPIException

Description copied from interface: WGDatabaseCore

Called when a database session is closed, i.e. the current thread/user stops working with this database for the logged in user.

Specified by:

closeSession in interface WGDatabaseCore

Throws:

WGAPIException

getTitle

public abstract java.lang.String getTitle()
                                   throws WGBackendException

Description copied from interface: WGDatabaseCore

Retrieves a descriptive database title.

Specified by:

getTitle in interface WGDatabaseCore

Returns:

String

Throws:

WGBackendException

getTypeName

public abstract java.lang.String getTypeName()

Description copied from interface: WGDatabaseCore

Returns a description of this core implementation type. Normally in format "dbplatform/dbdesign/furtherInfos/..."

Specified by:

getTypeName in interface WGDatabaseCore

Returns:

The implementation description

getRevision

public java.util.Date getRevision()
                           throws WGAPIException

Description copied from interface: WGDatabaseCore

Returns an revision indicator of the last change done to this database This may be a anything that indicates the revision of the current database, like some java.util.Date or a sequence number. If the database implementation does not maintain such a date, it should return the creation date of the database. In that case the change dates of the documents are used to control cache dropping.

Specified by:

getRevision in interface WGDatabaseCore

Returns:

Date

Throws:

WGAPIException

getExtensionData

public java.lang.Object getExtensionData(java.lang.String name)
                                  throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves the value of an extension data field stored in this database. This feature is only available in WGA Content Stores of Version 5 or higher.

Specified by:

getExtensionData in interface WGDatabaseCore

Parameters:

name - The name of the field.

Returns:

The value of the requested field for this database core.

Throws:

WGAPIException

writeExtensionData

public void writeExtensionData(java.lang.String name,
                      java.lang.Object value)
                        throws WGAPIException

Description copied from interface: WGDatabaseCore

Writes an extension data field to in this database. This writes a custom data value to the database. The value is immediately stored. This feature is only available in WGA Content Stores of Version 5 or higher.

Specified by:

writeExtensionData in interface WGDatabaseCore

Parameters:

name - The name of the field.

value - The value to store

Throws:

WGAPIException

getRoles

public java.util.List getRoles()

Description copied from interface: WGDatabaseCore

Returns the roles that this database complies. Based on this information, the WGAPI decides, which methods can be called on this database core.

Specified by:

getRoles in interface WGDatabaseCore

Returns:

A list containing the constants WGDatabase.ROLE_.... for the roles, that this database complies.

hasFeature

public boolean hasFeature(java.lang.String feature)

Description copied from interface: WGDatabaseCore

Returns information on specific features, that this database implements.

Specified by:

hasFeature in interface WGDatabaseCore

Parameters:

feature - The requested feature. The constants WGDatabase.FEATURE_... are used here.

Returns:

true, if this feature is implemented

getChildEntries

public java.util.Iterator<WGDocumentCore> getChildEntries(WGStructEntry structEntry,
                                                 WGPageOrderSet order)
                                                   throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves all child struct entries for the provided struct entry.

Specified by:

getChildEntries in interface WGDatabaseCore

Parameters:

structEntry - The struct entry, whose children are to be retrieved

order - Instructions about the desired order

Returns:

An iterator of all child entries, ordered by their intended default order

Throws:

WGAPIException

getRootEntries

public java.util.Iterator<WGDocumentCore> getRootEntries(WGArea area,
                                                WGPageOrderSet pageOrder)
                                                  throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves the root entries (i.e. entries without parents) of the given area.

Specified by:

getRootEntries in interface WGDatabaseCore

Parameters:

area - The area, whose root entries are to be retrieved

pageOrder - Order set denoting the order in which entries should be served, null for default order (position, title, both ascending)

Returns:

An iterator of root entries in their intended default order

Throws:

WGAPIException

getStructEntryByKey

public WGDocumentCore getStructEntryByKey(java.lang.Object key)
                                   throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves a struct entry for the given struct key

Specified by:

getStructEntryByKey in interface WGDatabaseCore

Returns:

The struct entry of that key. Null if no struct entry has this key.

Throws:

WGAPIException

getParentEntry

public WGDocumentCore getParentEntry(WGStructEntry entry)
                              throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves the parent struct enty for the given entry.

Specified by:

getParentEntry in interface WGDatabaseCore

Parameters:

entry - The struct entry, whose parent is to be retrieved

Returns:

The parent entry. Null if the parameter entry is a root entry and therefor has no parent.

Throws:

WGAPIException

getAllContent

public java.util.List getAllContent(WGStructEntry structEntry,
                           boolean includeArchived)
                             throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves a list of all content unter the specified struct entry.

Specified by:

getAllContent in interface WGDatabaseCore

Parameters:

structEntry - The struct entry, whose content is to be retrieved.

includeArchived - Decides, if archived documents should be also retrieved

Returns:

An unordered list of all content for this struct entry. An empty list, if there is no content for this struct entry.

Throws:

WGAPIException

getContentByKey

public WGDocumentCore getContentByKey(WGContentKey key)
                               throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves the content for the provided content key. If the version of the content key is 0 then the released content of the given struct and language must be retrieved.

Specified by:

getContentByKey in interface WGDatabaseCore

Parameters:

key - The content key

Returns:

The retrieved content. Null, if there is no content for this key.

Throws:

WGAPIException

getContentByName

public WGDocumentCore getContentByName(java.lang.String strName,
                              java.lang.String strLanguage)
                                throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves a content by it's unique name for the given language. If language is null, the default language of the content store is used.

Specified by:

getContentByName in interface WGDatabaseCore

Parameters:

strName - The unique name

strLanguage - The language name (i.e. short code). If null, the default language of the content store is to be used.

Returns:

The retrieved content for this name. Null if there is no content with this unique name.

Throws:

WGAPIException

getDummyContent

public WGDocumentCore getDummyContent(java.lang.String language)
                               throws WGAPIException

Description copied from interface: WGDatabaseCore

Creates a "dummy content" object, that is used, when rendering WebTML without a content context. May return the "fake" document core implementation, if no native expression language is needed.

Specified by:

getDummyContent in interface WGDatabaseCore

Returns:

WGDocumentCore

Throws:

WGAPIException

query

public WGResultSetCore query(java.lang.String type,
                    java.lang.String query,
                    java.util.Map parameters)
                      throws WGAPIException

Description copied from interface: WGDatabaseCore

Queries the database for content. For full content store implementations: The native query implementation should itself enforce the query option WGDatabase.QUERYOPTION_ENHANCE, if set as parameter, regarding the following field: - "ishiddenfrom" regarding the role given as query option WGDatabase.QUERYOPTION_ROLE It might choose to enforce more visibility fields to optimize performance, but is not obliged to do so.

Specified by:

query in interface WGDatabaseCore

Parameters:

type - Type of query. Interpretation is up to the specific core implementation.

query - The query

parameters - Query options as Map influencing the query result. See WGDatabase.QUERYOPTION_... for options keys.

Returns:

WGResultSetCore The result set of this query as a specific WGResultSetCore implementation containing content.

Throws:

WGAPIException

extractFolder

public java.lang.String extractFolder(java.lang.String type,
                             java.lang.String query,
                             java.util.Map parameters)
                               throws WGAPIException

Helps to retrieve the folder for query results based on the given query parameters. Base implementation returns null = the folder is the type of the query. Should be overwritten if this is different.

Parameters:

type - The query type used for the query

query - The query itself

parameters - The parameters given to the query

Returns:

The folder name if it is retrievable, null otherwise.

Throws:

WGAPIException

getDesignObjects

public java.util.List getDesignObjects(int type)
                                throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves all design objects of the given doc class.

Specified by:

getDesignObjects in interface WGDatabaseCore

Parameters:

type - The doc class. See constants WGDocument.FDC_...

Returns:

An unordered list of all design objects for this doc class. An empty list if there are no design objects of that class.

Throws:

WGAPIException

getDesignObject

public WGDocumentCore getDesignObject(int type,
                             java.lang.String name,
                             java.lang.String strMediaKey)
                               throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves a design object by it's doc class and unique name.

Specified by:

getDesignObject in interface WGDatabaseCore

Parameters:

type - The doc class of the design object. See Constants under WGDocument.FDC_...

name - The unique name of the design

strMediaKey - For media key specific design objects (e.g. WebTML-Modules), the media key of the design object to be retrieved

Returns:

The retrieved design object.

Throws:

WGAPIException

getUserProfile

public WGDocumentCore getUserProfile(java.lang.String name)
                              throws WGAPIException

Throws:

WGAPIException

createUserProfile

public WGDocumentCore createUserProfile(java.lang.String name,
                               int type)
                                 throws WGAPIException

Throws:

WGAPIException

fastAccess

public WGDocumentCore fastAccess(int type,
                        java.lang.Object key)
                          throws WGAPIException

Description copied from interface: WGDatabaseCore

Called for fast re-retrieval of a document core, if that core on first instantiation specified a fast access key.

Specified by:

fastAccess in interface WGDatabaseCore

key - The fast access key, that the document core provided, when it was instantiated the first time.

Returns:

Another instance of the document core for this fast access key. Null, if none could be retrieved.

Throws:

WGAPIException

parseStructKey

public java.lang.Object parseStructKey(java.lang.String key)
                                throws WGAPIException

Description copied from interface: WGDatabaseCore

Parses the string representation of a struct key (as used in URLs) to the implementation specific format.

Specified by:

parseStructKey in interface WGDatabaseCore

Parameters:

key - The string representation of the struct key

Returns:

The struct key object to be used with this implementation.

Throws:

WGAPIException

convertToKey

public abstract java.lang.Object convertToKey(java.lang.String key,
                            java.lang.String folder)
                                       throws WGAPIException

Converts the string representation of a data key to it's real data type.

Parameters:

key - The string representatino of the data key

folder - The folder of the data key

Returns:

The converted data key in it's original data type.

Throws:

WGAPIException

cleanup

public void cleanup()

createDesignDocument

public WGDocumentCore createDesignDocument(int type,
                                  java.lang.String name,
                                  java.lang.String mediaKey)
                                    throws WGAPIException

Description copied from interface: WGDatabaseCore

Create a design document of the given type and keys.

Specified by:

createDesignDocument in interface WGDatabaseCore

Parameters:

type - Design document type. Use constants WGDocument.TYPE_...

name - Unique name of design object. Use only A-Z,a-z,0-9 and _

mediaKey - Media key, if the document type is a TML module

Returns:

The new created design document

Throws:

WGAPIException

createStructEntry

public WGDocumentCore createStructEntry(java.lang.Object key,
                               WGDocument reference,
                               WGContentType contentType)
                                 throws WGAPIException

Description copied from interface: WGDatabaseCore

Creates a struct entry.

Specified by:

createStructEntry in interface WGDatabaseCore

Parameters:

key - Key of the struct entry if the implementation supports using explicit keys. Leave null otherwise.

reference - Reference document, which can be an WGArea (struct will be root in this area) or another WGStructEntry (struct will be child of that)

contentType - Content type for this struct entry

Returns:

The newly created struct entry

Throws:

WGAPIException

createContent

public WGDocumentCore createContent(WGStructEntry structEntry,
                           WGLanguage language,
                           java.lang.String title,
                           int version)
                             throws WGAPIException

Description copied from interface: WGDatabaseCore

Called to create a content document. Usage of parameters may vary according to the subset of WGA features implemented by this database core

Specified by:

createContent in interface WGDatabaseCore

Parameters:

structEntry - The structentry for the content

language - The language of the content

title - The title of the content

version - The version of the content if this should explicitly be set (only in clone creation!). Leave null for normal creation.

Returns:

The newly created content object.

Throws:

WGAPIException

getDedicatedWorkflowEngine

public java.lang.Class getDedicatedWorkflowEngine()

Description copied from interface: WGDatabaseCore

Retrieves the class of a dedicated workflow engine for this implementation. Return null to use the default engine of the runtime.

Specified by:

getDedicatedWorkflowEngine in interface WGDatabaseCore

isMemberOfUserList

public boolean isMemberOfUserList(java.util.List userList)
                           throws WGAPIException

Description copied from interface: WGDatabaseCore

Determines if the currently logged in user is a member of the given user/group/role list.

Specified by:

isMemberOfUserList in interface WGDatabaseCore

Returns:

true if so, false otherwise.

Throws:

WGAPIException

createCopy

public WGDocumentCore createCopy(WGDocumentCore original)
                          throws WGAPIException

Description copied from interface: WGDatabaseCore

Create a copy of the given doc core. Optional feature needed for methods WGDatabase.createDraftCopy and WGDatabase.createCopy

Specified by:

createCopy in interface WGDatabaseCore

Returns:

The copy.

Throws:

WGAPIException

beginTransaction

public boolean beginTransaction()

Description copied from interface: WGDatabaseCore

Called when a transaction should begin. Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.

Specified by:

beginTransaction in interface WGDatabaseCore

Returns:

true, if the operation succeeded, false otherwise

rollbackTransaction

public boolean rollbackTransaction()

Description copied from interface: WGDatabaseCore

Called when a started transaction should be rolled back. Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.

Specified by:

rollbackTransaction in interface WGDatabaseCore

commitTransaction

public boolean commitTransaction()

Description copied from interface: WGDatabaseCore

Called when a running transaction should get submitted Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.

Specified by:

commitTransaction in interface WGDatabaseCore

Returns:

true, if the operation succeeded, false otherwise

getContent

public abstract java.lang.Object getContent(java.lang.String folder,
                          java.lang.Object key)
                                     throws WGAPIException

Implement to retrieve a single data object by key information. This gets called by lazy data fetching, when result maps contain only keys but no data objects.

Parameters:

folder - The folder of the object

key - The data key of the object

Returns:

The data object if there is any under this key, null otherwise

Throws:

WGAPIException

insertContent

public abstract boolean insertContent(java.lang.String folder,
                    java.lang.Object key,
                    java.lang.Object bean)
                               throws WGAPIException

Implement functionality to insert a new data object to a folder

Parameters:

folder - The folder to insert this data object

key - The key for this data object. You may ignore this if this SCS implementation generates it's own keys.

bean - The data object to store

Returns:

true, if insertion succeeded, false otherwise

Throws:

WGAPIException

updateContent

public abstract boolean updateContent(java.lang.String folder,
                    java.lang.Object key,
                    java.lang.Object bean)
                               throws WGAPIException

Implement behaviour to update the database backend with new data for a data object

Parameters:

folder - The folder of the data object

key - The data key of the data object

bean - The data object itself.

Returns:

true, if update succeeded, false otherwise

Throws:

WGAPIException

createContent

public abstract java.lang.Object createContent(java.lang.String folder)
                                        throws WGAPIException

Creates a new content object in the given folder

Parameters:

folder - The folder name to create the content

Returns:

The new content object

Throws:

WGAPIException

find

public abstract java.util.Map find(java.lang.String type,
                 java.lang.String query,
                 java.util.Map parameters)
                            throws WGAPIException

Used to implement querying behaviour to the SCS implementation.

Parameters:

type - The query type (which by default should be the folder at which the query is directed)

query - The query

parameters - Query parameters. Map keys are Constants WGDatabase.QUERYOPTION_...

Returns:

A map containing the results. Map keys should be data keys. Map values should be data objects or null to use lazy retrieval

Throws:

WGAPIException

getLastModified

public abstract java.util.Date getLastModified()
                                        throws WGAPIException

Implement to return a last modified date. May return null if this feature is not supported by this SCS implementation.

Throws:

WGAPIException

removeContent

public abstract void removeContent(java.lang.String folder,
                 java.lang.Object key)
                            throws WGAPIException

Implement behaviour to remove a data object from a folder

Parameters:

folder - Folder of the data object

key - Key of the data object

Throws:

WGAPIException

init

public abstract ContentSourceSpecs init(WGDatabase db,
                      java.lang.String path)
                                 throws WGAPIException

Implement to initialize the SCS implementation when the database gets opened.

Parameters:

db - The WGAPI database object, that will represent this SCS implementation

path - The database path

Returns:

Specs of this implementation, telling the template what features will get used

Throws:

WGAPIException

destroy

public abstract void destroy()

Callback method, that gets called when the SCS is closed completely.

getFolders

public abstract java.lang.String[] getFolders()
                                       throws WGAPIException

Implement to return the available folders

Returns:

String array of folder names

Throws:

WGAPIException

browse

public abstract java.util.Map browse(java.lang.String folder)
                              throws WGAPIException

Browses the given folder for contents.

Parameters:

folder - The folder name

Returns:

A map of data objects. Use data keys as Map keys. Use data objects as Map values or leave values null to use lazy fetching behaviour.

Throws:

WGAPIException

getSpecs

public ContentSourceSpecs getSpecs()

Returns the specs that the init-Method returned for this SCS implementation.

execProcedure

public java.lang.Object execProcedure(java.lang.String procName,
                             java.util.List args)
                               throws WGProcedureException,
                                      WGBackendException

Throws:

WGProcedureException

WGBackendException

resultIsTrue

public boolean resultIsTrue(java.lang.Object result,
                   WGDocument doc)

Description copied from interface: WGDatabaseCore

Tests, if an native expression result equals true in the native expression language.

Specified by:

resultIsTrue in interface WGDatabaseCore

Parameters:

result - The expression result, retrieved by a call to evaluateExpression

doc - The document, against which the expression was evaluated

Returns:

boolean

resultIsFalse

public boolean resultIsFalse(java.lang.Object result,
                    WGDocument doc)

Description copied from interface: WGDatabaseCore

Tests, if an native expression result equals false in the native expression language.

Specified by:

resultIsFalse in interface WGDatabaseCore

Parameters:

result - The expression result, retrieved by a call to evaluateExpression

doc - The document, against which the expression was evaluated

Returns:

boolean

getACL

public WGACLCore getACL()

Description copied from interface: WGDatabaseCore

Retrieves the ACL if implementation supports WGDatabase.FEATURE_ACL_MANAGEABLE

Specified by:

getACL in interface WGDatabaseCore

getNativeObject

public java.lang.Object getNativeObject()
                                 throws WGBackendException

Description copied from interface: WGDatabaseCore

Retrieves the native backend object for this database if there is any.

Specified by:

getNativeObject in interface WGDatabaseCore

Throws:

WGBackendException

createWrapper

public BeanWrapper createWrapper(BeanKey key,
                        java.lang.Object bean,
                        boolean saved)
                          throws WGAPIException

Creates a wrapper for the given content object that implements WGDocumentCore for it

Parameters:

key - The key of the content object

bean - The content object

saved - Boolean showing if the object already has been saved

Returns:

The content wrapper, ready to be used as WGDocumentCore

Throws:

WGAPIException

calculateKey

public java.lang.Object calculateKey(java.lang.String folder,
                            java.lang.Object _bean)
                              throws WGAPIException

Method to calculate the key to a newly created data object. This is necessary to overwrite if the SCS implementation supports calculating keys.

Parameters:

folder - the folder where the data object gets stored

_bean - The data object

Returns:

The calculated key for the data object

Throws:

WGAPIException

refresh

public void refresh()

Description copied from interface: WGDatabaseCore

Is called when a database refresh is performed The core should perform necessary cleanups of cached data and held resources If the database supports WGAPI transactions it should reduce the impact of this method to the current session while in a transaction

Specified by:

refresh in interface WGDatabaseCore

clearSessionCache

public void clearSessionCache()
                       throws WGAPIException

Description copied from interface: WGDatabaseCore

Is called when the cache of the current WGAPI session is cleared. Should therefor clear all cached data and held resources for the current session. This may throw away make unsaved changes to backend classes.

Specified by:

clearSessionCache in interface WGDatabaseCore

Throws:

WGClosedSessionException - If currently no session is open

WGAPIException

getUpdatedDocumentsSince

public java.util.List getUpdatedDocumentsSince(java.util.Date cutoff)
                                        throws WGAPIException

Throws:

WGAPIException

moveStructEntry

public boolean moveStructEntry(WGStructEntry entry,
                      WGDocument newParent)
                        throws WGAPIException

Description copied from interface: WGDatabaseCore

Moves a struct entry to a new parent document, either another struct entry of an area. May return false if this operation is not supported.

Specified by:

moveStructEntry in interface WGDatabaseCore

Parameters:

entry - The entry to move

newParent - The new parent document, which can be either an WGStructEntry or a WGArea object

Returns:

true if the operation succeeded, false if it is not supported by this WGAPI implementation.

Throws:

WGAPIException

getContentCount

public int getContentCount(WGStructEntry entry)
                    throws WGBackendException

Description copied from interface: WGDatabaseCore

Returns the number of total contents on this struct entry, including those that are not visible to the user. This is helpful to determine if there are contents unknown to the current user, which may prevent some operations like deletions

Specified by:

getContentCount in interface WGDatabaseCore

Parameters:

entry - The entry to test

Returns:

true if there are contents, false otherwise

Throws:

WGNotSupportedException - If the database implementation does not support this operation

WGBackendException - On all other backend related errors

setCurrentSession

public void setCurrentSession(WGSessionContext context)

Description copied from interface: WGDatabaseCore

Method to inject the current session context to the core. This gives the core the ability to associate internal threadlocal resources to the corresponding session context.

Specified by:

setCurrentSession in interface WGDatabaseCore

convertFileNameForAttaching

public java.lang.String convertFileNameForAttaching(java.lang.String name)

Description copied from interface: WGDatabaseCore

Returns a file name like it would be converted when a file of this name got attached to a document. WGAPI implementations are allowed to convert the name of an attached file in some ways, e.g. convert the name to lowercase or replace some unallowed characters. This method is used to convert names of files to attach before they are attached. It can also be used to test attaching behaviour. Implementations that do not support file attaching should return null here.

Specified by:

convertFileNameForAttaching in interface WGDatabaseCore

getAllowedCredentialClasses

public java.lang.Class[] getAllowedCredentialClasses()

queryUserProfileNames

public java.util.List queryUserProfileNames(java.lang.String type,
                                   java.lang.String query,
                                   java.util.Map params)
                                     throws WGAPIException

Throws:

WGAPIException

getDeletions

public java.util.Set getDeletions(java.util.Set contentKeys)
                           throws WGAPIException

Throws:

WGAPIException

getAllContentKeys

public java.util.List getAllContentKeys(boolean includeArchived)
                                 throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves all content keys of all contents in this database as list. Optional feature. Implementations that do not implement this method shoud return false on hasFeature(WGDatabase.FEATURE_RETRIEVE_ALL_CONTENTKEYS).

Specified by:

getAllContentKeys in interface WGDatabaseCore

Parameters:

includeArchived - Specifies if archived content should be included in the list

Returns:

A list of objects #WGContentKey

Throws:

WGAPIException

beginUpdate

public void beginUpdate()

Description copied from interface: WGDatabaseCore

Notifies the backend database that the session will update data from now on. This is only neccessary in cluster environments when the underlying database connections are kept "readOnly" until a real update happens.

Specified by:

beginUpdate in interface WGDatabaseCore

getStructEntryByName

public WGDocumentCore getStructEntryByName(java.lang.String strName)
                                    throws WGAPIException

Description copied from interface: WGDatabaseCore

Returns a struct entry by it's unique name

Specified by:

getStructEntryByName in interface WGDatabaseCore

Parameters:

strName - The unique name

Returns:

A struct entry of that name or null

Throws:

WGAPIException

getRevisionDate

public java.util.Date getRevisionDate(java.lang.Comparable lastChanged)
                               throws WGAPIException,
                                      WGWrongRevisionException

Description copied from interface: WGDatabaseCore

Returns a date object corresponding to the given revision indicator Use this method to get concrete dates for the revisions returned by WGDatabaseCore.getRevision(). This method is obliged to throw a WGWrongRevisionException if the revision type does not match this database of the given revision is not known.

Specified by:

getRevisionDate in interface WGDatabaseCore

Parameters:

lastChanged - A revision indicator returned by WGDatabaseCore.getRevision()

Returns:

A date

Throws:

WGAPIException

WGWrongRevisionException - if the given revision is no revision of the current database

getUpdateLogs

public java.util.List getUpdateLogs(java.lang.Comparable cutoff)
                             throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves list of update logs - i.e. the operations done on documents - since a cutoff revision in ascending order of operation times. Needed if database supports WGDatabase.FEATURE_FIND_UPDATED_DOCS.

Specified by:

getUpdateLogs in interface WGDatabaseCore

Returns:

List of objects of type WGUpdateLog

Throws:

WGAPIException

getContentStoreVersion

public double getContentStoreVersion()
                              throws WGAPIException

Description copied from interface: WGDatabaseCore

Returns the version of WGA Content Store that this backend represents. The features available for this database are dependent on the content store version. This method returns values of constants WGDatabase.CSVERSION_...

Specified by:

getContentStoreVersion in interface WGDatabaseCore

Throws:

WGAPIException

getContentStorePatchLevel

public int getContentStorePatchLevel()
                              throws WGAPIException

Description copied from interface: WGDatabaseCore

Returns the patch level of the storage format of this WGA Content Store. Databases not representing content stores and not offering automatic patching should return 0.

Specified by:

getContentStorePatchLevel in interface WGDatabaseCore

Throws:

WGAPIException

removeExtensionData

public void removeExtensionData(java.lang.String name)
                         throws WGAPIException

Description copied from interface: WGDatabaseCore

Removes an extension data field from this database

Specified by:

removeExtensionData in interface WGDatabaseCore

Parameters:

name - The name of the field to remove

Throws:

WGAPIException

getExtensionDataNames

public java.util.List<java.lang.String> getExtensionDataNames()
                                                       throws WGAPIException

Description copied from interface: WGDatabaseCore

Retrieves names of all extension data fields stored in this database. This feature is only available in WGA Content Stores of Version 5 or higer.

Specified by:

getExtensionDataNames in interface WGDatabaseCore

Returns:

List of field names

Throws:

WGAPIException

getIncomingRelations

public java.util.List<WGRelationData> getIncomingRelations(java.lang.Object structKey,
                                                  java.lang.String language,
                                                  java.lang.String contentClass,
                                                  java.lang.String relName,
                                                  java.lang.String relGroupName,
                                                  java.lang.Boolean includeUnreleased,
                                                  WGColumnSet order)
                                                    throws WGAPIException

Description copied from interface: WGDatabaseCore

Must Return the relations that point to the given released content document

Specified by:

getIncomingRelations in interface WGDatabaseCore

Parameters:

structKey - The structkey of the content

language - The language of the content

contentClass - content class of the content owning the relation. null for contents of all content classes

relName - Name of the relation coming in. null should retrieve relations of all names

relGroupName - Group name of the relation coming in. null should retrieve relations of all groups

includeUnreleased - Specify true to also retrieve documents in draft or approval state. False will retrieve only published documents.

order - Optionally order in which to return relations, evaluated against the relation source documents, null for no order

Returns:

List of incoming relations in no particular order

Throws:

WGAPIException

isContentTypeUsed

public boolean isContentTypeUsed(WGContentType ct)
                          throws WGAPIException

Description copied from interface: WGDatabaseCore

Tests if the given content type is still in usage, i.e. if there are struct entries referencing it

Specified by:

isContentTypeUsed in interface WGDatabaseCore

Parameters:

ct - The content type to test

Returns:

true if the content type is in usage, false if not

Throws:

WGAPIException

isLanguageUsed

public boolean isLanguageUsed(WGLanguage lang)
                       throws WGAPIException

Description copied from interface: WGDatabaseCore

Tests if the given language is still in usage, i.e. if there are contents referencing it

Specified by:

isLanguageUsed in interface WGDatabaseCore

Parameters:

lang - The language to test

Returns:

true if the language is in usage, false if not

Throws:

WGAPIException

isBackendServiceSupported

public boolean isBackendServiceSupported(java.lang.String serviceName)

Description copied from interface: WGDatabaseCore

Returns if a backend service is supported

Specified by:

isBackendServiceSupported in interface WGDatabaseCore

Parameters:

serviceName - Name of the service

callBackendService

public java.lang.Object callBackendService(java.lang.String serviceName,
                                  java.lang.Object[] params)
                                    throws WGAPIException

Description copied from interface: WGDatabaseCore

Calls a backend service whose support is optional. Should throw WGNotSupportedException if the backend service is not supported.

Specified by:

callBackendService in interface WGDatabaseCore

Parameters:

serviceName - The service name. Use WGDatabase.BACKENDSERVICE_*

params - The matching parameters for the called service

Returns:

An optional return value of the service

Throws:

WGAPIException