de.innovationgate.webgate.api

Class WGUserProfile

java.lang.Object

de.innovationgate.webgate.api.WGDocument

de.innovationgate.webgate.api.WGUserProfile

All Implemented Interfaces:

Lockable, MetaInfoProvider, WGExtensionDataContainer, WGFileMetaDataContext

public class WGUserProfile
extends WGDocument

A user profile, used to store information about and from a web user.

Nested Class Summary

Nested classes/interfaces inherited from class de.innovationgate.webgate.api.WGDocument

WGDocument.Cache, WGDocument.FakeMetaDataContext, WGDocument.SaveAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ITEM_WGACREATIONVERSION Item automatically stored on every user profile denoting the WGA version under which this profile was created
static java.lang.String	META_CLIENT
static java.lang.String	META_DBLOGIN
static java.lang.String	META_HITS
static java.lang.String	META_LANGUAGES
static java.lang.String	META_LASTACCESS
static java.lang.String	META_LASTIP
static java.lang.String	META_LASTSESSIONDATE
static java.lang.String	META_LASTSESSIONHITS
static java.lang.String	META_LASTSESSIONID
static java.lang.String	META_NAME
static java.lang.String	META_PASSWORD
static java.lang.String	META_PORTLETITEMSTORAGE
static java.lang.String	META_PORTLETREGISTRY
static java.lang.String	META_PREVIOUSSESSIONDATE
static java.lang.String	META_PREVIOUSSESSIONHITS
static java.lang.String	META_PREVIOUSSESSIONID
static java.lang.String	META_SESSIONS
static java.lang.String	META_TYPE
static MetaInfo	METAINFO_CLIENT
static MetaInfo	METAINFO_DBLOGIN
static MetaInfo	METAINFO_HITS
static MetaInfo	METAINFO_LANGUAGES
static MetaInfo	METAINFO_LASTACCESS
static MetaInfo	METAINFO_LASTIP
static MetaInfo	METAINFO_LASTSESSIONDATE
static MetaInfo	METAINFO_LASTSESSIONHITS
static MetaInfo	METAINFO_LASTSESSIONID
static MetaInfo	METAINFO_NAME
static MetaInfo	METAINFO_PASSWORD
static MetaInfo	METAINFO_PORTLETITEMSTORAGE
static MetaInfo	METAINFO_PORTLETREGISTRY
static MetaInfo	METAINFO_PREVIOUSSESSIONDATE
static MetaInfo	METAINFO_PREVIOUSSESSIONHITS
static MetaInfo	METAINFO_PREVIOUSSESSIONID
static MetaInfo	METAINFO_SESSIONS
static MetaInfo	METAINFO_TYPE
static int	PROFILETYPE_UNDEFINED Value returned by getType() when the type is not determineable

Fields inherited from class de.innovationgate.webgate.api.WGDocument

CSFEATURE_EXTDATA, DERIVATE_NAME_PATTERN, DOCKEY_DIVIDER, EXT_PRIMARY_ATTACHMENT, EXTDATA_META_PREFIX, META_CREATED, META_LASTMODIFIED, META_PASTAUTHORS, META_PASTEDITDATES, META_REVISION, METAINFO_CREATED, METAINFO_LASTMODIFIED, METAINFO_PASTAUTHORS, METAINFO_PASTEDITDATES, METAINFO_REVISION, NOONE_ALLOWED, PAGERESTRICTION_ANY, PAGERESTRICTION_FIXEDTYPES, PAGERESTRICTION_NONE, PAGERESTRICTION_UNSPECIFIED, TYPE_ACLENTRY, TYPE_AREA, TYPE_CONTENT, TYPE_CONTENTTYPE, TYPE_CSSJS, TYPE_DBMETADATA, TYPE_FILECONTAINER, TYPE_FILEDERIVATE, TYPE_LANGUAGE, TYPE_STRUCTENTRY, TYPE_TML, TYPE_USERPROFILE, TYPENAME_ACLENTRY, TYPENAME_AREA, TYPENAME_CONTENT, TYPENAME_CONTENTTYPE, TYPENAME_CSSJS, TYPENAME_DBMETADATA, TYPENAME_FILECONTAINER, TYPENAME_FILEDERIVATE, TYPENAME_LANGUAGE, TYPENAME_STRUCTENTRY, TYPENAME_TML, TYPENAME_USERPROFILE

Constructor Summary

Constructors

