de.innovationgate.wgpublisher.webtml.utils

Class TMLUserProfile

java.lang.Object

de.innovationgate.wgpublisher.webtml.utils.TMLUserProfile

All Implemented Interfaces:

UserProfile, TMLObject

public class TMLUserProfile
extends java.lang.Object
implements TMLObject, UserProfile

Field Summary

Fields

Modifier and Type	Field and Description
static int	RC_METHOD_UNAVAILABLE
static int	RC_NO_DOMAIN
static int	RC_NO_PROFILE
static int	RC_NO_SESSION
static int	RC_NOT_CREATABLE
static int	RC_NOT_PERSONALIZED
static int	RC_OK
static int	RC_PROFILE_EXISTS
static int	RC_WRONG_PASSWORD
static int	RC_WRONG_PERSMODE

Constructor Summary

Constructors

Constructor and Description
TMLUserProfile(de.innovationgate.webgate.api.WGUserProfile profile, WGACore core, int persMode, javax.servlet.http.HttpSession session, de.innovationgate.wga.common.beans.csconfig.v1.Version complianceVersion)

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	generateProfileSessionId(javax.servlet.http.HttpSession session, de.innovationgate.webgate.api.WGUserProfile userProfile)
de.innovationgate.webgate.api.WGDocument	getapiobject()
de.innovationgate.wga.common.beans.csconfig.v1.Version	getComplianceVersion()
int	getPersMode()
de.innovationgate.webgate.api.WGUserProfile	getprofile() Offers the WGAPI object representing the personalisation profile
java.lang.String	getProfileSessionId()
boolean	hasitem(java.lang.String name) Tests if an item is available
boolean	isdummy()
boolean	isSavedOnEnd()
boolean	isstorageoptedin() Returns if the profile already was allowed to be stored persistently
java.lang.Object	item(java.lang.String name) Reads the value of a profile item as single value
java.util.List<java.lang.Object>	itemlist(java.lang.String name) Returns the value of a profile item as list value
java.lang.Object	meta(java.lang.String name) Reads the value of a metadata field as single value
java.util.List<java.lang.Object>	metalist(java.lang.String name) Reads the value of a metadata field as list value
boolean	optinstorage() Marks this profile as being allowed for persistent storage
static void	prepareNewProfile(de.innovationgate.webgate.api.WGUserProfile profile, javax.servlet.http.HttpServletRequest request)
void	removeitem(java.lang.String name) Removes an item from the profile
java.lang.Object	retrievemeta(java.lang.String name)
boolean	save()
boolean	save(boolean force)
boolean	setitem(java.lang.String name, java.lang.Object value) Creates or updates a profile item
void	setpassword(java.lang.String pwd)
void	setSavedOnEnd(boolean savedOnEnd)

Methods inherited from class java.lang.Object

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

Field Detail

RC_OK

public static final int RC_OK

See Also:

Constant Field Values

RC_NO_DOMAIN

public static final int RC_NO_DOMAIN

See Also:

Constant Field Values

RC_PROFILE_EXISTS

public static final int RC_PROFILE_EXISTS

See Also:

Constant Field Values

RC_WRONG_PERSMODE

public static final int RC_WRONG_PERSMODE

See Also:

Constant Field Values

RC_NOT_CREATABLE

public static final int RC_NOT_CREATABLE

See Also:

Constant Field Values

RC_NOT_PERSONALIZED

public static final int RC_NOT_PERSONALIZED

See Also:

Constant Field Values

RC_WRONG_PASSWORD

public static final int RC_WRONG_PASSWORD

See Also:

Constant Field Values

RC_NO_PROFILE

public static final int RC_NO_PROFILE

See Also:

Constant Field Values

RC_NO_SESSION

public static final int RC_NO_SESSION

See Also:

Constant Field Values

RC_METHOD_UNAVAILABLE

public static final int RC_METHOD_UNAVAILABLE

See Also:

Constant Field Values

Constructor Detail

