psdi.util

Class RMISession

java.lang.Object

psdi.util.MXSession

psdi.util.RMISession

Direct Known Subclasses:

SecuredWebAppSession, SimpleWebAppSession

public class RMISession
extends MXSession

Supports connection to the server thru RMI. This class should not be used directly, rather MXSession.getSessio() should be used to return the appropriate class.

Field Summary

Fields inherited from class psdi.util.MXSession

adminLogout, baseCurrency, clientAddr, clientHost, connected, credential, hostname, interactive, langCode, locale, password, remoteServer, servername, timeZone, username

Constructor Summary

Constructors

Constructor and Description
RMISession()

Method Summary

Modifier and Type	Method and Description
void	connect() Connect to the server.
void	disconnect() Disconnects from the server.
java.lang.String	getBaseLang() Returns the base language code
int	getBranding() Returns branding.
java.lang.String[][]	getLanguageList() Returns the language ID and name in corresponding language
MboSetRemote	getMboSet(java.lang.String name) Return a new MboSetRemote for the specified component
java.lang.String	getMessage(MXException mxe) Returns message for the exception
java.lang.String	getMessage(java.lang.String group, java.lang.String key) Returns the message for group and key for the mxsession langcode
java.lang.String[]	getMessages(java.lang.String group, java.lang.String[] key) Return list of translated strings from the maxmessages table in the order specified by the array of keys passed
protected MXServerRemote	getMXServer() Returns MXServer object depending on some settings.
MXServerRemote	getMXServerRemote() Return the MXServerRemote
ProfileRemote	getProfile() Return the user's security profile.
java.lang.String	getProperty(java.lang.String propName) Returns value of a public property.
java.lang.String	getTaggedMessage(MXException mxe) Returns message with MessageID for the exception
boolean	isSupportedLangCode(java.lang.String langCode) Is the language a supported maximo language code.
protected UserInfo	loadUserInfo() Returns user information based on the authentication details provided by authenticating the user credentials with the server.
ServiceRemote	lookup(java.lang.String name) Return the specified remote service

Methods inherited from class psdi.util.MXSession

addMXSessionListener, connectAsRegUser, getBaseCurrency, getClientAddr, getClientHost, getCredential, getDate, getForUser, getHost, getLocale, getNewSession, getPassword, getServer, getSession, getTenant, getTimeZone, getURLAsString, getUserInfo, getUserName, hasAdminLogout, isConnected, removeMXSessionListener, setClientAddr, setClientHost, setCredential, setForUser, setHost, setInteractive, setLangCode, setLocale, setMXSessionImplFactory, setPassword, setTenant, setTimeZone, setUserName

Methods inherited from class java.lang.Object

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

Constructor Detail

RMISession

public RMISession()

Method Detail

connect

public void connect()
             throws MXException,
                    java.rmi.RemoteException

Connect to the server. Programmer must have called setUserName(), setPassword() and setServer() before calling this method. Synchronized so only one thread tries to connect at a time !

Specified by:

connect in class MXSession

Throws:

MXException

java.rmi.RemoteException

See Also:

MXSession.isConnected(), MXSession.disconnect(), MXSession.setHost(String), MXSession.setUserName(String), MXSession.setPassword(String)

disconnect

public void disconnect()
                throws MXException,
                       java.rmi.RemoteException

Disconnects from the server.

Specified by:

disconnect in class MXSession

Throws:

MXException

java.rmi.RemoteException

See Also:

MXSession.isConnected(), RMISession.connect(), SecurityService.disconnectUser(UserInfo, int)

loadUserInfo

protected UserInfo loadUserInfo()
                         throws MXException,
                                java.rmi.RemoteException

Returns user information based on the authentication details provided by authenticating the user credentials with the server.

Returns:

user information object

Throws:

MXException

java.rmi.RemoteException

See Also:

RMISession.authenticateUser(String, String)

getMXServer

protected MXServerRemote getMXServer()
                              throws MXException,
                                     java.net.MalformedURLException,
                                     java.rmi.NotBoundException,
                                     java.rmi.RemoteException,
                                     java.net.UnknownHostException

Returns MXServer object depending on some settings. If an MXServer is running in-process, and the session is trying to connect to the same server and if the server allows local objects, then return the MXServer local object, bypassing the rmi registry.

