Maximo Java API · psdi.server

MXServer `psdi.server.MXServer`

MXServer is a Maximo class. It is in every release from 8.5 to 9.3, with 226 public and protected methods and 45 fields.

Using this class in Jython

Import and get the running instance

The running Manage server and entry point for server services, dates and independent MBO sets. Pass the intended UserInfo when opening a set. A server-opened set is independent of the launch point transaction.

from psdi.server import MXServer
server = MXServer.getMXServer()

Signature and hierarchy

public class MXServer implements MXServerRemote, FixedLoggers, MaxRemoteProxy

Extends: java.lang.Object.

Implements: psdi.server.MXServerRemote, psdi.util.logging.FixedLoggers, psdi.proxy.MaxRemoteProxy.

Where Maximo uses it

No object, attribute, screen, service or cron task names MXServer directly. No internal method callers can be inferred from these registrations.

Upgrading

Grade	Change	Member	Step
BLOCKING	method removed	`public JSONObject getBaseObject(String)`	9.0 → 9.1
BLOCKING	method removed	`public static MXServer.SmtpAuthenticator getMailAuth()`	8.5 → 8.6
BLOCKING	method removed	`public boolean isPartialUpgrade()`	9.0 → 9.1
BLOCKING	method removed	`public void loadMASApps(Connection)`	9.0 → 9.1
BLOCKING	field removed	`protected static final String nameDefault`	9.1 → 9.2

BLOCKING: the member is gone and nothing in the hierarchy provides it, so code that calls or extends it breaks. REVIEW: still callable through a supertype, or the class now extends something else; check your overrides.

Method context

getMXServer: Get the running server singleton. This is a static factory call; do not construct a new server. server = MXServer.getMXServer()
getMboSet: Open an independent set for an object and user context. The script owns this set and its lifecycle. records = server.getMboSet("ASSET", mbo.getUserInfo())
getDate: Get the server date and time. Returns java.util.Date. now = server.getDate()
getProperty: Read a Maximo system property. May return null when a property has no value. host = server.getProperty("mxe.hostname")
lookup: Look up a registered Maximo server service. Use the service name from MAXSERVICE and its public interface. svc = server.lookup("WORKORDER")

Methods

Signatures across captured releases. Use Browse to filter to one version.

