com.bmc.arsys.apitransport

Class ApiUserContextBase

java.lang.Object

com.bmc.arsys.apitransport.ApiUserContextBase

All Implemented Interfaces:

ApiUserContextI

Direct Known Subclasses:

ARServerUser

public abstract class ApiUserContextBase
extends Object
implements ApiUserContextI

This is the abstract base class for ARServerUser and CMDB API calls entry point i.e. public class ARServerUser extends ApiUserContextBase implements ApiUserContextI

Field Summary

Fields

Modifier and Type	Field and Description
ApiProxyI	m_CMDBproxyI
ApiProxyI	m_proxyI
ReentrantLock	proxyILock
Map<Integer,ApiValueBase>	userSession

Method Summary

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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bmc.arsys.apitransport.ApiUserContextI

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

Field Detail

userSession

public Map<Integer,ApiValueBase> userSession

proxyILock

public ReentrantLock proxyILock

m_proxyI

public ApiProxyI m_proxyI

m_CMDBproxyI

public ApiProxyI m_CMDBproxyI

Method Detail

getProxyI

public ApiProxyI getProxyI()

For ARSystem internal use only.

Specified by:

getProxyI in interface ApiUserContextI

setProxyI

public void setProxyI(ApiProxyI prxy)

For ARSystem internal use only.

Specified by:

setProxyI in interface ApiUserContextI

isProxyInContext

public boolean isProxyInContext()

For ARSystem internal use only.

Specified by:

isProxyInContext in interface ApiUserContextI

isCMDBProxyInContext

public boolean isCMDBProxyInContext()

For ARSystem internal CMDB use only.

Specified by:

isCMDBProxyInContext in interface ApiUserContextI

setUserSessionGuid

public void setUserSessionGuid(String guid)

Sets the password alternative that is used by this ARServerUser to make api calls.

Specified by:

setUserSessionGuid in interface ApiUserContextI

Parameters:

guid -

getUserSessionGuid

public String getUserSessionGuid()

Returns the user session authentication GUID. Your implementation supplies the user session authentication GUID which is set into this ARServerUser. API programs cannot use the user session authentication GUID in this release.

Specified by:

getUserSessionGuid in interface ApiUserContextI

Returns:

String user session authentication GUID

setImpersonatedUser

public void setImpersonatedUser(String impersonatedUser)

sets the name of the impersonated user in this object

Parameters:

impersonatedUser - the name of the impersonated user

getImpersonatedUser

public String getImpersonatedUser()

get the name of the impersonated user

Specified by:

getImpersonatedUser in interface ApiUserContextI

Returns:

the name of the impersonated user

setImpersonatedCacheId

public void setImpersonatedCacheId(int cacheId)

set the cache id of the impersonated user

Specified by:

setImpersonatedCacheId in interface ApiUserContextI

Parameters:

cacheId - - the cache id returned from the server

getImpersonatedCacheId

public long getImpersonatedCacheId()

get the cache id of the impersonated user. The cache ID is the cache area allocated by the server to store user information. This value is assigned by the server and should not be changed

Specified by:

getImpersonatedCacheId in interface ApiUserContextI

Returns:

the cache id of the impersonated user.

getCacheId

public long getCacheId()

Returns the cache ID. The server allocates the cache, stores user information in it, and uses that information for each API call.

Specified by:

getCacheId in interface ApiUserContextI

Returns:

long ID of the server user information cache area

setCacheId

public void setCacheId(long cacheId)

Sets cache ID.

Specified by:

setCacheId in interface ApiUserContextI

getOperationTime

public Timestamp getOperationTime()

Returns the operation time stamp.

Specified by:

getOperationTime in interface ApiUserContextI

Returns:

Timestamp date and time of the last operation. Set by the server for each API call.

setOperationTime

public void setOperationTime(Timestamp operationTime)

Specified by:

setOperationTime in interface ApiUserContextI

logApiTime

public void logApiTime(String msg)

Logs the start or finish time for the api call.

Specified by:

logApiTime in interface ApiUserContextI

Parameters:

msg - message to print with the timestamp

getUserSession

public Map<Integer,ApiValueBase> getUserSession()

Specified by:

getUserSession in interface ApiUserContextI

setUserSession

public void setUserSession(Map<Integer,ApiValueBase> userSession)

setAdminFlag

public void setAdminFlag(boolean adminFlag)

Sets administrator flag.

Specified by:

setAdminFlag in interface ApiUserContextI

setCustomFlag

public void setCustomFlag(boolean customFlag)

Sets custom flag if user is member of Customize group.

Specified by:

setCustomFlag in interface ApiUserContextI

setSubAdminFlag

public void setSubAdminFlag(boolean subAdminFlag)

Sets subadministrator flag.

Specified by:

setSubAdminFlag in interface ApiUserContextI

setStructAdminFlag

public void setStructAdminFlag(boolean stadminFlag)

Sets struct admin flag.

Specified by:

setStructAdminFlag in interface ApiUserContextI

setOverlayFlag

public void setOverlayFlag(boolean overlayFlag)

Sets overlay flag

Specified by:

setOverlayFlag in interface ApiUserContextI

