BaseConfiguration (Graylog 2.4.3 API)

java.lang.Object
- org.graylog2.plugin.BaseConfiguration

Direct Known Subclasses:: Configuration

public abstract class BaseConfiguration
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`GRAYLOG_DEFAULT_PORT`
`protected static int`	`GRAYLOG_DEFAULT_WEB_PORT`
`protected int`	`shutdownTimeout`
`protected static String`	`WILDCARD_IP_ADDRESS`

Constructor Summary

Constructors
Constructor and Description

BaseConfiguration()

Constructors
Constructor and Description
`BaseConfiguration()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAsyncEventbusProcessors()`
`protected URI`	`getDefaultRestTransportUri()`
`com.github.joschi.jadconfig.util.Duration`	`getHttpConnectTimeout()`
`URI`	`getHttpProxyUri()`
`com.github.joschi.jadconfig.util.Duration`	`getHttpReadTimeout()`
`com.github.joschi.jadconfig.util.Duration`	`getHttpWriteTimeout()`
`int`	`getInputbufferProcessors()`
`int`	`getInputBufferRingSize()`
`com.lmax.disruptor.WaitStrategy`	`getInputBufferWaitStrategy()`
`String`	`getInstallationSource()`
`abstract String`	`getNodeIdFile()`
`String`	`getPluginDir()`
`int`	`getProcessBufferProcessors()`
`com.lmax.disruptor.WaitStrategy`	`getProcessorWaitStrategy()`
`abstract URI`	`getRestListenUri()`
`int`	`getRestMaxHeaderSize()`
`int`	`getRestSelectorRunnersCount()`
`int`	`getRestThreadPoolSize()`
`Path`	`getRestTlsCertFile()`
`Path`	`getRestTlsKeyFile()`
`String`	`getRestTlsKeyPassword()`
`URI`	`getRestTransportUri()`
`String`	`getRestUriScheme()`
`int`	`getRingSize()`
`int`	`getShutdownTimeout()`
`int`	`getUdpRecvBufferSizes()`
`String`	`getUriScheme(boolean enableTls)`
`URI`	`getWebEndpointUri()`
`abstract URI`	`getWebListenUri()`
`int`	`getWebMaxHeaderSize()`
`String`	`getWebPrefix()`
`int`	`getWebSelectorRunnersCount()`
`int`	`getWebThreadPoolSize()`
`Path`	`getWebTlsCertFile()`
`Path`	`getWebTlsKeyFile()`
`String`	`getWebTlsKeyPassword()`
`String`	`getWebUriScheme()`
`boolean`	`isDisableSigar()`
`boolean`	`isMessageJournalEnabled()`
`boolean`	`isMessageRecordingsEnabled()`
`boolean`	`isRestAndWebOnSamePort()`
`boolean`	`isRestEnableCors()`
`boolean`	`isRestEnableGzip()`
`boolean`	`isRestEnableTls()`
`boolean`	`isWebEnable()`
`boolean`	`isWebEnableCors()`
`boolean`	`isWebEnableGzip()`
`boolean`	`isWebEnableTls()`
`void`	`setMessageJournalEnabled(boolean messageJournalEnabled)`
`void`	`setRestTransportUri(URI restTransportUri)`
`void`	`validateRestAndWebListenConfigConflict()`
`void`	`validateRestTlsConfig()`
`void`	`validateWebAndRestHaveSameProtocolIfOnSamePort()`
`void`	`validateWebTlsConfig()`

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

Field Detail

WILDCARD_IP_ADDRESS

protected static final String WILDCARD_IP_ADDRESS

See Also:: Constant Field Values

GRAYLOG_DEFAULT_PORT
```
protected static final int GRAYLOG_DEFAULT_PORT
```
See Also:

Constant Field Values

GRAYLOG_DEFAULT_WEB_PORT
```
protected static final int GRAYLOG_DEFAULT_WEB_PORT
```
See Also:

Constant Field Values

shutdownTimeout

@Parameter(value="shutdown_timeout",
           validator=com.github.joschi.jadconfig.validators.PositiveIntegerValidator.class)
protected int shutdownTimeout

Constructor Detail
- BaseConfiguration
```
public BaseConfiguration()
```

Method Detail

getRestUriScheme
```
public String getRestUriScheme()
```

getWebUriScheme
```
public String getWebUriScheme()
```

getUriScheme

public String getUriScheme(boolean enableTls)

getRestTransportUri
```
public URI getRestTransportUri()
```

setRestTransportUri

public void setRestTransportUri(URI restTransportUri)

getDefaultRestTransportUri

protected URI getDefaultRestTransportUri()

getProcessBufferProcessors

public int getProcessBufferProcessors()

getProcessorWaitStrategy

public com.lmax.disruptor.WaitStrategy getProcessorWaitStrategy()

getRingSize
```
public int getRingSize()
```

getInputBufferRingSize
```
public int getInputBufferRingSize()
```

getInputBufferWaitStrategy

public com.lmax.disruptor.WaitStrategy getInputBufferWaitStrategy()

isRestEnableCors
```
public boolean isRestEnableCors()
```

isRestEnableGzip
```
public boolean isRestEnableGzip()
```

getRestMaxHeaderSize
```
public int getRestMaxHeaderSize()
```

getRestThreadPoolSize
```
public int getRestThreadPoolSize()
```

getRestSelectorRunnersCount