Constructor and Description
WGUserProfile(WGDatabase db, WGDocumentCore doc, de.innovationgate.webgate.api.WGDocumentObjectFlags flags) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addHit() Registers a "hit" (page impression) for the current user.
void	addNewSession(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session) Registers a new session for the user of this profile
WGDocument	createClone(WGDatabase db, WGDocument ref) Creates a clone of this document in another database
java.lang.String	getClient() Returns the browser client of the user
java.lang.String	getDBLogin() Returns the database login used by the web user
int	getHits() Returns the registered "Hits" (i.e. page impressions) of the current user
java.util.List	getLanguages() Returns the languages that the users browser is configured to accept
java.util.Date	getLastAccess() Returns the last access date.
java.lang.String	getLastIP() Returns the IP address under which the last session was started
java.util.Date	getLastSessionDate() Returns the date when the last session was opened.
int	getLastSessionHits() Returns the hits in the last session.
java.lang.String	getLastSessionID() Returns the ID of the last session
java.lang.String	getName() Returns the profile name which also is used as web user name
Lockable	getParentLockable() returns the parent lockable of this lockable for e.g.
java.lang.String	getPassword() If the personalisation mode is "custom", returns set password for this profile
WGPortletItemStorage	getPortletItemStorage() Returns the storage for persistent portlet items for transient portlets of this profile
WGPortletRegistry	getPortletRegistry() Returns the registry object for persistently stored portlets on this user profile
int	getPreviousSessionHits() Returns the hits in the last already closed session
java.lang.String	getPreviousSessionID() Returns the ID of the last already closed session
int	getProfileType() Returns the profile type, which is the personalisation mode under which it was registered.
int	getSessionCount() Get the number of registered sessions for the current user.
int	getType() Returns the type of this document as constant WGDocument.TYPE_...
void	pushData(WGDocument doc) Pushed the data of this document to another document of the same type.
boolean	setClient(java.lang.String client) Sets the browser client name for the current user
boolean	setDBLogin(java.lang.String login) Sets the content db login for the current user
boolean	setLanguages(java.util.List langs) Sets the accepted languages for the current user
boolean	setLastAccess(java.util.Date lastAccess) Sets the last accessed date.
boolean	setPassword(java.lang.String value) Sets the custom password for this profile, used in personalisation mode "custom" to open this profile.

Methods inherited from class de.innovationgate.webgate.api.WGDocument

afterSave, attachAllFiles, attachAllFiles, attachFile, attachFile, attachFile, attachFileWithoutAnnotation, attachFileWithoutAnnotation, autoSave, buildDocumentKey, createFileDerivate, createFileDerivate, docTypeClassToNumber, doctypeNameToNumber, doctypeNumberToClass, doctypeNumberToName, dropCache, dropCore, equals, evaluateExpression, getCore, getCoreRetrieved, getCreated, getDatabase, getDocumentKey, getDocumentKeyObj, getExpectedMetaClass, getExtdataMetaName, getExtensionData, getExtensionDataNames, getFileData, getFileDerivateData, getFileDerivateMetaData, getFileDerivates, getFileLastModified, getFileMetaData, getFileMimeType, getFileMimeTypes, getFileNames, getFileParent, getFileSize, getFileText, getFileText, getItemDate, getItemNames, getItemNumber, getItemText, getItemValue, getItemValueList, getLastModified, getLastUpdates, getLockStatus, getLockStatus, getMetaData, getMetaDataList, getMetaInfo, getMetaInfoByType, getMetaNames, getName, getNativeObject, getObjectCreated, getPastAuthors, getPastEditDates, getPersistentStore, getPrimaryFileName, getRevision, hasFile, hasFileMetadata, hashCode, hasItem, innerAttachFile, isCachingEnabled, isCoreRetrieved, isDeleted, isDeleted, isDummy, isEdited, isListMeta, isSaved, isTemporary, lock, lock, markEdited, markMetaDataModified, mayRemove, mayRemove, maySave, performRemoveCheck, performRemoveCheck, performSaveCheck, remove, removeAllExtensionData, removeAllFiles, removeAllItems, removeExtensionData, removeFile, removeFileDerivate, removeItem, renameFile, resultIsFalse, resultIsTrue, save, save, saveQuiet, saveWithGivenTimestamps, setCachingEnabled, setItem, setItems, setItemValue, setMeta, setMetaData, setMetas, setMetaToDefault, setPrimaryFileName, setValues, unlock, unlock, validateMetas, validateMetas, writeExtensionData, writeFileDerivateMetaData

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROFILETYPE_UNDEFINED

public static final int PROFILETYPE_UNDEFINED

Value returned by getType() when the type is not determineable

See Also:

Constant Field Values

META_NAME

public static final java.lang.String META_NAME

See Also:

