public class TMLUserProfile extends java.lang.Object implements TMLObject, UserProfile
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 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) |
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) |
public static final int RC_OK
public static final int RC_NO_DOMAIN
public static final int RC_PROFILE_EXISTS
public static final int RC_WRONG_PERSMODE
public static final int RC_NOT_CREATABLE
public static final int RC_NOT_PERSONALIZED
public static final int RC_WRONG_PASSWORD
public static final int RC_NO_PROFILE
public static final int RC_NO_SESSION
public static final int RC_METHOD_UNAVAILABLE
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)
public void setpassword(java.lang.String pwd) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public void removeitem(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
UserProfile
removeitem
in interface UserProfile
name
- Name of the itemde.innovationgate.webgate.api.WGAPIException
public java.lang.Object item(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
UserProfile
item
in interface UserProfile
name
- Name of the itemde.innovationgate.webgate.api.WGAPIException
public java.lang.Object retrievemeta(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public java.lang.Object meta(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
UserProfile
meta
in interface UserProfile
name
- Name of the fieldde.innovationgate.webgate.api.WGAPIException
public boolean setitem(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGAPIException
UserProfile
setitem
in interface UserProfile
name
- Name of the itemvalue
- Value of the itemde.innovationgate.webgate.api.WGAPIException
public boolean save(boolean force) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public boolean save() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public boolean optinstorage() throws de.innovationgate.webgate.api.WGAPIException
UserProfile
optinstorage
in interface UserProfile
de.innovationgate.webgate.api.WGAPIException
public boolean isstorageoptedin() throws de.innovationgate.webgate.api.WGAPIException
UserProfile
isstorageoptedin
in interface UserProfile
de.innovationgate.webgate.api.WGAPIException
public de.innovationgate.webgate.api.WGUserProfile getprofile()
UserProfile
getprofile
in interface UserProfile
public de.innovationgate.webgate.api.WGDocument getapiobject()
getapiobject
in interface TMLObject
de.innovationgate.wgpublisher.webtml.utils.TMLObject#getAPIObject()
public java.util.List<java.lang.Object> itemlist(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
UserProfile
itemlist
in interface UserProfile
name
- Name of the itemde.innovationgate.webgate.api.WGAPIException
public java.util.List<java.lang.Object> metalist(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
UserProfile
metalist
in interface UserProfile
name
- Name of the fieldde.innovationgate.webgate.api.WGAPIException
public boolean hasitem(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
UserProfile
hasitem
in interface UserProfile
name
- Name of the itemde.innovationgate.webgate.api.WGAPIException
public boolean isSavedOnEnd()
public void setSavedOnEnd(boolean savedOnEnd)
savedOnEnd
- The savedOnEnd to set.public static final void prepareNewProfile(de.innovationgate.webgate.api.WGUserProfile profile, javax.servlet.http.HttpServletRequest request) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public boolean isdummy()
public int getPersMode()
public java.lang.String getProfileSessionId()
public static java.lang.String generateProfileSessionId(javax.servlet.http.HttpSession session, de.innovationgate.webgate.api.WGUserProfile userProfile) throws java.security.NoSuchAlgorithmException, java.io.UnsupportedEncodingException
java.security.NoSuchAlgorithmException
java.io.UnsupportedEncodingException
public de.innovationgate.wga.common.beans.csconfig.v1.Version getComplianceVersion()