Returns:

MXServer remote object reference.

Throws:

MXException

java.net.MalformedURLException

java.rmi.NotBoundException

java.rmi.RemoteException

java.net.UnknownHostException

getMboSet

public MboSetRemote getMboSet(java.lang.String name)
                       throws MXException

Return a new MboSetRemote for the specified component

Specified by:

getMboSet in class MXSession

Parameters:

name - The name of the type of set desired, such as WORKORDER, EQUIPMENT, etc.

Returns:

An empty set of the desired type.

Throws:

MXException

See Also:

MXSession.getSession(), MboSet.setWhere(String)

getMXServerRemote

public MXServerRemote getMXServerRemote()
                                 throws MXException

Return the MXServerRemote

Specified by:

getMXServerRemote in class MXSession

Throws:

MXException

getProfile

public ProfileRemote getProfile()
                         throws MXException,
                                java.rmi.RemoteException

Return the user's security profile.

Specified by:

getProfile in class MXSession

Throws:

MXException

java.rmi.RemoteException

See Also:

SecurityService.getProfile(psdi.security.UserInfo)

lookup

public ServiceRemote lookup(java.lang.String name)
                     throws java.rmi.RemoteException,
                            MXException

Return the specified remote service

Specified by:

lookup in class MXSession

Parameters:

name - The name of the desired service.

Returns:

The service as ServiceRemote (psdi.server.ServiceRemote).

Throws:

java.rmi.RemoteException

MXException

See Also:

ServiceRemote

isSupportedLangCode

public boolean isSupportedLangCode(java.lang.String langCode)
                            throws MXException,
                                   java.rmi.RemoteException

Is the language a supported maximo language code.

Parameters:

langCode -

Returns:

Throws:

MXException

java.rmi.RemoteException

getBaseLang

public java.lang.String getBaseLang()
                             throws MXException,
                                    java.rmi.RemoteException

Returns the base language code

Throws:

MXException

java.rmi.RemoteException

getLanguageList

public java.lang.String[][] getLanguageList()
                                     throws MXException,
                                            java.rmi.RemoteException

Returns the language ID and name in corresponding language

Specified by:

getLanguageList in class MXSession

Returns:

two dimensional string array of languageid and languagename

Throws:

MXException

java.rmi.RemoteException

getMessage

public java.lang.String getMessage(java.lang.String group,
                                   java.lang.String key)
                            throws MXException,
                                   java.rmi.RemoteException

Returns the message for group and key for the mxsession langcode

Specified by:

getMessage in class MXSession

Parameters:

group -

key -

Returns:

Throws:

MXException

java.rmi.RemoteException

getMessages

public java.lang.String[] getMessages(java.lang.String group,
                                      java.lang.String[] key)
                               throws MXException,
                                      java.rmi.RemoteException

Return list of translated strings from the maxmessages table in the order specified by the array of keys passed

Specified by:

getMessages in class MXSession

Parameters:

group -

key[] -

Returns:

Throws:

MXException

java.rmi.RemoteException

getMessage

public java.lang.String getMessage(MXException mxe)
                            throws MXException,
                                   java.rmi.RemoteException

Returns message for the exception

Specified by:

getMessage in class MXSession

Parameters:

exception -

Returns:

Throws:

MXException

java.rmi.RemoteException

getTaggedMessage

public java.lang.String getTaggedMessage(MXException mxe)
                                  throws MXException,
                                         java.rmi.RemoteException

Returns message with MessageID for the exception

Specified by:

getTaggedMessage in class MXSession

Parameters:

exception -

Returns:

Throws:

MXException

java.rmi.RemoteException

getProperty

public java.lang.String getProperty(java.lang.String propName)
                             throws MXException,
                                    java.rmi.RemoteException

Returns value of a public property. If the property is not public or is undefined, null is returned. If the property is public and has no value, the empty string is returned.

Specified by:

getProperty in class MXSession

Parameters:

propName - Property name

Returns:

Property value

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.getPublicProperty(String, String)

getBranding

public int getBranding()
                throws MXException,
                       java.rmi.RemoteException

Returns branding.

Specified by:

getBranding in class MXSession

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.getBranding()