Signature	Releases
`public void addApp(String)`	8.5–9.3
`public void addToMaximoCache(String, MaximoCache)`	8.5–9.3
`public void addWarning(MXException, Object)`	8.5–9.3
`public boolean blockOnlineConfigDB()`	9.0–9.3
`protected void boot(Properties)`	8.5–9.3
`public void checkAdminRestart()`	8.5–9.3
`public void checkFailedTenants()`	8.5–9.3
`public void clearLongOpPipe()`	8.5–9.3
`public void clearSecurityContext()`	8.5–9.3
`public static void clearTenantContext()`	8.5–9.3
`public void clearTenantRealmMap()`	8.5–9.3
`public void clearUserInput(UserInfo)`	8.5–9.3
`public void clearWarnings(Object)`	8.5–9.3
`public void collectTenantDBConForThisServer(UserInfo)`	8.5–9.3
`public void collectTenantDBConnInfo(UserInfo)`	8.5–9.3
`protected void configure(Properties)`	8.5–9.3
`public MXTransaction createMXTransaction()`	8.5–9.3
`public void decrementMboCount(String, int)`	8.5–9.3
`public void decrementMbosetCount(String, int)`	8.5–9.3
`public void decrementMbosetCount(String)`	8.5–9.3
`public void decrementMbosetIPCount(String, String, String)`	8.5–9.3
`public void destroy()`	8.5–9.3
`public void disableService(String)`	8.5–9.3
`public void enableService(String)`	8.5–9.3
`public byte[] encData(String, int)`	8.5–9.3
`protected void finalize()`	8.5–9.3
`public List getAllTenantIdsList(UserInfo)`	8.5–9.3
`public JSONObject getAllTenantsMboCountAsJSON()`	8.5–9.3
`public String getAppServerNameandVersion()`	8.5–9.3
`public String[] getAppServiceNames()`	8.5–9.3
`public AutoKeyCache getAutoKeyCache()`	8.5–9.3
`public JSONArray getAvailableMASIDPs()`	9.1–9.3
`public Set getAvailableMASProducts()`	9.1–9.3
`public String getBaseCalendar()`	8.5–9.3
`public String getBaseLang()`	8.5–9.3
`public JSONObject getBaseObject(String)`	9.0
`public int getBranding()`	8.5–9.3
`public UserInputBulletin getBulletin()`	8.5–9.3
`public static BulletinBoardServiceRemote getBulletinBoard()`	8.5–9.3
`public MaxConditionCache getConditionCache()`	8.5–9.3
`public Properties getConfig()`	8.5–9.3
`public Properties getConfig(UserInfo)`	8.5–9.3
`public CronTaskManager getCronTaskManager()`	8.5–9.3
`public String getDatabaseProductName()`	8.5–9.3
`public String getDatabaseProductSimpleVersion()`	8.5–9.3
`public String getDatabaseProductVersion()`	8.5–9.3
`public DataRestrictionCache getDataRestrictionCache()`	8.5–9.3
`public Date getDate()`	8.5–9.3
`public Date getDate(Locale, TimeZone)`	8.5–9.3
`public int getDBConnUsed()`	8.5–9.3
`public DBManager getDBManager()`	8.5–9.3
`public int getDBPlatform()`	8.5–9.3
`public String getDefaultRecipientEmail()`	9.2–9.3
`public String getDefaultSenderEmail()`	9.2–9.3
`public Pattern getEmailPattern()`	9.1–9.3
`public int getEvalDaysRemaining()`	8.5–9.3
`public static Map getEventTopicsCache()`	8.5–9.3
`public static EventTopicTree getEventTopicTree()`	8.5–9.3
`public String[] getFreeMemory()`	8.5–9.3
`public Object getFromMaximoCache(String)`	8.5–9.3
`public static Map getGlobalEventTopicsCache()`	8.5–9.3
`public UUID getGuid()`	8.5–9.3
`public static int getInstallMode()`	9.2–9.3
`public String[][] getLanguageList()`	8.5–9.3
`public HashSet getLicenseKeys()`	8.5–9.3
`public Map getLicensingProducts()`	9.1–9.3
`public Map getLoadedTenants()`	8.5–9.3
`public Set getLoadedTenants(String)`	8.5–9.3
`public String[] getLocalAppList()`	8.5–9.3
`public static MultiEmailAuthenticator getMailAuth()`	8.6–9.3
`public static MXServer.SmtpAuthenticator getMailAuth()`	8.5
`public MboValueInfo getMasterMboValueInfo(MboRemote)`	8.5–9.3
`public Map getMasterModifiedObjects()`	8.5–9.3
`public MaxDomainCache getMaxDomainCache()`	8.5–9.3
`public Set getMaximoCacheNames()`	8.5–9.3
`public MaximoDD getMaximoDD()`	8.5–9.3
`public MaximoMLDD getMaximoMLDD()`	8.5–9.3
`public MaxMessageCache getMaxMessageCache()`	8.5–9.3
`public static synchronized long getMaxSessionID()`	8.5–9.3
`public String getMaxupgValue()`	8.5–9.3
`public String getMAXUPGValue(Connection, String)`	8.5–9.3
`public String getMboCount()`	8.5–9.3
`public ArrayList getMboCounts()`	8.5–9.3
`public ArrayList getMboCounts(int)`	8.5–9.3
`public MboSetRemote getMboSet(String, UserInfo)`	8.5–9.3
`public int getMboSetCount(String)`	8.5–9.3
`public int getMboSetIPCount(String, String, String)`	8.5–9.3
`public ArrayList getMEAServerVersion()`	8.5–9.3
`public String getMessage(MXException, String)`	8.5–9.3
`public String getMessage(String, String, String)`	8.5–9.3
`public String[] getMessages(String, String[], String)`	8.5–9.3
`public MXCipher getMXCipher()`	8.5–9.3
`public MXCipherX getMXCipherX()`	8.5–9.3
`public static MXServer getMXServer()`	8.5–9.3
`public Properties getMxServerConfig()`	8.5–9.3
`public MXServerInfo getMXServerInfo()`	8.5–9.3
`public String[] getMXServerVersion()`	8.5–9.3
`public String getName()`	8.5–9.3
`public String getNativeSql(String)`	8.5–9.3
`public CronTaskManager getNewCronTaskManager()`	8.5–9.3
`public String getOrganization(String)`	8.5–9.3
`public void getPackagingInfo(UserInfo)`	8.5–9.3
`public JSONObject getPasswordPolicy()`	9.1–9.3
`public HashSet getProductKeys()`	8.5–9.3
`public String getProperty(String, boolean)`	8.5–9.3
`public String getProperty(String, String, UserInfo)`	8.5–9.3
`public String getProperty(String, String)`	8.5–9.3
`public String getProperty(String, UserInfo)`	8.5–9.3
`public String getProperty(String)`	8.5–9.3
`public Remote getProxy()`	8.5–9.3
`public String getPublicProperty(String, String)`	8.5–9.3
`public String getPublicProperty(String)`	8.5–9.3
`public String getRegistryHostName()`	8.5–9.3
`public String getRegistryPort()`	8.5–9.3
`public Hashtable getRemoteUsers()`	8.5–9.3
`public MXServer.SecurityContextFlag getSecurityContext()`	8.5–9.3
`public Map getSecurityHeaderProps()`	8.7–9.3
`public SrvCommRemote getServerCommandRemote(String, String)`	8.5–9.3
`public SrvCommRemote getServerCommandRemote(UserInfo)`	8.5–9.3
`public String getServerHost()`	8.5–9.3
`public int getSQLServerPrefetchRows()`	8.5–9.3
`public SrvCommRemote getSrvComm(String, String)`	8.5–9.3
`public String getSuperUser()`	9.1–9.3
`public Properties getSystemProperties()`	8.5–9.3
`public String getSystemType()`	8.5–9.3
`public UserInfo getSystemUserInfo()`	8.5–9.3
`public String getTaggedMessage(MXException, String)`	8.5–9.3
`public String getTaggedMessage(String, String, String)`	8.5–9.3
`public static int getTenantContext()`	8.5–9.3
`public static int getTenantContext(boolean)`	8.5–9.3
`public List getTenantIdsList(UserInfo, int)`	8.5–9.3
`public HashMap getTenantRealmMap()`	8.5–9.3
`public static synchronized Object getUID()`	8.5–9.3
`public String getURL()`	8.5–9.3
`public UserInfo getUserInfo(String)`	8.5–9.3
`public Object getUserInput(String, UserInfo)`	8.5–9.3
`public String getUserLicenseKey()`	8.5–9.3
`public HashSet getValidApps()`	8.5–9.3
`public ArrayList getWarnings(Object)`	8.5–9.3
`public static boolean hasFeatureToggle()`	8.5–9.3
`public boolean hasWarnings(Object)`	8.5–9.3
`public void incrementMboCount(String, int)`	8.5–9.3
`public void incrementMbosetCount(String, int)`	8.5–9.3
`public void incrementMbosetIPCount(String, String, String)`	8.5–9.3
`public void init(Connection)`	8.5–9.3
`protected void initEventTopicTree()`	8.5–9.3
`protected void initRegistryInfo()`	8.5–9.3
`public boolean isAdminModeOff(boolean)`	8.5–9.3
`public boolean isAdminModeOn(boolean)`	8.5–9.3
`public boolean isAdminModePending()`	8.5–9.3
`public static boolean isBotcInstalled()`	8.5–9.3
`public boolean isDefaultShouldEmailPassword()`	9.1–9.3
`public static boolean isInlineThreadLog()`	8.5–9.3
`public boolean isLocal(String)`	8.5–9.3
`public boolean isManage()`	8.5–9.3
`public boolean isMASProductInstalled(String)`	9.1–9.3
`public static boolean isMasterContext()`	8.5–9.3
`public static boolean isMTEnabled()`	8.5–9.3
`public boolean isMxserverStarted()`	8.5–9.3
`public boolean isPartialUpgrade()`	9.0
`public boolean isPermanentLicense()`	8.5–9.3
`public boolean isReadOnlyApp(String)`	8.5–9.3
`public static boolean isRMIEnabled()`	8.5–9.3
`public boolean isSaaS()`	9.1–9.3
`public boolean isSiteInOrganization(String, String)`	8.5–9.3
`public boolean isSQLServerPrefetchRowsNeeded()`	8.5–9.3
`public boolean isSystemUpdating()`	8.6–9.3
`public static boolean isTenantRegContext()`	8.5–9.3
`public boolean isValidApp(String)`	8.5–9.3
`public boolean isValidOrganization(String)`	8.5–9.3
`public boolean isValidSite(String)`	8.5–9.3
`public void listenToAdmin(MboRemote, boolean)`	8.5–9.3
`public void loadCustomApps()`	8.5–9.3
`public void loadCustomApps(Connection)`	8.5–9.3
`protected void loadMASApps(Map, HashSet, HashSet, HashSet)`	9.1–9.3
`public void loadMASApps(Connection)`	9.0
`public ServiceRemote lookup(String, UserInfo)`	8.5–9.3
`public ServiceRemote lookup(String)`	8.5–9.3
`public ServiceRemote lookupLocal(String)`	8.5–9.3
`public void needToRunUpdateDB(String, String, String, String, String, boolean)`	8.5–9.3
`public void postUserInput(String, Object, UserInfo)`	8.5–9.3
`public String printMaxsessionInfo()`	8.5–9.3
`public void reloadAdminModeByThread(String, MboRemote)`	8.5–9.3
`public void reloadMaximoCache(boolean)`	8.5–9.3
`public void reloadMaximoCache(String, boolean)`	8.5–9.3
`public void reloadMaximoCache(String, String, boolean)`	8.5–9.3
`public void removeApp(String)`	8.5–9.3
`public void removeFromMaximoCache(String)`	8.5–9.3
`public void removeMaxSessionEntriesDeadForAnHour()`	8.5–9.3
`public void removeMaxSessionEntriesDeadForAnHour(Connection)`	8.5–9.3
`public void removeUserInput(String, UserInfo)`	8.5–9.3
`public String resolveApiKey(String)`	8.5–9.3
`public void retryAsyncTask(Connection, String, String)`	8.5–9.3
`public void run()`	8.5–9.3
`public static void sendEMail(String, String, String, String, String, String, String, String[], String[], Properties)`	8.5–9.3
`public static void sendEMail(String, String, String, String, String, String, String, String[], String[])`	8.5–9.3
`public static void sendEMail(String, String, String, String, String, String)`	8.5–9.3
`public static void sendEMail(String, String, String, String)`	8.5–9.3
`public static void sendEMail(String, String, String, Throwable)`	8.5–9.3
`public static void sendEMail(String[], String, String, String, String, String)`	8.5–9.3
`public static void sendEMail(String[], String, String, String)`	8.5–9.3
`public static void sendEMail(String[], String, String, Throwable)`	8.5–9.3
`protected void setMXServerInfo(MXServerInfo)`	8.5–9.3
`protected void setName(String)`	8.5–9.3
`public void setProxy(Remote)`	8.5–9.3
`protected void setRegistryHostName(String)`	8.5–9.3
`protected void setRegistryPort(String)`	8.5–9.3
`public void setSecurityCheck(MXServer.SecurityContextFlag)`	8.5–9.3
`public void setServerHost(String)`	8.5–9.3
`public static int setTenantContext(UserInfo, int)`	8.5–9.3
`public static void setTenantContext(UserInfo)`	8.5–9.3
`public static void setTenantRegContext(Integer)`	8.5–9.3
`public InputStream setupLongOpPipe()`	8.5–9.3
`protected void setURL(String)`	8.5–9.3
`protected void shutdown(Object)`	8.5–9.3
`public static void start(Properties)`	8.5–9.3
`public void unloadInactiveCaches(long)`	8.5–9.3
`public void unloadTenantCache()`	8.5–9.3
`public void unloadTenantCache(String)`	8.5–9.3
`protected void upgradeDatabaseCheck(Connection)`	8.5–9.3
`public static boolean useClassicMaximo()`	8.5–9.3
`public String validateApiKeyConfigValue()`	8.5–9.3
`public boolean validateEmailPattern(String)`	9.1–9.3
`public void validateS2stokenConfigValue()`	8.5–9.3
`public String validateThisApiKeyConfigValue(String)`	8.5–9.3
`public void writeLongOpMsg(String)`	8.5–9.3

