Package com.mongodb.stitch.core
Class StitchClientConfiguration
- java.lang.Object
-
- com.mongodb.stitch.core.StitchClientConfiguration
-
- Direct Known Subclasses:
StitchAppClientConfiguration
public class StitchClientConfiguration extends Object
Properties representing the configuration of a client that communicate with a particular MongoDB Stitch application.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StitchClientConfiguration.Builder
A builder that can build aStitchClientConfiguration
object.
-
Method Summary
Modifier and Type Method Description StitchClientConfiguration.Builder
builder()
Gets the builder form of this configuration.String
getBaseUrl()
Gets the base URL of the Stitch server that the client will communicate with.CodecRegistry
getCodecRegistry()
Gets the codec registry used to encode/decode JSON.String
getDataDirectory()
Gets the local directory in which Stitch can store any data (e.g.Long
getDefaultRequestTimeout()
Gets the number of milliseconds that a `Transport` should spend by default on an HTTP round trip before failing with an error.NetworkMonitor
getNetworkMonitor()
Gets the network monitor.Storage
getStorage()
Gets the underlying storage to persist client specific data to.Transport
getTransport()
Gets theTransport
that the client will use to make round trips to the Stitch server.
-
-
-
Method Detail
-
getBaseUrl
public String getBaseUrl()
Gets the base URL of the Stitch server that the client will communicate with.- Returns:
- the base URL of the Stitch server that the client will communicate with.
-
getStorage
public Storage getStorage()
Gets the underlying storage to persist client specific data to.- Returns:
- the underlying storage to persist client specific data to.
-
getDataDirectory
public String getDataDirectory()
Gets the local directory in which Stitch can store any data (e.g. embedded MongoDB data directory).- Returns:
- the local directory in which Stitch can store any data.
-
getTransport
public Transport getTransport()
Gets theTransport
that the client will use to make round trips to the Stitch server.- Returns:
- the
Transport
that the client will use to make round trips to the Stitch server.
-
getDefaultRequestTimeout
public Long getDefaultRequestTimeout()
Gets the number of milliseconds that a `Transport` should spend by default on an HTTP round trip before failing with an error. Important: If a request timeout was specified for a specific operation, for example in a function call, that timeout will override this one.- Returns:
- the number of milliseconds that a `Transport` should spend by default on an HTTP round trip before failing with an error.
-
getCodecRegistry
public CodecRegistry getCodecRegistry()
Gets the codec registry used to encode/decode JSON.- Returns:
- the codec registry used to encode/decode JSON.
-
getNetworkMonitor
public NetworkMonitor getNetworkMonitor()
Gets the network monitor.- Returns:
- the network monitor.
-
builder
public StitchClientConfiguration.Builder builder()
Gets the builder form of this configuration.- Returns:
- the builder form of this configuration.
-
-