com.remedy.arsys.api
Class ARServerUser

java.lang.Object
  com.remedy.arsys.api.ARServerUser

public class ARServerUser

extends java.lang.Object

The ARServerUser class contains login information for accessing the AR System, including user name, password, and server. Sessions are established by using the ARServerUser class. User information contained in this class must be present for all subsequent API function calls intended to operate within that session. You use an ARServerUser object to initialize calls to a particular AR System server.

Constructor Summary

ARServerUser()
constructor

ARServerUser(java.lang.String user, java.lang.String password, java.lang.String locale, java.lang.String server)

ARServerUser(java.lang.String user, java.lang.String password, java.lang.String locale, java.lang.String serverName, int serverPort)

ARServerUser(java.lang.String user, java.lang.String password, java.lang.String locale, java.lang.String server, long cacheId)

ARServerUser(java.lang.String user, java.lang.String password, java.lang.String authentication, java.lang.String locale, java.lang.String server, long cacheId)

ARServerUser(java.lang.String user, java.lang.String password, java.lang.String authentication, java.lang.String locale, java.lang.String timeZone, java.lang.String customDateFormat, java.lang.String customTimeFormat, java.lang.String server, long cacheId)

Method Summary

void	clear() Clears all of the references to member objects.
protected void	finalize() Clears up all the resource held by native code, if logout has not been called.
boolean	getAdminFlag() Returns administrator flag.
java.lang.String	getAuthentication() Returns authentication string
long	getCacheId() Returns cache ID.
java.lang.String	getCharset() Returns charset, which has fixed value of UTF-8.
int	getChunkResponseSize() Get the chunk response size
int	getClientType() Get the client type
java.lang.String	getCustomDateFormat() Returns customDateFormat.
boolean	getCustomFlag() Returns custom flag if user is member of Customize group.
java.lang.String	getCustomTimeFormat() Returns customTimeFormat.
StatusInfo[]	getLastStatus() Returns last status information.
java.lang.String	getLocale() Returns locale used when returning error messages (if a message catalog exists), formatting date/time information, and sorting or comparing values.
long	getLockToSocketNumber() Get the lock to socket number
LoggingInfo	getLogging() Returns logging information.
Timestamp	getOperationTime() Returns operation time stamp identifying the date and time the last operation occurred for the user on the server.
int	getOverridePrevIP() Get the override previous IP flag
AccessNameID	getPassword() Returns password for the specified user name, in clear text.
int	getPort() get the port of the server connected to
Proxy	getProxy() For Remedy internal use only.
java.lang.String	getReservedParam1() CAUTION: For Remedy Internal Use Only
java.lang.String	getServer() Returns name of server connected to.
boolean	getSubAdminFlag() Returns subadministrator flag.
int	getTimeoutLong() Get the long timeout
int	getTimeoutNormal() Get the normal timeout
int	getTimeoutXLong() Get the extra long timeout
java.lang.String	getTimeZone() Returns timeZone.
AccessNameID	getUser() Returns the login name to use when connecting to the server as a AccessNameID object.
java.lang.String	getVersionString() Returns version of server.
java.lang.String	getVersionStringFromServer() Returns version of server.
int	getVUIType() Get the VUI type
protected boolean	isProxyInContext() For Remedy internal use only.
void	login() Verifies user.
void	logout() Clears context used in ARServerUser.
void	setAuthentication(java.lang.String authentication) Sets authentication.
void	setCharset(java.lang.String charset) set the charset
void	setChunkResponseSize(int chunkResponseSize) Set the chunk response size
void	setClientType(int clientType) Set the client type
void	setCustomDateFormat(java.lang.String customDateFormat) Sets customDateFormat.
void	setCustomTimeFormat(java.lang.String customTimeFormat) Sets customTimeFormat.
void	setIsGetMultipleActlinkSupported(int val)
void	setIsGetMultipleCharMenusSupported(int val)
void	setIsGetMultipleContainersSupported(int val)
void	setIsGetMultipleEscalationsSupported(int val)
void	setIsGetMultipleFieldSupported(int val)
void	setIsGetMultipleFiltersSupported(int val)
void	setIsGetMultipleVuisSupported(int val)
void	setLocale(java.lang.String locale) Sets locale.
void	setLockToSocketNumber(long lockToSocketNumber) Set the lock to socket number
void	setLogging(LoggingInfo info) Sets logging information.
void	setLogInterface(IARServerLogInterface logInterface)
void	setOverridePrevIP(int overridePrevIP) Set the override previous IP flag
void	setPassword(AccessNameID password) Sets password.
void	setPort(int serverPort) sets the port number of the server
void	setProxy(Proxy prxy) For Remedy internal use only.
void	setReservedParam1(java.lang.String pParam) CAUTION: For Remedy Internal Use Only
void	setServer(java.lang.String server) Sets name of server.
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(java.lang.String timeZone) Sets timeZone.
void	setUser(AccessNameID user) Sets the user.
void	setVersionString(java.lang.String versionString)
void	setVUIType(int vuiType) Set the VUI type
void	verifyUser(VerifyUserCriteria criteria) Returns user privilege flags.

