|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hyperic.hq.ui.WebUser
public class WebUser
A representation of the person currently interacting with the application.
Field Summary | |
---|---|
static java.lang.String |
PREF_FAV_RESOURCE_METRICS_PREFIX
|
static java.lang.String |
PREF_LIST_DELIM
|
static java.lang.String |
PREF_METRIC_RANGE
|
static java.lang.String |
PREF_METRIC_RANGE_LASTN
|
static java.lang.String |
PREF_METRIC_RANGE_RO
|
static java.lang.String |
PREF_METRIC_RANGE_UNIT
|
static java.lang.String |
PREF_METRIC_THRESHOLD
|
Constructor Summary | |
---|---|
WebUser()
|
|
WebUser(AuthzSubject subject,
java.lang.Integer sessionId,
ConfigResponse preferences,
boolean hasPrincipal)
|
|
WebUser(AuthzSubjectValue subject)
|
|
WebUser(AuthzSubjectValue subject,
java.lang.Integer sessionId,
ConfigResponse preferences,
boolean hasPrincipal)
|
Method Summary | |
---|---|
boolean |
getActive()
|
java.lang.String |
getAuthDsn()
|
boolean |
getBooleanPref(java.lang.String key,
boolean ifNull)
Get the value of a preference as a boolean. |
java.lang.String |
getDepartment()
|
java.lang.String |
getEmailAddress()
|
java.lang.String |
getFirstName()
|
boolean |
getHasPrincipal()
|
java.lang.Integer |
getId()
|
int |
getIntPref(java.lang.String key,
int ifNull)
Get the value of a preference as an int. |
java.lang.String |
getLastName()
|
java.util.Map |
getMetricRangePreference()
|
java.util.Map |
getMetricRangePreference(boolean defaultRange)
Returns a Map of pref values: MonitorUtils.RO : Boolean
MonitorUtils.LASTN : Integer
MonitorUtils.UNIT : Unit
MonitorUtils.BEGIN : Long
MonitorUtils.END : Long
|
java.lang.Integer |
getMetricThresholdPreference()
Returns a list of metric ids saved as favorites for a particular appdef type |
java.lang.String |
getName()
|
java.lang.String |
getPhoneNumber()
|
java.lang.String |
getPreference(java.lang.String key)
|
java.lang.String |
getPreference(java.lang.String key,
java.lang.String def)
|
java.util.List |
getPreferenceAsList(java.lang.String key)
Break the named preference into tokens delimited by PREF_LIST_DELIM . |
java.util.List |
getPreferenceAsList(java.lang.String key,
java.lang.String delimiter)
Break the named preference |
ConfigResponse |
getPreferences()
|
java.lang.String |
getResourceFavoriteMetricsKey(java.lang.String appdefTypeName)
Method getResourceFavoriteMetricsKey. |
java.util.List |
getResourceFavoriteMetricsPreference(java.lang.String appdefTypeName)
Returns a list of metric ids saved as favorites for a particular appdef type |
java.lang.Integer |
getSessionId()
Return the BizApp session id as an Integer for this web user |
java.lang.String |
getSmsaddress()
|
AuthzSubjectValue |
getSubject()
Return the AuthzSubjectValue represented by this web user. |
java.lang.String |
getUsername()
|
boolean |
isHtmlEmail()
|
void |
setActive(boolean active)
|
void |
setAuthDsn(java.lang.String phoneNumber)
|
void |
setDepartment(java.lang.String department)
|
void |
setEmailAddress(java.lang.String emailAddress)
|
void |
setFirstName(java.lang.String name)
|
void |
setHasPrincipal(boolean hasPrincipal)
|
void |
setHtmlEmail(boolean htmlEmail)
|
void |
setLastName(java.lang.String name)
|
void |
setPhoneNumber(java.lang.String phoneNumber)
|
void |
setPreference(java.lang.String key,
java.util.List values)
|
void |
setPreference(java.lang.String key,
java.util.List values,
java.lang.String delim)
|
void |
setPreference(java.lang.String key,
java.lang.Object value)
|
void |
setPreferences(ConfigResponse preferences)
|
void |
setSessionId(java.lang.Integer sessionId)
Set the BizApp session id as an Integer for this web user |
void |
setSmsaddress(java.lang.String s)
|
void |
setUsername(java.lang.String username)
|
java.lang.String |
toString()
Return a human readable serialization of this object |
void |
unsetPreference(java.lang.String key)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PREF_FAV_RESOURCE_METRICS_PREFIX
public static final java.lang.String PREF_METRIC_RANGE
public static final java.lang.String PREF_METRIC_RANGE_LASTN
public static final java.lang.String PREF_METRIC_RANGE_UNIT
public static final java.lang.String PREF_METRIC_RANGE_RO
public static final java.lang.String PREF_METRIC_THRESHOLD
public static final java.lang.String PREF_LIST_DELIM
Constructor Detail |
---|
public WebUser()
public WebUser(AuthzSubjectValue subject)
public WebUser(AuthzSubject subject, java.lang.Integer sessionId, ConfigResponse preferences, boolean hasPrincipal)
public WebUser(AuthzSubjectValue subject, java.lang.Integer sessionId, ConfigResponse preferences, boolean hasPrincipal)
Method Detail |
---|
public AuthzSubjectValue getSubject()
public java.lang.Integer getId()
public java.lang.Integer getSessionId()
public void setSessionId(java.lang.Integer sessionId)
sessionId
- the new session idpublic java.lang.String getUsername()
public void setUsername(java.lang.String username)
public java.lang.String getName()
public java.lang.String getSmsaddress()
public void setSmsaddress(java.lang.String s)
public java.lang.String getFirstName()
public void setFirstName(java.lang.String name)
public java.lang.String getLastName()
public void setLastName(java.lang.String name)
public java.lang.String getEmailAddress()
public void setEmailAddress(java.lang.String emailAddress)
public boolean isHtmlEmail()
public void setHtmlEmail(boolean htmlEmail)
public java.lang.String getAuthDsn()
public void setAuthDsn(java.lang.String phoneNumber)
public java.lang.String getPhoneNumber()
public void setPhoneNumber(java.lang.String phoneNumber)
public java.lang.String getDepartment()
public void setDepartment(java.lang.String department)
public boolean getActive()
public void setActive(boolean active)
public java.lang.String toString()
toString
in class java.lang.Object
public boolean getHasPrincipal()
public void setHasPrincipal(boolean hasPrincipal)
public ConfigResponse getPreferences()
public void setPreferences(ConfigResponse preferences)
public java.lang.String getPreference(java.lang.String key) throws InvalidOptionException
InvalidOptionException
public java.lang.String getPreference(java.lang.String key, java.lang.String def)
public java.util.List getPreferenceAsList(java.lang.String key) throws InvalidOptionException
PREF_LIST_DELIM
.
key
- the name of the preference
List
of String
tokens
InvalidOptionException
public java.util.List getPreferenceAsList(java.lang.String key, java.lang.String delimiter) throws InvalidOptionException
delimiter
- the delimeter to break it up bykey
- the name of the preference
List
of String
tokens
InvalidOptionException
public void setPreference(java.lang.String key, java.util.List values) throws InvalidOptionValueException, InvalidOptionException
InvalidOptionValueException
InvalidOptionException
public void setPreference(java.lang.String key, java.util.List values, java.lang.String delim) throws InvalidOptionValueException, InvalidOptionException
InvalidOptionValueException
InvalidOptionException
public void setPreference(java.lang.String key, java.lang.Object value) throws InvalidOptionValueException, InvalidOptionException
InvalidOptionValueException
InvalidOptionException
public void unsetPreference(java.lang.String key)
public java.util.List getResourceFavoriteMetricsPreference(java.lang.String appdefTypeName) throws InvalidOptionException
InvalidOptionException
public java.lang.String getResourceFavoriteMetricsKey(java.lang.String appdefTypeName)
appdefTypeName
- i.e. application, platform, server, service
public java.util.Map getMetricRangePreference(boolean defaultRange) throws InvalidOptionException
MonitorUtils.RO
: Boolean
MonitorUtils.LASTN
: Integer
MonitorUtils.UNIT
: Unit
MonitorUtils.BEGIN
: Long
MonitorUtils.END
: Long
InvalidOptionException
public java.util.Map getMetricRangePreference() throws InvalidOptionException
InvalidOptionException
public java.lang.Integer getMetricThresholdPreference() throws InvalidOptionException
InvalidOptionException
public boolean getBooleanPref(java.lang.String key, boolean ifNull)
key
- the preference to getifNull
- if the pref is undefined, return this value instead
public int getIntPref(java.lang.String key, int ifNull)
key
- the preference to getifNull
- if the pref is null, return this value instead
|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |