psdi.app.configure

Class ConfigureService

java.lang.Object

psdi.server.AppService

psdi.app.configure.ConfigureService

All Implemented Interfaces:

java.rmi.Remote, ConfigureServiceRemote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class ConfigureService
extends AppService
implements ConfigureServiceRemote

Manages Database Configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_NAME_LENGTH The maximum length of object name.
static java.lang.String	VALIDATION_ALL The Tenant delta validation type on ALL changes.
static java.lang.String	VALIDATION_LENGTH The Tenant delta validation type on LENGTH.
static java.lang.String	VALIDATION_PENDINGCHG The Tenant delta validation for pending changes.

Fields inherited from interface psdi.app.configure.ConfigureServiceRemote

CONFIGDB_NONE, CONFIGDB_NONSTRUCT, CONFIGDB_STRUCT, MAXTYPE_CHAR, MAXTYPE_DATE, MAXTYPE_MISC, MAXTYPE_NUM, MAXTYPE_UNKNOWN, MAXTYPE_YORN

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
ConfigureService()
ConfigureService(MXServer mxServer)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfigMsg(java.lang.String msg) Allow ConfigDB to add a message to our map.
void	applyTenantChanges(UserInfo tenantInfo, int tenanatId) Calls getRemoveChanges for each storage partition in the valuelist, and executes the statements returned, with the appropriate commit and rollback logic.
boolean	areTenantsOnboarded() Determine if tenants have been on boarded
boolean	canDeleteFromConfigExtTable(java.lang.String attributeName, java.lang.String objectName) Checks to see whether a tenant is using a given column on the extension table before allowing the DA to delete the attribute through the database configuration app.
void	changeAmountFormat(int newLength, int newScale) Calls changeAmountFormat, and executes the statements returned, with the appropriate commit and rollback logic.
void	changeAmountFormat(int newLength, int newScale, int origLength, int origScale) Calls changeAmountFormat, and executes the statements returned, with the appropriate commit and rollback logic.
void	changeIntFormat(int newIntLength, int newSmallintLength) Updates maxattributecfg / maxobjectcfg for change of length for INTEGER and/or SMALLINT attributes.
void	changeIntFormat(int newIntLength, int newSmallintLength, int origIntLength, int origSmallintLength) Updates maxattributecfg / maxobjectcfg for change of length for INTEGER and/or SMALLINT attributes.
java.lang.StringBuffer	checkDomainLinks(UserInfo ui, java.util.HashSet<java.lang.String> options) Check the domain link records for all the attributes comparing to other metadata of the attributes.
MXException	checkDomainLinks(UserInfo ui, MaxAttributeCfgRemote mac, MboSetRemote domainLinks) Checks the domainid on the maxattributecfg record to the maxdomainlink record.
MXException	compare(java.util.HashSet<java.lang.String> byPass, java.lang.String object, java.lang.String attr, java.util.HashSet<java.lang.String> domsOnMeta, java.lang.String[] domsByLink, java.lang.StringBuffer os, UserInfo ui, boolean genInsertStatement) Compare the MAXDOMAINLINK record and the domain id specified in field valiation class and domainid on maxattribute.
boolean	configIsRunning() Identifies whether the ConfigDB thread is running.
java.lang.String	convertToLocale(java.lang.String inputValue, java.lang.String maxtype, java.util.Locale fromLocale, java.util.TimeZone fromTimeZone, java.util.Locale toLocale, java.util.TimeZone toTimeZone) Convert the input value into the specified Locale.
boolean	createExtensionTable(UserInfo masterInfo, java.lang.String tableName) Calls createTable for each extension table to be created.
void	createSelectedExtensionViews(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> objectNames, java.util.Set<java.lang.String> deleteObjects, java.sql.Connection masterCon, int tenantId) Calls createTable for each extension table to be created.
boolean	descendingIndexesSupported() Indicates whether this database supports descending indexes.
void	discardALLTenantDeltas()
void	doSql(java.util.List list) Loops through an array and calls doSql for each element.
void	doSql(java.lang.String sql) Execute a sql statement, using our connection.
void	dropBackup(MboSetRemote tableSet) Call dropBackup for each selected table in the set.
void	dropBackup(java.lang.String tablenames) Drop backup tables that were created via ConfigDB, after their data has been restored.
java.util.HashSet	getAllCommonAttributes(MboSetRemote object1Attrs, MboSetRemote object2Attrs) If this is a view joining two tables, get the names of the attributes that exist in both objects (ExtendsObject and JoinObject).
int	getConfigLevel()
int	getConfigLevel(UserInfo ui) Determine whether there are any pending configuration changes, and if there are, whether they are structural or non-structural.
int	getDBPlatform() Get the database platform.
java.lang.String	getDefaultStoragePartition() Calls getDefaultStoragePartition (with valuelist check).
int	getGLMaxtypeLengthFromGLConfigure(UserInfo userInfo) Get the correct column length for a GL field.
java.util.HashMap	getGrants(java.lang.String dbUserID, java.lang.String entityname) Get grant info for a given user.
java.util.HashMap	getJoinAttributes(MboRemote object1, MboSetRemote object1Attrs, MboRemote object2, MboSetRemote object2Attrs) For a view joining two tables, get the names of the attributes used in the join.
int	getMaxColumnLength(java.lang.String tablename, java.lang.String columnname) Calls getMaxColumnLength to determine the maximum length of data currently in this column.
int	getMaxLengthColumnInIndex() Get the maximum allowed for the length of any one column in an index.
int	getMaxLengthIndex() Get the maximum allowed for the sum of lengths of all columns in an index.
int	getMaxtypeCategory(java.lang.String maxtype) Identify the general category of maxtype.
int	getNumConfigMsgs() Get the number of messages that have been added by ConfigDB.
MboSetRemote	getOldBackupTables(UserInfo userInfo) Return set of MaxTableCfg that have old backup tables.
MboSetRemote	getUnrestoredTables(UserInfo userInfo) Return set of MaxTableCfg that need data copied into them from backup tables.
void	grantNative(java.lang.String dbUserID, java.lang.String entityname, java.lang.String privilege, boolean grant) Grant or revoke native database access for a given suer and table/view.
void	init() Initialize the Application Service.
boolean	isActiveExtTable(java.lang.String objectName) /** Determines if the current object is an active extension table, meaning that it hosts extended attirbutes defined against a base object.
boolean	isReservedWord(java.lang.String testWord) Test whether this is a reserved word on the native database.
boolean	isValidChar(java.lang.String checkString) Checks to see if the input string contains valid characters for the database.
void	listenToConfigDB(MboRemote listenerMbo, boolean listen) Register another listener for ConfigDB.
java.util.HashMap<java.lang.String,java.lang.String[]>	loadDomainLinks(UserInfo ui) Load maxdomainlink records to a HashMap.
void	logException(java.lang.Exception e) If configLogger is error enabled, write error to log, else printStackTrace.
boolean	nativeTableExists(java.lang.String tablename) Indicates whether the table exists on the native database.
boolean	nativeTypesAreCompatible(java.lang.String oldNativeType, java.lang.String newNativeType) Identifies whether data can be copied from old native datatype to new native datatype without any conversion activity, or with Oracle to_char for date-to-string, or with SqlServer convert function.
boolean	nativeViewExists(java.lang.String viewname) Indicates whether the view exists on the native database.
boolean	noDeltaRows(MboRemote masterMbo, java.lang.String validationType) Validates tenant delta rows for length,required and default value.
boolean	pendingDeltaRowExist() Validates tenant delta rows for length,required and default value.
void	refreshIndexMetadata(MboSetRemote objectSet) Call refreshIndexMetadata for each table in the set.
void	refreshIndexMetadata(java.lang.String tablename) Calls getSysIndexRefresh and adjustPrimaryKeyColSeq, executing the statements returned, with the appropriate commit and rollback logic.
void	removeChanges() Calls getRemoveChanges for each storage partition in the valuelist, and executes the statements returned, with the appropriate commit and rollback logic.
void	removeTenantChanges(UserInfo tenantInfo, int tenanatId) Calls getRemoveChanges for each storage partition in the valuelist, and executes the statements returned, with the appropriate commit and rollback logic.
void	runConfigDB(MboRemote listenerMbo)
void	runConfigDB(MboRemote listenerMbo, java.util.HashMap<java.lang.String,java.lang.String> params) Run ConfigDB.
void	setConfigStatus(int status) Set value for "completionstatus" on ProcessMonitor.
boolean	spaceIsSysManaged(java.lang.String spaceName) Determine whether the specified tablespace is system-managed.
void	updateStatistics(MboSetRemote objectSet) Call updateStatistics for each table in the set.
void	updateStatistics(java.lang.String tablename) Calls getUpdateStatistics for tables/indexes in the Maximo metadata, and executes the statements returned.
boolean	validateFormat(java.util.Locale locale, java.util.TimeZone timezone, java.lang.String value, java.lang.String maxtype, int length, int scale, boolean checkCase) Validate the string value against the specified maxtype, length and scale.
void	verifyView(java.lang.String objectname) Check the Cfg metadata for a view to see if it is properly formed.

Methods inherited from class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Field Detail

MAX_NAME_LENGTH

public static int MAX_NAME_LENGTH

The maximum length of object name.

VALIDATION_LENGTH

public static final java.lang.String VALIDATION_LENGTH

The Tenant delta validation type on LENGTH.

See Also:

Constant Field Values

VALIDATION_ALL

public static final java.lang.String VALIDATION_ALL

The Tenant delta validation type on ALL changes.

See Also:

Constant Field Values

VALIDATION_PENDINGCHG

public static final java.lang.String VALIDATION_PENDINGCHG

The Tenant delta validation for pending changes.

See Also:

Constant Field Values

Constructor Detail

ConfigureService

public ConfigureService()
                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

ConfigureService

public ConfigureService(MXServer mxServer)
                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()

Description copied from class: AppService

Initialize the Application Service.

Specified by:

init in interface Service

Overrides:

init in class AppService

See Also:

Service

isValidChar

public boolean isValidChar(java.lang.String checkString)
                    throws MXException,
                           java.rmi.RemoteException

Checks to see if the input string contains valid characters for the database. A-Z, 0-9, _, and $ are valid. The first character cannot equal _ or $.

Specified by:

isValidChar in interface ConfigureServiceRemote

Parameters:

checkString - the string to be checked

Returns:

True if valid, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

isValidChar(java.lang.String)

validateFormat

public boolean validateFormat(java.util.Locale locale,
                     java.util.TimeZone timezone,
                     java.lang.String value,
                     java.lang.String maxtype,
                     int length,
                     int scale,
                     boolean checkCase)
                       throws MXException,
                              java.rmi.RemoteException

Validate the string value against the specified maxtype, length and scale. If value is not valid, this method will either throw an error or return False.

Specified by:

validateFormat in interface ConfigureServiceRemote

Parameters:

locale - Locale for numeric and datetime validations.

timezone - Timezone for datetime validations.

value - The string value to be tested.

maxtype - The maxtype to verify the value against.

length - The length to verify the value against.

scale - The scale to verify the value against.

checkCase - True to check for proper case for UPPER and LOWER maxtypes. False to not check for case.

Returns:

True if valid, False if not valid. If not valid, this may instead throw an error from MXFormat or MaxType.

Throws:

MXException

java.rmi.RemoteException

See Also:

MXFormat, MaxType

convertToLocale

public java.lang.String convertToLocale(java.lang.String inputValue,
                               java.lang.String maxtype,
                               java.util.Locale fromLocale,
                               java.util.TimeZone fromTimeZone,
                               java.util.Locale toLocale,
                               java.util.TimeZone toTimeZone)
                                 throws MXException,
                                        java.rmi.RemoteException

Convert the input value into the specified Locale.

Specified by:

convertToLocale in interface ConfigureServiceRemote

Parameters:

inputValue - The input value.

maxtype - The maxtype of the inputValue.

fromLocale - The Locale of the inputValue.

fromTimeZone - The TimeZone of the inputValue.

toLocale - The Locale to convert to.

toTimeZone - The TimeZone to convert to.

Returns:

The inputValue formatted for the toLocale.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxType.asLocaleString(java.util.Locale)

removeChanges

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

Calls getRemoveChanges for each storage partition in the valuelist, and executes the statements returned, with the appropriate commit and rollback logic.

Specified by:

removeChanges in interface ConfigureServiceRemote

Throws:

"configure" - "RemoveChangesFailure"

MXException

java.rmi.RemoteException

See Also:

Util.getRemoveChanges(), Util.rebuildMetadataSequences()

removeTenantChanges

public void removeTenantChanges(UserInfo tenantInfo,
                       int tenanatId)
                         throws MXException,
                                java.rmi.RemoteException

Calls getRemoveChanges for each storage partition in the valuelist, and executes the statements returned, with the appropriate commit and rollback logic.

Throws:

"configure" - "RemoveChangesFailure"

MXException

java.rmi.RemoteException

See Also:

Util.getRemoveChanges(), Util.rebuildMetadataSequences()

applyTenantChanges

public void applyTenantChanges(UserInfo tenantInfo,
                      int tenanatId)
                        throws MXException,
                               java.rmi.RemoteException

Calls getRemoveChanges for each storage partition in the valuelist, and executes the statements returned, with the appropriate commit and rollback logic.

Throws:

"configure" - "RemoveChangesFailure"

MXException

java.rmi.RemoteException

See Also:

Util.getRemoveChanges(), Util.rebuildMetadataSequences()

createSelectedExtensionViews

public void createSelectedExtensionViews(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> objectNames,
                                java.util.Set<java.lang.String> deleteObjects,
                                java.sql.Connection masterCon,
                                int tenantId)
                                  throws MXException,
                                         java.rmi.RemoteException

Calls createTable for each extension table to be created.

Parameters:

masterInfo - system configurator user info

tableName - name of the base table for which we want to create extension

Throws:

"configure" - "RemoveChangesFailure"

MXException

java.rmi.RemoteException

See Also:

psdi.configure.Util#createTable

createExtensionTable

public boolean createExtensionTable(UserInfo masterInfo,
                           java.lang.String tableName)
                             throws MXException,
                                    java.rmi.RemoteException

Calls createTable for each extension table to be created.

Specified by:

createExtensionTable in interface ConfigureServiceRemote

Parameters:

masterInfo - system configurator user info

tableName - name of the base table for which we want to create extension

Returns:

is table exists already or will be created (false if table already exists)

Throws:

"configure" - "RemoveChangesFailure"

MXException

java.rmi.RemoteException

See Also:

psdi.configure.Util#createTable

changeAmountFormat

public void changeAmountFormat(int newLength,
                      int newScale,
                      int origLength,
                      int origScale)
                        throws MXException,
                               java.rmi.RemoteException

Calls changeAmountFormat, and executes the statements returned, with the appropriate commit and rollback logic. This does not update maxvars (that should be done by AmountFormat object.)

Specified by:

changeAmountFormat in interface ConfigureServiceRemote

Parameters:

newLength - The new amount field length.

newScale - The new amount field scale.

origLength - The original amount field length.

origScale - The original amount field scale.

Throws:

"configure" - "AmountFormatChangeFailure"

MXException

java.rmi.RemoteException

See Also:

Util.changeAmountFormat(int, int)

changeAmountFormat

public void changeAmountFormat(int newLength,
                      int newScale)
                        throws MXException,
                               java.rmi.RemoteException

Calls changeAmountFormat, and executes the statements returned, with the appropriate commit and rollback logic. This does not update maxvars (that should be done by AmountFormat object.)

Specified by:

changeAmountFormat in interface ConfigureServiceRemote

Parameters:

newLength - The new amount field length.

newScale - The new amount field scale.

Throws:

"configure" - "AmountFormatChangeFailure"

MXException

java.rmi.RemoteException

See Also:

Util.changeAmountFormat(int, int)

changeIntFormat

public void changeIntFormat(int newIntLength,
                   int newSmallintLength,
                   int origIntLength,
                   int origSmallintLength)
                     throws MXException,
                            java.rmi.RemoteException

Updates maxattributecfg / maxobjectcfg for change of length for INTEGER and/or SMALLINT attributes. This does not update maxvars (that should be done by AmountFormat object.)

Specified by:

changeIntFormat in interface ConfigureServiceRemote

Parameters:

newIntLength - The new Integer field length. If it's not changing, pass 0 or the current value.

newSmallintLength - The new Smallint field length. If it's not changing, pass 0 or the current value.

origIntLength - The original Integer field length.

origSmallintLength - The original Smallint field length.

Throws:

"configure" - "AmountFormatChangeFailure"

MXException

java.rmi.RemoteException

See Also:

changeIntFormat(int, int, int, int)

changeIntFormat

public void changeIntFormat(int newIntLength,
                   int newSmallintLength)
                     throws MXException,
                            java.rmi.RemoteException

Updates maxattributecfg / maxobjectcfg for change of length for INTEGER and/or SMALLINT attributes. This does not update maxvars (that should be done by AmountFormat object.)

Specified by:

changeIntFormat in interface ConfigureServiceRemote

Parameters:

newIntLength - The new Integer field length. If it's not changing, pass 0 or the current value.

newSmallintLength - The new Smallint field length. If it's not changing, pass 0 or the current value.

Throws:

"configure" - "AmountFormatChangeFailure"

MXException

java.rmi.RemoteException

See Also:

changeIntFormat(int, int)

updateStatistics

public void updateStatistics(MboSetRemote objectSet)
                      throws MXException,
                             java.rmi.RemoteException

Call updateStatistics for each table in the set.

Specified by:

updateStatistics in interface ConfigureServiceRemote

Parameters:

objectSet - Set of MaxObjectCfg.

Throws:

MXException

java.rmi.RemoteException

See Also:

updateStatistics(String)

updateStatistics

public void updateStatistics(java.lang.String tablename)
                      throws MXException,
                             java.rmi.RemoteException

Calls getUpdateStatistics for tables/indexes in the Maximo metadata, and executes the statements returned.

Specified by:

updateStatistics in interface ConfigureServiceRemote

Parameters:

tablename - The table name (optional). If this is not null, then only the indexes for this table will have statistics updated. If this is null, then they will be updated for all tables.

Throws:

"configure" - "UpdateStatisticsFailure"

MXException

java.rmi.RemoteException

See Also:

nativeTableExists(java.lang.String), Util.getIndexMeta(java.lang.String, boolean), Util.getUpdateStatistics(java.util.TreeMap, java.util.TreeMap)

refreshIndexMetadata

public void refreshIndexMetadata(MboSetRemote objectSet)
                          throws MXException,
                                 java.rmi.RemoteException

Call refreshIndexMetadata for each table in the set.

Specified by:

refreshIndexMetadata in interface ConfigureServiceRemote

Parameters:

objectSet - Set of MaxObjectCfg.

Throws:

MXException

java.rmi.RemoteException

See Also:

refreshIndexMetadata(String)

refreshIndexMetadata

public void refreshIndexMetadata(java.lang.String tablename)
                          throws MXException,
                                 java.rmi.RemoteException

Calls getSysIndexRefresh and adjustPrimaryKeyColSeq, executing the statements returned, with the appropriate commit and rollback logic.

Specified by:

refreshIndexMetadata in interface ConfigureServiceRemote

Parameters:

tablename - The table name (optional). If this is not null, then only the indexes for this table will have metadata refreshed. If this is null, then they will be refreshed for all tables (for each storage partition in the valuelist).

Throws:

"configure" - "RefreshIndexMetaFailure"

MXException

java.rmi.RemoteException

See Also:

Util.longIndexNamesExist(java.lang.String), Util.dupIndexNamesExist(java.lang.String, java.lang.String), Util.getDBStoragePartitions(), Util.getSysIndexRefresh(java.lang.String, java.lang.String), Util.fixMetadataForDescendingKeys(java.lang.String, java.lang.String), Util.adjustPrimaryKeyColSeq(java.util.TreeMap), MaximoDD.reload(String)

getUnrestoredTables

public MboSetRemote getUnrestoredTables(UserInfo userInfo)
                                 throws MXException,
                                        java.rmi.RemoteException

Return set of MaxTableCfg that need data copied into them from backup tables.

Parameters:

userInfo - UserInfo for getting the MboSet.

Returns:

set of MaxTableCfg that need to be loaded from backup tables.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getUnrestoredTables(java.lang.String)

getOldBackupTables

public MboSetRemote getOldBackupTables(UserInfo userInfo)
                                throws MXException,
                                       java.rmi.RemoteException

Return set of MaxTableCfg that have old backup tables.

Parameters:

userInfo - UserInfo for getting the MboSet.

Returns:

set of MaxTableCfg that have old backup tables.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getOldBackupTables(java.lang.String)

dropBackup

public void dropBackup(MboSetRemote tableSet)
                throws MXException,
                       java.rmi.RemoteException

Call dropBackup for each selected table in the set.

Specified by:

dropBackup in interface ConfigureServiceRemote

Parameters:

tableSet - Set of DrpOldTabSet or MaxTableCfg .

Throws:

MXException

java.rmi.RemoteException

See Also:

dropBackup(String)

dropBackup

public void dropBackup(java.lang.String tablenames)
                throws MXException,
                       java.rmi.RemoteException

Drop backup tables that were created via ConfigDB, after their data has been restored. This is run with the -e and -l parameters, and if tbnames are supplied, also with the -t parameter.

Specified by:

dropBackup in interface ConfigureServiceRemote

Parameters:

tablenames - Optional list of table names (separated by commas) to be restored. If none specified, then all eligible tables will be dropped. For example, if this parameter equals EQUIPMENT, then if the backup table XXEQUIPMENT is eligible to be dropped, it will be dropped.

Throws:

MXException

java.rmi.RemoteException

See Also:

DropBackup

getConfigLevel

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

Specified by:

getConfigLevel in interface ConfigureServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getConfigLevel(UserInfo)

getConfigLevel

public int getConfigLevel(UserInfo ui)
                   throws MXException,
                          java.rmi.RemoteException

Determine whether there are any pending configuration changes, and if there are, whether they are structural or non-structural. Non-structural changes are eligible for "live" database configuration (ConfigDB when users are logged on and server is not in AdminMode). Structural changes must be applied with MXServer in AdminMode or MXServer shut down.

Both structural and non-structural changes are applied via ConfigDB. The difference is the state required of MXServer.

Returns:

Values:

• CONFIGDB_NONE = Nothing to configure
• CONFIGDB_NONSTRUCT = Can do partial live update ("non-structural")
• CONFIGDB_STRUCT = Need to do structural updates

Throws:

MXException

java.rmi.RemoteException

See Also:

ConfigureServiceRemote.CONFIGDB_NONE, ConfigureServiceRemote.CONFIGDB_NONSTRUCT, ConfigureServiceRemote.CONFIGDB_STRUCT

runConfigDB

public void runConfigDB(MboRemote listenerMbo)
                 throws MXException,
                        java.rmi.RemoteException

Specified by:

runConfigDB in interface ConfigureServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

runConfigDB(MboRemote, HashMap)

runConfigDB

public void runConfigDB(MboRemote listenerMbo,
               java.util.HashMap<java.lang.String,java.lang.String> params)
                 throws MXException,
                        java.rmi.RemoteException

Run ConfigDB.

1. Call dropBackup for all tables.
2. Start ConfigDBThread to run ConfigDB and do finish-up tasks.

Specified by:

runConfigDB in interface ConfigureServiceRemote

Parameters:

listenerMbo - ProcessMonitor mbo that will be updated with any messages from ConfigDB. If null then nothing will be listening.

params - Parameters for ConfigDB. Normally this will be null. If non-null then whatever values are in this map will be input to ConfigDB.

Throws:

MXException

java.rmi.RemoteException

See Also:

DropBackup, ConfigDB, RestoreFromBackup, ConfigureService.ConfigDBThread

listenToConfigDB

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

Register another listener for ConfigDB.

Specified by:

listenToConfigDB in interface ConfigureServiceRemote

Parameters:

listenerMbo - ProcessMonitor mbo.

listen - True to start listening, False to stop listening

Throws:

MXException

java.rmi.RemoteException

See Also:

listenToConfigDB(psdi.mbo.MboRemote, boolean)

configIsRunning

public boolean configIsRunning()
                        throws MXException,
                               java.rmi.RemoteException

Identifies whether the ConfigDB thread is running.

Specified by:

configIsRunning in interface ConfigureServiceRemote

Returns:

True if thread is running

Throws:

MXException

java.rmi.RemoteException

See Also:

configIsRunning()

addConfigMsg

public void addConfigMsg(java.lang.String msg)
                  throws MXException,
                         java.rmi.RemoteException

Allow ConfigDB to add a message to our map.

Specified by:

addConfigMsg in interface ConfigureServiceRemote

Parameters:

msg -

Throws:

MXException

java.rmi.RemoteException

See Also:

configMsgs, configdbListeners

setConfigStatus

public void setConfigStatus(int status)

Set value for "completionstatus" on ProcessMonitor. Valie values are associated with static variables defined in ProcessMonitor.

Parameters:

status - PROCESS_RUNNING, PROCESS_SUCCESS, or PROCESS_ERROR

See Also:

configMsgs, configdbListeners

getNumConfigMsgs

public int getNumConfigMsgs()

Get the number of messages that have been added by ConfigDB.

Specified by:

getNumConfigMsgs in interface ConfigureServiceRemote

Returns:

number of messages

See Also:

getNumConfigMsgs()

getMaxColumnLength

public int getMaxColumnLength(java.lang.String tablename,
                     java.lang.String columnname)
                       throws MXException,
                              java.rmi.RemoteException

Calls getMaxColumnLength to determine the maximum length of data currently in this column.

Specified by:

getMaxColumnLength in interface ConfigureServiceRemote

Parameters:

tablename - Table name.

columnname - Column name.

Throws:

"configure" - "MaxLengthFailure"

MXException

java.rmi.RemoteException

See Also:

Util.getMaxColumnLength(java.lang.String, java.lang.String)

getGLMaxtypeLengthFromGLConfigure

public int getGLMaxtypeLengthFromGLConfigure(UserInfo userInfo)
                                      throws MXException,
                                             java.rmi.RemoteException

Get the correct column length for a GL field. This is used when defining a GL column on MaxSysColsCfg to determine the value for the length attribute. The maxtype will be "GL" and the column will behave natively as though it were a regular ALN field. However, the segments of the GL account and their formats are defined in GLConfigure.

Specified by:

getGLMaxtypeLengthFromGLConfigure in interface ConfigureServiceRemote

Parameters:

userInfo - UserInfo

Returns:

Length to be used on maxsyscolscfg when maxtype is GL.

Throws:

MXException

java.rmi.RemoteException

See Also:

GLConfigureSet.getGLMaxtypeLength()

getDefaultStoragePartition

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

Calls getDefaultStoragePartition (with valuelist check).

Specified by:

getDefaultStoragePartition in interface ConfigureServiceRemote

Throws:

"configure" - "MiscUtilFailure"

MXException

java.rmi.RemoteException

See Also:

Util.getDefaultStoragePartition(boolean)

nativeTableExists

public boolean nativeTableExists(java.lang.String tablename)
                          throws MXException,
                                 java.rmi.RemoteException

Indicates whether the table exists on the native database. Called from field validation class for table name and eaudittbname.

Specified by:

nativeTableExists in interface ConfigureServiceRemote

Parameters:

tablename - The table to check for.

Returns:

True if the table exists on the native database, else False.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.nativeTableExists(java.lang.String)

nativeViewExists

public boolean nativeViewExists(java.lang.String viewname)
                         throws MXException,
                                java.rmi.RemoteException

Indicates whether the view exists on the native database. Called from field validation class for view name.

Specified by:

nativeViewExists in interface ConfigureServiceRemote

Parameters:

viewname - The view to check for.

Returns:

True if the view exists on the native database, else False.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.nativeViewExists(java.lang.String)

descendingIndexesSupported

public boolean descendingIndexesSupported()
                                   throws MXException

Indicates whether this database supports descending indexes.

Returns:

True if descending indexes are supported, else False.

Throws:

MXException

See Also:

Util.descendingIndexesSupported()

getMaxLengthColumnInIndex

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

Get the maximum allowed for the length of any one column in an index. This value depends on the native db platform.

Specified by:

getMaxLengthColumnInIndex in interface ConfigureServiceRemote

Returns:

The maximum allowed for the length of any one column in an index. If there is no maximum, this will return 999999.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getMaxLengthColumnInIndex()

getMaxLengthIndex

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

Get the maximum allowed for the sum of lengths of all columns in an index. This value depends on the native db platform.

Specified by:

getMaxLengthIndex in interface ConfigureServiceRemote

Returns:

The maximum allowed for the sum of lengths of all columns in an index. If there is no maximum, this will return 999999.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getMaxLengthIndex()

spaceIsSysManaged

public boolean spaceIsSysManaged(java.lang.String spaceName)
                          throws MXException,
                                 java.rmi.RemoteException

Determine whether the specified tablespace is system-managed. This pertains only to DB2. If the platform is not DB2, this method returns False.

Specified by:

spaceIsSysManaged in interface ConfigureServiceRemote

Parameters:

spaceName - Name of the tablespace to be checked.

Returns:

True if the tablespace is system-managed and platform is DB2

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.spaceIsSysManaged(java.lang.String)

getGrants

public java.util.HashMap getGrants(java.lang.String dbUserID,
                          java.lang.String entityname)
                            throws MXException,
                                   java.rmi.RemoteException

Get grant info for a given user.

Specified by:

getGrants in interface ConfigureServiceRemote

Parameters:

dbUserID - User Name on the native database (databaseuserid).

entityname - Table or view name, if only one is to be queried. If this is null then all maximo entities will be queried.

Returns:

HashMap where key = table or view name, element = int[] where [0] = Read access, [1] = Insert access, [2] = Update access, [3] = Delete access. (1 = granted, 0 = not granted.)

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getGrants(java.lang.String, java.lang.String)

grantNative

public void grantNative(java.lang.String dbUserID,
               java.lang.String entityname,
               java.lang.String privilege,
               boolean grant)
                 throws MXException,
                        java.rmi.RemoteException

Grant or revoke native database access for a given suer and table/view.

Specified by:

grantNative in interface ConfigureServiceRemote

Parameters:

dbUserID - User Name on the native database (databaseuserid).

entityname - Table or view name, if only one is to be queried. If this is null then all maximo entities will be queried.

privilege - READ, INSERT, UPDATE, or DELETE

grant - True to grant, False to revoke

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getGrants(java.lang.String, java.lang.String)

getDBPlatform

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

Get the database platform.

Specified by:

getDBPlatform in interface ConfigureServiceRemote

Returns:

The platform.

Throws:

MXException

java.rmi.RemoteException

See Also:

getDBPlatform()

isReservedWord

public boolean isReservedWord(java.lang.String testWord)
                       throws MXException,
                              java.rmi.RemoteException

Test whether this is a reserved word on the native database.

Specified by:

isReservedWord in interface ConfigureServiceRemote

Parameters:

testWord - The word to be tested. If this is SqlServer, this method will also test uppercase and lowercase of the testWord.

Returns:

True if reserved word, else False.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.isReservedWord(java.lang.String)

doSql

public void doSql(java.util.List list)
           throws MXException,
                  java.rmi.RemoteException

Loops through an array and calls doSql for each element.

Parameters:

list - Any instance or extension of AbstractList, including ArrayList, etc.

Throws:

MXException

java.rmi.RemoteException

See Also:

doSql(String)

doSql

public void doSql(java.lang.String sql)
           throws MXException,
                  java.rmi.RemoteException

Execute a sql statement, using our connection.

Parameters:

sql - The Sql statement

Throws:

"configure" - "DoSqlFailure"

MXException

java.rmi.RemoteException

getJoinAttributes

public java.util.HashMap getJoinAttributes(MboRemote object1,
                                  MboSetRemote object1Attrs,
                                  MboRemote object2,
                                  MboSetRemote object2Attrs)
                                    throws MXException,
                                           java.rmi.RemoteException

For a view joining two tables, get the names of the attributes used in the join. This method first tries by matching the attribute in primarykeycolseq, and if that doesn't work, it looks through all the unique indexes.

Parameters:

object1 - MaxObjectCfg mbo for extendsobject

object1Attrs - Set of maxattributecfg from extendsobject

object2 - MaxObjectCfg for joinobject

object2Attrs - Set of maxattributecfg from joinobject

Returns:

The names of attributes that are used in the join. Key = attributename from object1. Value = attributename from object2.

Throws:

MXException

java.rmi.RemoteException

See Also:

getMaxAttribute(java.lang.String, java.lang.String, psdi.mbo.MboSetRemote), attributesAreEquivalent(psdi.mbo.MboRemote, psdi.mbo.MboRemote)

getAllCommonAttributes

public java.util.HashSet getAllCommonAttributes(MboSetRemote object1Attrs,
                                       MboSetRemote object2Attrs)
                                         throws MXException,
                                                java.rmi.RemoteException

If this is a view joining two tables, get the names of the attributes that exist in both objects (ExtendsObject and JoinObject). This method just checks for duplicate attributenames, and is used when populating views.

Parameters:

object1Attrs - Set of maxattributecfg from extendsobject

object2Attrs - Set of maxattributecfg from joinobject

Returns:

The names of all attributes that exist in both ExtendsObject and JoinObject.

Throws:

MXException

java.rmi.RemoteException

getMaxtypeCategory

public int getMaxtypeCategory(java.lang.String maxtype)
                       throws MXException,
                              java.rmi.RemoteException

Identify the general category of maxtype.

Specified by:

getMaxtypeCategory in interface ConfigureServiceRemote

Parameters:

maxtype - The maxtype to be evaluated.

Returns:

MAXTYPE_CHAR, MAXTYPE_NUM, MAXTYPE_DATE, MAXTYPE_YORN, MAXTYPE_MISC, or MAXTYPE_UNKNOWN.

Throws:

MXException

java.rmi.RemoteException

See Also:

getMaxtypeCategory(java.lang.String)

nativeTypesAreCompatible

public boolean nativeTypesAreCompatible(java.lang.String oldNativeType,
                               java.lang.String newNativeType)
                                 throws MXException,
                                        java.rmi.RemoteException

Identifies whether data can be copied from old native datatype to new native datatype without any conversion activity, or with Oracle to_char for date-to-string, or with SqlServer convert function. Called from FldMaxAttributeCfgMaxType.

Specified by:

nativeTypesAreCompatible in interface ConfigureServiceRemote

Parameters:

oldNativeType - Old native datatype

newNativeType - New native datatype

Returns:

True if data can be copied, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.nativeTypesAreCompatible(java.lang.String, java.lang.String), Util.getOracleConvertString(java.lang.String, java.lang.String, java.lang.String), Util.explicitConversionSupported(java.lang.String, java.lang.String)

logException

public void logException(java.lang.Exception e)

If configLogger is error enabled, write error to log, else printStackTrace.

checkDomainLinks

public java.lang.StringBuffer checkDomainLinks(UserInfo ui,
                                      java.util.HashSet<java.lang.String> options)
                                        throws MXException,
                                               java.rmi.RemoteException

Check the domain link records for all the attributes comparing to other metadata of the attributes. This is a expensive and lengthy operation. The output will be written to the domain checker logger as well as the output stream.

Specified by:

checkDomainLinks in interface ConfigureServiceRemote

Parameters:

ui - UserInfo object

options - A HashSet for option strings. -s for generate insert statement, -d for checking against data

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.configure.ConfigureService#checkDomainLinks(UserInfo, HashSet)

compare

public MXException compare(java.util.HashSet<java.lang.String> byPass,
                  java.lang.String object,
                  java.lang.String attr,
                  java.util.HashSet<java.lang.String> domsOnMeta,
                  java.lang.String[] domsByLink,
                  java.lang.StringBuffer os,
                  UserInfo ui,
                  boolean genInsertStatement)
                    throws MXException,
                           java.rmi.RemoteException

Compare the MAXDOMAINLINK record and the domain id specified in field valiation class and domainid on maxattribute.

Parameters:

byPass -

object -

attr -

domsOnMeta -

domsByLink -

os -

ui - UserInfo

genInsertStatement - True or false

Returns:

Null if no error, else MXException

Throws:

MXException

java.rmi.RemoteException

checkDomainLinks

public MXException checkDomainLinks(UserInfo ui,
                           MaxAttributeCfgRemote mac,
                           MboSetRemote domainLinks)
                             throws MXException,
                                    java.rmi.RemoteException

Checks the domainid on the maxattributecfg record to the maxdomainlink record. If error or warning encounterd, and exception object will be returned, otherwise null will be returned.

Specified by:

checkDomainLinks in interface ConfigureServiceRemote

Parameters:

ui - UserInfo

mac - MaxAttributeCfgRemote

domainLinks - MboSetRemote

Returns:

Null if no error, otherwise MXException

Throws:

MXException

java.rmi.RemoteException

See Also:

checkDomainLinks(UserInfo, MaxAttributeCfgRemote, MboSetRemote)

loadDomainLinks

public java.util.HashMap<java.lang.String,java.lang.String[]> loadDomainLinks(UserInfo ui)
                                                                       throws MXException,
                                                                              java.rmi.RemoteException

Load maxdomainlink records to a HashMap.

Parameters:

ui - UserInfo

Returns:

HashMap

Throws:

MXException

java.rmi.RemoteException

verifyView

public void verifyView(java.lang.String objectname)
                throws MXException,
                       java.rmi.RemoteException

Check the Cfg metadata for a view to see if it is properly formed. If badly formed then throw error.

Specified by:

verifyView in interface ConfigureServiceRemote

Parameters:

objectname -

Throws:

MXException

java.rmi.RemoteException

See Also:

verifyView(java.lang.String)

noDeltaRows

public boolean noDeltaRows(MboRemote masterMbo,
                  java.lang.String validationType)
                    throws MXApplicationException

Validates tenant delta rows for length,required and default value.

Specified by:

noDeltaRows in interface ConfigureServiceRemote

Parameters:

masterMbo - MboRemote

validationType - String - valid are LENGTH and ALL

Returns:

boolean - true if no delta rows exist

Throws:

MXApplicationException

See Also:

noDeltaRows(psdi.mbo.MboRemote, java.lang.String)

pendingDeltaRowExist

public boolean pendingDeltaRowExist()
                             throws MXApplicationException

Validates tenant delta rows for length,required and default value.

Specified by:

pendingDeltaRowExist in interface ConfigureServiceRemote

Parameters:

masterMbo - MboRemote

validationType - String - valid are LENGTH and ALL

Returns:

boolean - true if no delta rows exist

Throws:

MXApplicationException

See Also:

pendingDeltaRowExist()

discardALLTenantDeltas

public void discardALLTenantDeltas()
                            throws MXApplicationException

Specified by:

discardALLTenantDeltas in interface ConfigureServiceRemote

Throws:

MXApplicationException

See Also:

discardALLTenantDeltas()

isActiveExtTable

public boolean isActiveExtTable(java.lang.String objectName)
                         throws MXApplicationException,
                                java.rmi.RemoteException

/** Determines if the current object is an active extension table, meaning that it hosts extended attirbutes defined against a base object. If it is an active extension table, the object name of the base object is returned. If the environment is configured for multitenancy, all tenants are checked except master.

Specified by:

isActiveExtTable in interface ConfigureServiceRemote

Parameters:

objectName - the name of the object

Returns:

the name of the base object if the extension table is used, null if not

Throws:

MXApplicationException

java.rmi.RemoteException

See Also:

isActiveExtTable(java.lang.String)

canDeleteFromConfigExtTable

public boolean canDeleteFromConfigExtTable(java.lang.String attributeName,
                                  java.lang.String objectName)
                                    throws MXException,
                                           java.rmi.RemoteException

Checks to see whether a tenant is using a given column on the extension table before allowing the DA to delete the attribute through the database configuration app.

Specified by:

canDeleteFromConfigExtTable in interface ConfigureServiceRemote

Parameters:

attributeName -

objectName -

Returns:

Throws:

MXException

java.rmi.RemoteException

See Also:

canDeleteFromConfigExtTable(java.lang.String, java.lang.String)

areTenantsOnboarded

public boolean areTenantsOnboarded()
                            throws java.rmi.RemoteException,
                                   MXException

Determine if tenants have been on boarded

Specified by:

areTenantsOnboarded in interface ConfigureServiceRemote

Returns:

true if tenants are on boarded other than the Global Administrator and System Monitor

Throws:

MXApplicationException - if MXServer is not multi tenancy enabled

java.rmi.RemoteException

MXException

See Also:

areTenantsOnboarded()