DefaultSentryClientFactory (Sentry-Java client 1.7.10 API)

java.lang.Object
- io.sentry.SentryClientFactory
- - io.sentry.DefaultSentryClientFactory

```
public class DefaultSentryClientFactory
extends SentryClientFactory
```
Default implementation of SentryClientFactory.
In most cases this is the implementation to use or extend for additional features.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class DefaultSentryClientFactory.DaemonThreadFactory
Thread factory generating daemon threads with a custom priority.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`DefaultSentryClientFactory.DaemonThreadFactory` Thread factory generating daemon threads with a custom priority.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ASYNC_GRACEFUL_SHUTDOWN_OPTION` Option to disable the graceful shutdown of the async connection.
`static String`	`ASYNC_OPTION` Option for whether to send events asynchronously.
`static String`	`ASYNC_PRIORITY_OPTION` Option for the priority of threads used for the async connection.
`static String`	`ASYNC_QUEUE_DISCARDNEW` Async executor overflow behavior that will discard the new event that was attempting to be sent.
`static String`	`ASYNC_QUEUE_DISCARDOLD` Async executor overflow behavior that will discard old events in the queue.
`static String`	`ASYNC_QUEUE_OVERFLOW_DEFAULT` Default behavior to use when the async executor queue is full.
`static String`	`ASYNC_QUEUE_OVERFLOW_OPTION` Option for what to do when the async executor queue is full.
`static String`	`ASYNC_QUEUE_SIZE_OPTION` Option for the maximum size of the async send queue.
`static String`	`ASYNC_QUEUE_SYNC` Async executor overflow behavior that will cause a synchronous send to occur on the current thread.
`static long`	`ASYNC_SHUTDOWN_TIMEOUT_DEFAULT` Default timeout of the `AsyncConnection` executor, in milliseconds.
`static String`	`ASYNC_SHUTDOWN_TIMEOUT_OPTION` Option for the graceful shutdown timeout of the async executor, in milliseconds.
`static String`	`ASYNC_THREADS_OPTION` Option for the number of threads used for the async connection.
`static String`	`BUFFER_DIR_OPTION` Option to buffer events to disk when network is down.
`static boolean`	`BUFFER_ENABLED_DEFAULT` Default value for whether buffering is enabled (if a directory is also provided).
`static String`	`BUFFER_ENABLED_OPTION` Option to enable or disable Event buffering.
`static long`	`BUFFER_FLUSHTIME_DEFAULT` Default number of milliseconds between attempts to flush buffered events.
`static String`	`BUFFER_FLUSHTIME_OPTION` Option for how long to wait between attempts to flush the disk buffer, in milliseconds.
`static String`	`BUFFER_GRACEFUL_SHUTDOWN_OPTION` Option to disable the graceful shutdown of the buffer flusher.
`static long`	`BUFFER_SHUTDOWN_TIMEOUT_DEFAULT` Default timeout of the `BufferedConnection` shutdown, in milliseconds.
`static String`	`BUFFER_SHUTDOWN_TIMEOUT_OPTION` Option for the graceful shutdown timeout of the buffer flushing executor, in milliseconds.
`static int`	`BUFFER_SIZE_DEFAULT` Default number of events to cache offline when network is down or project is throttled.
`static String`	`BUFFER_SIZE_OPTION` Option for maximum number of events to cache offline when network is down.
`static String`	`COMPRESSION_OPTION` Option for whether to compress requests sent to the Sentry Server.
`static String`	`DIST_OPTION` Option to set the distribution of the application.
`static String`	`ENVIRONMENT_OPTION` Option to set the environment of the application.
`static String`	`EXTRA_OPTION` Option to set extra data to be sent to Sentry.
`static String`	`EXTRATAGS_OPTION` Deprecated. prefer `MDCTAGS_OPTION`
`static String`	`HIDE_COMMON_FRAMES_OPTION` Option for whether to hide common stackframes with enclosing exceptions.
`static String`	`HTTP_PROXY_HOST_OPTION` Option to set an HTTP proxy hostname for Sentry connections.
`static String`	`HTTP_PROXY_PASS_OPTION` Option to set an HTTP proxy password for Sentry connections.
`static int`	`HTTP_PROXY_PORT_DEFAULT` The default HTTP proxy port to use if an HTTP Proxy hostname is set but port is not.
`static String`	`HTTP_PROXY_PORT_OPTION` Option to set an HTTP proxy port for Sentry connections.
`static String`	`HTTP_PROXY_USER_OPTION` Option to set an HTTP proxy username for Sentry connections.
`static String`	`IN_APP_FRAMES_OPTION` Option for which package prefixes are part of the user's application code, as a single comma separated string.
`static String`	`MAX_MESSAGE_LENGTH_OPTION` Option to set the maximum length of the message body in the requests to the Sentry Server.
`static String`	`MDCTAGS_OPTION` Option to set tags that are extracted from the MDC system, where applicable.
`static String`	`NAIVE_PROTOCOL` Protocol setting to disable security checks over an SSL connection.
`static int`	`QUEUE_SIZE_DEFAULT` The default async queue size if none is provided.
`static String`	`RELEASE_OPTION` Option to set the version of the application.
`static String`	`SAMPLE_RATE_OPTION` Option for whether to sample events, allowing from 0.0 to 1.0 (0 to 100%) to be sent to the server.
`static String`	`SERVERNAME_OPTION` Option to set the server name.
`static String`	`TAGS_OPTION` Option to set additional tags to be sent to Sentry.
`static int`	`TIMEOUT_DEFAULT` Default timeout of an HTTP connection to Sentry.
`static String`	`TIMEOUT_OPTION` Option to set a timeout for requests to the Sentry server, in milliseconds.
`static String`	`UNCAUGHT_HANDLER_ENABLED_OPTION` Option for whether to enable an uncaught exception handler, defaults to 'true'.

Constructor Summary

Constructors
Constructor and Description

DefaultSentryClientFactory()

Constructors
Constructor and Description
`DefaultSentryClientFactory()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected SentryClient`	`configureSentryClient(SentryClient sentryClient, Dsn dsn)` Configures a `SentryClient` instance after it has been constructed.
`protected Connection`	`createAsyncConnection(Dsn dsn, Connection connection)` Encapsulates an already existing connection in an `AsyncConnection` and get the async options from the Sentry DSN.
`protected Connection`	`createConnection(Dsn dsn)` Creates a connection to the given DSN by determining the protocol.
`protected Connection`	`createHttpConnection(Dsn dsn)` Creates an HTTP connection to the Sentry server.
`protected JsonMarshaller`	`createJsonMarshaller(int maxMessageLength)` Create a `JsonMarshaller`.
`protected Marshaller`	`createMarshaller(Dsn dsn)` Creates a JSON marshaller that will convert every `Event` in a format handled by the Sentry server.
`SentryClient`	`createSentryClient(Dsn dsn)` Creates an instance of Sentry given a DSN.
`protected Connection`	`createStdOutConnection(Dsn dsn)` Uses stdout to send the logs.
`protected boolean`	`getAsyncEnabled(Dsn dsn)` Whether or not to wrap the underlying connection in an `AsyncConnection`.
`protected boolean`	`getAsyncGracefulShutdownEnabled(Dsn dsn)` Whether or not to attempt the graceful shutdown of the `AsyncConnection` upon close.
`protected int`	`getAsyncPriority(Dsn dsn)` Priority of threads used for the async connection.
`protected int`	`getAsyncQueueSize(Dsn dsn)` Maximum size of the async send queue.
`protected long`	`getAsyncShutdownTimeout(Dsn dsn)` The graceful shutdown timeout of the async executor, in milliseconds.
`protected int`	`getAsyncThreads(Dsn dsn)` The number of threads used for the async connection.
`protected Buffer`	`getBuffer(Dsn dsn)` Get the `Buffer` where events are stored when network is down.
`protected boolean`	`getBufferedConnectionGracefulShutdownEnabled(Dsn dsn)` Whether or not to attempt a graceful shutdown of the `BufferedConnection` upon close.
`protected long`	`getBufferedConnectionShutdownTimeout(Dsn dsn)` Maximum time to wait for `BufferedConnection` shutdown when closed, in milliseconds.
`protected boolean`	`getBufferEnabled(Dsn dsn)` Whether or not buffering is enabled.
`protected long`	`getBufferFlushtime(Dsn dsn)` How long to wait between attempts to flush the disk buffer, in milliseconds.
`protected int`	`getBufferSize(Dsn dsn)` Get the maximum number of events to cache offline when network is down.
`protected boolean`	`getBypassSecurityEnabled(Dsn dsn)` Whether to disable security checks over an SSL connection.
`protected boolean`	`getCompressionEnabled(Dsn dsn)` Whether to compress requests sent to the Sentry Server.
`protected ContextManager`	`getContextManager(Dsn dsn)` Returns the `ContextManager` to use for locating and storing data that is context specific, such as `Breadcrumb`s.
`protected String`	`getDist(Dsn dsn)` Application distribution to send with `Event`s that don't already have a value for the field set.
`protected String`	`getEnvironment(Dsn dsn)` Application environmentribution to send with `Event`s that don't already have a value for the field set.
`protected Map<String,String>`	`getExtra(Dsn dsn)` Extra data to send with `Event`s.
`protected Set<String>`	`getExtraTags(Dsn dsn)` Deprecated. prefer `getMdcTags(Dsn)`
`protected boolean`	`getHideCommonFramesEnabled(Dsn dsn)` Whether to hide common stackframes with enclosing exceptions.
`protected Collection<String>`	`getInAppFrames(Dsn dsn)` Returns the list of package names to consider "in-app".
`protected int`	`getMaxMessageLength(Dsn dsn)` The maximum length of the message body in the requests to the Sentry Server.
`protected Set<String>`	`getMdcTags(Dsn dsn)` Tags to extract from the MDC system and set on `Event`s, where applicable.
`protected String`	`getProxyHost(Dsn dsn)` HTTP proxy hostname for Sentry connections.
`protected String`	`getProxyPass(Dsn dsn)` HTTP proxy password for Sentry connections.
`protected int`	`getProxyPort(Dsn dsn)` HTTP proxy port for Sentry connections.
`protected String`	`getProxyUser(Dsn dsn)` HTTP proxy username for Sentry connections.
`protected RejectedExecutionHandler`	`getRejectedExecutionHandler(Dsn dsn)` Handler for tasks that cannot be immediately queued by a `ThreadPoolExecutor`.
`protected String`	`getRelease(Dsn dsn)` Application version to send with `Event`s that don't already have a value for the field set.
`protected Double`	`getSampleRate(Dsn dsn)` Whether to sample events, and if so how much to allow through to the server (from 0.0 to 1.0).
`protected String`	`getServerName(Dsn dsn)` Server name to send with `Event`s that don't already have a value for the field set.
`protected Map<String,String>`	`getTags(Dsn dsn)` Additional tags to send with `Event`s.
`protected int`	`getTimeout(Dsn dsn)` Timeout for requests to the Sentry server, in milliseconds.
`protected boolean`	`getUncaughtHandlerEnabled(Dsn dsn)` Whether or not to enable a `SentryUncaughtExceptionHandler`.

Methods inherited from class io.sentry.SentryClientFactory
sentryClient, sentryClient, sentryClient, toString

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

- Field Detail
  - NAIVE_PROTOCOL
```
public static final String NAIVE_PROTOCOL
```
    Protocol setting to disable security checks over an SSL connection.
    
    See Also:
    Constant Field Values
  - COMPRESSION_OPTION
```
public static final String COMPRESSION_OPTION
```
    Option for whether to compress requests sent to the Sentry Server.
    
    See Also:
    Constant Field Values
  - MAX_MESSAGE_LENGTH_OPTION
```
public static final String MAX_MESSAGE_LENGTH_OPTION
```
    Option to set the maximum length of the message body in the requests to the Sentry Server.
    
    See Also:
    Constant Field Values
  - TIMEOUT_OPTION
```
public static final String TIMEOUT_OPTION
```
    Option to set a timeout for requests to the Sentry server, in milliseconds.
    
    See Also:
    Constant Field Values
  - TIMEOUT_DEFAULT
```
public static final int TIMEOUT_DEFAULT
```
    Default timeout of an HTTP connection to Sentry.
  - BUFFER_ENABLED_OPTION
```
public static final String BUFFER_ENABLED_OPTION
```
    Option to enable or disable Event buffering. A buffering directory is also required. This setting is mostly useful on Android where a buffering directory is set by default.
    
    See Also:
    Constant Field Values
  - BUFFER_ENABLED_DEFAULT
```
public static final boolean BUFFER_ENABLED_DEFAULT
```
    Default value for whether buffering is enabled (if a directory is also provided).
    
    See Also:
    Constant Field Values
  - BUFFER_DIR_OPTION
```
public static final String BUFFER_DIR_OPTION
```
    Option to buffer events to disk when network is down.
    
    See Also:
    Constant Field Values
  - BUFFER_SIZE_OPTION
```
public static final String BUFFER_SIZE_OPTION
```
    Option for maximum number of events to cache offline when network is down.
    
    See Also:
    Constant Field Values
  - BUFFER_SIZE_DEFAULT
```
public static final int BUFFER_SIZE_DEFAULT
```
    Default number of events to cache offline when network is down or project is throttled.
    
    See Also:
    Constant Field Values
  - BUFFER_FLUSHTIME_OPTION
```
public static final String BUFFER_FLUSHTIME_OPTION
```
    Option for how long to wait between attempts to flush the disk buffer, in milliseconds.
    
    See Also:
    Constant Field Values
  - BUFFER_FLUSHTIME_DEFAULT
```
public static final long BUFFER_FLUSHTIME_DEFAULT
```
    Default number of milliseconds between attempts to flush buffered events.
    
    See Also:
    Constant Field Values
  - BUFFER_GRACEFUL_SHUTDOWN_OPTION
```
public static final String BUFFER_GRACEFUL_SHUTDOWN_OPTION
```
    Option to disable the graceful shutdown of the buffer flusher.
    
    See Also:
    Constant Field Values
  - BUFFER_SHUTDOWN_TIMEOUT_OPTION
```
public static final String BUFFER_SHUTDOWN_TIMEOUT_OPTION
```
    Option for the graceful shutdown timeout of the buffer flushing executor, in milliseconds.
    
    See Also:
    Constant Field Values
  - BUFFER_SHUTDOWN_TIMEOUT_DEFAULT
```
public static final long BUFFER_SHUTDOWN_TIMEOUT_DEFAULT
```
    Default timeout of the BufferedConnection shutdown, in milliseconds.
  - ASYNC_OPTION
```
public static final String ASYNC_OPTION
```
    Option for whether to send events asynchronously.
    
    See Also:
    Constant Field Values
  - ASYNC_GRACEFUL_SHUTDOWN_OPTION
```
public static final String ASYNC_GRACEFUL_SHUTDOWN_OPTION
```
    Option to disable the graceful shutdown of the async connection.
    
    See Also:
    Constant Field Values
  - ASYNC_THREADS_OPTION
```
public static final String ASYNC_THREADS_OPTION
```
    Option for the number of threads used for the async connection.
    
    See Also:
    Constant Field Values
  - ASYNC_PRIORITY_OPTION
```
public static final String ASYNC_PRIORITY_OPTION
```
    Option for the priority of threads used for the async connection.
    
    See Also:
    Constant Field Values
  - ASYNC_QUEUE_SIZE_OPTION
```
public static final String ASYNC_QUEUE_SIZE_OPTION
```
    Option for the maximum size of the async send queue.
    
    See Also:
    Constant Field Values
  - ASYNC_QUEUE_OVERFLOW_OPTION
```
public static final String ASYNC_QUEUE_OVERFLOW_OPTION
```
    Option for what to do when the async executor queue is full.
    
    See Also:
    Constant Field Values
  - ASYNC_QUEUE_DISCARDOLD
```
public static final String ASYNC_QUEUE_DISCARDOLD
```
    Async executor overflow behavior that will discard old events in the queue.
    
    See Also:
    Constant Field Values
  - ASYNC_QUEUE_DISCARDNEW
```
public static final String ASYNC_QUEUE_DISCARDNEW
```
    Async executor overflow behavior that will discard the new event that was attempting to be sent.
    
    See Also:
    Constant Field Values
  - ASYNC_QUEUE_SYNC
```
public static final String ASYNC_QUEUE_SYNC
```
    Async executor overflow behavior that will cause a synchronous send to occur on the current thread.
    
    See Also:
    Constant Field Values
  - ASYNC_QUEUE_OVERFLOW_DEFAULT
```
public static final String ASYNC_QUEUE_OVERFLOW_DEFAULT
```
    Default behavior to use when the async executor queue is full.
    
    See Also:
    Constant Field Values
  - ASYNC_SHUTDOWN_TIMEOUT_OPTION
```
public static final String ASYNC_SHUTDOWN_TIMEOUT_OPTION
```
    Option for the graceful shutdown timeout of the async executor, in milliseconds.
    
    See Also:
    Constant Field Values
  - ASYNC_SHUTDOWN_TIMEOUT_DEFAULT
```
public static final long ASYNC_SHUTDOWN_TIMEOUT_DEFAULT
```
    Default timeout of the AsyncConnection executor, in milliseconds.
  - IN_APP_FRAMES_OPTION
```
public static final String IN_APP_FRAMES_OPTION
```
    Option for which package prefixes are part of the user's application code, as a single comma separated string.
    
    See Also:
    Constant Field Values
  - HIDE_COMMON_FRAMES_OPTION
```
public static final String HIDE_COMMON_FRAMES_OPTION
```
    Option for whether to hide common stackframes with enclosing exceptions.
    
    See Also:
    Constant Field Values
  - SAMPLE_RATE_OPTION
```
public static final String SAMPLE_RATE_OPTION
```
    Option for whether to sample events, allowing from 0.0 to 1.0 (0 to 100%) to be sent to the server.
    
    See Also:
    Constant Field Values
  - HTTP_PROXY_HOST_OPTION
```
public static final String HTTP_PROXY_HOST_OPTION
```
    Option to set an HTTP proxy hostname for Sentry connections.
    
    See Also:
    Constant Field Values
  - HTTP_PROXY_PORT_OPTION
```
public static final String HTTP_PROXY_PORT_OPTION
```
    Option to set an HTTP proxy port for Sentry connections.
    
    See Also:
    Constant Field Values
  - HTTP_PROXY_USER_OPTION
```
public static final String HTTP_PROXY_USER_OPTION
```
    Option to set an HTTP proxy username for Sentry connections.
    
    See Also:
    Constant Field Values
  - HTTP_PROXY_PASS_OPTION
```
public static final String HTTP_PROXY_PASS_OPTION
```
    Option to set an HTTP proxy password for Sentry connections.
    
    See Also:
    Constant Field Values
  - QUEUE_SIZE_DEFAULT
```
public static final int QUEUE_SIZE_DEFAULT
```
    The default async queue size if none is provided.
    
    See Also:
    Constant Field Values
  - HTTP_PROXY_PORT_DEFAULT
```
public static final int HTTP_PROXY_PORT_DEFAULT
```
    The default HTTP proxy port to use if an HTTP Proxy hostname is set but port is not.
    
    See Also:
    Constant Field Values
  - RELEASE_OPTION
```
public static final String RELEASE_OPTION
```
    Option to set the version of the application.
    
    See Also:
    Constant Field Values
  - DIST_OPTION
```
public static final String DIST_OPTION
```
    Option to set the distribution of the application.
    
    See Also:
    Constant Field Values
  - ENVIRONMENT_OPTION
```
public static final String ENVIRONMENT_OPTION
```
    Option to set the environment of the application.
    
    See Also:
    Constant Field Values
  - SERVERNAME_OPTION
```
public static final String SERVERNAME_OPTION
```
    Option to set the server name.
    
    See Also:
    Constant Field Values
  - TAGS_OPTION
```
public static final String TAGS_OPTION
```
    Option to set additional tags to be sent to Sentry.
    
    See Also:
    Constant Field Values
  - EXTRATAGS_OPTION
```
@Deprecated
public static final String EXTRATAGS_OPTION
```
    Deprecated. prefer MDCTAGS_OPTION
    
    Option to set tags that are extracted from the MDC system, where applicable.
    
    See Also:
    Constant Field Values
  - MDCTAGS_OPTION
```
public static final String MDCTAGS_OPTION
```
    Option to set tags that are extracted from the MDC system, where applicable.
    
    See Also:
    Constant Field Values
  - EXTRA_OPTION
```
public static final String EXTRA_OPTION
```
    Option to set extra data to be sent to Sentry.
    
    See Also:
    Constant Field Values
  - UNCAUGHT_HANDLER_ENABLED_OPTION
```
public static final String UNCAUGHT_HANDLER_ENABLED_OPTION
```
    Option for whether to enable an uncaught exception handler, defaults to 'true'.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DefaultSentryClientFactory
```
public DefaultSentryClientFactory()
```
- Method Detail
  - createSentryClient
```
public SentryClient createSentryClient(Dsn dsn)
```
    Description copied from class: SentryClientFactory
    
    Creates an instance of Sentry given a DSN.
    
    Specified by:
    
    createSentryClient in class SentryClientFactory
    
    Parameters:
    dsn - Data Source Name of the Sentry server.
    
    Returns:
    an instance of Sentry.
  - configureSentryClient
```
protected SentryClient configureSentryClient(SentryClient sentryClient,
                                 Dsn dsn)
