public class FreeClassObjectAction extends LibrarySessionAction
The classobject to be removed is specified by a property. As a result, upgrade actions can often use this class as is, without needing to add an action-specific subclass.
Modifier and Type | Field and Description |
---|---|
protected static String |
PROPERTY_CLASSOBJECT
The property whose string value is the name of the classobject to free.
|
protected static String |
PROPERTY_DROPTABLEDURINGPOSTUPGRADE
The property whose boolean value controls when the classobject's base
table is dropped.
|
protected static String |
PROPERTY_FREEINSTANCEBATCHSIZE
The property whose integer value specifies the batch size used in freeing
instances of the classobject, if
PROPERTY_FREEINSTANCES is true. |
protected static String |
PROPERTY_FREEINSTANCES
The property whose boolean value indicates whether, during the upgrade
phase, any existing instances of the classobject are to be freed.
|
PROPERTY_PREVENTSESSIONTIMEOUTS
Constructor and Description |
---|
FreeClassObjectAction() |
Modifier and Type | Method and Description |
---|---|
protected void |
analyze(LibrarySession session)
Called by
analyze . |
void |
postUpgrade(LibrarySession session)
Called by
postUpgrade . |
protected void |
upgrade(LibrarySession session)
Called by
upgrade . |
abortTransaction, analyze, postUpgrade, preUpgrade, preUpgrade, rollback, rollback, upgrade
getName, getProperties, getProperty, getUpgradeActionContext, initialize
protected static final String PROPERTY_CLASSOBJECT
protected static final String PROPERTY_FREEINSTANCES
If false (the default), the upgrade phase will fail if there exist any instances of the classobject.
protected static final String PROPERTY_FREEINSTANCEBATCHSIZE
PROPERTY_FREEINSTANCES
is true.protected static final String PROPERTY_DROPTABLEDURINGPOSTUPGRADE
If false (the default), the base table is dropped during the upgrade phase; if true, it is dropped during the post-upgrade phase.
protected void analyze(LibrarySession session) throws IfsException
analyze
.
Subclasses should override this method to perform the analysis phase of the upgrade action.
analyze
in class LibrarySessionAction
session
- the sessionIfsException
- if the operation failsprotected void upgrade(LibrarySession session) throws IfsException
upgrade
.
Subclasses should override this method to perform the upgrade phase of the upgrade action.
upgrade
in class LibrarySessionAction
session
- the sessionIfsException
- if the operation failspublic void postUpgrade(LibrarySession session) throws IfsException
postUpgrade
.
Subclasses should override this method to perform the post-upgrade phase of the upgrade action.
postUpgrade
in class LibrarySessionAction
session
- the sessionIfsException
- if the operation failsCopyright © 2023. All rights reserved.