psdi.server

Interface MXServerRemote

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

MXServer

public interface MXServerRemote
extends java.rmi.Remote

A Command and Control interface for the MXServer.

Version:

%I%, %G%

Author:

John Langley

Field Summary

Fields

Modifier and Type	Field and Description
static int	BRAND_MAXIMO
static int	BRAND_MAXIMO_AND_TIVOLI
static int	BRAND_NONE
static int	BRAND_TIVOLI

Method Summary

Modifier and Type	Method and Description
void	clearTenantRealmMap()
void	clearUserInput(UserInfo ui) Remove all the user input from the bulletin board.
void	collectTenantDBConForThisServer(UserInfo info)
void	collectTenantDBConnInfo(UserInfo info)
byte[]	encData(java.lang.String in, int type)
java.lang.String	getAppServerNameandVersion() Returns the App Srever Name and Version
java.lang.String[]	getAppServiceNames()
java.lang.String	getBaseLang() Returns the base language code
int	getBranding()
java.util.Properties	getConfig(UserInfo userInfo)
java.lang.String	getDatabaseProductName() Returns the name of the database product name.
java.lang.String	getDatabaseProductSimpleVersion() Returns the name of the database product name.
java.lang.String	getDatabaseProductVersion() Returns the name of the database product name.
java.util.Date	getDate()
int	getDBConnUsed()
int	getEvalDaysRemaining()
java.lang.String[]	getFreeMemory()
java.lang.String[][]	getLanguageList() Returns the language ID and name in corresponding language
java.util.HashSet	getLicenseKeys()
java.lang.String[]	getLocalAppList()
java.util.ArrayList	getMboCounts()
java.util.ArrayList	getMboCounts(int tenantID)
MboSetRemote	getMboSet(java.lang.String name, UserInfo user) Lookup a MboSet and return to the caller
java.util.ArrayList	getMEAServerVersion() Get MEA version
java.lang.String	getMessage(MXException mxe, java.lang.String langCode) Returns message for the exception and langcode
java.lang.String	getMessage(java.lang.String group, java.lang.String key, java.lang.String langCode) Returns the maxmessage entry for group and key
java.lang.String[]	getMessages(java.lang.String group, java.lang.String[] key, java.lang.String langCode) Return list of translated strings from the maxmessages table in the order specified by the array of keys passed
java.lang.String	getName()
java.lang.String	getOrganization(java.lang.String siteId) Returns organization id for the given siteid.
void	getPackagingInfo(UserInfo ui)
java.util.HashSet	getProductKeys()
java.lang.String	getProperty(java.lang.String propName, java.lang.String lang, UserInfo userInfo)
java.lang.String	getProperty(java.lang.String propName, UserInfo userInfo)
java.lang.String	getPublicProperty(java.lang.String propName)
java.lang.String	getPublicProperty(java.lang.String propName, java.lang.String lang)
SrvCommRemote	getServerCommandRemote(java.lang.String name, java.lang.String passwd)
SrvCommRemote	getServerCommandRemote(UserInfo userInfo)
SrvCommRemote	getSrvComm(java.lang.String name, java.lang.String passwd)
java.util.Properties	getSystemProperties() Returns system properties.
java.lang.String	getTaggedMessage(MXException mxe, java.lang.String langCode) Returns message with Message id for the exception and langcode
java.lang.String	getTaggedMessage(java.lang.String group, java.lang.String key, java.lang.String langCode) Returns the maxmessage entry for group and key
java.util.HashMap<java.lang.String,java.lang.String>	getTenantRealmMap()
java.lang.Object	getUserInput(java.lang.String id, UserInfo ui) Get the user input of the id.
java.lang.String	getUserLicenseKey() Deprecated.
boolean	isAdminModeOff(boolean allInstances)
boolean	isAdminModeOn(boolean allInstances)
boolean	isPermanentLicense()
boolean	isSiteInOrganization(java.lang.String siteId, java.lang.String orgId) Returns whether the site belongs to the org or not.
boolean	isValidOrganization(java.lang.String orgId) Returns whether the orgid is valid or not.
boolean	isValidSite(java.lang.String siteId) Returns whether the siteid is valid or not.
void	listenToAdmin(MboRemote listenerMbo, boolean listen)
ServiceRemote	lookup(java.lang.String name)
ServiceRemote	lookup(java.lang.String name, UserInfo userInfo)
ServiceRemote	lookupLocal(java.lang.String name)
void	postUserInput(java.lang.String id, java.lang.Object value, UserInfo ui) Post the object to the bulletin board maintained by the server.
void	reloadAdminModeByThread(java.lang.String key, MboRemote listenerMbo)
void	reloadMaximoCache(boolean fromCron)
void	reloadMaximoCache(java.lang.String name, boolean fromCron)
void	reloadMaximoCache(java.lang.String name, java.lang.String key, boolean fromCron)
void	removeUserInput(java.lang.String id, UserInfo ui) Remove the user input from the bulletin board.

