com.alibaba.csp.sentinel.datasource

Class FileRefreshableDataSource<T>

java.lang.Object

com.alibaba.csp.sentinel.datasource.AbstractDataSource<S,T>

com.alibaba.csp.sentinel.datasource.AutoRefreshDataSource<String,T>

com.alibaba.csp.sentinel.datasource.FileRefreshableDataSource<T>

All Implemented Interfaces:

DataSource<String,T>

public class FileRefreshableDataSource<T>
extends AutoRefreshDataSource<String,T>

A DataSource based on file. This class will automatically fetches the backend file every 3 seconds.

Limitations: default read buffer size is 1MB, if file size is greater than buffer size, exceeding bytes will be ignored. Default charset is UTF8.

Author:

Carpenter Lee

Field Summary

Fields inherited from class com.alibaba.csp.sentinel.datasource.AutoRefreshDataSource

recommendRefreshMs

Fields inherited from class com.alibaba.csp.sentinel.datasource.AbstractDataSource

parser, property

Constructor Summary

Constructors

Constructor and Description
FileRefreshableDataSource(File file, ConfigParser<String,T> configParser) Create a file based DataSource whose read buffer size is 1MB, charset is UTF8, and read interval is 3 seconds.
FileRefreshableDataSource(File file, ConfigParser<String,T> configParser, Charset charset)
FileRefreshableDataSource(File file, ConfigParser<String,T> configParser, int bufSize)
FileRefreshableDataSource(File file, ConfigParser<String,T> configParser, long recommendRefreshMs, int bufSize, Charset charset)
FileRefreshableDataSource(String fileName, ConfigParser<String,T> configParser)

Method Summary

Modifier and Type	Method and Description
void	close() Close the data source.
String	readSource() Read original data from the data source.
void	writeDataSource(T values) Write the values to the data source.

Methods inherited from class com.alibaba.csp.sentinel.datasource.AbstractDataSource

getProperty, loadConfig, loadConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

FileRefreshableDataSource

public FileRefreshableDataSource(File file,
                                 ConfigParser<String,T> configParser)
                          throws FileNotFoundException

Create a file based DataSource whose read buffer size is 1MB, charset is UTF8, and read interval is 3 seconds.

Parameters:

file - the file to read.

configParser - the config parser.

Throws:

FileNotFoundException

FileRefreshableDataSource

public FileRefreshableDataSource(String fileName,
                                 ConfigParser<String,T> configParser)
                          throws FileNotFoundException

Throws:

FileNotFoundException

FileRefreshableDataSource

public FileRefreshableDataSource(File file,
                                 ConfigParser<String,T> configParser,
                                 int bufSize)
                          throws FileNotFoundException

Throws:

FileNotFoundException

FileRefreshableDataSource

public FileRefreshableDataSource(File file,
                                 ConfigParser<String,T> configParser,
                                 Charset charset)
                          throws FileNotFoundException

Throws:

FileNotFoundException

FileRefreshableDataSource

public FileRefreshableDataSource(File file,
                                 ConfigParser<String,T> configParser,
                                 long recommendRefreshMs,
                                 int bufSize,
                                 Charset charset)
                          throws FileNotFoundException

Throws:

FileNotFoundException

Method Detail

readSource

public String readSource()
                  throws Exception

Description copied from interface: DataSource

Read original data from the data source.

Returns:

the original data.

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: DataSource

Close the data source.

Specified by:

close in interface DataSource<String,T>

Overrides:

close in class AutoRefreshDataSource<String,T>

Throws:

Exception

writeDataSource

public void writeDataSource(T values)
                     throws Exception

Description copied from interface: DataSource

Write the values to the data source.

Specified by:

writeDataSource in interface DataSource<String,T>

Overrides:

writeDataSource in class AbstractDataSource<String,T>

Throws:

Exception