org.apache.hadoop.fs.s3a

Class FailureInjectionPolicy

java.lang.Object

org.apache.hadoop.fs.s3a.FailureInjectionPolicy

public class FailureInjectionPolicy
extends Object

Simple object which stores current failure injection settings. "Delaying a key" can mean: - Removing it from the S3 client's listings while delay is in effect. - Causing input stream reads to fail. - Causing the S3 side of getFileStatus(), i.e. AmazonS3#getObjectMetadata(), to throw FileNotFound.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_DELAY_KEY_MSEC How many seconds affected keys will have delayed visibility.
static float	DEFAULT_DELAY_KEY_PROBABILITY
static String	DEFAULT_DELAY_KEY_SUBSTRING Keys containing this substring will be subject to delayed visibility.
static String	MATCH_ALL_KEYS Special config value since we can't store empty strings in XML.

Constructor Summary

Constructors

Constructor and Description
FailureInjectionPolicy(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
long	getDelayKeyMsec()
float	getDelayKeyProbability()
String	getDelayKeySubstring()
int	getFailureLimit()
float	getThrottleProbability()
void	setFailureLimit(int failureLimit)
void	setThrottleProbability(float throttleProbability) Set the probability of throttling a request.
boolean	shouldDelay(String key) Should we delay listing visibility for this key?
String	toString()
static boolean	trueWithProbability(float p)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELAY_KEY_SUBSTRING

public static final String DEFAULT_DELAY_KEY_SUBSTRING

Keys containing this substring will be subject to delayed visibility.

See Also:

Constant Field Values

DEFAULT_DELAY_KEY_MSEC

public static final long DEFAULT_DELAY_KEY_MSEC

How many seconds affected keys will have delayed visibility. This should probably be a config value.

See Also:

Constant Field Values

DEFAULT_DELAY_KEY_PROBABILITY

public static final float DEFAULT_DELAY_KEY_PROBABILITY

See Also:

Constant Field Values

MATCH_ALL_KEYS

public static final String MATCH_ALL_KEYS

Special config value since we can't store empty strings in XML.

See Also:

Constant Field Values

Constructor Detail

FailureInjectionPolicy

public FailureInjectionPolicy(org.apache.hadoop.conf.Configuration conf)

Method Detail

getDelayKeySubstring

public String getDelayKeySubstring()

getDelayKeyProbability

public float getDelayKeyProbability()

getDelayKeyMsec

public long getDelayKeyMsec()

getThrottleProbability

public float getThrottleProbability()

getFailureLimit

public int getFailureLimit()

setFailureLimit

public void setFailureLimit(int failureLimit)

setThrottleProbability

public void setThrottleProbability(float throttleProbability)

Set the probability of throttling a request.

Parameters:

throttleProbability - the probability of a request being throttled.

trueWithProbability

public static boolean trueWithProbability(float p)

shouldDelay

public boolean shouldDelay(String key)

Should we delay listing visibility for this key?

Parameters:

key - key which is being put

Returns:

true if we should delay

toString

public String toString()

Overrides:

toString in class Object