Field Detail

BRAND_NONE

static final int BRAND_NONE

See Also:

Constant Field Values

BRAND_MAXIMO

static final int BRAND_MAXIMO

See Also:

Constant Field Values

BRAND_TIVOLI

static final int BRAND_TIVOLI

See Also:

Constant Field Values

BRAND_MAXIMO_AND_TIVOLI

static final int BRAND_MAXIMO_AND_TIVOLI

See Also:

Constant Field Values

Method Detail

getMboSet

MboSetRemote getMboSet(java.lang.String name,
                       UserInfo user)
                throws MXException,
                       java.rmi.RemoteException

Lookup a MboSet and return to the caller

Throws:

MXException

java.rmi.RemoteException

getSrvComm

SrvCommRemote getSrvComm(java.lang.String name,
                         java.lang.String passwd)
                  throws java.rmi.RemoteException,
                         MXApplicationException

Throws:

java.rmi.RemoteException

MXApplicationException

getAppServiceNames

java.lang.String[] getAppServiceNames()
                               throws java.rmi.RemoteException,
                                      MXApplicationException

Throws:

java.rmi.RemoteException

MXApplicationException

lookup

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

Throws:

java.rmi.RemoteException

MXException

lookup

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

Throws:

java.rmi.RemoteException

MXException

lookupLocal

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

Throws:

java.rmi.RemoteException

MXException

getDate

java.util.Date getDate()
                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getLocalAppList

java.lang.String[] getLocalAppList()
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSystemProperties

java.util.Properties getSystemProperties()
                                  throws java.rmi.RemoteException

Returns system properties.

Throws:

java.rmi.RemoteException

getConfig

java.util.Properties getConfig(UserInfo userInfo)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

MXServer.getConfig(UserInfo userInfo)

getPublicProperty

java.lang.String getPublicProperty(java.lang.String propName)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

MXServer.getPublicProperty(String)

getPublicProperty

java.lang.String getPublicProperty(java.lang.String propName,
                                   java.lang.String lang)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

MXServer.getPublicProperty(String, String)

getProperty

java.lang.String getProperty(java.lang.String propName,
                             UserInfo userInfo)
                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

MXServer.getProperty(String, UserInfo)

getProperty

java.lang.String getProperty(java.lang.String propName,
                             java.lang.String lang,
                             UserInfo userInfo)
                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

psdi.server.MXServer#getProperty(String, String, userInfo)

getDatabaseProductName

java.lang.String getDatabaseProductName()
                                 throws java.rmi.RemoteException

Returns the name of the database product name.

Throws:

java.rmi.RemoteException

getDatabaseProductSimpleVersion

java.lang.String getDatabaseProductSimpleVersion()
                                          throws java.rmi.RemoteException

Returns the name of the database product name.

Throws:

java.rmi.RemoteException

getDatabaseProductVersion

java.lang.String getDatabaseProductVersion()
                                    throws java.rmi.RemoteException

Returns the name of the database product name.

Throws:

java.rmi.RemoteException

