Package com.evolveum.midpoint.model.impl.controller

Class ModelInteractionServiceImpl

java.lang.Object

com.evolveum.midpoint.model.impl.controller.ModelInteractionServiceImpl

All Implemented Interfaces:

ModelInteractionService

@Component("modelInteractionService")
public class ModelInteractionServiceImpl
extends Object
implements ModelInteractionService

Author:

semancik

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.model.api.ModelInteractionService

ModelInteractionService.SearchSpec<T>

Field Summary

Fields inherited from interface com.evolveum.midpoint.model.api.ModelInteractionService

CHECK_PASSWORD, CLASS_NAME_WITH_DOT, GET_ALLOWED_REQUEST_ASSIGNMENT_ITEMS, GET_ASSIGNABLE_ROLE_SPECIFICATION, GET_AUTHENTICATIONS_POLICY, GET_CONNECTOR_OPERATIONAL_STATUS, GET_CREDENTIALS_POLICY, GET_DEPUTY_ASSIGNEES, GET_EDIT_OBJECT_DEFINITION, GET_REGISTRATIONS_POLICY, GET_SECURITY_POLICY, GET_SECURITY_POLICY_FOR_ARCHETYPE, MERGE_OBJECTS_PREVIEW_DELTA, MERGE_OBJECTS_PREVIEW_OBJECT, OP_SUBMIT, PREVIEW_CHANGES, SUBMIT_TASK_FROM_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
ModelInteractionServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	applyDefinitions(ShadowType shadow, Task task, OperationResult result)	Helper method to properly apply definitions to shadow.
void	applyView(CompiledObjectCollectionView existingView, GuiObjectListViewType objectListViewType)	Applying all GuiObjectListViewsType to CompiledObjectCollectionView
PrismContainerDefinition<AssignmentType>	assignmentTypeDefinitionWithConcreteTargetRefType(PrismContainerDefinition<AssignmentType> orig, QName targetType)	Returns Container Definition of Assignment Type with target type of assignment replaced by more concrete situation This allows for using more specific definition when searching for definitions for dereference, in GUI search or columns where we are sure (on other criteria) only assignment types we are processing have concrete target type.
MidPointPrincipal	assumePowerOfAttorney(PrismObject<? extends FocusType> donor, Task task, OperationResult result)
void	authorizeBulkActionExecution(@Nullable BulkAction action, @Nullable AuthorizationPhaseType phase, @NotNull Task task, @NotNull OperationResult result)	Just a convenience method that checks that relevant authorization is present.
boolean	checkPassword(String userOid, ProtectedStringType password, Task task, OperationResult parentResult)	Checks if the supplied password matches with current user password.
@NotNull CompiledObjectCollectionView	compileObjectCollectionView(@NotNull CollectionRefSpecificationType collectionRef, @Nullable Class<? extends Containerable> targetTypeClass, @NotNull Task task, @NotNull OperationResult result)
void	compileView(CompiledObjectCollectionView existingView, GuiObjectListViewType objectListViewsType, Task task, OperationResult result)	Compile object list view together with collection ref specification if present
Integer	countObjectsFromCollection(CollectionRefSpecificationType collectionConfig, QName typeForFilter, Collection<SelectorOptions<GetOperationOptions>> defaultOptions, ObjectPaging usedPaging, VariablesMap variables, Task task, OperationResult result)
@NotNull TaskType	createExecutionTask(@NotNull ActivityDefinitionType activityDefinition, @NotNull ActivitySubmissionOptions options, @NotNull Task task, @NotNull OperationResult result)	As ModelInteractionService.submit(ActivityDefinitionType, ActivitySubmissionOptions, Task, OperationResult) but only prepares the task for execution; does not submit it.
@NotNull LocalizableMessageType	createLocalizableMessageType(LocalizableMessageTemplateType template, VariablesMap variables, Task task, OperationResult result)
<O extends AssignmentHolderType> ArchetypePolicyType	determineArchetypePolicy(PrismObject<O> assignmentHolder, OperationResult result)	Efficiently determines information about archetype policy applicable for a particular object.
@NotNull List<ArchetypeType>	determineArchetypes(@Nullable ObjectType object, OperationResult result)
<O extends AbstractRoleType> AssignmentCandidatesSpecification	determineAssignmentHolderSpecification(PrismObject<O> assignmentTarget, OperationResult result)	Returns data structure that contains information about possible assignment holders for a particular target object.
<O extends AssignmentHolderType> AssignmentCandidatesSpecification	determineAssignmentTargetSpecification(PrismObject<O> object, OperationResult result)	Returns data structure that contains information about possible assignment targets for a particular holder object.
@NotNull CollectionStats	determineCollectionStats(@NotNull CompiledObjectCollectionView collectionView, @NotNull Task task, @NotNull OperationResult result)
<F extends FocusType> NonceCredentialsPolicyType	determineNonceCredentialsPolicy(PrismObject<F> focus, String nonceCredentialName, Task task, OperationResult parentResult)
MidPointPrincipal	dropPowerOfAttorney(Task task, OperationResult result)
@NotNull Collection<EvaluatedPolicyRule>	evaluateCollectionPolicyRules(@NotNull PrismObject<ObjectCollectionType> collection, @Nullable CompiledObjectCollectionView preCompiledView, @Nullable Class<? extends ObjectType> targetTypeClass, @NotNull Task task, @NotNull OperationResult result)	Returns all policy rules that apply to the collection.
ExecuteCredentialResetResponseType	executeCredentialsReset(PrismObject<UserType> user, ExecuteCredentialResetRequestType executeCredentialResetRequest, Task task, OperationResult parentResult)
<X> X	executeWithSimulationResult(@NotNull TaskExecutionMode mode, @Nullable SimulationDefinitionType simulationDefinition, @NotNull Task task, @NotNull OperationResult result, SimulationResultManager.SimulatedFunctionCall<X> functionCall)	Executes the code in `functionCall` parameter (SimulationResultManager.SimulatedFunctionCall) in the simulation mode (`mode` parameter), with the provided simulation result definition.
void	expandConfigurationObject(@NotNull PrismObject<? extends ObjectType> configurationObject, @NotNull Task task, @NotNull OperationResult result)	See ProvisioningService.expandConfigurationObject(PrismObject, Task, OperationResult) for the description.
<O extends ObjectType> String	generateNonce(NonceCredentialsPolicyType noncePolicy, Task task, OperationResult result)
<O extends ObjectType> void	generateValue(PrismObject<O> object, PolicyItemsDefinitionType policyItemsDefinition, Task task, OperationResult parentResult)
<O extends ObjectType> String	generateValue(ValuePolicyType policy, int defaultLength, boolean generateMinimalSize, PrismObject<O> object, String shortDesc, Task task, OperationResult parentResult)	TEMPORARY.
<T extends ObjectType> ObjectFilter	getAccessibleForAssignmentObjectsFilter(Class<T> searchResultType, ObjectFilter origFilter, Task task, OperationResult parentResult)	Returns a filter for lookup of users which are allowed to be objects during assign operation.
Collection<? extends DisplayableValue<String>>	getActionUrls()	Returns a collection of all authorization actions known to the system.
<O extends ObjectType, R extends AbstractRoleType> ItemSecurityConstraints	getAllowedRequestAssignmentItems(PrismObject<O> object, PrismObject<R> target, Task task, OperationResult result)	Returns decisions for individual items for "assign" authorization.
<H extends AssignmentHolderType, R extends AbstractRoleType> RoleSelectionSpecification	getAssignableRoleSpecification(@NotNull PrismObject<H> focus, Class<R> targetType, int assignmentOrder, Task task, OperationResult parentResult)	Returns an object that defines which roles can be assigned by the currently logged-in user.
ActivationStatusType	getAssignmentEffectiveStatus(String lifecycleStatus, ActivationType activationType)	Computes effective status for the current ActivationType in for an assignment
SystemConfigurationAuditType	getAuditConfiguration(OperationResult parentResult)
AuthenticationsPolicyType	getAuthenticationPolicy(PrismObject<UserType> user, Task task, OperationResult parentResult)	Returns an authentications policies as defined in the system configuration security policy.
AccessCertificationConfigurationType	getCertificationConfiguration(OperationResult parentResult)
@NotNull CompiledGuiProfile	getCompiledGuiProfile(Task task, OperationResult parentResult)	Returns currently applicable user profile, compiled for efficient use in the user interface.
List<ConnectorOperationalStatus>	getConnectorOperationalStatus(String resourceOid, Task task, OperationResult parentResult)
CredentialsPolicyType	getCredentialsPolicy(PrismObject<? extends FocusType> focus, Task task, OperationResult parentResult)	Returns a credential policy that applies to the specified user.
DeploymentInformationType	getDeploymentInformationConfiguration(OperationResult parentResult)
@NotNull List<ObjectReferenceType>	getDeputyAssignees(AbstractWorkItemType workItem, Task task, OperationResult parentResult)	Gets "deputy assignees" i.e.
@NotNull List<ObjectReferenceType>	getDeputyAssignees(ObjectReferenceType assigneeRef, OtherPrivilegesLimitations.Type limitationType, Task task, OperationResult parentResult)
<T extends ObjectType> ObjectFilter	getDonorFilter(Class<T> searchResultType, ObjectFilter origFilter, String targetAuthorizationAction, Task task, OperationResult parentResult)	Returns filter for lookup of donors of power of attorney.
ResourceObjectDefinition	getEditObjectClassDefinition(@NotNull PrismObject<ShadowType> shadow, @NotNull PrismObject<ResourceType> resource, AuthorizationPhaseType phase, Task task, OperationResult result)	Returns an object definition that reflects edit-ability of the resource object in terms of midPoint schema limitations and security.
<O extends ObjectType> @NotNull PrismObjectDefinition<O>	getEditObjectDefinition(PrismObject<O> object, AuthorizationPhaseType phase, Task task, OperationResult parentResult)	Returns a schema that reflects editability of the object in terms of midPoint schema limitations and security.
PrismObjectDefinition<ShadowType>	getEditShadowDefinition(ResourceShadowCoordinates coordinates, AuthorizationPhaseType phase, Task task, OperationResult parentResult)
<O extends AssignmentHolderType> List<ArchetypeType>	getFilteredArchetypesByHolderType(PrismObject<O> object, OperationResult result)	This method is used to differentiate which archetypes can be added to object with holderType type.
<O extends AssignmentHolderType> List<ArchetypeType>	getFilteredArchetypesByHolderType(Class<O> objectType, OperationResult result)
RegistrationsPolicyType	getFlowPolicy(PrismObject<? extends FocusType> focus, Task task, OperationResult parentResult)	Returns a policy for registration, e.g.
List<UserSessionManagementType>	getLoggedInPrincipals(Task task, OperationResult result)
List<MergeConfigurationType>	getMergeConfiguration(OperationResult parentResult)
<O extends ObjectType> MetadataItemProcessingSpec	getMetadataItemProcessingSpec(ItemPath metadataItemPath, PrismObject<O> object, Task task, OperationResult result)	Returns specification of processing of given metadata item (e.g.
List<RelationDefinitionType>	getRelationDefinitions()
<T> ModelInteractionService.SearchSpec<T>	getSearchSpecificationFromCollection(CompiledObjectCollectionView compiledCollection, QName typeForFilter, Collection<SelectorOptions<GetOperationOptions>> defaultOptions, VariablesMap variables, Task task, OperationResult result)	TODO document and clean up the interface
SecurityPolicyType	getSecurityPolicy(@Nullable PrismObject<? extends FocusType> focus, Task task, OperationResult parentResult)	Returns security policy for given focus (or global policy if the focus is not specified).
SecurityPolicyType	getSecurityPolicy(ResourceObjectDefinition rOCDef, Task task, OperationResult parentResult)	Returns resolved value policy references.
SecurityPolicyType	getSecurityPolicyForArchetype(@Nullable String archetypeOid, @NotNull Task task, @NotNull OperationResult parentResult)	Returns security policy for given archetype (or global policy if the archetype is not specified).
SystemConfigurationType	getSystemConfiguration(OperationResult parentResult)
boolean	isOfArchetype(AssignmentHolderType assignmentHolderType, String archetypeOid, OperationResult result)	Determines if the object is of the specified archetype considering also archetypes hierarchy.
boolean	isSubarchetypeOrArchetype(String archetypeOid, String parentArchetype, OperationResult result)
ArchetypePolicyType	mergeArchetypePolicies(PrismObject<ArchetypeType> archetype, OperationResult result)
<O extends ObjectType> MergeDeltas<O>	mergeObjectsPreviewDeltas(Class<O> type, String leftOid, String rightOid, String mergeConfigurationName, Task task, OperationResult parentResult)
<O extends ObjectType> PrismObject<O>	mergeObjectsPreviewObject(Class<O> type, String leftOid, String rightOid, String mergeConfigurationName, Task task, OperationResult parentResult)
<F extends ObjectType> @NotNull ModelContext<F>	previewChanges(Collection<ObjectDelta<? extends ObjectType>> deltas, ModelExecuteOptions options, Task task, Collection<ProgressListener> listeners, OperationResult result)	The "modern" implementation that uses the simulations feature.
void	processObjectsFromCollection(CollectionRefSpecificationType collectionConfig, QName typeForFilter, Predicate<PrismContainer> handler, Collection<SelectorOptions<GetOperationOptions>> defaultOptions, VariablesMap variables, Task task, OperationResult result, boolean recordProgress)	TODO document
PrismReferenceDefinition	refDefinitionWithConcreteTargetRefType(PrismReferenceDefinition orig, QName targetType)	Returns Container Definition of Assignment Type with target type of assignment replaced by more concrete situation This allows for using more specific definition when searching for definitions for dereference, in GUI search or columns where we are sure (on other criteria) only assignment types we are processing have concrete target type.
void	refreshPrincipal(String oid, Class<? extends FocusType> clazz)
<T> T	runUnderPowerOfAttorney(Producer<T> producer, PrismObject<? extends FocusType> donor, Task task, OperationResult result)
List<? extends Serializable>	searchObjectsFromCollection(CollectionRefSpecificationType collectionConfig, QName typeForFilter, Collection<SelectorOptions<GetOperationOptions>> defaultOptions, ObjectPaging usedPaging, VariablesMap variables, Task task, OperationResult result)
@NotNull String	submit(@NotNull ActivityDefinitionType activityDefinition, @NotNull ActivitySubmissionOptions options, @NotNull Task task, @NotNull OperationResult parentResult)	Executes specified activity.
@NotNull String	submitTaskFromTemplate(@NotNull String templateOid, @NotNull ActivityCustomization customization, @NotNull Task task, @NotNull OperationResult parentResult)	Submits a task from template (pointed to by `templateOid`).
@NotNull TaskType	submitTaskFromTemplate(String templateTaskOid, List<Item<?,?>> extensionItems, Task opTask, OperationResult parentResult)	Use ModelInteractionService.submitTaskFromTemplate(String, ActivityCustomization, Task, OperationResult) instead.
@NotNull TaskType	submitTaskFromTemplate(String templateTaskOid, Map<QName,Object> extensionValues, Task opTask, OperationResult parentResult)	Use ModelInteractionService.submitTaskFromTemplate(String, ActivityCustomization, Task, OperationResult) instead.
void	terminateSessions(TerminateSessionEvent terminateSessionEvent, Task task, OperationResult result)	Terminates specified sessions (clusterwide).
<F extends ObjectType> ModelContext<F>	unwrapModelContext(LensContextType wrappedContext, Task task, OperationResult result)
<O extends ObjectType> void	validateValue(PrismObject<O> object, PolicyItemsDefinitionType policyItemsDefinition, Task task, OperationResult parentResult)
<O extends ObjectType> List<StringLimitationResult>	validateValue(ProtectedStringType protectedStringValue, ValuePolicyType valuePolicy, PrismObject<O> object, Task task, OperationResult result)
@NotNull Visualization	visualizeDelta(ObjectDelta<? extends ObjectType> delta, boolean includeOperationalItems, boolean includeOriginalObject, Task task, OperationResult result)
@NotNull Visualization	visualizeDelta(ObjectDelta<? extends ObjectType> delta, boolean includeOperationalItems, Task task, OperationResult result)
@NotNull Visualization	visualizeDelta(ObjectDelta<? extends ObjectType> delta, boolean includeOperationalItems, ObjectReferenceType objectRef, Task task, OperationResult result)
@NotNull Visualization	visualizeDelta(ObjectDelta<? extends ObjectType> delta, Task task, OperationResult result)
List<Visualization>	visualizeDeltas(List<ObjectDelta<? extends ObjectType>> deltas, Task task, OperationResult result)
<O extends ObjectType> ModelContextVisualization	visualizeModelContext(ModelContext<O> context, Task task, OperationResult result)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.evolveum.midpoint.model.api.ModelInteractionService

getSecurityPolicy, previewChanges, runUnderPowerOfAttorneyChecked, submitScriptingExpression

Constructor Details

ModelInteractionServiceImpl

public ModelInteractionServiceImpl()

Method Details

previewChanges

@NotNull
public <F extends ObjectType>
@NotNull ModelContext<F> previewChanges(Collection<ObjectDelta<? extends ObjectType>> deltas,
 ModelExecuteOptions options,
 Task task,
 Collection<ProgressListener> listeners,
 OperationResult result)
                                 throws SchemaException,
PolicyViolationException,
ExpressionEvaluationException,
ObjectNotFoundException,
ObjectAlreadyExistsException,
CommunicationException,
ConfigurationException,
SecurityViolationException

The "modern" implementation that uses the simulations feature.

Specified by:

previewChanges in interface ModelInteractionService

Throws:

SchemaException

PolicyViolationException

ExpressionEvaluationException

ObjectNotFoundException

ObjectAlreadyExistsException

CommunicationException

ConfigurationException

SecurityViolationException

unwrapModelContext

public <F extends ObjectType> ModelContext<F> unwrapModelContext(LensContextType wrappedContext,
 Task task,
 OperationResult result)
                                                          throws SchemaException,
ConfigurationException,
ObjectNotFoundException,
CommunicationException,
ExpressionEvaluationException

Specified by:

unwrapModelContext in interface ModelInteractionService

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

ExpressionEvaluationException

getEditObjectDefinition

@NotNull
public <O extends ObjectType>
@NotNull PrismObjectDefinition<O> getEditObjectDefinition(PrismObject<O> object,
 AuthorizationPhaseType phase,
 Task task,
 OperationResult parentResult)
                                                   throws SchemaException,
ConfigurationException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException

Description copied from interface: ModelInteractionService

Returns a schema that reflects editability of the object in terms of midPoint schema limitations and security. This method merges together all the applicable limitations that midPoint knows of (schema, security, other constraints). It may be required to pre-populate new object before calling this method, e.g. to put the object in a correct org in case that delegated administration is used.

If null is returned then the access to the entire object is denied. It cannot be created or edited at all.

The returned definition contains all parts of static schema and run-time extensions. It does not contain parts of resource "refined" schemas. Therefore for shadows it is only applicable to static parts of the shadow (not attributes).

This is not security-sensitive function. It provides data about security constraints but it does not enforce it and it does not modify anything or reveal any data. The purpose of this method is to enable convenient display of GUI form fields, e.g. to hide non-accessible fields from the form. The actual enforcement of the security is executed regardless of this method.

Specified by:

getEditObjectDefinition in interface ModelInteractionService

Parameters:

object - object to edit

Returns:

schema with correctly set constraint parts or null

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

getEditShadowDefinition

public PrismObjectDefinition<ShadowType> getEditShadowDefinition(ResourceShadowCoordinates coordinates,
 AuthorizationPhaseType phase,
 Task task,
 OperationResult parentResult)
                                                          throws SchemaException,
ConfigurationException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException

Specified by:

getEditShadowDefinition in interface ModelInteractionService

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

getEditObjectClassDefinition

public ResourceObjectDefinition getEditObjectClassDefinition(@NotNull
 @NotNull PrismObject<ShadowType> shadow,
 @NotNull
 @NotNull PrismObject<ResourceType> resource,
 AuthorizationPhaseType phase,
 Task task,
 OperationResult result)
                                                      throws SchemaException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException,
SecurityViolationException

Description copied from interface: ModelInteractionService

Returns an object definition that reflects edit-ability of the resource object in terms of midPoint schema limitations and security. I.e. just like ModelInteractionService.getEditShadowDefinition(ResourceShadowCoordinates, AuthorizationPhaseType, Task, OperationResult) but for resource objects.

Specified by:

getEditObjectClassDefinition in interface ModelInteractionService

Throws:

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

SecurityViolationException

getMetadataItemProcessingSpec

public <O extends ObjectType>
MetadataItemProcessingSpec getMetadataItemProcessingSpec(ItemPath metadataItemPath,
 PrismObject<O> object,
 Task task,
 OperationResult result)
                                                  throws SchemaException,
ConfigurationException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException

Description copied from interface: ModelInteractionService

Returns specification of processing of given metadata item (e.g. provenance). The caller can use returned object to find out the processing of given metadata item for various data items (e.g. givenName, familyName, etc).

Specified by:

getMetadataItemProcessingSpec in interface ModelInteractionService

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

getAllowedRequestAssignmentItems

public <O extends ObjectType,
R extends AbstractRoleType>
ItemSecurityConstraints getAllowedRequestAssignmentItems(PrismObject<O> object,
 PrismObject<R> target,
 Task task,
 OperationResult result)
                                                  throws SchemaException,
SecurityViolationException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException

Description copied from interface: ModelInteractionService

Returns decisions for individual items for "assign" authorization. This is usually applicable to assignment parameters. The decisions are evaluated using the security context of a currently logged-in user.

Specified by:

getAllowedRequestAssignmentItems in interface ModelInteractionService

Parameters:

object - object of the operation (user)

target - target of the operation (role, org, service that is being assigned)

Throws:

SchemaException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

getActionUrls

public Collection<? extends DisplayableValue<String>> getActionUrls()

Description copied from interface: ModelInteractionService

Returns a collection of all authorization actions known to the system. The format of returned data is designed for displaying purposes.

Note: this method returns only the list of authorization actions that are known to the IDM Model component and the components below. It does not return a GUI-specific authorization actions.

Specified by:

getActionUrls in interface ModelInteractionService

getAssignableRoleSpecification

public <H extends AssignmentHolderType,
R extends AbstractRoleType>
RoleSelectionSpecification getAssignableRoleSpecification(@NotNull
 @NotNull PrismObject<H> focus,
 Class<R> targetType,
 int assignmentOrder,
 Task task,
 OperationResult parentResult)
                                                   throws ObjectNotFoundException,
SchemaException,
ConfigurationException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException

Description copied from interface: ModelInteractionService

Returns an object that defines which roles can be assigned by the currently logged-in user.

Specified by:

getAssignableRoleSpecification in interface ModelInteractionService

Parameters:

focus - Object of the operation. The object (usually user) to whom the roles should be assigned.

assignmentOrder - order=0 means assignment, order>0 means inducement

Throws:

ObjectNotFoundException

SchemaException

ConfigurationException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

getDonorFilter

public <T extends ObjectType> ObjectFilter getDonorFilter(Class<T> searchResultType,
 ObjectFilter origFilter,
 String targetAuthorizationAction,
 Task task,
 OperationResult parentResult)
                                                   throws SchemaException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException,
SecurityViolationException

Description copied from interface: ModelInteractionService

Returns filter for lookup of donors of power of attorney. The donors are the users that have granted the power of attorney to the currently logged-in user.

TODO: authorization limitations

Specified by:

getDonorFilter in interface ModelInteractionService

Parameters:

searchResultType - type of the expected search results

origFilter - original filter (e.g. taken from GUI search bar)

targetAuthorizationAction - Authorization action that the attorney is trying to execute on behalf of donor. Only donors for which the use of this authorization was not limited will be returned (that does not necessarily mean that the donor is able to execute this action, it may be limited by donor's authorizations). If the parameter is null then all donors are returned.

task - task

parentResult - operation result

Returns:

original filter with AND clause limiting the search.

Throws:

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

SecurityViolationException

getAccessibleForAssignmentObjectsFilter

public <T extends ObjectType> ObjectFilter getAccessibleForAssignmentObjectsFilter(Class<T> searchResultType,
 ObjectFilter origFilter,
 Task task,
 OperationResult parentResult)
                                                                            throws SchemaException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException,
SecurityViolationException

Description copied from interface: ModelInteractionService

Returns a filter for lookup of users which are allowed to be objects during assign operation. "assign" authorization can define a filter for object. This means that logged in user can request an assignment only for those user(s) which satisfies the filter.

Specified by:

getAccessibleForAssignmentObjectsFilter in interface ModelInteractionService

Parameters:

searchResultType - type of the expected search results

origFilter - original filter (e.g. taken from GUI search bar)

task - task

parentResult - operation result

Returns:

original filter with AND clause limiting the search.

Throws:

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

SecurityViolationException

getAuthenticationPolicy

public AuthenticationsPolicyType getAuthenticationPolicy(PrismObject<UserType> user,
 Task task,
 OperationResult parentResult)
                                                  throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Description copied from interface: ModelInteractionService

Returns an authentications policies as defined in the system configuration security policy. This method is designed to be used during registration process or reset password process. security questions, etc).

Specified by:

getAuthenticationPolicy in interface ModelInteractionService

Returns:

applicable credentials policy or null

Throws:

SchemaException - Wrong schema or content of security policy

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

getFlowPolicy

public RegistrationsPolicyType getFlowPolicy(PrismObject<? extends FocusType> focus,
 Task task,
 OperationResult parentResult)
                                      throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Description copied from interface: ModelInteractionService

Returns a policy for registration, e.g. type of the supported registrations (self, social,...)

Specified by:

getFlowPolicy in interface ModelInteractionService

Parameters:

focus - focus for who the policy should apply

Returns:

applicable credentials policy or null

Throws:

SchemaException - Wrong schema or content of security policy

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

getCredentialsPolicy

public CredentialsPolicyType getCredentialsPolicy(PrismObject<? extends FocusType> focus,
 Task task,
 OperationResult parentResult)
                                           throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Description copied from interface: ModelInteractionService

Returns a credential policy that applies to the specified user. This method is designed to be used during credential reset so the GUI has enough information to set up the credential (e.g. password policies, security questions, etc).

Specified by:

getCredentialsPolicy in interface ModelInteractionService

Parameters:

focus - focus for who the policy should apply

Returns:

applicable credentials policy or null

Throws:

SchemaException - Wrong schema or content of security policy

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

determineNonceCredentialsPolicy

public <F extends FocusType>
NonceCredentialsPolicyType determineNonceCredentialsPolicy(PrismObject<F> focus,
 String nonceCredentialName,
 Task task,
 OperationResult parentResult)
                                                    throws SchemaException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException,
ConfigurationException

Specified by:

determineNonceCredentialsPolicy in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

getSecurityPolicy

public SecurityPolicyType getSecurityPolicy(@Nullable
 @Nullable PrismObject<? extends FocusType> focus,
 Task task,
 OperationResult parentResult)
                                     throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Description copied from interface: ModelInteractionService

Returns security policy for given focus (or global policy if the focus is not specified).

Specified by:

getSecurityPolicy in interface ModelInteractionService

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

getSecurityPolicyForArchetype

public SecurityPolicyType getSecurityPolicyForArchetype(@Nullable
 @Nullable String archetypeOid,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult parentResult)
                                                 throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Description copied from interface: ModelInteractionService

Returns security policy for given archetype (or global policy if the archetype is not specified).

Specified by:

getSecurityPolicyForArchetype in interface ModelInteractionService

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

getSecurityPolicy

public SecurityPolicyType getSecurityPolicy(ResourceObjectDefinition rOCDef,
 Task task,
 OperationResult parentResult)
                                     throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException,
ObjectNotFoundException

Description copied from interface: ModelInteractionService

Returns resolved value policy references.

Specified by:

getSecurityPolicy in interface ModelInteractionService

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

ObjectNotFoundException

getCompiledGuiProfile

@NotNull
public @NotNull CompiledGuiProfile getCompiledGuiProfile(Task task,
 OperationResult parentResult)
                                                  throws ObjectNotFoundException,
SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Description copied from interface: ModelInteractionService

Returns currently applicable user profile, compiled for efficient use in the user interface. Use profile contains configuration, customization and user preferences for the user interface. Note: This operation bypasses the authorizations. It will always return the value regardless whether the current user is authorized to read the underlying objects or not. However, it will always return only values applicable for current user, therefore the authorization might be considered to be implicit in this case.

Specified by:

getCompiledGuiProfile in interface ModelInteractionService

Throws:

ObjectNotFoundException

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

getLoggedInPrincipals

public List<UserSessionManagementType> getLoggedInPrincipals(Task task,
 OperationResult result)

Specified by:

getLoggedInPrincipals in interface ModelInteractionService

Returns:

list of logged in users with at least 1 active session (clusterwide)

terminateSessions

public void terminateSessions(TerminateSessionEvent terminateSessionEvent,
 Task task,
 OperationResult result)

Description copied from interface: ModelInteractionService

Terminates specified sessions (clusterwide).

Specified by:

terminateSessions in interface ModelInteractionService

getSystemConfiguration

public SystemConfigurationType getSystemConfiguration(OperationResult parentResult)
                                               throws SchemaException

Specified by:

getSystemConfiguration in interface ModelInteractionService

Throws:

SchemaException

getDeploymentInformationConfiguration

public DeploymentInformationType getDeploymentInformationConfiguration(OperationResult parentResult)
                                                                throws SchemaException

Specified by:

getDeploymentInformationConfiguration in interface ModelInteractionService

Throws:

SchemaException

getAuditConfiguration

public SystemConfigurationAuditType getAuditConfiguration(OperationResult parentResult)
                                                   throws SchemaException

Specified by:

getAuditConfiguration in interface ModelInteractionService

Throws:

SchemaException

getMergeConfiguration

public List<MergeConfigurationType> getMergeConfiguration(OperationResult parentResult)
                                                   throws SchemaException

Specified by:

getMergeConfiguration in interface ModelInteractionService

Throws:

SchemaException

getCertificationConfiguration

public AccessCertificationConfigurationType getCertificationConfiguration(OperationResult parentResult)
                                                                   throws SchemaException

Specified by:

getCertificationConfiguration in interface ModelInteractionService

Throws:

SchemaException

checkPassword

public boolean checkPassword(String userOid,
 ProtectedStringType password,
 Task task,
 OperationResult parentResult)
                      throws ObjectNotFoundException,
SchemaException

Description copied from interface: ModelInteractionService

Checks if the supplied password matches with current user password. This method is NOT subject to any password expiration policies, it does not update failed login counters, it does not change any data or meta-data. This method is NOT SUPPOSED to be used to validate password on login. This method is supposed to check old password when the password is changed by the user. We assume that the user already passed normal system authentication.

Note: no authorizations are checked in the implementation. It is assumed that authorizations will be enforced at the page level.

Specified by:

checkPassword in interface ModelInteractionService

Returns:

true if the password matches, false otherwise

Throws:

ObjectNotFoundException

SchemaException

visualizeDeltas

public List<Visualization> visualizeDeltas(List<ObjectDelta<? extends ObjectType>> deltas,
 Task task,
 OperationResult result)
                                    throws SchemaException,
ExpressionEvaluationException

Specified by:

visualizeDeltas in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

visualizeModelContext

public <O extends ObjectType>
ModelContextVisualization visualizeModelContext(ModelContext<O> context,
 Task task,
 OperationResult result)
                                         throws SchemaException,
ExpressionEvaluationException,
ConfigurationException

Specified by:

visualizeModelContext in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

ConfigurationException

visualizeDelta

@NotNull
public @NotNull Visualization visualizeDelta(ObjectDelta<? extends ObjectType> delta,
 Task task,
 OperationResult result)
                                      throws SchemaException,
ExpressionEvaluationException

Specified by:

visualizeDelta in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

visualizeDelta

@NotNull
public @NotNull Visualization visualizeDelta(ObjectDelta<? extends ObjectType> delta,
 boolean includeOperationalItems,
 Task task,
 OperationResult result)
                                      throws SchemaException,
ExpressionEvaluationException

Specified by:

visualizeDelta in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

visualizeDelta

@NotNull
public @NotNull Visualization visualizeDelta(ObjectDelta<? extends ObjectType> delta,
 boolean includeOperationalItems,
 boolean includeOriginalObject,
 Task task,
 OperationResult result)
                                      throws SchemaException,
ExpressionEvaluationException

Specified by:

visualizeDelta in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

visualizeDelta

@NotNull
public @NotNull Visualization visualizeDelta(ObjectDelta<? extends ObjectType> delta,
 boolean includeOperationalItems,
 ObjectReferenceType objectRef,
 Task task,
 OperationResult result)
                                      throws SchemaException,
ExpressionEvaluationException

Specified by:

visualizeDelta in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

getConnectorOperationalStatus

public List<ConnectorOperationalStatus> getConnectorOperationalStatus(String resourceOid,
 Task task,
 OperationResult parentResult)
                                                               throws SchemaException,
ObjectNotFoundException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException

Specified by:

getConnectorOperationalStatus in interface ModelInteractionService

Throws:

SchemaException

ObjectNotFoundException

CommunicationException

ConfigurationException

ExpressionEvaluationException

mergeObjectsPreviewDeltas

public <O extends ObjectType> MergeDeltas<O> mergeObjectsPreviewDeltas(Class<O> type,
 String leftOid,
 String rightOid,
 String mergeConfigurationName,
 Task task,
 OperationResult parentResult)
                                                                throws ObjectNotFoundException,
SchemaException,
ConfigurationException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException

Specified by:

mergeObjectsPreviewDeltas in interface ModelInteractionService

Throws:

ObjectNotFoundException

SchemaException

ConfigurationException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

mergeObjectsPreviewObject

public <O extends ObjectType> PrismObject<O> mergeObjectsPreviewObject(Class<O> type,
 String leftOid,
 String rightOid,
 String mergeConfigurationName,
 Task task,
 OperationResult parentResult)
                                                                throws ObjectNotFoundException,
SchemaException,
ConfigurationException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException

Specified by:

mergeObjectsPreviewObject in interface ModelInteractionService

Throws:

ObjectNotFoundException

SchemaException

ConfigurationException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

generateNonce

public <O extends ObjectType> String generateNonce(NonceCredentialsPolicyType noncePolicy,
 Task task,
 OperationResult result)
                                            throws ExpressionEvaluationException,
SchemaException,
ObjectNotFoundException,
CommunicationException,
ConfigurationException,
SecurityViolationException

Specified by:

generateNonce in interface ModelInteractionService

Throws:

ExpressionEvaluationException

SchemaException

ObjectNotFoundException

CommunicationException

ConfigurationException

SecurityViolationException

generateValue

public <O extends ObjectType> String generateValue(ValuePolicyType policy,
 int defaultLength,
 boolean generateMinimalSize,
 PrismObject<O> object,
 String shortDesc,
 Task task,
 OperationResult parentResult)
                                            throws ExpressionEvaluationException,
SchemaException,
ObjectNotFoundException,
CommunicationException,
ConfigurationException,
SecurityViolationException

Description copied from interface: ModelInteractionService

TEMPORARY. Need to find out better way how to deal with generated values

Specified by:

generateValue in interface ModelInteractionService

object - object for which we generate the value (e.g. user or shadow)

Returns:

Throws:

ExpressionEvaluationException

SchemaException

ObjectNotFoundException

CommunicationException

ConfigurationException

SecurityViolationException

generateValue

public <O extends ObjectType> void generateValue(PrismObject<O> object,
 PolicyItemsDefinitionType policyItemsDefinition,
 Task task,
 OperationResult parentResult)
                                          throws ObjectAlreadyExistsException,
ExpressionEvaluationException,
SchemaException,
ObjectNotFoundException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
PolicyViolationException

Specified by:

generateValue in interface ModelInteractionService

Throws:

ObjectAlreadyExistsException

ExpressionEvaluationException

SchemaException

ObjectNotFoundException

CommunicationException

ConfigurationException

SecurityViolationException

PolicyViolationException

validateValue

public <O extends ObjectType> void validateValue(PrismObject<O> object,
 PolicyItemsDefinitionType policyItemsDefinition,
 Task task,
 OperationResult parentResult)
                                          throws ExpressionEvaluationException,
SchemaException,
ObjectNotFoundException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
PolicyViolationException

Specified by:

validateValue in interface ModelInteractionService

Throws:

ExpressionEvaluationException

SchemaException

ObjectNotFoundException

CommunicationException

ConfigurationException

SecurityViolationException

PolicyViolationException

getDeputyAssignees

@NotNull
public @NotNull List<ObjectReferenceType> getDeputyAssignees(AbstractWorkItemType workItem,
 Task task,
 OperationResult parentResult)
                                                      throws SchemaException

Description copied from interface: ModelInteractionService

Gets "deputy assignees" i.e. users that are deputies of assignees. Takes limitations into account.

MAY NOT CHECK AUTHORIZATIONS (uses repository directly, at least at some places) - TODO TODO parameterize on limitation kind

Specified by:

getDeputyAssignees in interface ModelInteractionService

Throws:

SchemaException

getDeputyAssignees

@NotNull
public @NotNull List<ObjectReferenceType> getDeputyAssignees(ObjectReferenceType assigneeRef,
 OtherPrivilegesLimitations.Type limitationType,
 Task task,
 OperationResult parentResult)
                                                      throws SchemaException

Specified by:

getDeputyAssignees in interface ModelInteractionService

Throws:

SchemaException

getAssignmentEffectiveStatus

public ActivationStatusType getAssignmentEffectiveStatus(String lifecycleStatus,
 ActivationType activationType)

Description copied from interface: ModelInteractionService

Computes effective status for the current ActivationType in for an assignment

Specified by:

getAssignmentEffectiveStatus in interface ModelInteractionService

assumePowerOfAttorney

public MidPointPrincipal assumePowerOfAttorney(PrismObject<? extends FocusType> donor,
 Task task,
 OperationResult result)
                                        throws SchemaException,
SecurityViolationException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException

Specified by:

assumePowerOfAttorney in interface ModelInteractionService

Throws:

SchemaException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

dropPowerOfAttorney

public MidPointPrincipal dropPowerOfAttorney(Task task,
 OperationResult result)
                                      throws SecurityViolationException

Specified by:

dropPowerOfAttorney in interface ModelInteractionService

Throws:

SecurityViolationException

runUnderPowerOfAttorney

public <T> T runUnderPowerOfAttorney(Producer<T> producer,
 PrismObject<? extends FocusType> donor,
 Task task,
 OperationResult result)
                              throws SchemaException,
SecurityViolationException,
ObjectNotFoundException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException

Specified by:

runUnderPowerOfAttorney in interface ModelInteractionService

Throws:

SchemaException

SecurityViolationException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

createLocalizableMessageType

@NotNull
public @NotNull LocalizableMessageType createLocalizableMessageType(LocalizableMessageTemplateType template,
 VariablesMap variables,
 Task task,
 OperationResult result)
                                                             throws ObjectNotFoundException,
SchemaException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException,
SecurityViolationException

Specified by:

createLocalizableMessageType in interface ModelInteractionService

Throws:

ObjectNotFoundException

SchemaException

ExpressionEvaluationException

CommunicationException

ConfigurationException

SecurityViolationException

executeCredentialsReset

public ExecuteCredentialResetResponseType executeCredentialsReset(PrismObject<UserType> user,
 ExecuteCredentialResetRequestType executeCredentialResetRequest,
 Task task,
 OperationResult parentResult)
                                                           throws ObjectNotFoundException,
SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException,
ObjectAlreadyExistsException,
PolicyViolationException

Specified by:

executeCredentialsReset in interface ModelInteractionService

Throws:

ObjectNotFoundException

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

ObjectAlreadyExistsException

PolicyViolationException

refreshPrincipal

public void refreshPrincipal(String oid,
 Class<? extends FocusType> clazz)
                      throws ObjectNotFoundException,
SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Specified by:

refreshPrincipal in interface ModelInteractionService

Throws:

ObjectNotFoundException

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

getRelationDefinitions

public List<RelationDefinitionType> getRelationDefinitions()

Specified by:

getRelationDefinitions in interface ModelInteractionService

submitTaskFromTemplate

@NotNull
public @NotNull TaskType submitTaskFromTemplate(String templateTaskOid,
 List<Item<?,?>> extensionItems,
 Task opTask,
 OperationResult parentResult)
                                         throws CommunicationException,
ObjectNotFoundException,
SchemaException,
SecurityViolationException,
ConfigurationException,
ExpressionEvaluationException,
ObjectAlreadyExistsException,
PolicyViolationException

Description copied from interface: ModelInteractionService

Use ModelInteractionService.submitTaskFromTemplate(String, ActivityCustomization, Task, OperationResult) instead.

Specified by:

submitTaskFromTemplate in interface ModelInteractionService

Throws:

CommunicationException

ObjectNotFoundException

SchemaException

SecurityViolationException

ConfigurationException

ExpressionEvaluationException

ObjectAlreadyExistsException

PolicyViolationException

submitTaskFromTemplate

@NotNull
public @NotNull TaskType submitTaskFromTemplate(String templateTaskOid,
 Map<QName,Object> extensionValues,
 Task opTask,
 OperationResult parentResult)
                                         throws CommunicationException,
ObjectNotFoundException,
SchemaException,
SecurityViolationException,
ConfigurationException,
ExpressionEvaluationException,
ObjectAlreadyExistsException,
PolicyViolationException

Description copied from interface: ModelInteractionService

Use ModelInteractionService.submitTaskFromTemplate(String, ActivityCustomization, Task, OperationResult) instead.

Specified by:

submitTaskFromTemplate in interface ModelInteractionService

Throws:

CommunicationException

ObjectNotFoundException

SchemaException

SecurityViolationException

ConfigurationException

ExpressionEvaluationException

ObjectAlreadyExistsException

PolicyViolationException

submitTaskFromTemplate

@NotNull
public @NotNull String submitTaskFromTemplate(@NotNull
 @NotNull String templateOid,
 @NotNull
 @NotNull ActivityCustomization customization,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult parentResult)
                                       throws CommonException

Description copied from interface: ModelInteractionService

Submits a task from template (pointed to by `templateOid`). See MidpointFunctions.submitTaskFromTemplate(String, ActivityCustomization) for details.

Specified by:

submitTaskFromTemplate in interface ModelInteractionService

Throws:

CommonException

determineArchetypePolicy

public <O extends AssignmentHolderType>
ArchetypePolicyType determineArchetypePolicy(PrismObject<O> assignmentHolder,
 OperationResult result)
                                      throws SchemaException,
ConfigurationException

Description copied from interface: ModelInteractionService

Efficiently determines information about archetype policy applicable for a particular object. Returns null if no archetype policy is applicable. This is a "one stop" method for archetype policy in the GUI. The method returns archetype policy even for "legacy" situations, e.g. if the policy needs to be determined from system configuration using legacy subtype. GUI should not need to to any other processing to determine archetype information.

This method is invoked very often, usually when any object is displayed (including display of object lists and search results). Therefore this method is supposed to be very efficient. It should be using caching as much as possible.

Specified by:

determineArchetypePolicy in interface ModelInteractionService

Throws:

SchemaException

ConfigurationException

mergeArchetypePolicies

public ArchetypePolicyType mergeArchetypePolicies(PrismObject<ArchetypeType> archetype,
 OperationResult result)
                                           throws SchemaException,
ConfigurationException

Specified by:

mergeArchetypePolicies in interface ModelInteractionService

Throws:

SchemaException

ConfigurationException

determineAssignmentTargetSpecification

public <O extends AssignmentHolderType>
AssignmentCandidatesSpecification determineAssignmentTargetSpecification(PrismObject<O> object,
 OperationResult result)
                                                                  throws SchemaException

Description copied from interface: ModelInteractionService

Returns data structure that contains information about possible assignment targets for a particular holder object.

This method should be used when editing assignment holder (e.g. user) and looking for available assignment target. The determineAssignmentHolderSpecification is a "reverse" version of this method.

This method is not used that often. It is used when an object is edited. But it should be quite efficient anyway. It should use cached archetype information.

Specified by:

determineAssignmentTargetSpecification in interface ModelInteractionService

Throws:

SchemaException

getFilteredArchetypesByHolderType

public <O extends AssignmentHolderType>
List<ArchetypeType> getFilteredArchetypesByHolderType(Class<O> objectType,
 OperationResult result)
                                               throws SchemaException

Specified by:

getFilteredArchetypesByHolderType in interface ModelInteractionService

Throws:

SchemaException

getFilteredArchetypesByHolderType

public <O extends AssignmentHolderType>
List<ArchetypeType> getFilteredArchetypesByHolderType(PrismObject<O> object,
 OperationResult result)
                                               throws SchemaException

Description copied from interface: ModelInteractionService

This method is used to differentiate which archetypes can be added to object with holderType type. e.g. when changing archetype within Change archetype functionality should provide only those archetypes which can be assigned according to holderType.

Specified by:

getFilteredArchetypesByHolderType in interface ModelInteractionService

Throws:

SchemaException

determineAssignmentHolderSpecification

public <O extends AbstractRoleType>
AssignmentCandidatesSpecification determineAssignmentHolderSpecification(PrismObject<O> assignmentTarget,
 OperationResult result)
                                                                  throws SchemaException

Description copied from interface: ModelInteractionService

Returns data structure that contains information about possible assignment holders for a particular target object.

This method should be used when editing assignment target (role, org, service) and looking for object that can be potential members. The determineAssignmentTargetSpecification is a "reverse" version of this method.

This method is not used that often. It is used when an object is edited. But it should be quite efficient anyway. It should use cached archetype information.

Specified by:

determineAssignmentHolderSpecification in interface ModelInteractionService

Throws:

SchemaException

evaluateCollectionPolicyRules

@Experimental
@NotNull
public @NotNull Collection<EvaluatedPolicyRule> evaluateCollectionPolicyRules(@NotNull
 @NotNull PrismObject<ObjectCollectionType> collection,
 @Nullable
 @Nullable CompiledObjectCollectionView preCompiledView,
 @Nullable
 @Nullable Class<? extends ObjectType> targetTypeClass,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result)
                                                                       throws ObjectNotFoundException,
SchemaException,
SecurityViolationException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException

Description copied from interface: ModelInteractionService

Returns all policy rules that apply to the collection. Later, the policy rules are compiled from all the applicable sources (target, meta-roles, etc.). But for now we support only policy rules that are directly placed in collection assignments. EXPERIMENTAL. Quite likely to change later. [EP:APSO] DONE We assume that the collection is provided from the repository! Verified with the caller.

Specified by:

evaluateCollectionPolicyRules in interface ModelInteractionService

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException

compileObjectCollectionView

@Experimental
@NotNull
public @NotNull CompiledObjectCollectionView compileObjectCollectionView(@NotNull
 @NotNull CollectionRefSpecificationType collectionRef,
 @Nullable
 @Nullable Class<? extends Containerable> targetTypeClass,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result)
                                                                  throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException,
ObjectNotFoundException

Specified by:

compileObjectCollectionView in interface ModelInteractionService

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

ObjectNotFoundException

determineCollectionStats

@Experimental
@NotNull
public @NotNull CollectionStats determineCollectionStats(@NotNull
 @NotNull CompiledObjectCollectionView collectionView,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result)
                                                  throws SchemaException,
ObjectNotFoundException,
SecurityViolationException,
ConfigurationException,
CommunicationException,
ExpressionEvaluationException

Specified by:

determineCollectionStats in interface ModelInteractionService

Throws:

SchemaException

ObjectNotFoundException

SecurityViolationException

ConfigurationException

CommunicationException

ExpressionEvaluationException

applyView

public void applyView(CompiledObjectCollectionView existingView,
 GuiObjectListViewType objectListViewType)

Description copied from interface: ModelInteractionService

Applying all GuiObjectListViewsType to CompiledObjectCollectionView

Specified by:

applyView in interface ModelInteractionService

compileView

public void compileView(CompiledObjectCollectionView existingView,
 GuiObjectListViewType objectListViewsType,
 Task task,
 OperationResult result)
                 throws SchemaException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException,
ConfigurationException,
ObjectNotFoundException

Description copied from interface: ModelInteractionService

Compile object list view together with collection ref specification if present

Specified by:

compileView in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

validateValue

public <O extends ObjectType>
List<StringLimitationResult> validateValue(ProtectedStringType protectedStringValue,
 ValuePolicyType valuePolicy,
 PrismObject<O> object,
 Task task,
 OperationResult result)
                                    throws SchemaException,
PolicyViolationException,
ObjectNotFoundException,
SecurityViolationException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException

Specified by:

validateValue in interface ModelInteractionService

Throws:

SchemaException

PolicyViolationException

ObjectNotFoundException

SecurityViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException

processObjectsFromCollection

public void processObjectsFromCollection(CollectionRefSpecificationType collectionConfig,
 QName typeForFilter,
 Predicate<PrismContainer> handler,
 Collection<SelectorOptions<GetOperationOptions>> defaultOptions,
 VariablesMap variables,
 Task task,
 OperationResult result,
 boolean recordProgress)
                                  throws SchemaException,
ObjectNotFoundException,
SecurityViolationException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException

Description copied from interface: ModelInteractionService

TODO document

Specified by:

processObjectsFromCollection in interface ModelInteractionService

Throws:

SchemaException

ObjectNotFoundException

SecurityViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException

getSearchSpecificationFromCollection

public <T> ModelInteractionService.SearchSpec<T> getSearchSpecificationFromCollection(CompiledObjectCollectionView compiledCollection,
 QName typeForFilter,
 Collection<SelectorOptions<GetOperationOptions>> defaultOptions,
 VariablesMap variables,
 Task task,
 OperationResult result)
                                                                               throws ConfigurationException,
SchemaException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException,
ObjectNotFoundException

Description copied from interface: ModelInteractionService

TODO document and clean up the interface

Specified by:

getSearchSpecificationFromCollection in interface ModelInteractionService

Throws:

ConfigurationException

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ObjectNotFoundException

searchObjectsFromCollection

public List<? extends Serializable> searchObjectsFromCollection(CollectionRefSpecificationType collectionConfig,
 QName typeForFilter,
 Collection<SelectorOptions<GetOperationOptions>> defaultOptions,
 ObjectPaging usedPaging,
 VariablesMap variables,
 Task task,
 OperationResult result)
                                                         throws SchemaException,
ObjectNotFoundException,
SecurityViolationException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException

Specified by:

searchObjectsFromCollection in interface ModelInteractionService

Throws:

SchemaException

ObjectNotFoundException

SecurityViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException

countObjectsFromCollection

public Integer countObjectsFromCollection(CollectionRefSpecificationType collectionConfig,
 QName typeForFilter,
 Collection<SelectorOptions<GetOperationOptions>> defaultOptions,
 ObjectPaging usedPaging,
 VariablesMap variables,
 Task task,
 OperationResult result)
                                   throws SchemaException,
ObjectNotFoundException,
SecurityViolationException,
CommunicationException,
ConfigurationException,
ExpressionEvaluationException

Specified by:

countObjectsFromCollection in interface ModelInteractionService

Throws:

SchemaException

ObjectNotFoundException

SecurityViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException

expandConfigurationObject

public void expandConfigurationObject(@NotNull
 @NotNull PrismObject<? extends ObjectType> configurationObject,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result)
                               throws SchemaException,
ConfigurationException,
ObjectNotFoundException

Description copied from interface: ModelInteractionService

See ProvisioningService.expandConfigurationObject(PrismObject, Task, OperationResult) for the description. TODO security aspects

Specified by:

expandConfigurationObject in interface ModelInteractionService

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

submit

@NotNull
public @NotNull String submit(@NotNull
 @NotNull ActivityDefinitionType activityDefinition,
 @NotNull
 @NotNull ActivitySubmissionOptions options,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult parentResult)
                       throws CommonException

Description copied from interface: ModelInteractionService

Executes specified activity. Currently hard-wired to do that on background, i.e. by wrapping it into a task, and creating the task via the clockwork. (So that mappings from e.g. archetypes are executed.) Does _not_ require any special authorizations to submit the task. (The submit operation executes with elevated privileges.) The planned future state is that GUI declares the work that should be done (like "recompute members of role X") and the model will then decide the optimal way of doing that (e.g., on foreground or on background) and executes the action. When determining the way it needs to consider user preferences and/or authorizations, or the situation, like how many members are there. The goal is to better isolate GUI from the rest of midPoint, and to provide means for 3rd party GUI implementations. The current method should be seen as a (very rough) placeholder. Task archetype(s) are determined from the work, from the task template or from explicit options. Returns the background task OID. It is also set in the operation result.

Specified by:

submit in interface ModelInteractionService

Throws:

CommonException

createExecutionTask

@NotNull
public @NotNull TaskType createExecutionTask(@NotNull
 @NotNull ActivityDefinitionType activityDefinition,
 @NotNull
 @NotNull ActivitySubmissionOptions options,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result)
                                      throws CommonException

Description copied from interface: ModelInteractionService

As ModelInteractionService.submit(ActivityDefinitionType, ActivitySubmissionOptions, Task, OperationResult) but only prepares the task for execution; does not submit it.

Specified by:

createExecutionTask in interface ModelInteractionService

Throws:

CommonException

assignmentTypeDefinitionWithConcreteTargetRefType

public PrismContainerDefinition<AssignmentType> assignmentTypeDefinitionWithConcreteTargetRefType(PrismContainerDefinition<AssignmentType> orig,
 QName targetType)

Description copied from interface: ModelInteractionService

Returns Container Definition of Assignment Type with target type of assignment replaced by more concrete situation This allows for using more specific definition when searching for definitions for dereference, in GUI search or columns where we are sure (on other criteria) only assignment types we are processing have concrete target type.

Specified by:

assignmentTypeDefinitionWithConcreteTargetRefType in interface ModelInteractionService

Parameters:

orig - Original definition of Assignment Type

targetType - Concrete target type

refDefinitionWithConcreteTargetRefType

public PrismReferenceDefinition refDefinitionWithConcreteTargetRefType(PrismReferenceDefinition orig,
 QName targetType)

Description copied from interface: ModelInteractionService

Returns Container Definition of Assignment Type with target type of assignment replaced by more concrete situation This allows for using more specific definition when searching for definitions for dereference, in GUI search or columns where we are sure (on other criteria) only assignment types we are processing have concrete target type.

Specified by:

refDefinitionWithConcreteTargetRefType in interface ModelInteractionService

Parameters:

orig - Original definition of Assignment Type

targetType - Concrete target type

executeWithSimulationResult

public <X> X executeWithSimulationResult(@NotNull
 @NotNull TaskExecutionMode mode,
 @Nullable
 @Nullable SimulationDefinitionType simulationDefinition,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result,
 @NotNull
 SimulationResultManager.SimulatedFunctionCall<X> functionCall)
                                  throws CommonException

Description copied from interface: ModelInteractionService

Executes the code in `functionCall` parameter (SimulationResultManager.SimulatedFunctionCall) in the simulation mode (`mode` parameter), with the provided simulation result definition. The task must not be persistent. (This limitation can be lifted in the future, if needed.) Requires the native repository.

Specified by:

executeWithSimulationResult in interface ModelInteractionService

Throws:

CommonException

authorizeBulkActionExecution

public void authorizeBulkActionExecution(@Nullable
 @Nullable BulkAction action,
 @Nullable
 @Nullable AuthorizationPhaseType phase,
 @NotNull
 @NotNull Task task,
 @NotNull
 @NotNull OperationResult result)
                                  throws SchemaException,
ExpressionEvaluationException,
SecurityViolationException,
CommunicationException,
ConfigurationException,
ObjectNotFoundException

Description copied from interface: ModelInteractionService

Just a convenience method that checks that relevant authorization is present. (No action means the authorization for all actions is checked.)

Specified by:

authorizeBulkActionExecution in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

SecurityViolationException

CommunicationException

ConfigurationException

ObjectNotFoundException

applyDefinitions

public void applyDefinitions(ShadowType shadow,
 Task task,
 OperationResult result)
                      throws SchemaException,
ExpressionEvaluationException,
CommunicationException,
ConfigurationException,
ObjectNotFoundException

Description copied from interface: ModelInteractionService

Helper method to properly apply definitions to shadow. It is only needed when raw option is used for shadow search. Not sure about correctness of the method place and if even should be needed.

Specified by:

applyDefinitions in interface ModelInteractionService

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

ConfigurationException

ObjectNotFoundException

isOfArchetype

public boolean isOfArchetype(AssignmentHolderType assignmentHolderType,
 String archetypeOid,
 OperationResult result)
                      throws SchemaException,
ConfigurationException

Description copied from interface: ModelInteractionService

Determines if the object is of the specified archetype considering also archetypes hierarchy. In other works, looks recursively at superArchetypeRef is there is a match with specified archetype Later, this should be the functionality directly supported in DB (and midPoint query language)

Specified by:

isOfArchetype in interface ModelInteractionService

Throws:

SchemaException

ConfigurationException

isSubarchetypeOrArchetype

public boolean isSubarchetypeOrArchetype(String archetypeOid,
 String parentArchetype,
 OperationResult result)

Specified by:

isSubarchetypeOrArchetype in interface ModelInteractionService

determineArchetypes

@NotNull
public @NotNull List<ArchetypeType> determineArchetypes(@Nullable
 @Nullable ObjectType object,
 OperationResult result)
                                                 throws SchemaException

Specified by:

determineArchetypes in interface ModelInteractionService

Throws:

SchemaException