AbstractFSWALProvider (Apache HBase

java.lang.Object
- org.apache.hadoop.hbase.wal.AbstractFSWALProvider<T>

所有已实现的接口:

WALProvider

直接已知子类:

AsyncFSWALProvider, FSHLogProvider
```
@InterfaceAudience.Private
 @InterfaceStability.Evolving
public abstract class AbstractFSWALProvider<T extends AbstractFSWAL<?>>
extends Object
implements WALProvider
```
Base class of a WAL Provider that returns a single thread safe WAL that writes to Hadoop FS. By default, this implementation picks a directory in Hadoop FS based on a combination of
- the HBase root directory
- HConstants.HREGION_LOGDIR_NAME
- the given factory's factoryId (usually identifying the regionserver by host:port)
It also uses the providerId to differentiate among files.

嵌套类概要

嵌套类
限定符和类型类和说明

static interface AbstractFSWALProvider.Reader
- 从接口继承的嵌套类/接口 org.apache.hadoop.hbase.wal.WALProvider
  WALProvider.AsyncWriter, WALProvider.Writer, WALProvider.WriterBase

嵌套类
限定符和类型	类和说明
`static interface`	`AbstractFSWALProvider.Reader`

字段概要

字段
限定符和类型	字段和说明
`protected org.apache.hadoop.conf.Configuration`	`conf`
`static boolean`	`DEFAULT_SEPARATE_OLDLOGDIR`
`protected WALFactory`	`factory`
`protected AtomicBoolean`	`initialized`
`protected List<WALActionsListener>`	`listeners`
`protected String`	`logPrefix`
`static String`	`META_WAL_PROVIDER_ID` The hbase:meta region's WAL filename extension
`protected String`	`providerId`
`static String`	`SEPARATE_OLDLOGDIR` Separate old log into different dir by regionserver name
`static String`	`SPLITTING_EXT` File Extension used while splitting an WAL into regions (HBASE-2312)
`protected T`	`wal`
`static String`	`WAL_FILE_NAME_DELIMITER`

构造器概要

构造器
构造器和说明

AbstractFSWALProvider()

构造器
构造器和说明
`AbstractFSWALProvider()`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`addWALActionsListener(WALActionsListener listener)` Add a `WALActionsListener`.
`void`	`close()` shutdown utstanding WALs and clean up any persisted state.
`protected abstract T`	`createWAL()`
`protected abstract void`	`doInit(org.apache.hadoop.conf.Configuration conf)`
`static long`	`extractFileNumFromWAL(WAL wal)` It returns the file create timestamp from the file name.
`static org.apache.hadoop.fs.Path`	`getArchivedLogPath(org.apache.hadoop.fs.Path path, org.apache.hadoop.conf.Configuration conf)` Get the archived WAL file path
`static org.apache.hadoop.fs.Path`	`getCurrentFileName(WAL wal)` return the current filename from the current wal.
`long`	`getLogFileSize()` iff the given WALFactory is using the DefaultWALProvider for meta and/or non-meta, count the size of files (only rolled). if either of them aren't, count 0 for that provider.
`static long`	`getLogFileSize(WAL wal)` returns the size of rolled WAL files.
`long`	`getNumLogFiles()` iff the given WALFactory is using the DefaultWALProvider for meta and/or non-meta, count the number of files (rolled and active). if either of them aren't, count 0 for that provider.
`static int`	`getNumRolledLogFiles(WAL wal)` returns the number of rolled WAL files.
`static ServerName`	`getServerNameFromWALDirectoryName(org.apache.hadoop.conf.Configuration conf, String path)` Pulls a ServerName out of a Path generated according to our layout rules.
`static ServerName`	`getServerNameFromWALDirectoryName(org.apache.hadoop.fs.Path logFile)` This function returns region server name from a log file name which is in one of the following formats: hdfs://<name node>/hbase/.logs/<server name>-splitting/...
`T`	`getWAL(RegionInfo region)`
`static String`	`getWALArchiveDirectoryName(org.apache.hadoop.conf.Configuration conf, String serverName)` Construct the directory name for all old WALs on a given server.
`static String`	`getWALDirectoryName(String serverName)` Construct the directory name for all WALs on a given server.
`static String`	`getWALPrefixFromWALName(String name)` Get prefix of the log from its name, assuming WAL name in format of log_prefix.filenumber.log_suffix
`List<WAL>`	`getWALs()`
`void`	`init(WALFactory factory, org.apache.hadoop.conf.Configuration conf, String providerId)` Set up the provider to create wals. will only be called once per instance.
`static boolean`	`isArchivedLogFile(org.apache.hadoop.fs.Path p)`
`static boolean`	`isMetaFile(org.apache.hadoop.fs.Path p)`
`static boolean`	`isMetaFile(String p)`
`static WAL.Reader`	`openReader(org.apache.hadoop.fs.Path path, org.apache.hadoop.conf.Configuration conf)` Opens WAL reader with retries and additional exception handling
`void`	`shutdown()` persist outstanding WALs to storage and stop accepting new appends.
`static boolean`	`validateWALFilename(String filename)` A WAL file name is of the format: <wal-name>`WAL_FILE_NAME_DELIMITER` <file-creation-timestamp>[.meta]. provider-name is usually made up of a server-name and a provider-id

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.apache.hadoop.hbase.wal.WALProvider
getWALFileLengthProvider

- 字段详细资料
  - SEPARATE_OLDLOGDIR
```
public static final String SEPARATE_OLDLOGDIR
```
    Separate old log into different dir by regionserver name
    
    另请参阅:
    
    常量字段值
  - DEFAULT_SEPARATE_OLDLOGDIR
```
public static final boolean DEFAULT_SEPARATE_OLDLOGDIR
```
    另请参阅:
    
    常量字段值
  - wal
```
protected volatile T extends AbstractFSWAL<?> wal
```
  - factory
```
protected WALFactory factory
```
  - conf
```
protected org.apache.hadoop.conf.Configuration conf
```
  - listeners
```
protected List<WALActionsListener> listeners
```
  - providerId
```
protected String providerId
```
  - initialized
```
protected AtomicBoolean initialized
```
  - logPrefix
```
protected String logPrefix
```
  - WAL_FILE_NAME_DELIMITER
```
public static final String WAL_FILE_NAME_DELIMITER
```
    另请参阅:
    
    常量字段值
  - META_WAL_PROVIDER_ID
```
public static final String META_WAL_PROVIDER_ID
```
    The hbase:meta region's WAL filename extension
    
    另请参阅:
    
    常量字段值
  - SPLITTING_EXT
```
public static final String SPLITTING_EXT
```
    File Extension used while splitting an WAL into regions (HBASE-2312)
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AbstractFSWALProvider
```
public AbstractFSWALProvider()
```
- 方法详细资料
  - init
```
public void init(WALFactory factory,
                 org.apache.hadoop.conf.Configuration conf,
                 String providerId)
          throws IOException
```
    从接口复制的说明: WALProvider
    
    Set up the provider to create wals. will only be called once per instance.
    
    指定者:
    
    init 在接口中 WALProvider
    
    参数:
    
    factory - factory that made us, identity used for FS layout. may not be null
    
    conf - may not be null
    
    providerId - differentiate between providers from one factory, used for FS layout. may be null
    
    抛出:
    
    IOException
  - getWALs
```
public List<WAL> getWALs()
```
    指定者:
    
    getWALs 在接口中 WALProvider
    
    返回:
    
    the List of WALs that are used by this server
  - getWAL
```
public T getWAL(RegionInfo region)
         throws IOException
```
    指定者:
    
    getWAL 在接口中 WALProvider
    
    参数:
    
    region - the region which we want to get a WAL for it. Could be null.
    
    返回:
    
    a WAL for writing entries for the given region.
    
    抛出:
    
    IOException
  - createWAL
```
protected abstract T createWAL()
                        throws IOException
```
    抛出:
    
    IOException
  - doInit
```
protected abstract void doInit(org.apache.hadoop.conf.Configuration conf)
                        throws IOException
```
    抛出:
    
    IOException
  - shutdown
```
public void shutdown()
              throws IOException
```
    从接口复制的说明: WALProvider
    
    persist outstanding WALs to storage and stop accepting new appends. This method serves as shorthand for sending a sync to every WAL provided by a given implementation. Those WALs will also stop accepting new writes.
    
    指定者:
    
    shutdown 在接口中 WALProvider
    
    抛出:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    从接口复制的说明: WALProvider
    
    shutdown utstanding WALs and clean up any persisted state. Call this method only when you will not need to replay any of the edits to the WALs from this provider. After this call completes, the underlying resources should have been reclaimed.
    
    指定者:
    
    close 在接口中 WALProvider
    
    抛出:
    
    IOException
  - getNumLogFiles
```
public long getNumLogFiles()
```
    iff the given WALFactory is using the DefaultWALProvider for meta and/or non-meta, count the number of files (rolled and active). if either of them aren't, count 0 for that provider.
    
    指定者:
    
    getNumLogFiles 在接口中 WALProvider
  - getLogFileSize
```
public long getLogFileSize()
```
    iff the given WALFactory is using the DefaultWALProvider for meta and/or non-meta, count the size of files (only rolled). if either of them aren't, count 0 for that provider.
    
    指定者:
    
    getLogFileSize 在接口中 WALProvider
  - getNumRolledLogFiles
```
public static int getNumRolledLogFiles(WAL wal)
```
    returns the number of rolled WAL files.
  - getLogFileSize
```
public static long getLogFileSize(WAL wal)
```
    returns the size of rolled WAL files.
  - getCurrentFileName
```
public static org.apache.hadoop.fs.Path getCurrentFileName(WAL wal)
```
    return the current filename from the current wal.
  - extractFileNumFromWAL
```
public static long extractFileNumFromWAL(WAL wal)
```
    It returns the file create timestamp from the file name. For name format see validateWALFilename(String) public until remaining tests move to o.a.h.h.wal
    
    参数:
    
    wal - must not be null
    
    返回:
    
    the file number that is part of the WAL file name
  - validateWALFilename
```
public static boolean validateWALFilename(String filename)
```
    A WAL file name is of the format: <wal-name>WAL_FILE_NAME_DELIMITER <file-creation-timestamp>[.meta]. provider-name is usually made up of a server-name and a provider-id
    
    参数:
    
    filename - name of the file to validate
    
    返回:
    
    true if the filename matches an WAL, false otherwise
  - getWALDirectoryName
```
public static String getWALDirectoryName(String serverName)
```
    Construct the directory name for all WALs on a given server. Dir names currently look like this for WALs: hbase//WALs/kalashnikov.att.net,61634,1486865297088.
    
    参数:
    
    serverName - Server name formatted as described in ServerName
    
    返回:
    
    the relative WAL directory name, e.g. .logs/1.example.org,60030,12345 if serverName passed is 1.example.org,60030,12345
  - getWALArchiveDirectoryName
```
public static String getWALArchiveDirectoryName(org.apache.hadoop.conf.Configuration conf,
                                                String serverName)
```
    Construct the directory name for all old WALs on a given server. The default old WALs dir looks like: hbase/oldWALs. If you config hbase.separate.oldlogdir.by.regionserver to true, it looks like hbase//oldWALs/kalashnikov.att.net,61634,1486865297088.
    
    参数:
    
    conf -
    
    serverName - Server name formatted as described in ServerName
    
    返回:
    
    the relative WAL directory name
  - getServerNameFromWALDirectoryName
```
public static ServerName getServerNameFromWALDirectoryName(org.apache.hadoop.conf.Configuration conf,
                                                           String path)
                                                    throws IOException
```
    Pulls a ServerName out of a Path generated according to our layout rules. In the below layouts, this method ignores the format of the logfile component. Current format: [base directory for hbase]/hbase/.logs/ServerName/logfile or [base directory for hbase]/hbase/.logs/ServerName-splitting/logfile Expected to work for individual log files and server-specific directories.
    
    返回:
    
    null if it's not a log file. Returns the ServerName of the region server that created this log file otherwise.
    
    抛出:
    
    IOException
  - getServerNameFromWALDirectoryName
```
public static ServerName getServerNameFromWALDirectoryName(org.apache.hadoop.fs.Path logFile)
```
    This function returns region server name from a log file name which is in one of the following formats:
    - hdfs://<name node>/hbase/.logs/<server name>-splitting/...
    - hdfs://<name node>/hbase/.logs/<server name>/...
    返回:
    
    null if the passed in logFile isn't a valid WAL file path
  - isMetaFile
```
public static boolean isMetaFile(org.apache.hadoop.fs.Path p)
```
  - isMetaFile
```
public static boolean isMetaFile(String p)
```
  - isArchivedLogFile
```
public static boolean isArchivedLogFile(org.apache.hadoop.fs.Path p)
```
  - getArchivedLogPath
```
public static org.apache.hadoop.fs.Path getArchivedLogPath(org.apache.hadoop.fs.Path path,
                                                           org.apache.hadoop.conf.Configuration conf)
                                                    throws IOException
```
    Get the archived WAL file path
    
    参数:
    
    path - - active WAL file path
    
    conf - - configuration
    
    返回:
    
    archived path if exists, path - otherwise
    
    抛出:
    
    IOException - exception
  - openReader
```
public static WAL.Reader openReader(org.apache.hadoop.fs.Path path,
                                    org.apache.hadoop.conf.Configuration conf)
                             throws IOException
```
    Opens WAL reader with retries and additional exception handling
    
    参数:
    
    path - path to WAL file
    
    conf - configuration
    
    返回:
    
    WAL Reader instance
    
    抛出:
    
    IOException
  - addWALActionsListener
```
public void addWALActionsListener(WALActionsListener listener)
```
    从接口复制的说明: WALProvider
    
    Add a WALActionsListener.
    Notice that you must call this method before calling WALProvider.getWAL(RegionInfo) as this method will not effect the WAL which has already been created. And as long as we can only it when initialization, it is not thread safe.
    
    指定者:
    
    addWALActionsListener 在接口中 WALProvider
  - getWALPrefixFromWALName
```
public static String getWALPrefixFromWALName(String name)
```
    Get prefix of the log from its name, assuming WAL name in format of log_prefix.filenumber.log_suffix
    
    参数:
    
    name - Name of the WAL to parse
    
    返回:
    
    prefix of the log
    
    另请参阅:
    
    AbstractFSWAL.getCurrentFileName()

类 AbstractFSWALProvider<T extends AbstractFSWAL<?>>

嵌套类概要

从接口继承的嵌套类/接口 org.apache.hadoop.hbase.wal.WALProvider

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.hadoop.hbase.wal.WALProvider

字段详细资料

SEPARATE_OLDLOGDIR

DEFAULT_SEPARATE_OLDLOGDIR

wal

factory

conf

listeners

providerId

initialized

logPrefix

WAL_FILE_NAME_DELIMITER

META_WAL_PROVIDER_ID

SPLITTING_EXT

构造器详细资料

AbstractFSWALProvider

方法详细资料

init

getWALs

getWAL

createWAL

doInit

shutdown

close

getNumLogFiles

getLogFileSize

getNumRolledLogFiles

getLogFileSize

getCurrentFileName

extractFileNumFromWAL

validateWALFilename

getWALDirectoryName

getWALArchiveDirectoryName

getServerNameFromWALDirectoryName

getServerNameFromWALDirectoryName

isMetaFile

isMetaFile

isArchivedLogFile

getArchivedLogPath

openReader

addWALActionsListener

getWALPrefixFromWALName