isAdminModeOn

boolean isAdminModeOn(boolean allInstances)
               throws MXException,
                      java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.isAdminModeOn(boolean)

isAdminModeOff

boolean isAdminModeOff(boolean allInstances)
                throws MXException,
                       java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.isAdminModeOff(boolean)

listenToAdmin

void listenToAdmin(MboRemote listenerMbo,
                   boolean listen)
            throws MXException,
                   java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.listenToAdmin(psdi.mbo.MboRemote, boolean)

getUserLicenseKey

@Deprecated
java.lang.String getUserLicenseKey()
                                         throws java.rmi.RemoteException

Deprecated.

Returns the User license Key

Throws:

java.rmi.RemoteException

getAppServerNameandVersion

java.lang.String getAppServerNameandVersion()
                                     throws java.rmi.RemoteException

Returns the App Srever Name and Version

Throws:

java.rmi.RemoteException

getMEAServerVersion

java.util.ArrayList getMEAServerVersion()
                                 throws java.rmi.RemoteException

Get MEA version

Throws:

java.rmi.RemoteException

isValidSite

boolean isValidSite(java.lang.String siteId)
             throws java.rmi.RemoteException

Returns whether the siteid is valid or not.

Throws:

java.rmi.RemoteException

isValidOrganization

boolean isValidOrganization(java.lang.String orgId)
                     throws java.rmi.RemoteException

Returns whether the orgid is valid or not.

Throws:

java.rmi.RemoteException

isSiteInOrganization

boolean isSiteInOrganization(java.lang.String siteId,
                             java.lang.String orgId)
                      throws java.rmi.RemoteException

Returns whether the site belongs to the org or not.

Throws:

java.rmi.RemoteException

getOrganization

java.lang.String getOrganization(java.lang.String siteId)
                          throws java.rmi.RemoteException

Returns organization id for the given siteid.

Throws:

java.rmi.RemoteException

getName

java.lang.String getName()
                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

MXServer.getName()

reloadMaximoCache

void reloadMaximoCache(boolean fromCron)
                throws MXException,
                       java.rmi.RemoteException

Parameters:

fromCron - is reloadMaximoCache called from crontask or from other source code

Throws:

java.rmi.RemoteException

MXException

See Also:

MXServer.reloadMaximoCache(boolean)

reloadMaximoCache

void reloadMaximoCache(java.lang.String name,
                       boolean fromCron)
                throws MXException,
                       java.rmi.RemoteException

Parameters:

name -

fromCron - is reloadMaximoCache called from crontask or from other source code

Throws:

java.rmi.RemoteException

MXException

See Also:

MXServer.reloadMaximoCache(boolean)

reloadMaximoCache

void reloadMaximoCache(java.lang.String name,
                       java.lang.String key,
                       boolean fromCron)
                throws MXException,
                       java.rmi.RemoteException

Parameters:

name -

key -

fromCron - is reloadMaximoCache called from crontask or from other source code

Throws:

java.lang.Exception

java.rmi.RemoteException

MXException

See Also:

MXServer.reloadMaximoCache(boolean)

reloadAdminModeByThread

void reloadAdminModeByThread(java.lang.String key,
                             MboRemote listenerMbo)
                      throws MXException,
                             java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.reloadAdminModeByThread(java.lang.String, psdi.mbo.MboRemote)

postUserInput

void postUserInput(java.lang.String id,
                   java.lang.Object value,
                   UserInfo ui)
            throws java.rmi.RemoteException

Post the object to the bulletin board maintained by the server.

Parameters:

id -

value -

ui -

Throws:

MXException

java.rmi.RemoteException

getUserInput

java.lang.Object getUserInput(java.lang.String id,
                              UserInfo ui)
                       throws java.rmi.RemoteException

Get the user input of the id.

Parameters:

id -

ui -

Throws:

java.rmi.RemoteException

removeUserInput

void removeUserInput(java.lang.String id,
                     UserInfo ui)
              throws java.rmi.RemoteException