Methods inherited from class java.lang.Object

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

Constructor Detail

ARServerUser

public ARServerUser()

constructor

ARServerUser

public ARServerUser(java.lang.String user,
                    java.lang.String password,
                    java.lang.String locale,
                    java.lang.String server)

ARServerUser

public ARServerUser(java.lang.String user,
                    java.lang.String password,
                    java.lang.String locale,
                    java.lang.String server,
                    long cacheId)

ARServerUser

public ARServerUser(java.lang.String user,
                    java.lang.String password,
                    java.lang.String authentication,
                    java.lang.String locale,
                    java.lang.String server,
                    long cacheId)

ARServerUser

public ARServerUser(java.lang.String user,
                    java.lang.String password,
                    java.lang.String locale,
                    java.lang.String serverName,
                    int serverPort)

ARServerUser

public ARServerUser(java.lang.String user,
                    java.lang.String password,
                    java.lang.String authentication,
                    java.lang.String locale,
                    java.lang.String timeZone,
                    java.lang.String customDateFormat,
                    java.lang.String customTimeFormat,
                    java.lang.String server,
                    long cacheId)

Method Detail

login

public void login()
           throws ARException

Verifies user.

Throws:

ARException - if invalid login

logout

public void logout()

Clears context used in ARServerUser. This method should be called to avoid memory leaks.

clear

public void clear()

Clears all of the references to member objects.

getCacheId

public long getCacheId()

Returns cache ID. The cache ID is the cache area allocated by the server to store user information.It should be initialized to zero before the first API call. This value is assigned by the server and should not be changed, enabling the server to use the cache instead of reloading user information for each API call.

getOperationTime

public Timestamp getOperationTime()

Returns operation time stamp identifying the date and time the last operation occurred for the user on the server. The server assigns this value for each API call.

getUser

public AccessNameID getUser()

Returns the login name to use when connecting to the server as a AccessNameID object. The privileges associated with this user determine whether the API function call can be performed.

setUser

public void setUser(AccessNameID user)

Sets the user.

getPassword

public AccessNameID getPassword()

Returns password for the specified user name, in clear text. The API encrypts this parameter before sending it to the server.

setPassword

public void setPassword(AccessNameID password)

Sets password.

getAuthentication

public java.lang.String getAuthentication()

Returns authentication string

setAuthentication

public void setAuthentication(java.lang.String authentication)

Sets authentication.

getLocale

public java.lang.String getLocale()

Returns locale used when returning error messages (if a message catalog exists), formatting date/time information, and sorting or comparing values.

setLocale

public void setLocale(java.lang.String locale)

Sets locale.

getTimeZone

public java.lang.String getTimeZone()

Returns timeZone.

setTimeZone

public void setTimeZone(java.lang.String timeZone)

Sets timeZone.

getCustomDateFormat

public java.lang.String getCustomDateFormat()

Returns customDateFormat.

setCustomDateFormat

public void setCustomDateFormat(java.lang.String customDateFormat)

Sets customDateFormat.

getCustomTimeFormat

public java.lang.String getCustomTimeFormat()

Returns customTimeFormat.

setCustomTimeFormat

public void setCustomTimeFormat(java.lang.String customTimeFormat)

