RegexHBase2EventSerializer (Apache Flume 1.9.0-cdh6.3.2 API)

java.lang.Object
- org.apache.flume.sink.hbase2.RegexHBase2EventSerializer

All Implemented Interfaces:

Configurable, ConfigurableComponent, HBase2EventSerializer

Direct Known Subclasses:

RegexHbaseEventSerializer
```
public class RegexHBase2EventSerializer
extends Object
implements HBase2EventSerializer
```
An HBase2EventSerializer which parses columns based on a supplied regular expression and column name list.
Note that if the regular expression does not return the correct number of groups for a particular event, or it does not correctly match an event, the event is silently dropped.
Row keys for each event consist of a timestamp concatenated with an identifier which enforces uniqueness of keys across flume agents.
See static constant variables for configuration options.

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`cf`
`static String`	`CHARSET_CONFIG` What charset to use when serializing into HBase's byte arrays
`static String`	`CHARSET_DEFAULT`
`static String`	`COL_NAME_CONFIG` Comma separated list of column names to place matching groups in.
`static String`	`COLUMN_NAME_DEFAULT`
`static String`	`DEPOSIT_HEADERS_CONFIG` Whether to deposit event headers into corresponding column qualifiers
`static boolean`	`DEPOSIT_HEADERS_DEFAULT`
`static String`	`IGNORE_CASE_CONFIG` Whether to ignore case when performing regex matches.
`static boolean`	`IGNORE_CASE_DEFAULT`
`protected static AtomicInteger`	`nonce`
`protected static String`	`randomKey`
`static String`	`REGEX_CONFIG` Regular expression used to parse groups from event data.
`static String`	`REGEX_DEFAULT`
`static String`	`ROW_KEY_INDEX_CONFIG` Index of the row key in matched regex groups
`static String`	`ROW_KEY_NAME` Placeholder in colNames for row key

Constructor Summary

Constructors
Constructor and Description

RegexHBase2EventSerializer()

Constructors
Constructor and Description
`RegexHBase2EventSerializer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`configure(ComponentConfiguration conf)`
`void`	`configure(Context context)` Request the implementing class to (re)configure itself.
`List<org.apache.hadoop.hbase.client.Row>`	`getActions()` Get the actions that should be written out to hbase as a result of this event.
`List<org.apache.hadoop.hbase.client.Increment>`	`getIncrements()`
`protected byte[]`	`getRowKey()`
`protected byte[]`	`getRowKey(Calendar cal)` Returns a row-key with the following format: [time in millis]-[random key]-[nonce]
`void`	`initialize(Event event, byte[] columnFamily)` Initialize the event serializer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REGEX_CONFIG
```
public static final String REGEX_CONFIG
```
    Regular expression used to parse groups from event data.
    
    See Also:
    
    Constant Field Values
  - REGEX_DEFAULT
```
public static final String REGEX_DEFAULT
```
    See Also:
    
    Constant Field Values
  - IGNORE_CASE_CONFIG
```
public static final String IGNORE_CASE_CONFIG
```
    Whether to ignore case when performing regex matches.
    
    See Also:
    
    Constant Field Values
  - IGNORE_CASE_DEFAULT
```
public static final boolean IGNORE_CASE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - COL_NAME_CONFIG
```
public static final String COL_NAME_CONFIG
```
    Comma separated list of column names to place matching groups in.
    
    See Also:
    
    Constant Field Values
  - COLUMN_NAME_DEFAULT
```
public static final String COLUMN_NAME_DEFAULT
```
    See Also:
    
    Constant Field Values
  - ROW_KEY_INDEX_CONFIG
```
public static final String ROW_KEY_INDEX_CONFIG
```
    Index of the row key in matched regex groups
    
    See Also:
    
    Constant Field Values
  - ROW_KEY_NAME
```
public static final String ROW_KEY_NAME
```
    Placeholder in colNames for row key
    
    See Also:
    
    Constant Field Values
  - DEPOSIT_HEADERS_CONFIG
```
public static final String DEPOSIT_HEADERS_CONFIG
```
    Whether to deposit event headers into corresponding column qualifiers
    
    See Also:
    
    Constant Field Values
  - DEPOSIT_HEADERS_DEFAULT
```
public static final boolean DEPOSIT_HEADERS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - CHARSET_CONFIG
```
public static final String CHARSET_CONFIG
```
    What charset to use when serializing into HBase's byte arrays
    
    See Also:
    
    Constant Field Values
  - CHARSET_DEFAULT
```
public static final String CHARSET_DEFAULT
```
    See Also:
    
    Constant Field Values
  - nonce
```
protected static final AtomicInteger nonce
```
  - randomKey
```
protected static final String randomKey
```
  - cf
```
protected byte[] cf
```
- Constructor Detail
  - RegexHBase2EventSerializer
```
public RegexHBase2EventSerializer()
```
- Method Detail
  - configure
```
public void configure(Context context)
```
    Description copied from interface: Configurable
    
    Request the implementing class to (re)configure itself.
    
    When configuration parameters are changed, they must be reflected by the component asap.
    
    There are no thread safety guarantees on when configure might be called.
    
    Specified by:
    
    configure in interface Configurable
  - configure
```
public void configure(ComponentConfiguration conf)
```
    Specified by:
    
    configure in interface ConfigurableComponent
  - initialize
```
public void initialize(Event event,
                       byte[] columnFamily)
```
    Description copied from interface: HBase2EventSerializer
    
    Initialize the event serializer.
    
    Specified by:
    
    initialize in interface HBase2EventSerializer
    
    Parameters:
    
    event - Event to be written to HBase
    
    columnFamily - Column family to write to
  - getRowKey
```
protected byte[] getRowKey(Calendar cal)
```
    Returns a row-key with the following format: [time in millis]-[random key]-[nonce]
  - getRowKey
```
protected byte[] getRowKey()
```
  - getActions
```
public List<org.apache.hadoop.hbase.client.Row> getActions()
                                                    throws FlumeException
```
    Description copied from interface: HBase2EventSerializer
    
    Get the actions that should be written out to hbase as a result of this event. This list is written to HBase using the HBase batch API.
    
    Specified by:
    
    getActions in interface HBase2EventSerializer
    
    Returns:
    
    List of Row which are written as such to HBase. 0.92 increments do not implement Row, so this is not generic.
    
    Throws:
    
    FlumeException
  - getIncrements
```
public List<org.apache.hadoop.hbase.client.Increment> getIncrements()
```
    Specified by:
    
    getIncrements in interface HBase2EventSerializer
  - close
```
public void close()
```
    Specified by:
    
    close in interface HBase2EventSerializer

Class RegexHBase2EventSerializer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REGEX_CONFIG

REGEX_DEFAULT

IGNORE_CASE_CONFIG

IGNORE_CASE_DEFAULT

COL_NAME_CONFIG

COLUMN_NAME_DEFAULT

ROW_KEY_INDEX_CONFIG

ROW_KEY_NAME

DEPOSIT_HEADERS_CONFIG

DEPOSIT_HEADERS_DEFAULT

CHARSET_CONFIG

CHARSET_DEFAULT

nonce

randomKey

cf

Constructor Detail

RegexHBase2EventSerializer

Method Detail

configure

configure

initialize

getRowKey

getRowKey

getActions

getIncrements

close