Remove the user input from the bulletin board.

Parameters:

id -

ui -

Throws:

java.rmi.RemoteException

clearUserInput

void clearUserInput(UserInfo ui)
             throws java.rmi.RemoteException

Remove all the user input from the bulletin board. Since bulletin board is Thread Local object, only the user input for this thread is removed.

Parameters:

ui -

Throws:

java.rmi.RemoteException

getLanguageList

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

Returns the language ID and name in corresponding language

Returns:

two dimensional string array

Throws:

MXException

java.rmi.RemoteException

getBaseLang

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

Returns the base language code

Throws:

MXException

java.rmi.RemoteException

getMessage

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

Returns the maxmessage entry for group and key

Parameters:

group -

key -

Throws:

MXException

java.rmi.RemoteException

getTaggedMessage

java.lang.String getTaggedMessage(java.lang.String group,
                                  java.lang.String key,
                                  java.lang.String langCode)
                           throws MXException,
                                  java.rmi.RemoteException

Returns the maxmessage entry for group and key

Parameters:

group -

key -

Throws:

MXException

java.rmi.RemoteException

getMessages

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

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

Parameters:

group -

key -

Throws:

MXException

java.rmi.RemoteException

getMessage

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

Returns message for the exception and langcode

Parameters:

mxe -

langCode -

Throws:

MXException

java.rmi.RemoteException

getTaggedMessage

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

Returns message with Message id for the exception and langcode

Parameters:

mxe -

langCode -

Throws:

MXException

java.rmi.RemoteException

isPermanentLicense

boolean isPermanentLicense()
                    throws MXException,
                           java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.isPermanentLicense

getEvalDaysRemaining

int getEvalDaysRemaining()
                  throws MXException,
                         java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.getEvalDaysRemaining()

getBranding

int getBranding()
         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

MXServer.getBranding()

encData

byte[] encData(java.lang.String in,
               int type)
        throws MXException,
               java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getPackagingInfo

void getPackagingInfo(UserInfo ui)
               throws MXException,
                      java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

MXServer.getPackagingInfo(psdi.security.UserInfo)

getLicenseKeys

java.util.HashSet getLicenseKeys()
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

MXServer.getLicenseKeys()

getProductKeys

java.util.HashSet getProductKeys()
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

See Also:

MXServer.getProductKeys()

getServerCommandRemote

SrvCommRemote getServerCommandRemote(java.lang.String name,
                                     java.lang.String passwd)
                              throws java.rmi.RemoteException,
                                     MXApplicationException

Throws:

java.rmi.RemoteException

MXApplicationException

getServerCommandRemote

SrvCommRemote getServerCommandRemote(UserInfo userInfo)
                              throws java.rmi.RemoteException,
                                     MXApplicationException

Throws:

java.rmi.RemoteException

MXApplicationException

getMboCounts

java.util.ArrayList getMboCounts()
                          throws java.rmi.RemoteException,
                                 MXApplicationException

Throws:

java.rmi.RemoteException

MXApplicationException

getMboCounts

java.util.ArrayList getMboCounts(int tenantID)
                          throws java.rmi.RemoteException,
                                 MXApplicationException

Throws:

java.rmi.RemoteException

MXApplicationException

getDBConnUsed

int getDBConnUsed()
           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFreeMemory

java.lang.String[] getFreeMemory()
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

collectTenantDBConnInfo

void collectTenantDBConnInfo(UserInfo info)
                      throws java.rmi.RemoteException,
                             MXException

Throws:

java.rmi.RemoteException

MXException

collectTenantDBConForThisServer

void collectTenantDBConForThisServer(UserInfo info)
                              throws java.rmi.RemoteException,
                                     MXException

Throws:

java.rmi.RemoteException

MXException

getTenantRealmMap

java.util.HashMap<java.lang.String,java.lang.String> getTenantRealmMap()
                                                                throws MXException,
                                                                       java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

clearTenantRealmMap

void clearTenantRealmMap()
                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException