UpgradeObjectProcessor (midPoint API Distribution 4.7.2 API)

All Superinterfaces:

ProcessorMixin

All Known Implementing Classes:

AccountPasswordPolicyProcessor, ActivityTracingProcessor, AdditionalPanelsProcessor, AddRemoveAttributeValuesProcessor, ApprovalWorkItemsProcessor, AuthenticationNameProcessor, BoundaryProcessor, CaseTaskRefProcessor, CleanupPolicyProcessor, ContainerProcessor, CredentialsResetNameProcessor, CustomTransportProcessor, DefaultObjectTypeProcessor, DefaultScopeProcessor, ExecutionModeProcessor, ExecutionRecordProcessor, ExpectedTotalProcessor, FileTransportProcessor, FollowOnProcessor, GuiActionNameProcessor, LiveSyncErrorHandlingProcessor, MailTransportProcessor, ModelOperationContextProcessor, NonIterativeChangeExecutionProcessor, ObjectFormsProcessor, OidBoundProcessor, PersonaTargetSubtypeProcessor, PropertyConstraintProcessor, ReconcileAffectedProcessor, RecurrenceProcessor, ReportDataProcessor, ReportOutputOidProcessor, ResourceSynchronizationProcessor, RoleCatalogCollectionsProcessor, RoleCatalogRefProcessor, RoleManagementDefaultCollectionProcessor, Saml2NetworkProcessor, SearchItemDisplayNameProcessor, SmsTransportProcessor, SubtypeProcessor, TaskCategoryProcessor, TaskPolicyProcessor, UseLegacyApproversProcessor, UserDashboardLinkProcessor, UserDashboardProcessor
```
public interface UpgradeObjectProcessor<T extends Objectable>
extends ProcessorMixin
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default String`	`getIdentifier()`
`UpgradePhase`	`getPhase()`
`UpgradePriority`	`getPriority()`
`UpgradeType`	`getType()`
`boolean`	`isApplicable(PrismObject<?> object, ItemPath path)`	Checks if the processor is applicable for the object and path.
`boolean`	`process(PrismObject<T> object, ItemPath path)`	Executes upgrade of item defined by path argument by modifying the object to correct state.
`default String`	`upgradeDescription(PrismObject<T> object, ItemPath path)`

Methods inherited from interface com.evolveum.midpoint.schema.validator.processor.ProcessorMixin
copyTransport, copyUserInterfaceFeature, getIdentifier, getItemParent, getRoleCatalog, matchObjectTypeAndPathTemplate, matchParentTypeAndItemName

- Method Detail
  - getIdentifier
```
default String getIdentifier()
```
    Returns:
    
    Unique identifier of the processor. By default, it is class name without "Processor" suffix.
  - getPhase
```
UpgradePhase getPhase()
```
  - getPriority
```
UpgradePriority getPriority()
```
  - getType
```
UpgradeType getType()
```
  - isApplicable
```
boolean isApplicable(PrismObject<?> object,
                     ItemPath path)
```
    Checks if the processor is applicable for the object and path. Most often whether object is instance of proper ObjectType and item at the path exists.
  - process
```
boolean process(PrismObject<T> object,
                ItemPath path)
         throws Exception
```
    Executes upgrade of item defined by path argument by modifying the object to correct state.
    
    Throws:
    
    Exception
  - upgradeDescription
```
default String upgradeDescription(PrismObject<T> object,
                                  ItemPath path)
```
    Parameters:
    
    object - before processing
    
    path -
    
    Returns:
    
    Returns description of the upgrade if not done automatically. Should be single line (might end up in CSV) without any special characters. Certainly not semicolon (;) and double quote ("). Best approach is to put in short description and link to documentation.