TMLUserProfile

public TMLUserProfile(de.innovationgate.webgate.api.WGUserProfile profile,
              WGACore core,
              int persMode,
              javax.servlet.http.HttpSession session,
              de.innovationgate.wga.common.beans.csconfig.v1.Version complianceVersion)

Method Detail

setpassword

public void setpassword(java.lang.String pwd)
                 throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

removeitem

public void removeitem(java.lang.String name)
                throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Removes an item from the profile

Specified by:

removeitem in interface UserProfile

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

item

public java.lang.Object item(java.lang.String name)
                      throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Reads the value of a profile item as single value

Specified by:

item in interface UserProfile

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

retrievemeta

public java.lang.Object retrievemeta(java.lang.String name)
                              throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

meta

public java.lang.Object meta(java.lang.String name)
                      throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Reads the value of a metadata field as single value

Specified by:

meta in interface UserProfile

Parameters:

name - Name of the field

Throws:

de.innovationgate.webgate.api.WGAPIException

setitem

public boolean setitem(java.lang.String name,
              java.lang.Object value)
                throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Creates or updates a profile item

Specified by:

setitem in interface UserProfile

Parameters:

name - Name of the item

value - Value of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

save

public boolean save(boolean force)
             throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

save

public boolean save()
             throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

optinstorage

public boolean optinstorage()
                     throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Marks this profile as being allowed for persistent storage

Specified by:

optinstorage in interface UserProfile

Throws:

de.innovationgate.webgate.api.WGAPIException

isstorageoptedin

public boolean isstorageoptedin()
                         throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Returns if the profile already was allowed to be stored persistently

Specified by:

isstorageoptedin in interface UserProfile

Throws:

de.innovationgate.webgate.api.WGAPIException

getprofile

public de.innovationgate.webgate.api.WGUserProfile getprofile()

Description copied from interface: UserProfile

Offers the WGAPI object representing the personalisation profile

Specified by:

getprofile in interface UserProfile

getapiobject

public de.innovationgate.webgate.api.WGDocument getapiobject()

Specified by:

getapiobject in interface TMLObject

See Also:

de.innovationgate.wgpublisher.webtml.utils.TMLObject#getAPIObject()

itemlist

public java.util.List<java.lang.Object> itemlist(java.lang.String name)
                                          throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Returns the value of a profile item as list value

Specified by:

itemlist in interface UserProfile

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

metalist

public java.util.List<java.lang.Object> metalist(java.lang.String name)
                                          throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Reads the value of a metadata field as list value

Specified by:

metalist in interface UserProfile

Parameters:

name - Name of the field

Throws:

de.innovationgate.webgate.api.WGAPIException

hasitem

public boolean hasitem(java.lang.String name)
                throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: UserProfile

Tests if an item is available

Specified by:

hasitem in interface UserProfile

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

isSavedOnEnd

public boolean isSavedOnEnd()

Returns:

Returns the savedOnEnd.

setSavedOnEnd

public void setSavedOnEnd(boolean savedOnEnd)

Parameters:

savedOnEnd - The savedOnEnd to set.

prepareNewProfile

public static final void prepareNewProfile(de.innovationgate.webgate.api.WGUserProfile profile,
                     javax.servlet.http.HttpServletRequest request)
                                    throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

isdummy

public boolean isdummy()

getPersMode

public int getPersMode()

getProfileSessionId

public java.lang.String getProfileSessionId()

generateProfileSessionId

public static java.lang.String generateProfileSessionId(javax.servlet.http.HttpSession session,
                                        de.innovationgate.webgate.api.WGUserProfile userProfile)
                                                 throws java.security.NoSuchAlgorithmException,
                                                        java.io.UnsupportedEncodingException

Throws:

java.security.NoSuchAlgorithmException

java.io.UnsupportedEncodingException

getComplianceVersion

public de.innovationgate.wga.common.beans.csconfig.v1.Version getComplianceVersion()