public class BeanAdapter extends SimpleContentSource
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPTION_BEAN_JARFILE |
static java.lang.String |
COPTION_CREATION_HANDLER |
static java.lang.String |
COPTION_ONE_BEAN_PER |
static java.lang.String |
COPTION_ONE_BEAN_PER_DB |
static java.lang.String |
COPTION_ONE_BEAN_PER_REQUEST |
static java.lang.String |
COPTION_ONE_BEAN_PER_USER |
static int |
ONE_BEAN_PER_DB |
static int |
ONE_BEAN_PER_REQUEST |
static int |
ONE_BEAN_PER_USER |
static java.lang.String |
USER_BEAN |
COPTION_LANGUAGE, DUMMY_AREA
Constructor and Description |
---|
BeanAdapter() |
Modifier and Type | Method and Description |
---|---|
java.util.Map |
browse(java.lang.String folder)
Browses the given folder for contents.
|
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.
|
java.lang.Object |
createContent(java.lang.String folder)
Creates a new content object in the given folder
|
void |
destroy()
Callback method, that gets called when the SCS is closed completely.
|
java.util.Map |
find(java.lang.String folder,
java.lang.String query,
java.util.Map parameters)
Used to implement querying behaviour to the SCS implementation.
|
java.lang.Object |
getContent(java.lang.String folder,
java.lang.Object key)
Implement to retrieve a single data object by key information.
|
java.util.Date |
getCreated() |
WGDatabase |
getDB() |
WGDocumentCore |
getDummyContent(java.lang.String language)
Creates a "dummy content" object, that is used, when rendering WebTML without a content context.
|
java.lang.String[] |
getFolders()
Implement to return the available folders
|
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.
|
java.lang.String |
getServerName()
Returns the name of the server for the backend database (if there is one)
|
java.lang.String |
getTitle()
Retrieves a descriptive database title.
|
java.lang.String |
getTypeName()
Returns a description of this core implementation type.
|
ContentSourceSpecs |
init(WGDatabase db,
java.lang.String path)
Implement to initialize the SCS implementation when the database gets opened.
|
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
|
int |
login(java.lang.String user,
java.lang.String pwd)
Implement to specify login behaviour for users opening single sessions.
|
void |
logout()
Called when a user session is closed to cleanup resources of it
|
void |
removeContent(java.lang.String folder,
java.lang.Object key)
Implement behaviour to remove a data object from a folder
|
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
|
beginTransaction, beginUpdate, calculateKey, callBackendService, cleanup, clearSessionCache, close, closeSession, commitTransaction, convertFileNameForAttaching, createContent, createCopy, createDesignDocument, createStructEntry, createUserProfile, createWrapper, execProcedure, extractFolder, fastAccess, getACL, getAllContent, getAllContentKeys, getAllowedCredentialClasses, getChildEntries, getContentByKey, getContentByName, getContentCount, getContentStorePatchLevel, getContentStoreVersion, getDedicatedWorkflowEngine, getDeletions, getDesignObject, getDesignObjects, getExtensionData, getExtensionDataNames, getIncomingRelations, getParentEntry, getRevision, getRevisionDate, getRoles, getRootEntries, getSpecs, getStructEntryByKey, getStructEntryByName, getUpdatedDocumentsSince, getUpdateLogs, getUserProfile, hasFeature, isBackendServiceSupported, isContentTypeUsed, isLanguageUsed, isMemberOfUserList, moveStructEntry, open, openSession, parseStructKey, query, queryUserProfileNames, refresh, removeExtensionData, resultIsFalse, resultIsTrue, rollbackTransaction, setCurrentSession, writeExtensionData
public static final java.lang.String USER_BEAN
public static final java.lang.String COPTION_ONE_BEAN_PER
public static final java.lang.String COPTION_ONE_BEAN_PER_REQUEST
public static final java.lang.String COPTION_ONE_BEAN_PER_USER
public static final java.lang.String COPTION_ONE_BEAN_PER_DB
public static final java.lang.String COPTION_CREATION_HANDLER
public static final int ONE_BEAN_PER_REQUEST
public static final int ONE_BEAN_PER_USER
public static final int ONE_BEAN_PER_DB
public static final java.lang.String COPTION_BEAN_JARFILE
public int login(java.lang.String user, java.lang.String pwd) throws WGAPIException
SimpleContentSource
login
in class SimpleContentSource
user
- login usernamepwd
- login passwordWGAPIException
public void logout()
SimpleContentSource
logout
in class SimpleContentSource
public java.lang.String getTitle()
WGDatabaseCore
getTitle
in interface WGDatabaseCore
getTitle
in class SimpleContentSource
public java.lang.String getTypeName()
WGDatabaseCore
getTypeName
in interface WGDatabaseCore
getTypeName
in class SimpleContentSource
public java.util.Date getCreated()
public java.lang.Object convertToKey(java.lang.String key, java.lang.String folder)
SimpleContentSource
convertToKey
in class SimpleContentSource
key
- The string representatino of the data keyfolder
- The folder of the data keypublic java.lang.Object getContent(java.lang.String folder, java.lang.Object key)
SimpleContentSource
getContent
in class SimpleContentSource
folder
- The folder of the objectkey
- The data key of the objectpublic boolean insertContent(java.lang.String folder, java.lang.Object key, java.lang.Object bean)
SimpleContentSource
insertContent
in class SimpleContentSource
folder
- The folder to insert this data objectkey
- The key for this data object. You may ignore this if this SCS implementation generates it's own keys.bean
- The data object to storepublic java.lang.Object createContent(java.lang.String folder)
SimpleContentSource
createContent
in class SimpleContentSource
folder
- The folder name to create the contentpublic java.util.Map find(java.lang.String folder, java.lang.String query, java.util.Map parameters) throws WGQueryException
SimpleContentSource
find
in class SimpleContentSource
folder
- The query type (which by default should be the folder at which the query is directed)query
- The queryparameters
- Query parameters. Map keys are Constants WGDatabase.QUERYOPTION_...WGQueryException
public java.util.Date getLastModified()
SimpleContentSource
getLastModified
in class SimpleContentSource
public void removeContent(java.lang.String folder, java.lang.Object key)
SimpleContentSource
removeContent
in class SimpleContentSource
folder
- Folder of the data objectkey
- Key of the data objectpublic ContentSourceSpecs init(WGDatabase db, java.lang.String path) throws WGInvalidDatabaseException
SimpleContentSource
init
in class SimpleContentSource
db
- The WGAPI database object, that will represent this SCS implementationpath
- The database pathWGInvalidDatabaseException
public void destroy()
SimpleContentSource
destroy
in class SimpleContentSource
public java.lang.String[] getFolders()
SimpleContentSource
getFolders
in class SimpleContentSource
public java.util.Map browse(java.lang.String folder)
SimpleContentSource
browse
in class SimpleContentSource
folder
- The folder namepublic java.lang.String getServerName()
WGDatabaseCore
public WGDocumentCore getDummyContent(java.lang.String language)
WGDatabaseCore
getDummyContent
in interface WGDatabaseCore
getDummyContent
in class SimpleContentSource
public java.lang.Object getNativeObject()
WGDatabaseCore
getNativeObject
in interface WGDatabaseCore
getNativeObject
in class SimpleContentSource
public boolean updateContent(java.lang.String folder, java.lang.Object key, java.lang.Object bean)
SimpleContentSource
updateContent
in class SimpleContentSource
folder
- The folder of the data objectkey
- The data key of the data objectbean
- The data object itself.public WGDatabase getDB()