Package com.evolveum.midpoint.model.api
Interface ModelDiagnosticService
public interface ModelDiagnosticService
A service provided by the IDM Model focused on system diagnostic. It allows to retrieve diagnostic data
that are not exactly part of system configuration (such as repository configuration). It can also be used
to initiate self-tests and similar diagnostic routines.
UNSTABLE: This is likely to change
PRIVATE: This interface is not supposed to be used outside of midPoint
- Author:
- Radovan Semancik
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescription@NotNull AuthorizationEvaluationResponseTypeevaluateAuthorizations(@NotNull AuthorizationEvaluationRequestType request, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result) Evaluates an authorization request.evaluateMapping(MappingEvaluationRequestType request, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) Execute arbitrary mapping.executeRepositoryQuery(RepositoryQueryDiagRequest request, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) Execute arbitrary implementation-specific query.exportDataModel(ResourceType resource, DataModelVisualizer.Target target, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) exportDataModel(Collection<String> resourceOids, DataModelVisualizer.Target target, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) Exports data model EXPERIMENTAL.getLogFileContent(Long fromPosition, Long maxSize, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) Returns the contents of the log file.longgetLogFileSize(com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) getMemoryInformation(com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) getProvisioningDiag(com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) Provide provisioning run-time configuration and diagnostic information.getRepositoryDiag(com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) Provide repository run-time configuration and diagnostic information.provisioningSelfTest(com.evolveum.midpoint.task.api.Task task) Runs a short, non-destructive internal provisioning test.repositorySelfTest(com.evolveum.midpoint.task.api.Task task) Runs a short, non-destructive repository self test.voidrepositoryTestOrgClosureConsistency(com.evolveum.midpoint.task.api.Task task, boolean repairIfNecessary, OperationResult result) Checks a org closure table for consistency, repairing any problems found.
-
Field Details
-
CLASS_NAME_WITH_DOT
-
REPOSITORY_SELF_TEST
-
REPOSITORY_TEST_ORG_CLOSURE_CONSISTENCY
-
EXECUTE_REPOSITORY_QUERY
-
EVALUATE_MAPPING
-
EVALUATE_AUTHORIZATIONS
-
PROVISIONING_SELF_TEST
-
GET_LOG_FILE_CONTENT
-
GET_LOG_FILE_SIZE
-
GET_MEMORY_INFORMATION
-
-
Method Details
-
getRepositoryDiag
RepositoryDiag getRepositoryDiag(com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) Provide repository run-time configuration and diagnostic information. -
repositorySelfTest
Runs a short, non-destructive repository self test. This methods should never throw a (checked) exception. All the results should be in the returned result structure (including fatal errors). -
repositoryTestOrgClosureConsistency
void repositoryTestOrgClosureConsistency(com.evolveum.midpoint.task.api.Task task, boolean repairIfNecessary, OperationResult result) throws SchemaException, SecurityViolationException, ObjectNotFoundException, ExpressionEvaluationException, ConfigurationException, CommunicationException Checks a org closure table for consistency, repairing any problems found. This methods should never throw a (checked) exception. All the results should be in the returned result structure (including fatal errors). The current implementation expects closure to be of reasonable size - so it could be fetched into main memory as well as recomputed online (perhaps up to ~250K entries). In future, this method will be reimplemented. BEWARE, this method locks out the M_ORG_CLOSURE table, so org-related operations would wait until it completes. TODO this method is SQL service specific; it should be generalized/fixed somehow. -
provisioningSelfTest
Runs a short, non-destructive internal provisioning test. It tests provisioning framework and general setup. Use ModelService.testResource for testing individual resource configurations. -
getProvisioningDiag
ProvisioningDiag getProvisioningDiag(com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) Provide provisioning run-time configuration and diagnostic information. -
executeRepositoryQuery
RepositoryQueryDiagResponse executeRepositoryQuery(RepositoryQueryDiagRequest request, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) throws SchemaException, SecurityViolationException, ObjectNotFoundException, ExpressionEvaluationException, ConfigurationException, CommunicationException Execute arbitrary implementation-specific query. In current implementation this means hibernate query. EXPERIMENTAL. -
evaluateMapping
MappingEvaluationResponseType evaluateMapping(MappingEvaluationRequestType request, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) throws SchemaException, SecurityViolationException, ExpressionEvaluationException, ObjectNotFoundException, CommunicationException, ConfigurationException Execute arbitrary mapping. EXPERIMENTAL -
evaluateAuthorizations
@Experimental @NotNull @NotNull AuthorizationEvaluationResponseType evaluateAuthorizations(@NotNull @NotNull AuthorizationEvaluationRequestType request, @NotNull @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull @NotNull OperationResult result) throws SchemaException, SecurityViolationException, ExpressionEvaluationException, ObjectNotFoundException, CommunicationException, ConfigurationException Evaluates an authorization request. -
exportDataModel
String exportDataModel(Collection<String> resourceOids, DataModelVisualizer.Target target, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) throws SchemaException, ConfigurationException, ObjectNotFoundException, CommunicationException, SecurityViolationException, ExpressionEvaluationException Exports data model EXPERIMENTAL. (TODO find a better place) -
exportDataModel
String exportDataModel(ResourceType resource, DataModelVisualizer.Target target, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) throws SchemaException, ConfigurationException, ObjectNotFoundException, CommunicationException, SecurityViolationException, ExpressionEvaluationException -
getLogFileContent
LogFileContentType getLogFileContent(Long fromPosition, Long maxSize, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) throws SecurityViolationException, IOException, SchemaException, ObjectNotFoundException, ExpressionEvaluationException, CommunicationException, ConfigurationException Returns the contents of the log file.- Parameters:
fromPosition- From absolute log file position (if non-negative); or counted from the end (if negative).maxSize- Max number of bytes to return.task-parentResult-- Throws:
SecurityViolationExceptionIOExceptionSchemaExceptionObjectNotFoundExceptionExpressionEvaluationExceptionCommunicationExceptionConfigurationException
-
getLogFileSize
long getLogFileSize(com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) throws SchemaException, SecurityViolationException, ObjectNotFoundException, ExpressionEvaluationException, ConfigurationException, CommunicationException -
getMemoryInformation
String getMemoryInformation(com.evolveum.midpoint.task.api.Task task, OperationResult parentResult) throws CommunicationException, ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException, ExpressionEvaluationException, IOException
-