org.corfudb.runtime

Class CorfuRuntime

java.lang.Object

org.corfudb.runtime.CorfuRuntime

public class CorfuRuntime
extends Object

Created by mwei on 12/9/15.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CorfuRuntime.CorfuRuntimeParameters A class which holds parameters and settings for the CorfuRuntime.

Field Summary

Fields

Modifier and Type	Field and Description
UUID	clusterId The UUID of the cluster we are currently connected to, or null, if there is no cluster yet.
CompletableFuture<Layout>	layout A completable future containing a layout, when completed.
static BiFunction<CorfuRuntime,String,IClientRouter>	overrideGetRouterFunction When set, overrides the default getRouterFunction.

Constructor Summary

Constructors

Constructor and Description
CorfuRuntime() Deprecated. Use fromParameters(CorfuRuntimeParameters)
CorfuRuntime(String configurationString) Deprecated. Use fromParameters(CorfuRuntimeParameters)

Method Summary

Modifier and Type	Method and Description
CorfuRuntime	addLayoutServer(String layoutServer) Add a layout server to the list of servers known by the CorfuRuntime.
CorfuRuntime	connect() Connect to the Corfu server instance.
CorfuRuntime	enableSaslPlainText(String usernameFile, String passwordFile) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	enableTls(String keyStore, String ksPasswordFile, String trustStore, String tsPasswordFile) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
static CorfuRuntime	fromParameters(CorfuRuntime.CorfuRuntimeParameters parameters) Factory method for generating new CorfuRuntimes given a set of CorfuRuntime.CorfuRuntimeParameters to configure the runtime with.
static UUID	getCheckpointStreamIdFromId(UUID streamId)
static UUID	getCheckpointStreamIdFromName(String streamName)
IClientRouter	getRouter(String address) Get a router, given the address.
static UUID	getStreamID(String string) Get a UUID for a named stream.
static String	getVersionString() Get corfu runtime version.
void	invalidateLayout() Invalidate the current layout.
CorfuRuntime	parseConfigurationString(String configurationString) Parse a configuration string and get a CorfuRuntime.
CorfuRuntime	registerBeforeRpcHandler(Runnable handler) Deprecated.
CorfuRuntime	registerSystemDownHandler(Runnable handler) Deprecated.
CorfuRuntime	setBackpointersDisabled(boolean disable) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setBulkReadSize(int size) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setCacheDisabled(boolean disable) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setCacheExpiryTime(int expiryTime) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setHoleFillingDisabled(boolean disable) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setLoadSmrMapsAtConnect(boolean enable) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setNumCacheEntries(long numCacheEntries) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setTimeoutInMinutesForFastLoading(int timeout) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setTransactionLogging(boolean enable) If enabled, successful transactions will be written to a special transaction stream (i.e.
CorfuRuntime	setTrimRetry(int trimRetry) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
CorfuRuntime	setWriteRetry(int writeRetry) Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.
void	shutdown() Shuts down the CorfuRuntime.
void	stop() Stop all routers associated with this runtime & disconnect them.
void	stop(boolean shutdown) Stop all routers associated with this Corfu Runtime.

Methods inherited from class java.lang.Object

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

Field Detail

layout

public volatile CompletableFuture<Layout> layout

A completable future containing a layout, when completed.

clusterId

public volatile UUID clusterId

The UUID of the cluster we are currently connected to, or null, if there is no cluster yet.

overrideGetRouterFunction

public static BiFunction<CorfuRuntime,String,IClientRouter> overrideGetRouterFunction

When set, overrides the default getRouterFunction. Used by the testing framework to ensure the default routers used are for testing.

Constructor Detail

CorfuRuntime

@Deprecated
public CorfuRuntime()

Deprecated. Use fromParameters(CorfuRuntimeParameters)

Constructor for CorfuRuntime.

CorfuRuntime

@Deprecated
public CorfuRuntime(String configurationString)

Deprecated. Use fromParameters(CorfuRuntimeParameters)

Parse a configuration string and get a CorfuRuntime.

Parameters:

configurationString - The configuration string to parse.

Method Detail

registerSystemDownHandler

@Deprecated
public CorfuRuntime registerSystemDownHandler(Runnable handler)

Deprecated.

Register SystemDownHandler. Please use CorfuRuntimeParameters builder to register this.

Parameters:

handler - Handler to invoke in case of system Down.

Returns:

CorfuRuntime instance.

registerBeforeRpcHandler

@Deprecated
public CorfuRuntime registerBeforeRpcHandler(Runnable handler)

Deprecated.

Register BeforeRPCHandler. Please use CorfuRuntimeParameters builder to register this.

Parameters:

handler - Handler to invoke before every RPC.

Returns:

CorfuRuntime instance.

fromParameters

public static CorfuRuntime fromParameters(@Nonnull
                                          CorfuRuntime.CorfuRuntimeParameters parameters)

Factory method for generating new CorfuRuntimes given a set of CorfuRuntime.CorfuRuntimeParameters to configure the runtime with.

Parameters:

parameters - A CorfuRuntime.CorfuRuntimeParameters to use.

Returns:

A new CorfuRuntime.

shutdown

public void shutdown()

Shuts down the CorfuRuntime. Stops async tasks from fetching the layout. Cannot reuse the runtime once shutdown is called.

stop

public void stop()

Stop all routers associated with this runtime & disconnect them.

stop

public void stop(boolean shutdown)

Stop all routers associated with this Corfu Runtime.

getStreamID

public static UUID getStreamID(String string)

Get a UUID for a named stream.

Parameters:

string - The name of the stream.

Returns:

The ID of the stream.

getCheckpointStreamIdFromId

public static UUID getCheckpointStreamIdFromId(UUID streamId)

getCheckpointStreamIdFromName

public static UUID getCheckpointStreamIdFromName(String streamName)

getVersionString

public static String getVersionString()

Get corfu runtime version.

setTransactionLogging

public CorfuRuntime setTransactionLogging(boolean enable)

If enabled, successful transactions will be written to a special transaction stream (i.e. TRANSACTION_STREAM_ID)

Parameters:

enable - indicates if transaction logging is enabled

Returns:

corfu runtime object

parseConfigurationString

public CorfuRuntime parseConfigurationString(String configurationString)

Parse a configuration string and get a CorfuRuntime.

Parameters:

configurationString - The configuration string to parse.

Returns:

A CorfuRuntime Configured based on the configuration string.

addLayoutServer

public CorfuRuntime addLayoutServer(String layoutServer)

Add a layout server to the list of servers known by the CorfuRuntime.

Parameters:

layoutServer - A layout server to use.

Returns:

A CorfuRuntime, to support the builder pattern.

getRouter

public IClientRouter getRouter(String address)

Get a router, given the address.

Parameters:

address - The address of the router to get.

Returns:

The router.

invalidateLayout

public void invalidateLayout()

Invalidate the current layout. If the layout has been previously invalidated and a new layout has not yet been retrieved, this function does nothing.

connect

public CorfuRuntime connect()

Connect to the Corfu server instance. When this function returns, the Corfu server is ready to be accessed.

enableTls

@Deprecated
public CorfuRuntime enableTls(String keyStore,
                                          String ksPasswordFile,
                                          String trustStore,
                                          String tsPasswordFile)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Enable TLS.

enableSaslPlainText

@Deprecated
public CorfuRuntime enableSaslPlainText(String usernameFile,
                                                    String passwordFile)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Enable SASL Plain Text.

setBackpointersDisabled

@Deprecated
public CorfuRuntime setBackpointersDisabled(boolean disable)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Whether or not to disable backpointers

Parameters:

disable - True, if the cache should be disabled, false otherwise.

Returns:

A CorfuRuntime to support chaining.

setCacheDisabled

@Deprecated
public CorfuRuntime setCacheDisabled(boolean disable)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Whether or not to disable the cache

Parameters:

disable - True, if the cache should be disabled, false otherwise.

Returns:

A CorfuRuntime to support chaining.

setLoadSmrMapsAtConnect

@Deprecated
public CorfuRuntime setLoadSmrMapsAtConnect(boolean enable)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Whether or not to use the fast loader.

Parameters:

enable - True, if the fast loader should be used, false otherwise.

Returns:

A CorfuRuntime to support chaining.

setHoleFillingDisabled

@Deprecated
public CorfuRuntime setHoleFillingDisabled(boolean disable)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Whether or not hole filling is disabled

Parameters:

disable - True, if hole filling should be disabled

Returns:

A CorfuRuntime to support chaining.

setNumCacheEntries

@Deprecated
public CorfuRuntime setNumCacheEntries(long numCacheEntries)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Set the number of cache entries.

Parameters:

numCacheEntries - The number of cache entries.

setCacheExpiryTime

@Deprecated
public CorfuRuntime setCacheExpiryTime(int expiryTime)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Set the cache expiration time.

Parameters:

expiryTime - The time before cache expiration, in seconds.

setBulkReadSize

@Deprecated
public CorfuRuntime setBulkReadSize(int size)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Set the bulk read size.

Parameters:

size - The bulk read size.

setWriteRetry

@Deprecated
public CorfuRuntime setWriteRetry(int writeRetry)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Set the write retry time.

Parameters:

writeRetry - The number of times to retry writes.

setTrimRetry

@Deprecated
public CorfuRuntime setTrimRetry(int trimRetry)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Set the trim retry time.

Parameters:

trimRetry - The number of times to retry on trims.

setTimeoutInMinutesForFastLoading

@Deprecated
public CorfuRuntime setTimeoutInMinutesForFastLoading(int timeout)

Deprecated. Deprecated, set using CorfuRuntime.CorfuRuntimeParameters instead.

Set the timeout of the fast loader, in minutes.

Parameters:

timeout - The number of minutes to wait.