From automation scripts

The running Manage server and entry point for server services, dates and independent MBO sets.

Query an independent set with typed values

Action launch point · WORKORDER with ASSETNUM and SITEID · Jython

from psdi.server import MXServer
from psdi.mbo import SqlFormat

where = SqlFormat("assetnum = :1 and siteid = :2")
where.setObject(1, "ASSET", "ASSETNUM", mbo.getString("ASSETNUM"))
where.setObject(2, "ASSET", "SITEID", mbo.getString("SITEID"))
assets = MXServer.getMXServer().getMboSet("ASSET", mbo.getUserInfo())
try:
    assets.setWhere(where.format())
    assets.reset()
    asset = assets.getMbo(0)
    if asset is not None:
        service.log(asset.getString("DESCRIPTION"))
finally:
    try:
        assets.cleanup()
    finally:
        assets.close()

Request a business status transition

Action launch point · WORKORDER · intended transition is valid · Jython

from psdi.server import MXServer

# Use a valid external status from this environment's WOSTATUS domain.
targetStatus = "APPR"
mbo.changeStatus(targetStatus, MXServer.getMXServer().getDate(),
                 "Reviewed through an action script")

For IBM's description of each method, see IBM's Javadoc for Maximo and Manage.

MXServer psdi.server.MXServer