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 language, java.lang.String server)

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

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

Method Summary

void	clear() Clears all of the references to member objects.
boolean	getAdminFlag() Returns administrator flag.
java.lang.String	getAuthentication() Returns authentication string
long	getCacheId() Returns cache ID.
boolean	getCustomFlag() Returns custom flag if user is member of Customize group.
java.lang.String	getLanguage() Returns language used when returning error messages (if a message catalog exists), formatting date/time information, and sorting or comparing values.
StatusInfo[]	getLastStatus() Returns last status information.
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.
AccessNameID	getPassword() Returns password for the specified user name, in clear text.
Proxy	getProxy() For Peregrine internal use only.
java.lang.String	getServer() Returns name of server connected to.
boolean	getSubAdminFlag() Returns subadministrator flag.
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.
boolean	isProxyInContext() For Peregrine internal use only.
void	login() Verifies user.
void	logout() Clears context used in ARServerUser.
void	setAuthentication(java.lang.String authentication) Sets authentication.
void	setLanguage(java.lang.String language) Sets language.
void	setLogging(LoggingInfo info) Sets logging information.
void	setPassword(AccessNameID password) Sets password.
void	setProxy(Proxy prxy) For Peregrine internal use only.
void	setServer(java.lang.String server) Sets name of server.
void	setUser(AccessNameID user) Sets the user.
void	verifyUser(VerifyUserCriteria criteria) Returns user privilege flags.

Methods inherited from class java.lang.Object

clone, equals, finalize, 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 language,
                    java.lang.String server)

ARServerUser

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

ARServerUser

public ARServerUser(java.lang.String user,
                    java.lang.String password,
                    java.lang.String authentication,
                    java.lang.String language,
                    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.

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.

getLanguage

public java.lang.String getLanguage()

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

setLanguage

public void setLanguage(java.lang.String language)

Sets language.

getServer

public java.lang.String getServer()

Returns name of server connected to.

setServer

public void setServer(java.lang.String server)

Sets name of server.

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.

getProxy

public Proxy getProxy()

For Peregrine internal use only.

setProxy

public void setProxy(Proxy prxy)

For Peregrine internal use only.

isProxyInContext

public boolean isProxyInContext()

For Peregrine internal use only.

getVersionString

public java.lang.String getVersionString()

Returns version of server.

verifyUser

public void verifyUser(VerifyUserCriteria criteria)
                throws ARException

Returns user privilege flags.

Throws:

ARException - if user is not verified