public interface ApiUserContextI
Modifier and Type | Method and Description |
---|---|
ApiConfigI |
getApiConfig() |
ApiPropertyManagerI |
getApiPropertyManager() |
String |
getAuthentication()
Returns the authentication string.
|
long |
getCacheId()
Returns the cache ID.
|
int |
getChunkResponseSize()
Get the chunk response size
|
int |
getClientType()
Get the client type
|
ApiProxyI |
getCMDBProxyI()
For ARSystem internal CMDB use only.
|
String |
getContextInfoStr()
get context information
|
String |
getCustomDateFormat()
Returns the custom date format.
|
String |
getCustomTimeFormat()
Returns the custom time format.
|
String |
getDesignOverlayGroup()
Get design overlay group.
|
String |
getEndClientIPAddress()
Returns the end client IP address which is being
used as part of monitoring the API traffic
|
ExtendedClassRegistry |
getExtendedClassRegistry() |
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
|
List<StatusInfo> |
getLastStatus()
Returns the last operation status list.
|
String |
getLocale()
Returns the locale.
|
com.bmc.arsys.utils.LocaleInfo |
getLocaleInfo()
Returns the
LocaleInfo object. |
LoggingInfo |
getLogging()
Returns the client-side logging information.
|
List<List<StatusInfo>> |
getMultiLastStatus()
Returns the list of last operation status list.
|
Timestamp |
getOperationTime()
Returns the operation time stamp.
|
String |
getOverlayGroup()
Get overlay group.
|
int |
getOverlayObjType()
Get object type as either real or resolved.
|
boolean |
getOverridePrevIP()
Get the override previous IP flag
|
String |
getPassword()
Returns the password for the user to use to connect to the server.
|
int |
getPort()
Returns the port used to connect to the server.
|
ApiProxyI |
getProxyI()
For ARSystem internal use only.
|
String |
getReservedParam1()
CAUTION: For AR System internal Only
|
String |
getServer()
Returns the host name used to connect to the server.
|
String |
getServerInfoStr()
get server and port information
|
int |
getServerRpcQueueNumber() |
String |
getServiceStatMsg() |
String |
getTenantId()
Get tenant Id
|
int |
getTimeoutLong()
Get the long timeout
|
int |
getTimeoutNormal()
Get the normal timeout
|
int |
getTimeoutXLong()
Get the extra long timeout
|
String |
getTimeZone()
Returns the time zone.
|
String |
getUser()
Returns the user login name to use to connect to the server.
|
Map<Integer,ApiValueBase> |
getUserSession() |
String |
getUserSessionGuid()
Returns the user session authentication GUID.
|
int |
getVUIType()
Get the VUI type
|
boolean |
isCMDBProxyInContext()
For ARSystem internal CMDB use only.
|
boolean |
isProxyInContext()
For ARSystem internal use only.
|
void |
logApiTime(String msg)
Logs the start or finish time for the api call.
|
void |
setAdminFlag(boolean adminFlag)
Sets administrator flag.
|
void |
setAuthentication(String authentication)
Sets the authentication string.
|
void |
setBaseOverlayFlag(boolean boverlayFlag)
Sets base overlay flag.
|
void |
setCacheId(long cacheId)
Sets cache ID.
|
void |
setChunkResponseSize(int chunkResponseSize)
Set the chunk response size
|
void |
setClientType(int clientType)
Set the client type
|
void |
setCMDBProxyI(ApiProxyI prxy)
For ARSystem internal CMDB use only.
|
void |
setCustomDateFormat(String customDateFormat)
Sets the custom date format.
|
void |
setCustomFlag(boolean customFlag)
Sets custom flag if user is member of Customize group.
|
void |
setCustomTimeFormat(String customTimeFormat)
Sets the custom time format.
|
void |
setDesignOverlayGroup(String designOverlayGroup)
Set design overlay group.
|
void |
setEndClientIPAddress(String endClientIPAddress)
Sets the end client IP address through which the request is being made
|
void |
setExtendedClassRegistry(ExtendedClassRegistry ecr)
Sets the class extension registry object.
|
void |
setGranularMode(int granularOverlayMode)
Set granular overlay mode.
|
void |
setImpersonatedCacheId(int cacheId)
set the cache id of the impersonated user
|
void |
setLastStatus(List<StatusInfo> lastStatus)
Sets the last operation status list.
|
void |
setLocale(String locale)
Sets the locale.
|
void |
setLocaleInfo(com.bmc.arsys.utils.LocaleInfo localeInfo)
Sets the
LocaleInfo . |
void |
setMultiLastStatus(List<List<StatusInfo>> lastStatusList)
Sets the multi last operation status list.
|
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 |
setOverridePrevIP(boolean overridePrevIP)
Set the override previous IP flag
|
void |
setPassword(String password)
Sets the password for the user to use to connect to the server.
|
void |
setProxyI(ApiProxyI prxy)
For ARSystem internal use only.
|
void |
setReservedParam1(String pParam)
CAUTION: For AR System internal Only
|
void |
setServer(String server)
Sets the host name used to connect to the server.
|
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 struct subadmin flag.
|
void |
setSubAdminFlag(boolean subAdminFlag)
Sets subadministrator flag.
|
void |
setTenantId(String tenantId)
Set tenant Id
|
void |
setTimeoutLong(int timeoutLong)
Set the long timeout
|
void |
setTimeoutNormal(int timeoutNormal)
Set the normal timeout
|
void |
setTimeoutXLong(int timeoutXLong)
Set the extra long timeout
|
void |
setTimeZone(String timeZone)
Sets the time zone.
|
void |
setUser(String user)
Sets the user login name to use to connect to the server.
|
void |
setUserSessionGuid(String guid)
Sets the password alternative that is used by this ARServerUser to make api calls.
|
void |
setVUIType(int vuiType)
Set the VUI type
|
ApiPropertyManagerI getApiPropertyManager()
ApiConfigI getApiConfig()
ApiProxyI getProxyI()
int getPort()
void setCMDBProxyI(ApiProxyI prxy)
String getEndClientIPAddress()
void setEndClientIPAddress(String endClientIPAddress)
endClientIPAddress
- String getServiceStatMsg()
void setServiceStatMsg(String serviceStatMsg)
setServiceStatMsg
- ApiProxyI getCMDBProxyI()
void setProxyI(ApiProxyI prxy)
boolean isProxyInContext()
boolean isCMDBProxyInContext()
String getServer()
void setServer(String server)
#login
before
you can successfully call any method that accesses the server.server
- String server host nameint getServerRpcQueueNumber()
boolean getOverridePrevIP()
int getChunkResponseSize()
void setChunkResponseSize(int chunkResponseSize)
void setTimeoutNormal(int timeoutNormal)
int getTimeoutNormal()
void setTimeoutLong(int timeoutLong)
int getTimeoutLong()
void setTimeoutXLong(int timeoutXLong)
int getTimeoutXLong()
void setClientType(int clientType)
int getClientType()
void setVUIType(int vuiType)
int getVUIType()
void setReservedParam1(String pParam)
String getReservedParam1()
List<StatusInfo> getLastStatus()
StatusInfo
status objectsvoid setLastStatus(List<StatusInfo> lastStatus)
AR_NOTE_LOG_INFO
.lastStatus
- list of StatusInfo
status objectsList<List<StatusInfo>> getMultiLastStatus()
list>
status objectsvoid setMultiLastStatus(List<List<StatusInfo>> lastStatusList)
AR_NOTE_LOG_INFO
.lastStatus
- list of list ofStatusInfo
status objectsExtendedClassRegistry getExtendedClassRegistry()
void setExtendedClassRegistry(ExtendedClassRegistry ecr)
ecr
- LoggingInfo getLogging()
LoggingInfo
client-side logging information#setLogging
void logApiTime(String msg)
msg
- message to print with the timestamplong getCacheId()
void setCacheId(long cacheId)
Timestamp getOperationTime()
void setOperationTime(Timestamp operationTime)
String getUser()
void setUser(String user)
user
- String user login name. The privileges associated with this user determine whether the API function
call can be performed.String getPassword()
void setPassword(String password)
password
- String password in clear text. The API encrypts the password before sending it to the server.String getAuthentication()
void setAuthentication(String authentication)
authentication
- String authentication string, for example, the network domainvoid setUserSessionGuid(String guid)
guid
- String getUserSessionGuid()
ARNativeAuthenticationInfo
supplies
the user session authentication GUID which is set into this ARServerUser. API programs cannot use the user
session authentication GUID in this release.com.bmc.arsys.utils.LocaleInfo getLocaleInfo()
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.language[_territory[.codeset]][@modifier]
void setLocaleInfo(com.bmc.arsys.utils.LocaleInfo localeInfo)
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.locale
- String locale in the form language[_territory[.codeset]][@modifier]
String getLocale()
language[_territory[.codeset]][@modifier]
void setLocale(String locale)
locale
- String locale in the form language[_territory[.codeset]][@modifier]
String getTimeZone()
void setTimeZone(String timeZone)
timeZone
- String time zoneString getCustomDateFormat()
void setCustomDateFormat(String customDateFormat)
String getCustomTimeFormat()
void setCustomTimeFormat(String customTimeFormat)
String getImpersonatedUser()
long getImpersonatedCacheId()
void setImpersonatedCacheId(int cacheId)
cacheId
- - the cache id returned from the servervoid setOverridePrevIP(boolean overridePrevIP)
Map<Integer,ApiValueBase> getUserSession()
void setAdminFlag(boolean adminFlag)
void setSubAdminFlag(boolean subAdminFlag)
void setCustomFlag(boolean customFlag)
void setStructAdminFlag(boolean stadminFlag)
void setStructSubAdminFlag(boolean stsubAdminFlag)
void setOverlayFlag(boolean overlayFlag)
void setBaseOverlayFlag(boolean boverlayFlag)
int getOverlayObjType()
void setOverlayObjType(int overlayType)
String getOverlayGroup()
void setOverlayGroup(String name)
String getDesignOverlayGroup()
void setDesignOverlayGroup(String designOverlayGroup)
String getTenantId()
void setTenantId(String tenantId)
String getContextInfoStr()
String getServerInfoStr()
int getGranularMode()
void setGranularMode(int granularOverlayMode)
? Copyright 2013 BMC Software, Inc.