Package com.evolveum.midpoint.task.api

Interface Tracer

public interface Tracer

Method Summary

Modifier and Type	Method	Description
CompiledTracingProfile	compileProfile(@Nullable TracingProfileType profile, @NotNull OperationResult result)	Compiles the tracing profile; or a default one, if no profile is provided.
@NotNull TracingProfileType	getDefaultProfile()	TODO
TracingProfileType	resolve(TracingProfileType tracingProfile, OperationResult result)	Resolves a tracing profile - i.e.
void	setTemplateParametersCustomizer(@NotNull Consumer<Map<String,String>> customizer)	Sets customizer of tracer template parameters, replacing any previous one.
void	storeTrace(Task task, OperationResult result, @Nullable OperationResult parentResult)	Stores trace to persistent storage (usually a file in "trace" directory).

Method Detail

storeTrace

void storeTrace(Task task,
                OperationResult result,
                @Nullable
                @Nullable OperationResult parentResult)

Stores trace to persistent storage (usually a file in "trace" directory).

Parameters:

task - Task containing the context information necessary e.g. to derive name of the trace file.

result - Result that is to be serialized and stored.

parentResult - Parent result where this operation should be recorded (if any).

resolve

TracingProfileType resolve(TracingProfileType tracingProfile,
                           OperationResult result)
                    throws SchemaException

Resolves a tracing profile - i.e. replaces references to other (named) profiles with their content.

Throws:

SchemaException - If the profile name cannot be resolved e.g. if the referenced profile does not exist or the name in ambiguous.

getDefaultProfile

@NotNull
@NotNull TracingProfileType getDefaultProfile()

TODO

compileProfile

CompiledTracingProfile compileProfile(@Nullable
                                      @Nullable TracingProfileType profile,
                                      @NotNull
                                      @NotNull OperationResult result)
                               throws SchemaException

Compiles the tracing profile; or a default one, if no profile is provided.

Throws:

SchemaException

setTemplateParametersCustomizer

void setTemplateParametersCustomizer(@NotNull
                                     @NotNull Consumer<Map<String,String>> customizer)

Sets customizer of tracer template parameters, replacing any previous one. This allows to inject custom parameters, for instance during test runs.