com.jn.langx.text.grok

类 GrokCompiler

java.lang.Object

com.jn.langx.lifecycle.AbstractInitializable

com.jn.langx.lifecycle.AbstractLifecycle

com.jn.langx.text.grok.GrokCompiler

所有已实现的接口:

Initializable, Lifecycle, Named

public class GrokCompiler
extends AbstractLifecycle

从以下版本开始:

4.7.2

字段概要

从类继承的字段 com.jn.langx.lifecycle.AbstractInitializable

inited

构造器概要

构造器

构造器和说明
GrokCompiler()

方法概要

限定符和类型	方法和说明
GrokTemplate	compile(String pattern) Compiles a given Grok pattern and returns a Grok object which can parse the pattern.
GrokTemplate	compile(String pattern, boolean namedOnly)
GrokTemplate	compile(String pattern, String timeZoneId, boolean namedOnly) Compiles a given Grok pattern and returns a Grok object which can parse the pattern.
protected void	doStart() Subclasses must implement this method with the start behavior.
protected void	doStop() Subclasses must implement this method with the stop behavior.
Map<String,PatternDefinition>	getPatternDefinitions()
void	init()
void	register(InputStream input) Registers multiple pattern definitions from a given inputStream, and decoded as a UTF-8 source.
void	register(InputStream input, Charset charset) Registers multiple pattern definitions from a given inputStream.
void	register(Map<String,String> patternDefinitions) Registers multiple pattern definitions.
void	register(Reader input) Registers multiple pattern definitions from a given Reader.
void	register(String name, String pattern) Registers a new pattern definition.
void	registerDefaultPatterns()
void	registerPatternFromClasspath(String path)
void	registerPatternFromClasspath(String path, Charset charset)
void	setDefinitionRepository(PatternDefinitionRepository definitionRepository)

从类继承的方法 com.jn.langx.lifecycle.AbstractLifecycle

getName, isRunning, setName, shutdown, startup, stopAndExecute, toString

从类继承的方法 com.jn.langx.lifecycle.AbstractInitializable

doInit

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

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

构造器详细资料

GrokCompiler

public GrokCompiler()

方法详细资料

setDefinitionRepository

public void setDefinitionRepository(PatternDefinitionRepository definitionRepository)

getPatternDefinitions

public Map<String,PatternDefinition> getPatternDefinitions()

init

public void init()
          throws InitializationException

指定者:

init 在接口中 Initializable

覆盖:

init 在类中 AbstractInitializable

抛出:

InitializationException

doStart

protected void doStart()

从类复制的说明: AbstractLifecycle

Subclasses must implement this method with the start behavior. This method will be invoked while holding the AbstractLifecycle.lifecycleLock.

覆盖:

doStart 在类中 AbstractLifecycle

doStop

protected void doStop()

从类复制的说明: AbstractLifecycle

Subclasses must implement this method with the stop behavior. This method will be invoked while holding the AbstractLifecycle.lifecycleLock.

覆盖:

doStop 在类中 AbstractLifecycle

register

public void register(String name,
                     String pattern)

Registers a new pattern definition.

参数:

name - : Pattern Name

pattern - : Regular expression Or Grok pattern

抛出:

GrokException - runtime expt

register

public void register(Map<String,String> patternDefinitions)

Registers multiple pattern definitions.

registerDefaultPatterns

public void registerDefaultPatterns()

registerPatternFromClasspath

public void registerPatternFromClasspath(String path)
                                  throws GrokException

抛出:

GrokException

registerPatternFromClasspath

public void registerPatternFromClasspath(String path,
                                         Charset charset)
                                  throws GrokException

抛出:

GrokException

register

public void register(InputStream input)
              throws IOException

Registers multiple pattern definitions from a given inputStream, and decoded as a UTF-8 source.

抛出:

IOException

register

public void register(InputStream input,
                     Charset charset)
              throws IOException

Registers multiple pattern definitions from a given inputStream.

抛出:

IOException

register

public void register(Reader input)
              throws IOException

Registers multiple pattern definitions from a given Reader.

抛出:

IOException

compile

public GrokTemplate compile(String pattern)
                     throws IllegalArgumentException

Compiles a given Grok pattern and returns a Grok object which can parse the pattern.

抛出:

IllegalArgumentException

compile

public GrokTemplate compile(String pattern,
                            boolean namedOnly)
                     throws IllegalArgumentException

抛出:

IllegalArgumentException

compile

public GrokTemplate compile(String pattern,
                            String timeZoneId,
                            boolean namedOnly)
                     throws IllegalArgumentException

Compiles a given Grok pattern and returns a Grok object which can parse the pattern.

参数:

pattern - : Grok pattern (ex: %{IP})

timeZoneId - : time zone used to parse a timestamp when it doesn't contain the time zone

namedOnly - : Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP})

返回:

a compiled pattern

抛出:

IllegalArgumentException - when pattern definition is invalid