public int getRestSelectorRunnersCount()

isRestEnableTls
```
public boolean isRestEnableTls()
```

getRestTlsCertFile
```
public Path getRestTlsCertFile()
```

getRestTlsKeyFile
```
public Path getRestTlsKeyFile()
```

getRestTlsKeyPassword
```
public String getRestTlsKeyPassword()
```

getPluginDir
```
public String getPluginDir()
```

getAsyncEventbusProcessors

public int getAsyncEventbusProcessors()

getNodeIdFile

public abstract String getNodeIdFile()

getRestListenUri

public abstract URI getRestListenUri()

getWebListenUri
```
public abstract URI getWebListenUri()
```

isMessageJournalEnabled

public boolean isMessageJournalEnabled()

setMessageJournalEnabled

public void setMessageJournalEnabled(boolean messageJournalEnabled)

getInputbufferProcessors
```
public int getInputbufferProcessors()
```

getShutdownTimeout
```
public int getShutdownTimeout()
```

getUdpRecvBufferSizes
```
public int getUdpRecvBufferSizes()
```

isMessageRecordingsEnabled

public boolean isMessageRecordingsEnabled()

isDisableSigar
```
public boolean isDisableSigar()
```

getHttpProxyUri
```
public URI getHttpProxyUri()
```

getHttpConnectTimeout

public com.github.joschi.jadconfig.util.Duration getHttpConnectTimeout()

getHttpWriteTimeout

public com.github.joschi.jadconfig.util.Duration getHttpWriteTimeout()

getHttpReadTimeout

public com.github.joschi.jadconfig.util.Duration getHttpReadTimeout()

getInstallationSource
```
public String getInstallationSource()
```

isWebEnable
```
public boolean isWebEnable()
```

isRestAndWebOnSamePort

public boolean isRestAndWebOnSamePort()

isWebEnableCors
```
public boolean isWebEnableCors()
```

isWebEnableGzip
```
public boolean isWebEnableGzip()
```

getWebMaxHeaderSize
```
public int getWebMaxHeaderSize()
```

isWebEnableTls
```
public boolean isWebEnableTls()
```

getWebThreadPoolSize
```
public int getWebThreadPoolSize()
```

getWebSelectorRunnersCount

public int getWebSelectorRunnersCount()

getWebTlsCertFile
```
public Path getWebTlsCertFile()
```

getWebTlsKeyFile
```
public Path getWebTlsKeyFile()
```

getWebTlsKeyPassword
```
public String getWebTlsKeyPassword()
```

getWebEndpointUri
```
public URI getWebEndpointUri()
```

getWebPrefix
```
public String getWebPrefix()
```

validateRestTlsConfig

@ValidatorMethod
public void validateRestTlsConfig()
                                            throws com.github.joschi.jadconfig.ValidationException

Throws:: com.github.joschi.jadconfig.ValidationException

validateWebTlsConfig

@ValidatorMethod
public void validateWebTlsConfig()
                                           throws com.github.joschi.jadconfig.ValidationException

Throws:: com.github.joschi.jadconfig.ValidationException

validateRestAndWebListenConfigConflict

@ValidatorMethod
public void validateRestAndWebListenConfigConflict()
                                                             throws com.github.joschi.jadconfig.ValidationException

Throws:: com.github.joschi.jadconfig.ValidationException

validateWebAndRestHaveSameProtocolIfOnSamePort

@ValidatorMethod
public void validateWebAndRestHaveSameProtocolIfOnSamePort()
                                                                     throws com.github.joschi.jadconfig.ValidationException

Throws:: com.github.joschi.jadconfig.ValidationException

Class BaseConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WILDCARD_IP_ADDRESS

GRAYLOG_DEFAULT_PORT

GRAYLOG_DEFAULT_WEB_PORT

shutdownTimeout

Constructor Detail

BaseConfiguration

Method Detail

getRestUriScheme

getWebUriScheme

getUriScheme

getRestTransportUri

setRestTransportUri

getDefaultRestTransportUri

getProcessBufferProcessors

getProcessorWaitStrategy

getRingSize

getInputBufferRingSize

getInputBufferWaitStrategy

isRestEnableCors

isRestEnableGzip

getRestMaxHeaderSize

getRestThreadPoolSize

getRestSelectorRunnersCount

isRestEnableTls

getRestTlsCertFile

getRestTlsKeyFile

getRestTlsKeyPassword

getPluginDir

getAsyncEventbusProcessors

getNodeIdFile

getRestListenUri

getWebListenUri

isMessageJournalEnabled

setMessageJournalEnabled

getInputbufferProcessors

getShutdownTimeout

getUdpRecvBufferSizes

isMessageRecordingsEnabled

isDisableSigar

getHttpProxyUri

getHttpConnectTimeout

getHttpWriteTimeout

getHttpReadTimeout

getInstallationSource

isWebEnable

isRestAndWebOnSamePort

isWebEnableCors

isWebEnableGzip

getWebMaxHeaderSize

isWebEnableTls

getWebThreadPoolSize

getWebSelectorRunnersCount

getWebTlsCertFile

getWebTlsKeyFile

getWebTlsKeyPassword

getWebEndpointUri

getWebPrefix

validateRestTlsConfig

validateWebTlsConfig

validateRestAndWebListenConfigConflict

validateWebAndRestHaveSameProtocolIfOnSamePort