psdi.dm.pkg

Class DMPackage

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

psdi.dm.pkg.DMPackage

All Implemented Interfaces:

java.rmi.Remote, DMPackageRemote, MboConstants, MboRemote, StatefulMboRemote, MaxRemoteProxy, FixedLoggerNames, FixedLoggers

public class DMPackage
extends StatefulMbo
implements DMPackageRemote, FixedLoggers

Field Summary

Fields inherited from class psdi.mbo.StatefulMbo

onListTab, statusChangeButtonSigoption, targetStatusOption

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

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

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
DMPackage(MboSet ms) Construct the Pkg object

Method Summary

Modifier and Type	Method and Description
void	add() Add a new package
void	applyFix() Update the file where the error occurred with the updated XML.
void	canDelete() Check if package can be deleted or not.
void	canDistribute() Throws an exception if this package can not be distributed due to its status.
java.lang.String	canDownloadFile(MboRemote cmpSrc) Check whether a compiled source file exists for download.
java.lang.String	canDownloadPkg() Check whether a package file exists for download.
java.lang.String	canDownloadPreviewLog() Check whether a preview log file exists for download.
java.lang.String	canDownloadScriptLog() Check whether a script log file exists for download.
void	changeMaxStatus(java.lang.String status, java.lang.String progressStatus, java.util.Date asOfDate, java.lang.String memo, long accessModifier) Change status, using the default values for the status and progress status.
void	changeStatus(java.lang.String status, java.lang.String progressStatus, java.util.Date date, java.lang.String memo, long accessModifier) Change the status of package with the progressstatus
void	closePkg() Purge a package.
MboRemote	confirmCompSrcDeployed() Set status after Confirmation of compiled sources have been deployed
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
void	deleteForPreview(long accessModifier) Delete package metadata to preview again.
void	deployPackage(MboSetRemote pkgDefSet) Start deploy thread at target server.
java.lang.String	distributePackage() Distribute package to FILE or Database
boolean	distributeZipPackage() Creates a zip file in the dmroot directory for download in the browser.
void	getLongopPreviewOKMsg(java.lang.String pkgName, UserInfo ui, MboSetRemote defSet) Write preview done messages to longop.
MboRemote	getPackageDef() Returns the package's definition.
boolean	getRedistribute() Returns true if the package is set to be redistributed.
java.lang.String	getStatusListName() Gets the name of the value list that contains all the status's.
void	init() initialize package
java.util.HashMap<java.lang.Integer,psdi.dm.pkg.DMPackage.MosPreviewInfo>	mosGrpResolver(java.util.HashMap<java.lang.Integer,java.lang.String> objMap) Find group for a mos and find start and end number of Mos and group
void	previewLogger(java.lang.String pkgName, boolean load) Load and unload preview logger dynamically
void	processPreviewXML(MXTransaction mxTrans, UserInfo ui, java.lang.String mos, byte[] content, boolean recordRollback) Process xml using preview mode.
void	setRedistribute(boolean isRedistribute) Set redistribute flag for the package
void	uploadCompiledSrcFile(java.lang.String fileName, byte[] content) Upload compiled source file into the staging table.
boolean	writeMosToXML(java.lang.String type, java.lang.String defClassName, java.lang.String mosName, MboSetRemote mosMboSet, boolean isChange, int batchSize, boolean useDefaultXMLAction) Write the provided MOS mboset into an xml.

Methods inherited from class psdi.mbo.StatefulMbo

canChangeMaxStatus, canChangeStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, checkForOpenStatus, checkStatusChangeAuthorization, filterByValidStatusList, fireEvent, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, duplicate, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.StatefulMboRemote

canChangeMaxStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, checkForOpenStatus, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, duplicate, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

DMPackage

public DMPackage(MboSet ms)
          throws java.rmi.RemoteException

Construct the Pkg object

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

initialize package

Overrides:

init in class Mbo

Throws:

MXException

add

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

Add a new package

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

canDelete

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

Check if package can be deleted or not.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

Description copied from class: Mbo

Mark the object to be deleted depending on the access modifier. This will usually be overridden in the subclass of Mbo as there may be application specific rules as to if and when an object can be deleted. Object is not actually deleted in the database until save() is called. This method will also mark all associated Long Description and Translation Mbos for deletion.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

deleteForPreview

public void deleteForPreview(long accessModifier)
                      throws MXException,
                             java.rmi.RemoteException

Delete package metadata to preview again.

Specified by:

deleteForPreview in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

writeMosToXML

public boolean writeMosToXML(java.lang.String type,
                             java.lang.String defClassName,
                             java.lang.String mosName,
                             MboSetRemote mosMboSet,
                             boolean isChange,
                             int batchSize,
                             boolean useDefaultXMLAction)
                      throws MXException,
                             java.rmi.RemoteException

Write the provided MOS mboset into an xml.

Specified by:

writeMosToXML in interface DMPackageRemote

Parameters:

mosName - The name of the MOS (configuration object).

mosMboSet - The mboset that represents data for this MOS.

isChange - Boolean to indicate whether this is a snapshot or change type.

batchSize - The number of top level mbos to process at each batch.

Throws:

MXException

java.rmi.RemoteException

getStatusListName

public java.lang.String getStatusListName()

Gets the name of the value list that contains all the status's.

Specified by:

getStatusListName in interface StatefulMboRemote

Specified by:

getStatusListName in class StatefulMbo

Returns:

"PACKAGESTATUS"

changeStatus

