Interface SecurityAnalysisInterceptor
-
- All Known Implementing Classes:
CurrentLimitViolationInterceptor
,DefaultSecurityAnalysisInterceptor
public interface SecurityAnalysisInterceptor
Security analysis interceptors are notified at various steps of the construction of theSecurityAnalysisResult
, for instance when adding newlimit violations
. This mechanism allows for example users of theSecurityAnalysis
to add additional information in the result, asextensions
.Some of this information can be retrieved from the provided
SecurityAnalysisResultContext
. Implementations of the security analysis can provide implementation-specific information by providing their own implementation of this context.Note that the contexts provided to the various methods can be different objects, in order to provide more specific information, for example for violations or contingencies. This can also be helpful to guarantee thread safety, if the result builder is used concurrently.
- Author:
- Mathieu Bague
-
-
Method Summary
All Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description default void
onLimitViolation(Contingency contingency, LimitViolation limitViolation, SecurityAnalysisResultContext context)
Callback when a violation is detected on N-1 situation.default void
onLimitViolation(LimitViolation limitViolation, SecurityAnalysisResultContext context)
Callback when a violation is detected on N situation.default void
onPostContingencyResult(RunningContext context, PostContingencyResult postContingencyResult)
default void
onPostContingencyResult(PostContingencyResult postContingencyResult, SecurityAnalysisResultContext context)
Callback after the post-contingency result is built.default void
onPreContingencyResult(RunningContext context, LimitViolationsResult preContingencyResult)
Deprecated.UseonPreContingencyResult(LimitViolationsResult, SecurityAnalysisResultContext)
Callback after the pre-contingency analysis result is createddefault void
onPreContingencyResult(LimitViolationsResult preContingencyResult, SecurityAnalysisResultContext context)
Callback after the pre-contingency result is built.default void
onSecurityAnalysisResult(RunningContext context, SecurityAnalysisResult result)
Deprecated.UseonSecurityAnalysisResult(SecurityAnalysisResult, SecurityAnalysisResultContext)
Callback after the result is createddefault void
onSecurityAnalysisResult(SecurityAnalysisResult result, SecurityAnalysisResultContext context)
Callback after the security-analysis result is built.
-
-
-
Method Detail
-
onPreContingencyResult
@Deprecated default void onPreContingencyResult(RunningContext context, LimitViolationsResult preContingencyResult)
Deprecated.UseonPreContingencyResult(LimitViolationsResult, SecurityAnalysisResultContext)
Callback after the pre-contingency analysis result is created- Parameters:
context
- The running contextpreContingencyResult
-
-
onPostContingencyResult
@Deprecated default void onPostContingencyResult(RunningContext context, PostContingencyResult postContingencyResult)
- Parameters:
context
-postContingencyResult
-
-
onSecurityAnalysisResult
@Deprecated default void onSecurityAnalysisResult(RunningContext context, SecurityAnalysisResult result)
Deprecated.UseonSecurityAnalysisResult(SecurityAnalysisResult, SecurityAnalysisResultContext)
Callback after the result is created- Parameters:
context
-result
-
-
onPreContingencyResult
default void onPreContingencyResult(LimitViolationsResult preContingencyResult, SecurityAnalysisResultContext context)
Callback after the pre-contingency result is built.- Parameters:
preContingencyResult
-context
-
-
onPostContingencyResult
default void onPostContingencyResult(PostContingencyResult postContingencyResult, SecurityAnalysisResultContext context)
Callback after the post-contingency result is built.- Parameters:
context
-postContingencyResult
-
-
onSecurityAnalysisResult
default void onSecurityAnalysisResult(SecurityAnalysisResult result, SecurityAnalysisResultContext context)
Callback after the security-analysis result is built.- Parameters:
result
-context
-
-
onLimitViolation
default void onLimitViolation(LimitViolation limitViolation, SecurityAnalysisResultContext context)
Callback when a violation is detected on N situation.- Parameters:
limitViolation
-context
-
-
onLimitViolation
default void onLimitViolation(Contingency contingency, LimitViolation limitViolation, SecurityAnalysisResultContext context)
Callback when a violation is detected on N-1 situation.- Parameters:
contingency
-limitViolation
-context
-
-
-