```
    Configures a SentryClient instance after it has been constructed.
    
    Parameters:
    sentryClient - The SentryClient to configure.
    dsn - Data Source Name of the Sentry server to use.
    
    Returns:
    The same SentryClient instance, after configuration.
  - createConnection
```
protected Connection createConnection(Dsn dsn)
```
    Creates a connection to the given DSN by determining the protocol.
    
    Parameters:
    dsn - Data Source Name of the Sentry server to use.
    
    Returns:
    a connection to the server.
  - createAsyncConnection
```
protected Connection createAsyncConnection(Dsn dsn,
                               Connection connection)
```
    Encapsulates an already existing connection in an AsyncConnection and get the async options from the Sentry DSN.
    
    Parameters:
    dsn - Data Source Name of the Sentry server.
    connection - Connection to encapsulate in an AsyncConnection.
    
    Returns:
    the asynchronous connection.
  - createHttpConnection
```
protected Connection createHttpConnection(Dsn dsn)
```
    Creates an HTTP connection to the Sentry server.
    
    Parameters:
    dsn - Data Source Name of the Sentry server.
    
    Returns:
    an HttpConnection to the server.
  - createStdOutConnection
```
protected Connection createStdOutConnection(Dsn dsn)
```
    Uses stdout to send the logs.
    
    Parameters:
    dsn - Data Source Name of the Sentry server.
    
    Returns:
    an OutputStreamConnection using System.out.
  - createMarshaller
```
protected Marshaller createMarshaller(Dsn dsn)
```
    Creates a JSON marshaller that will convert every Event in a format handled by the Sentry server.
    
    Parameters:
    dsn - Data Source Name of the Sentry server.
    
    Returns:
    a JsonMarshaller to process the events.
  - createJsonMarshaller
```
protected JsonMarshaller createJsonMarshaller(int maxMessageLength)
```
    Create a JsonMarshaller. This method makes it easier to provide a custom implementation.
    
    Parameters:
    maxMessageLength - of the whole json output
    
    Returns:
    new marshaller
  - getContextManager
```
protected ContextManager getContextManager(Dsn dsn)
```
    Returns the ContextManager to use for locating and storing data that is context specific, such as Breadcrumbs.
    Defaults to ThreadLocalContextManager.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    the ContextManager to use.
  - getInAppFrames
```
protected Collection<String> getInAppFrames(Dsn dsn)
```
    Returns the list of package names to consider "in-app".
    Those packages will be used with the StackTraceInterface to show frames that are a part of the main application in the Sentry UI by default.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    the list of package names to consider "in-app".
  - getAsyncEnabled
```
protected boolean getAsyncEnabled(Dsn dsn)
```
    Whether or not to wrap the underlying connection in an AsyncConnection.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Whether or not to wrap the underlying connection in an AsyncConnection.
  - getRejectedExecutionHandler
```
protected RejectedExecutionHandler getRejectedExecutionHandler(Dsn dsn)
```
    Handler for tasks that cannot be immediately queued by a ThreadPoolExecutor.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Handler for tasks that cannot be immediately queued by a ThreadPoolExecutor.
  - getBufferedConnectionShutdownTimeout
```
protected long getBufferedConnectionShutdownTimeout(Dsn dsn)
```
    Maximum time to wait for BufferedConnection shutdown when closed, in milliseconds.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Maximum time to wait for BufferedConnection shutdown when closed, in milliseconds.
  - getBufferedConnectionGracefulShutdownEnabled
```
protected boolean getBufferedConnectionGracefulShutdownEnabled(Dsn dsn)
```
    Whether or not to attempt a graceful shutdown of the BufferedConnection upon close.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Whether or not to attempt a graceful shutdown of the BufferedConnection upon close.
  - getBufferFlushtime
```
protected long getBufferFlushtime(Dsn dsn)
```
    How long to wait between attempts to flush the disk buffer, in milliseconds.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    ow long to wait between attempts to flush the disk buffer, in milliseconds.
  - getAsyncShutdownTimeout
```
protected long getAsyncShutdownTimeout(Dsn dsn)
```
    The graceful shutdown timeout of the async executor, in milliseconds.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    The graceful shutdown timeout of the async executor, in milliseconds.
  - getAsyncGracefulShutdownEnabled
```
protected boolean getAsyncGracefulShutdownEnabled(Dsn dsn)
```
    Whether or not to attempt the graceful shutdown of the AsyncConnection upon close.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Whether or not to attempt the graceful shutdown of the AsyncConnection upon close.
  - getAsyncQueueSize
```
protected int getAsyncQueueSize(Dsn dsn)
```
    Maximum size of the async send queue.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Maximum size of the async send queue.
  - getAsyncPriority
```
protected int getAsyncPriority(Dsn dsn)
```
    Priority of threads used for the async connection.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Priority of threads used for the async connection.
  - getAsyncThreads
```
protected int getAsyncThreads(Dsn dsn)
```
    The number of threads used for the async connection.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    The number of threads used for the async connection.
  - getBypassSecurityEnabled
```
protected boolean getBypassSecurityEnabled(Dsn dsn)
```
    Whether to disable security checks over an SSL connection.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Whether to disable security checks over an SSL connection.
  - getSampleRate
```
protected Double getSampleRate(Dsn dsn)
```
    Whether to sample events, and if so how much to allow through to the server (from 0.0 to 1.0).
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    The ratio of events to allow through to server, or null if sampling is disabled.
  - getProxyPort
```
protected int getProxyPort(Dsn dsn)
```
    HTTP proxy port for Sentry connections.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    HTTP proxy port for Sentry connections.
  - getProxyHost
```
protected String getProxyHost(Dsn dsn)
```
    HTTP proxy hostname for Sentry connections.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    HTTP proxy hostname for Sentry connections.
  - getProxyUser
```
protected String getProxyUser(Dsn dsn)
```
    HTTP proxy username for Sentry connections.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    HTTP proxy username for Sentry connections.
  - getProxyPass
```
protected String getProxyPass(Dsn dsn)
```
    HTTP proxy password for Sentry connections.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    HTTP proxy password for Sentry connections.
  - getRelease
```
protected String getRelease(Dsn dsn)
```
    Application version to send with Events that don't already have a value for the field set.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Application version to send with Events.
  - getDist
```
protected String getDist(Dsn dsn)
```
    Application distribution to send with Events that don't already have a value for the field set.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Application version to send with Events.
  - getEnvironment
```
protected String getEnvironment(Dsn dsn)
```
    Application environmentribution to send with Events that don't already have a value for the field set.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Application version to send with Events.
  - getServerName
```
protected String getServerName(Dsn dsn)
```
    Server name to send with Events that don't already have a value for the field set.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Server name to send with Events.
  - getTags
```
protected Map<String,String> getTags(Dsn dsn)
```
    Additional tags to send with Events.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Additional tags to send with Events.
  - getExtraTags
```
@Deprecated
protected Set<String> getExtraTags(Dsn dsn)
```
    Deprecated. prefer getMdcTags(Dsn)
    
    Tags to extract from the MDC system and set on Events, where applicable.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Tags to extract from the MDC system and set on Events, where applicable.
  - getMdcTags
```
protected Set<String> getMdcTags(Dsn dsn)
```
    Tags to extract from the MDC system and set on Events, where applicable.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Tags to extract from the MDC system and set on Events, where applicable.
  - getExtra
```
protected Map<String,String> getExtra(Dsn dsn)
```
    Extra data to send with Events.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Extra data to send with Events.
  - getCompressionEnabled
```
protected boolean getCompressionEnabled(Dsn dsn)
```
    Whether to compress requests sent to the Sentry Server.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Whether to compress requests sent to the Sentry Server.
  - getHideCommonFramesEnabled
```
protected boolean getHideCommonFramesEnabled(Dsn dsn)
```
    Whether to hide common stackframes with enclosing exceptions.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Whether to hide common stackframes with enclosing exceptions.
  - getMaxMessageLength
```
protected int getMaxMessageLength(Dsn dsn)
```
    The maximum length of the message body in the requests to the Sentry Server.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    The maximum length of the message body in the requests to the Sentry Server.
  - getTimeout
```
protected int getTimeout(Dsn dsn)
```
    Timeout for requests to the Sentry server, in milliseconds.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Timeout for requests to the Sentry server, in milliseconds.
  - getBufferEnabled
```
protected boolean getBufferEnabled(Dsn dsn)
```
    Whether or not buffering is enabled.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Whether or not buffering is enabled.
  - getBuffer
```
protected Buffer getBuffer(Dsn dsn)
```
    Get the Buffer where events are stored when network is down.
    
    Parameters:
    dsn - Dsn passed in by the user.
    
    Returns:
    the Buffer where events are stored when network is down.
  - getBufferSize
```
protected int getBufferSize(Dsn dsn)
```
    Get the maximum number of events to cache offline when network is down.
    
    Parameters:
    dsn - Dsn passed in by the user.
    
    Returns:
    the maximum number of events to cache offline when network is down.
  - getUncaughtHandlerEnabled
```
protected boolean getUncaughtHandlerEnabled(Dsn dsn)
```
    Whether or not to enable a SentryUncaughtExceptionHandler.
    
    Parameters:
    dsn - Sentry server DSN which may contain options.
    
    Returns:
    Whether or not to enable a SentryUncaughtExceptionHandler.

Class DefaultSentryClientFactory

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.sentry.SentryClientFactory

Methods inherited from class java.lang.Object

Field Detail

NAIVE_PROTOCOL

COMPRESSION_OPTION

MAX_MESSAGE_LENGTH_OPTION

TIMEOUT_OPTION

TIMEOUT_DEFAULT

BUFFER_ENABLED_OPTION

BUFFER_ENABLED_DEFAULT

BUFFER_DIR_OPTION

BUFFER_SIZE_OPTION

BUFFER_SIZE_DEFAULT

BUFFER_FLUSHTIME_OPTION

BUFFER_FLUSHTIME_DEFAULT

BUFFER_GRACEFUL_SHUTDOWN_OPTION

BUFFER_SHUTDOWN_TIMEOUT_OPTION

BUFFER_SHUTDOWN_TIMEOUT_DEFAULT

ASYNC_OPTION

ASYNC_GRACEFUL_SHUTDOWN_OPTION

ASYNC_THREADS_OPTION

ASYNC_PRIORITY_OPTION

ASYNC_QUEUE_SIZE_OPTION

ASYNC_QUEUE_OVERFLOW_OPTION

ASYNC_QUEUE_DISCARDOLD

ASYNC_QUEUE_DISCARDNEW

ASYNC_QUEUE_SYNC

ASYNC_QUEUE_OVERFLOW_DEFAULT

ASYNC_SHUTDOWN_TIMEOUT_OPTION

ASYNC_SHUTDOWN_TIMEOUT_DEFAULT

IN_APP_FRAMES_OPTION

HIDE_COMMON_FRAMES_OPTION

SAMPLE_RATE_OPTION

HTTP_PROXY_HOST_OPTION

HTTP_PROXY_PORT_OPTION

HTTP_PROXY_USER_OPTION

HTTP_PROXY_PASS_OPTION

QUEUE_SIZE_DEFAULT

HTTP_PROXY_PORT_DEFAULT

RELEASE_OPTION

DIST_OPTION

ENVIRONMENT_OPTION

SERVERNAME_OPTION

TAGS_OPTION

EXTRATAGS_OPTION

MDCTAGS_OPTION

EXTRA_OPTION

UNCAUGHT_HANDLER_ENABLED_OPTION

Constructor Detail

DefaultSentryClientFactory

Method Detail

createSentryClient

configureSentryClient

createConnection

createAsyncConnection

createHttpConnection

createStdOutConnection

createMarshaller

createJsonMarshaller

getContextManager

getInAppFrames

getAsyncEnabled

getRejectedExecutionHandler

getBufferedConnectionShutdownTimeout

getBufferedConnectionGracefulShutdownEnabled

getBufferFlushtime

getAsyncShutdownTimeout

getAsyncGracefulShutdownEnabled

getAsyncQueueSize

getAsyncPriority

getAsyncThreads

getBypassSecurityEnabled

getSampleRate

getProxyPort

getProxyHost