Constant Field Values

METAINFO_NAME

public static final MetaInfo METAINFO_NAME

META_TYPE

public static final java.lang.String META_TYPE

See Also:

Constant Field Values

METAINFO_TYPE

public static final MetaInfo METAINFO_TYPE

META_LASTACCESS

public static final java.lang.String META_LASTACCESS

See Also:

Constant Field Values

METAINFO_LASTACCESS

public static final MetaInfo METAINFO_LASTACCESS

META_LASTSESSIONID

public static final java.lang.String META_LASTSESSIONID

See Also:

Constant Field Values

METAINFO_LASTSESSIONID

public static final MetaInfo METAINFO_LASTSESSIONID

META_LASTSESSIONDATE

public static final java.lang.String META_LASTSESSIONDATE

See Also:

Constant Field Values

METAINFO_LASTSESSIONDATE

public static final MetaInfo METAINFO_LASTSESSIONDATE

META_LASTSESSIONHITS

public static final java.lang.String META_LASTSESSIONHITS

See Also:

Constant Field Values

METAINFO_LASTSESSIONHITS

public static final MetaInfo METAINFO_LASTSESSIONHITS

META_PREVIOUSSESSIONID

public static final java.lang.String META_PREVIOUSSESSIONID

See Also:

Constant Field Values

METAINFO_PREVIOUSSESSIONID

public static final MetaInfo METAINFO_PREVIOUSSESSIONID

META_PREVIOUSSESSIONDATE

public static final java.lang.String META_PREVIOUSSESSIONDATE

See Also:

Constant Field Values

METAINFO_PREVIOUSSESSIONDATE

public static final MetaInfo METAINFO_PREVIOUSSESSIONDATE

META_PREVIOUSSESSIONHITS

public static final java.lang.String META_PREVIOUSSESSIONHITS

See Also:

Constant Field Values

METAINFO_PREVIOUSSESSIONHITS

public static final MetaInfo METAINFO_PREVIOUSSESSIONHITS

META_HITS

public static final java.lang.String META_HITS

See Also:

Constant Field Values

METAINFO_HITS

public static final MetaInfo METAINFO_HITS

META_SESSIONS

public static final java.lang.String META_SESSIONS

See Also:

Constant Field Values

METAINFO_SESSIONS

public static final MetaInfo METAINFO_SESSIONS

META_CLIENT

public static final java.lang.String META_CLIENT

See Also:

Constant Field Values

METAINFO_CLIENT

public static final MetaInfo METAINFO_CLIENT

META_LANGUAGES

public static final java.lang.String META_LANGUAGES

See Also:

Constant Field Values

METAINFO_LANGUAGES

public static final MetaInfo METAINFO_LANGUAGES

META_DBLOGIN

public static final java.lang.String META_DBLOGIN

See Also:

Constant Field Values

METAINFO_DBLOGIN

public static final MetaInfo METAINFO_DBLOGIN

META_PASSWORD

public static final java.lang.String META_PASSWORD

See Also:

Constant Field Values

METAINFO_PASSWORD

public static final MetaInfo METAINFO_PASSWORD

META_PORTLETREGISTRY

public static final java.lang.String META_PORTLETREGISTRY

See Also:

Constant Field Values

METAINFO_PORTLETREGISTRY

public static final MetaInfo METAINFO_PORTLETREGISTRY

META_PORTLETITEMSTORAGE

public static final java.lang.String META_PORTLETITEMSTORAGE

See Also:

Constant Field Values

METAINFO_PORTLETITEMSTORAGE

public static final MetaInfo METAINFO_PORTLETITEMSTORAGE

META_LASTIP

public static final java.lang.String META_LASTIP

See Also:

Constant Field Values

METAINFO_LASTIP

public static final MetaInfo METAINFO_LASTIP

ITEM_WGACREATIONVERSION

public static final java.lang.String ITEM_WGACREATIONVERSION

Item automatically stored on every user profile denoting the WGA version under which this profile was created

See Also:

Constant Field Values

Constructor Detail

WGUserProfile

