@InterfaceAudience.Public
@InterfaceStability.Unstable
public interface FenceMethod
Since these methods are often vendor- or device-specific, operators may implement this interface in order to achieve fencing.
Fencing is configured by the operator as an ordered list of methods to
attempt. Each method will be tried in turn, and the next in the list
will only be attempted if the previous one fails. See NodeFencer
for more information.
If an implementation also implements Configurable
then its
setConf
method will be called upon instantiation.
Modifier and Type | Method and Description |
---|---|
void |
checkArgs(String args)
Verify that the given fencing method's arguments are valid.
|
boolean |
tryFence(HAServiceTarget target,
String args)
Attempt to fence the target node.
|
void checkArgs(String args) throws BadFencingConfigurationException
args
- the arguments provided in the configuration. This may
be null if the operator did not configure any arguments.BadFencingConfigurationException
- if the arguments are invalidboolean tryFence(HAServiceTarget target, String args) throws BadFencingConfigurationException
target
- the target of the service to fenceargs
- the configured arguments, which were checked at startup by
checkArgs(String)
BadFencingConfigurationException
- if the configuration was
determined to be invalid only at runtimeCopyright © 2024 Apache Software Foundation. All rights reserved.