setBaseOverlayFlag

public void setBaseOverlayFlag(boolean boverlayFlag)

Sets base overlay flag

Specified by:

setBaseOverlayFlag in interface ApiUserContextI

setStructSubAdminFlag

public void setStructSubAdminFlag(boolean stsubAdminFlag)

Sets subadministrator flag.

Specified by:

setStructSubAdminFlag in interface ApiUserContextI

getOverlayObjType

public int getOverlayObjType()

Description copied from interface: ApiUserContextI

Get object type as either real or resolved.

Specified by:

getOverlayObjType in interface ApiUserContextI

setOverlayObjType

public void setOverlayObjType(int overlayType)

Description copied from interface: ApiUserContextI

Set object type as either real or resolved.

Specified by:

setOverlayObjType in interface ApiUserContextI

getOverlayGroup

public String getOverlayGroup()

Description copied from interface: ApiUserContextI

Get overlay group.

Specified by:

getOverlayGroup in interface ApiUserContextI

setOverlayGroup

public void setOverlayGroup(String name)

Description copied from interface: ApiUserContextI

Set overlay group.

Specified by:

setOverlayGroup in interface ApiUserContextI

setDesignOverlayGroup

public void setDesignOverlayGroup(String designOverlayGroup)

Description copied from interface: ApiUserContextI

Set design overlay group.

Specified by:

setDesignOverlayGroup in interface ApiUserContextI

getDesignOverlayGroup

public String getDesignOverlayGroup()

Description copied from interface: ApiUserContextI

Get design overlay group.

Specified by:

getDesignOverlayGroup in interface ApiUserContextI

getGranularMode

public int getGranularMode()

Description copied from interface: ApiUserContextI

Get granular overlay mode.

Specified by:

getGranularMode in interface ApiUserContextI

setGranularMode

public void setGranularMode(int granularOverlayMode)

Description copied from interface: ApiUserContextI

Set granular overlay mode.

Specified by:

setGranularMode in interface ApiUserContextI

getCMDBProxyI

public ApiProxyI getCMDBProxyI()

Description copied from interface: ApiUserContextI

For ARSystem internal CMDB use only.

Specified by:

getCMDBProxyI in interface ApiUserContextI

setCMDBProxyI

public void setCMDBProxyI(ApiProxyI prxy)

Description copied from interface: ApiUserContextI

For ARSystem internal CMDB use only.

Specified by:

setCMDBProxyI in interface ApiUserContextI

isProxyInMultiThreadTransaction

public boolean isProxyInMultiThreadTransaction()

getTransactionHandle

public String getTransactionHandle()

getLogging

public LoggingInfo getLogging()

Description copied from interface: ApiUserContextI

Returns the client-side logging information.

Specified by:

getLogging in interface ApiUserContextI

Returns:

LoggingInfo client-side logging information

See Also:

#setLogging

getContextInfoStr

public String getContextInfoStr()

Description copied from interface: ApiUserContextI

get context information

Specified by:

getContextInfoStr in interface ApiUserContextI

Returns:

getServerInfoStr

public String getServerInfoStr()

Description copied from interface: ApiUserContextI

get server and port information

Specified by:

getServerInfoStr in interface ApiUserContextI

Returns:

getWebSocketURLKey

public String getWebSocketURLKey()

getLocaleInfo

public com.bmc.arsys.utils.LocaleInfo getLocaleInfo()

Description copied from interface: ApiUserContextI

Returns the 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.

Specified by:

getLocaleInfo in interface ApiUserContextI

Returns:

String locale in the form language[_territory[.codeset]][@modifier]

setLocaleInfo

public void setLocaleInfo(com.bmc.arsys.utils.LocaleInfo localeInfo)

Description copied from interface: ApiUserContextI

Sets the 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.

Specified by:

setLocaleInfo in interface ApiUserContextI

setUserGenericSessionMap

public void setUserGenericSessionMap(Map<Object,Object> newUserGenericSessionN)

Set generic user session info that API needs keep with ARServerUser instance. i.e. webSocket parameter keys: ARConstantsBase.WEBSOCKET_URL_KEY ARConstantsBase.WEBSOCKET_LOGIN_KEY ARConstantsBase.WEBSOCKET_PASSWORD_KEY and other keys.

Parameters:

newUserGenericSessionN -

getUserGenericSessionMap

public Map<Object,Object> getUserGenericSessionMap()

return generic session map for current user

Parameters:

userGenericSession -

getServiceStatMsg

public String getServiceStatMsg()

Specified by:

getServiceStatMsg in interface ApiUserContextI

setServiceStatMsg

public void setServiceStatMsg(String serviceStatMsg)

Description copied from interface: ApiUserContextI

Sets the Monitoring Indicator for Peripheral Services like Email,Approval

Specified by:

setServiceStatMsg in interface ApiUserContextI

getTenantId

public String getTenantId()

Description copied from interface: ApiUserContextI

Get tenant Id

Specified by:

getTenantId in interface ApiUserContextI

setTenantId

public void setTenantId(String tenantId)

Description copied from interface: ApiUserContextI

Set tenant Id

Specified by:

setTenantId in interface ApiUserContextI