public WGUserProfile(WGDatabase db,
             WGDocumentCore doc,
             de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
              throws WGAPIException

Constructor. Not to be used outside the WGAPI.

Parameters:

db -

doc -

Throws:

WGAPIException

Method Detail

getName

public java.lang.String getName()
                         throws WGAPIException

Returns the profile name which also is used as web user name

Throws:

WGAPIException

getProfileType

public int getProfileType()
                   throws WGAPIException

Returns the profile type, which is the personalisation mode under which it was registered.

Throws:

WGAPIException

getClient

public java.lang.String getClient()
                           throws WGAPIException

Returns the browser client of the user

Throws:

WGAPIException

setClient

public boolean setClient(java.lang.String client)
                  throws WGAPIException

Sets the browser client name for the current user

Throws:

WGAPIException

getDBLogin

public java.lang.String getDBLogin()
                            throws WGAPIException

Returns the database login used by the web user

Throws:

WGAPIException

setDBLogin

public boolean setDBLogin(java.lang.String login)
                   throws WGAPIException

Sets the content db login for the current user

Throws:

WGAPIException

getHits

public int getHits()
            throws WGAPIException

Returns the registered "Hits" (i.e. page impressions) of the current user

Throws:

WGAPIException

addHit

public boolean addHit()
               throws WGAPIException

Registers a "hit" (page impression) for the current user.

Throws:

WGAPIException

getLanguages

public java.util.List getLanguages()
                            throws WGAPIException

Returns the languages that the users browser is configured to accept

Throws:

WGAPIException

setLanguages

public boolean setLanguages(java.util.List langs)
                     throws WGAPIException

Sets the accepted languages for the current user

Throws:

WGAPIException

getLastAccess

public java.util.Date getLastAccess()
                             throws WGAPIException

Returns the last access date.

Throws:

WGAPIException

setLastAccess

public boolean setLastAccess(java.util.Date lastAccess)
                      throws WGAPIException

Sets the last accessed date.

Throws:

WGAPIException

getLastSessionDate

public java.util.Date getLastSessionDate()
                                  throws WGAPIException

Returns the date when the last session was opened.

Throws:

WGAPIException

getLastSessionHits

public int getLastSessionHits()
                       throws WGAPIException

Returns the hits in the last session.

Throws:

WGAPIException

getLastSessionID

public java.lang.String getLastSessionID()
                                  throws WGAPIException

Returns the ID of the last session

Throws:

WGAPIException

addNewSession

public void addNewSession(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpSession session)
                   throws WGAPIException

Registers a new session for the user of this profile

Throws:

WGAPIException

getPreviousSessionHits

public int getPreviousSessionHits()
                           throws WGAPIException

Returns the hits in the last already closed session

Throws:

WGAPIException

getPreviousSessionID

public java.lang.String getPreviousSessionID()
                                      throws WGAPIException

Returns the ID of the last already closed session

Throws:

WGAPIException

getSessionCount

public int getSessionCount()
                    throws WGAPIException

Get the number of registered sessions for the current user.

Throws:

WGAPIException

getPassword

public java.lang.String getPassword()
                             throws WGAPIException

If the personalisation mode is "custom", returns set password for this profile

Throws:

WGAPIException

setPassword

public boolean setPassword(java.lang.String value)
                    throws WGAPIException

Sets the custom password for this profile, used in personalisation mode "custom" to open this profile.

Parameters:

value -

Throws:

WGAPIException

createClone

public WGDocument createClone(WGDatabase db,
                     WGDocument ref)
                       throws WGAPIException

Description copied from class: WGDocument

Creates a clone of this document in another database

Specified by:

createClone in class WGDocument

Parameters:

db - The target database

ref - A reference document in the target database. For struct entries, this is the parent entry in the target db. For contents this is the struct entry in the target db.

Returns:

The clone

Throws:

WGAPIException

pushData

public void pushData(WGDocument doc)
              throws WGAPIException

Description copied from class: WGDocument

Pushed the data of this document to another document of the same type. This method is allowed to save the target document if necessary, but is not required to.

Overrides:

pushData in class WGDocument

Parameters:

doc - The target document receiving the data.

Throws:

WGAPIException - If something goes wrong

getParentLockable

public Lockable getParentLockable()

Description copied from interface: Lockable

returns the parent lockable of this lockable for e.g. WGStructEntry in case of WGContent

Specified by:

getParentLockable in interface Lockable

Specified by:

getParentLockable in class WGDocument

getPortletRegistry

public WGPortletRegistry getPortletRegistry()
                                     throws WGAPIException

Returns the registry object for persistently stored portlets on this user profile

Throws:

WGAPIException

getPortletItemStorage

public WGPortletItemStorage getPortletItemStorage()
                                           throws WGAPIException

Returns the storage for persistent portlet items for transient portlets of this profile

Throws:

WGAPIException

getType

public int getType()

Description copied from class: WGDocument

Returns the type of this document as constant WGDocument.TYPE_...

Specified by:

getType in class WGDocument

getLastIP

public java.lang.String getLastIP()
                           throws WGAPIException

Returns the IP address under which the last session was started

Throws:

WGAPIException