Sets customTimeFormat.

getPort

public int getPort()

get the port of the server connected to

Returns:

server port number

setPort

public void setPort(int serverPort)

sets the port number of the server

Parameters:

serverPort - the port number of the server

getServer

public java.lang.String getServer()

Returns name of server connected to.

setServer

public void setServer(java.lang.String server)

Sets name of server.

setVersionString

public void setVersionString(java.lang.String versionString)

setIsGetMultipleFieldSupported

public void setIsGetMultipleFieldSupported(int val)

setIsGetMultipleActlinkSupported

public void setIsGetMultipleActlinkSupported(int val)

setIsGetMultipleEscalationsSupported

public void setIsGetMultipleEscalationsSupported(int val)

setIsGetMultipleFiltersSupported

public void setIsGetMultipleFiltersSupported(int val)

setIsGetMultipleContainersSupported

public void setIsGetMultipleContainersSupported(int val)

setIsGetMultipleCharMenusSupported

public void setIsGetMultipleCharMenusSupported(int val)

setIsGetMultipleVuisSupported

public void setIsGetMultipleVuisSupported(int val)

getLastStatus

public StatusInfo[] getLastStatus()

Returns last status information.

getAdminFlag

public boolean getAdminFlag()

Returns administrator flag.

getSubAdminFlag

public boolean getSubAdminFlag()

Returns subadministrator flag.

getCustomFlag

public boolean getCustomFlag()

Returns custom flag if user is member of Customize group.

getLogging

public LoggingInfo getLogging()

Returns logging information.

setLogging

public void setLogging(LoggingInfo info)

Sets logging information.

setLogInterface

public void setLogInterface(IARServerLogInterface logInterface)

getProxy

public Proxy getProxy()

For Remedy internal use only.

setProxy

public void setProxy(Proxy prxy)

For Remedy internal use only.

isProxyInContext

protected boolean isProxyInContext()

For Remedy internal use only.

getVersionString

public java.lang.String getVersionString()

Returns version of server.

getVersionStringFromServer

public java.lang.String getVersionStringFromServer()

Returns version of server.

verifyUser

public void verifyUser(VerifyUserCriteria criteria)
                throws ARException

Returns user privilege flags.

Throws:

ARException - if user is not verified

finalize

protected void finalize()
                 throws java.lang.Throwable

Clears up all the resource held by native code, if logout has not been called.

Throws:

java.lang.Throwable

setChunkResponseSize

public void setChunkResponseSize(int chunkResponseSize)

Set the chunk response size

getChunkResponseSize

public int getChunkResponseSize()

Get the chunk response size

setTimeoutNormal

public void setTimeoutNormal(int timeoutNormal)

Set the normal timeout

getTimeoutNormal

public int getTimeoutNormal()

Get the normal timeout

setTimeoutLong

public void setTimeoutLong(int timeoutLong)

Set the long timeout

getTimeoutLong

public int getTimeoutLong()

Get the long timeout

setTimeoutXLong

public void setTimeoutXLong(int timeoutXLong)

Set the extra long timeout

getTimeoutXLong

public int getTimeoutXLong()

Get the extra long timeout

setLockToSocketNumber

public void setLockToSocketNumber(long lockToSocketNumber)

Set the lock to socket number

getLockToSocketNumber

public long getLockToSocketNumber()

Get the lock to socket number

setClientType

public void setClientType(int clientType)

Set the client type

getClientType

public int getClientType()

Get the client type

setVUIType

public void setVUIType(int vuiType)

Set the VUI type

getVUIType

public int getVUIType()

Get the VUI type

setOverridePrevIP

public void setOverridePrevIP(int overridePrevIP)

Set the override previous IP flag

getOverridePrevIP

public int getOverridePrevIP()

Get the override previous IP flag

setReservedParam1

public void setReservedParam1(java.lang.String pParam)

CAUTION: For Remedy Internal Use Only

getReservedParam1

public java.lang.String getReservedParam1()

CAUTION: For Remedy Internal Use Only

getCharset

public java.lang.String getCharset()

Returns charset, which has fixed value of UTF-8.

setCharset

public void setCharset(java.lang.String charset)

set the charset

Parameters:

charset -