public abstract class ApiUserContextBase extends Object implements ApiUserContextI
Modifier and Type | Field and Description |
---|---|
ApiProxyI |
m_CMDBproxyI |
ApiProxyI |
m_proxyI |
ReentrantLock |
proxyILock |
Map<Integer,ApiValueBase> |
userSession |
Modifier and Type | Method and Description |
---|---|
long |
getCacheId()
Returns the cache ID.
|
ApiProxyI |
getCMDBProxyI()
For ARSystem internal CMDB use only.
|
String |
getContextInfoStr()
get context information
|
String |
getDesignOverlayGroup()
Get design overlay group.
|
int |
getGranularMode()
Get granular overlay mode.
|
long |
getImpersonatedCacheId()
get the cache id of the impersonated user.
|
String |
getImpersonatedUser()
get the name of the impersonated user
|
com.bmc.arsys.utils.LocaleInfo |
getLocaleInfo()
Returns the
LocaleInfo object. |
LoggingInfo |
getLogging()
Returns the client-side logging information.
|
Timestamp |
getOperationTime()
Returns the operation time stamp.
|
String |
getOverlayGroup()
Get overlay group.
|
int |
getOverlayObjType()
Get object type as either real or resolved.
|
ApiProxyI |
getProxyI()
For ARSystem internal use only.
|
String |
getServerInfoStr()
get server and port information
|
String |
getServiceStatMsg() |
String |
getTenantId()
Get tenant Id
|
String |
getTransactionHandle() |
Map<Object,Object> |
getUserGenericSessionMap()
return generic session map for current user
|
Map<Integer,ApiValueBase> |
getUserSession() |
String |
getUserSessionGuid()
Returns the user session authentication GUID.
|
String |
getWebSocketURLKey() |
boolean |
isCMDBProxyInContext()
For ARSystem internal CMDB use only.
|
boolean |
isProxyInContext()
For ARSystem internal use only.
|
boolean |
isProxyInMultiThreadTransaction() |
void |
logApiTime(String msg)
Logs the start or finish time for the api call.
|
void |
setAdminFlag(boolean adminFlag)
Sets administrator flag.
|
void |
setBaseOverlayFlag(boolean boverlayFlag)
Sets base overlay flag
|
void |
setCacheId(long cacheId)
Sets cache ID.
|
void |
setCMDBProxyI(ApiProxyI prxy)
For ARSystem internal CMDB use only.
|
void |
setCustomFlag(boolean customFlag)
Sets custom flag if user is member of Customize group.
|
void |
setDesignOverlayGroup(String designOverlayGroup)
Set design overlay group.
|
void |
setGranularMode(int granularOverlayMode)
Set granular overlay mode.
|
void |
setImpersonatedCacheId(int cacheId)
set the cache id of the impersonated user
|
void |
setImpersonatedUser(String impersonatedUser)
sets the name of the impersonated user in this object
|
void |
setLocaleInfo(com.bmc.arsys.utils.LocaleInfo localeInfo)
Sets the
LocaleInfo . |
void |
setOperationTime(Timestamp operationTime) |
void |
setOverlayFlag(boolean overlayFlag)
Sets overlay flag
|
void |
setOverlayGroup(String name)
Set overlay group.
|
void |
setOverlayObjType(int overlayType)
Set object type as either real or resolved.
|
void |
setProxyI(ApiProxyI prxy)
For ARSystem internal use only.
|
void |
setServiceStatMsg(String serviceStatMsg)
Sets the Monitoring Indicator for Peripheral Services like Email,Approval
|
void |
setStructAdminFlag(boolean stadminFlag)
Sets struct admin flag.
|
void |
setStructSubAdminFlag(boolean stsubAdminFlag)
Sets subadministrator flag.
|
void |
setSubAdminFlag(boolean subAdminFlag)
Sets subadministrator flag.
|
void |
setTenantId(String tenantId)
Set tenant Id
|
void |
setUserGenericSessionMap(Map<Object,Object> newUserGenericSessionN)
Set generic user session info that API needs keep with ARServerUser instance.
|
void |
setUserSession(Map<Integer,ApiValueBase> userSession) |
void |
setUserSessionGuid(String guid)
Sets the password alternative that is used by this ARServerUser to make api calls.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getApiConfig, getApiPropertyManager, getAuthentication, getChunkResponseSize, getClientType, getCustomDateFormat, getCustomTimeFormat, getEndClientIPAddress, getExtendedClassRegistry, getLastStatus, getLocale, getMultiLastStatus, getOverridePrevIP, getPassword, getPort, getReservedParam1, getServer, getServerRpcQueueNumber, getTimeoutLong, getTimeoutNormal, getTimeoutXLong, getTimeZone, getUser, getVUIType, setAuthentication, setChunkResponseSize, setClientType, setCustomDateFormat, setCustomTimeFormat, setEndClientIPAddress, setExtendedClassRegistry, setLastStatus, setLocale, setMultiLastStatus, setOverridePrevIP, setPassword, setReservedParam1, setServer, setTimeoutLong, setTimeoutNormal, setTimeoutXLong, setTimeZone, setUser, setVUIType
public Map<Integer,ApiValueBase> userSession
public ReentrantLock proxyILock
public ApiProxyI m_proxyI
public ApiProxyI m_CMDBproxyI
public ApiProxyI getProxyI()
getProxyI
in interface ApiUserContextI
public void setProxyI(ApiProxyI prxy)
setProxyI
in interface ApiUserContextI
public boolean isProxyInContext()
isProxyInContext
in interface ApiUserContextI
public boolean isCMDBProxyInContext()
isCMDBProxyInContext
in interface ApiUserContextI
public void setUserSessionGuid(String guid)
setUserSessionGuid
in interface ApiUserContextI
guid
- public String getUserSessionGuid()
getUserSessionGuid
in interface ApiUserContextI
public void setImpersonatedUser(String impersonatedUser)
impersonatedUser
- the name of the impersonated userpublic String getImpersonatedUser()
getImpersonatedUser
in interface ApiUserContextI
public void setImpersonatedCacheId(int cacheId)
setImpersonatedCacheId
in interface ApiUserContextI
cacheId
- - the cache id returned from the serverpublic long getImpersonatedCacheId()
getImpersonatedCacheId
in interface ApiUserContextI
public long getCacheId()
getCacheId
in interface ApiUserContextI
public void setCacheId(long cacheId)
setCacheId
in interface ApiUserContextI
public Timestamp getOperationTime()
getOperationTime
in interface ApiUserContextI
public void setOperationTime(Timestamp operationTime)
setOperationTime
in interface ApiUserContextI
public void logApiTime(String msg)
logApiTime
in interface ApiUserContextI
msg
- message to print with the timestamppublic Map<Integer,ApiValueBase> getUserSession()
getUserSession
in interface ApiUserContextI
public void setUserSession(Map<Integer,ApiValueBase> userSession)
public void setAdminFlag(boolean adminFlag)
setAdminFlag
in interface ApiUserContextI
public void setCustomFlag(boolean customFlag)
setCustomFlag
in interface ApiUserContextI
public void setSubAdminFlag(boolean subAdminFlag)
setSubAdminFlag
in interface ApiUserContextI
public void setStructAdminFlag(boolean stadminFlag)
setStructAdminFlag
in interface ApiUserContextI
public void setOverlayFlag(boolean overlayFlag)
setOverlayFlag
in interface ApiUserContextI
public void setBaseOverlayFlag(boolean boverlayFlag)
setBaseOverlayFlag
in interface ApiUserContextI
public void setStructSubAdminFlag(boolean stsubAdminFlag)
setStructSubAdminFlag
in interface ApiUserContextI
public int getOverlayObjType()
ApiUserContextI
getOverlayObjType
in interface ApiUserContextI
public void setOverlayObjType(int overlayType)
ApiUserContextI
setOverlayObjType
in interface ApiUserContextI
public String getOverlayGroup()
ApiUserContextI
getOverlayGroup
in interface ApiUserContextI
public void setOverlayGroup(String name)
ApiUserContextI
setOverlayGroup
in interface ApiUserContextI
public void setDesignOverlayGroup(String designOverlayGroup)
ApiUserContextI
setDesignOverlayGroup
in interface ApiUserContextI
public String getDesignOverlayGroup()
ApiUserContextI
getDesignOverlayGroup
in interface ApiUserContextI
public int getGranularMode()
ApiUserContextI
getGranularMode
in interface ApiUserContextI
public void setGranularMode(int granularOverlayMode)
ApiUserContextI
setGranularMode
in interface ApiUserContextI
public ApiProxyI getCMDBProxyI()
ApiUserContextI
getCMDBProxyI
in interface ApiUserContextI
public void setCMDBProxyI(ApiProxyI prxy)
ApiUserContextI
setCMDBProxyI
in interface ApiUserContextI
public boolean isProxyInMultiThreadTransaction()
public String getTransactionHandle()
public LoggingInfo getLogging()
ApiUserContextI
getLogging
in interface ApiUserContextI
LoggingInfo
client-side logging information#setLogging
public String getContextInfoStr()
ApiUserContextI
getContextInfoStr
in interface ApiUserContextI
public String getServerInfoStr()
ApiUserContextI
getServerInfoStr
in interface ApiUserContextI
public String getWebSocketURLKey()
public com.bmc.arsys.utils.LocaleInfo getLocaleInfo()
ApiUserContextI
LocaleInfo
object. The locale is used to find an error message (if a message catalog exists), to format date and
time strings, for sorting, and for comparing values.getLocaleInfo
in interface ApiUserContextI
language[_territory[.codeset]][@modifier]
public void setLocaleInfo(com.bmc.arsys.utils.LocaleInfo localeInfo)
ApiUserContextI
LocaleInfo
. The LocaleInfo
is used to find Locale related error message (if a message catalog exists), to format date and
time strings, for sorting, and for comparing values.setLocaleInfo
in interface ApiUserContextI
public void setUserGenericSessionMap(Map<Object,Object> newUserGenericSessionN)
newUserGenericSessionN
- public Map<Object,Object> getUserGenericSessionMap()
userGenericSession
- public String getServiceStatMsg()
getServiceStatMsg
in interface ApiUserContextI
public void setServiceStatMsg(String serviceStatMsg)
ApiUserContextI
setServiceStatMsg
in interface ApiUserContextI
public String getTenantId()
ApiUserContextI
getTenantId
in interface ApiUserContextI
public void setTenantId(String tenantId)
ApiUserContextI
setTenantId
in interface ApiUserContextI
? Copyright 2013 BMC Software, Inc.