public void changeStatus(java.lang.String status,
                         java.lang.String progressStatus,
                         java.util.Date date,
                         java.lang.String memo,
                         long accessModifier)
                  throws MXException,
                         java.rmi.RemoteException

Change the status of package with the progressstatus

Specified by:

changeStatus in interface DMPackageRemote

Specified by:

changeStatus in interface StatefulMboRemote

Overrides:

changeStatus in class StatefulMbo

Parameters:

status -

progressStatus -

date -

memo -

accessModifier -

Throws:

MXException

java.rmi.RemoteException

See Also:

* @param status

canDistribute

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

Throws an exception if this package can not be distributed due to its status.

Specified by:

canDistribute in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

distributeZipPackage

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

Creates a zip file in the dmroot directory for download in the browser. If the file is already present, does nothing. This is used for package distribution in multitenant environments.

Specified by:

distributeZipPackage in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

distributePackage

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

Distribute package to FILE or Database

Specified by:

distributePackage in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

deployPackage

public void deployPackage(MboSetRemote pkgDefSet)
                   throws MXException,
                          java.rmi.RemoteException

Start deploy thread at target server.

Specified by:

deployPackage in interface DMPackageRemote

Parameters:

pkgDefSet - The package def set passed from UI. Used for writing longop messages.

Throws:

MXException

java.rmi.RemoteException

getLongopPreviewOKMsg

public void getLongopPreviewOKMsg(java.lang.String pkgName,
                                  UserInfo ui,
                                  MboSetRemote defSet)
                           throws java.lang.Exception

Write preview done messages to longop.

Parameters:

pkgName -

ui -

defSet -

Throws:

java.lang.Exception

changeMaxStatus

public void changeMaxStatus(java.lang.String status,
                            java.lang.String progressStatus,
                            java.util.Date asOfDate,
                            java.lang.String memo,
                            long accessModifier)
                     throws MXException,
                            java.rmi.RemoteException

Change status, using the default values for the status and progress status.

Specified by:

changeMaxStatus in interface DMPackageRemote

Parameters:

status - MaxValue of the status to change to.

progressStatus - MaxValue of the progress status to change to

asOfDate - The date of the status change

memo - Memo

accessModifier - access flag

Throws:

MXException

java.rmi.RemoteException

previewLogger

public void previewLogger(java.lang.String pkgName,
                          boolean load)
                   throws MXException,
                          java.rmi.RemoteException

Load and unload preview logger dynamically

Parameters:

pkgName -

load -

Throws:

MXException

java.rmi.RemoteException

processPreviewXML

public void processPreviewXML(MXTransaction mxTrans,
                              UserInfo ui,
                              java.lang.String mos,
                              byte[] content,
                              boolean recordRollback)
                       throws MXException,
                              java.rmi.RemoteException

Process xml using preview mode.

Parameters:

mxTrans -

mos -

rollbackpoint -

content -

Throws:

MXException

java.rmi.RemoteException

confirmCompSrcDeployed

public MboRemote confirmCompSrcDeployed()
                                 throws MXException,
                                        java.rmi.RemoteException

Set status after Confirmation of compiled sources have been deployed

Specified by:

confirmCompSrcDeployed in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

closePkg

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

Purge a package.

Specified by:

closePkg in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

uploadCompiledSrcFile

public void uploadCompiledSrcFile(java.lang.String fileName,
                                  byte[] content)
                           throws MXException,
                                  java.rmi.RemoteException

Upload compiled source file into the staging table.

Specified by:

uploadCompiledSrcFile in interface DMPackageRemote

Parameters:

fileName - The compiled source file name.

content - Content of the file

Throws:

MXException

java.rmi.RemoteException

canDownloadPkg

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

Check whether a package file exists for download.

Specified by:

canDownloadPkg in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

canDownloadFile

public java.lang.String canDownloadFile(MboRemote cmpSrc)
                                 throws MXException,
                                        java.rmi.RemoteException

Check whether a compiled source file exists for download.

Specified by:

canDownloadFile in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

getRedistribute

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

Returns true if the package is set to be redistributed.

Specified by:

getRedistribute in interface DMPackageRemote

Returns:

Throws:

java.rmi.RemoteException

MXException

setRedistribute

public void setRedistribute(boolean isRedistribute)

Set redistribute flag for the package

Parameters:

isRedistribute -

getPackageDef

public MboRemote getPackageDef()
                        throws MXException,
                               java.rmi.RemoteException

Returns the package's definition.

Specified by:

getPackageDef in interface DMPackageRemote

Returns:

Throws:

MXException

java.rmi.RemoteException

canDownloadPreviewLog

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

Check whether a preview log file exists for download.

Specified by:

canDownloadPreviewLog in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

canDownloadScriptLog

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

Check whether a script log file exists for download.

Specified by:

canDownloadScriptLog in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException

mosGrpResolver

public java.util.HashMap<java.lang.Integer,psdi.dm.pkg.DMPackage.MosPreviewInfo> mosGrpResolver(java.util.HashMap<java.lang.Integer,java.lang.String> objMap)
                                                                                         throws MXException,
                                                                                                java.rmi.RemoteException

Find group for a mos and find start and end number of Mos and group

Parameters:

objMap -

Returns:

HashMap

Throws:

MXException

java.rmi.RemoteException

applyFix

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

Update the file where the error occurred with the updated XML.

Specified by:

applyFix in interface DMPackageRemote

Throws:

MXException

java.rmi.RemoteException