com.lucidworks.fusion.connector.plugin

Class Logging

java.lang.Object

com.lucidworks.fusion.connector.plugin.Logging

public class Logging
extends java.lang.Object

A Context utility, mostly meant for logging context, but not limited to.

This class provides a way to modify a Map<String,String> for various scopes of Context. The incoming values can be String/String key-value pairs or additional Map<String,String> objects.

It's important to note that all maps are instances of ImmutableMap. This is done to prevent one context's map from being updated by another. Additionally, the maps returned by export() are specifically meant to be immutable. The return type for export() is a Map<String,String> but it's imple is ImmutableMap. Attempting to change this map will throw a UnsupportedOperationException.

See Also:

Context, Context.Key

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_NAME

Constructor Summary

Constructors

Constructor and Description
Logging()

Method Summary

Modifier and Type	Method and Description
static <V> V	call(io.grpc.Context context, java.util.concurrent.Callable<V> callable) Accepts a Context and execute the provided callable with this context.
static void	diagnostics(java.lang.Runnable runnable) Execute the provided runnable stuff only if datasource property 'diagnosticLogging' is set to true.
static io.grpc.Context	empty() Uses the Context.current().
static io.grpc.Context	empty(io.grpc.Context context) Uses the provided Context.
static java.util.Map<java.lang.String,java.lang.String>	export() Returns an immutable copy of the KEY contents from the current Context.
static java.util.Map<java.lang.String,java.lang.String>	export(io.grpc.Context context) Returns an immutable copy of the KEY contents from the given Context.
static io.grpc.Context	getContext(ConnectorConfig config) Get a Context for the provided config
static boolean	isDiagnosticsEnabled()
static io.grpc.Context.Key<java.util.Map<java.lang.String,java.lang.String>>	key()
static void	run(io.grpc.Context context, java.lang.Runnable runnable) Accepts a Context and execute the provided runnable with this context.
static io.grpc.Context	with(io.grpc.Context context, java.util.Map<java.lang.String,java.lang.String> map) Accepts a Context and applies the provided map to the KEY.
static io.grpc.Context	with(io.grpc.Context context, java.lang.String k1, java.lang.String v1) Applies the provided key-value pairs as a map to the given Context.
static io.grpc.Context	with(io.grpc.Context context, java.lang.String k1, java.lang.String v1, java.lang.String k2, java.lang.String v2) Applies the provided key-value pairs as a map to the given Context.
static io.grpc.Context	with(io.grpc.Context context, java.lang.String k1, java.lang.String v1, java.lang.String k2, java.lang.String v2, java.lang.String k3, java.lang.String v3) Applies the provided key-value pairs as a map to the given Context.
static io.grpc.Context	with(io.grpc.Context context, java.lang.String k1, java.lang.String v1, java.lang.String k2, java.lang.String v2, java.lang.String k3, java.lang.String v3, java.lang.String k4, java.lang.String v4) Applies the provided key-value pairs as a map to the given Context.
static io.grpc.Context	with(io.grpc.Context context, java.lang.String k1, java.lang.String v1, java.lang.String k2, java.lang.String v2, java.lang.String k3, java.lang.String v3, java.lang.String k4, java.lang.String v4, java.lang.String k5, java.lang.String v5) Applies the provided key-value pairs as a map to the given Context.
static io.grpc.Context	with(java.util.Map<java.lang.String,java.lang.String> map) Applies the provided Map to the current Context.
static io.grpc.Context	with(java.lang.String k1, java.lang.String v1) Applies the provided key-value pairs as a map to the current Context.
static io.grpc.Context	with(java.lang.String k1, java.lang.String v1, java.lang.String k2, java.lang.String v2) Applies the provided key-value pairs as a map to the current Context.
static io.grpc.Context	with(java.lang.String k1, java.lang.String v1, java.lang.String k2, java.lang.String v2, java.lang.String k3, java.lang.String v3) Applies the provided key-value pairs as a map to the current Context.
static io.grpc.Context	with(java.lang.String k1, java.lang.String v1, java.lang.String k2, java.lang.String v2, java.lang.String k3, java.lang.String v3, java.lang.String k4, java.lang.String v4) Applies the provided key-value pairs as a map to the current Context.
static io.grpc.Context	with(java.lang.String k1, java.lang.String v1, java.lang.String k2, java.lang.String v2, java.lang.String k3, java.lang.String v3, java.lang.String k4, java.lang.String v4, java.lang.String k5, java.lang.String v5) Applies the provided key-value pairs as a map to the current Context.
static <V> java.util.function.Consumer<V>	wrap(java.util.function.Consumer<V> consumer)
static <V> java.util.function.Consumer<V>	wrap(io.grpc.Context context, java.util.function.Consumer<V> consumer)
static java.lang.Runnable	wrap(io.grpc.Context context, java.lang.Runnable r)
static <V> java.util.function.Supplier<V>	wrap(io.grpc.Context context, java.util.function.Supplier<V> supplier)
static java.lang.Runnable	wrap(java.lang.Runnable r)
static <V> java.util.function.Supplier<V>	wrap(java.util.function.Supplier<V> supplier)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_NAME

public static final java.lang.String KEY_NAME

See Also:

Constant Field Values

Constructor Detail

Logging

public Logging()

Method Detail

key

public static io.grpc.Context.Key<java.util.Map<java.lang.String,java.lang.String>> key()

empty

public static io.grpc.Context empty()

Uses the Context.current(). Returns a new Context with "map" key, which will contain an empty Map.

Returns:

empty

public static io.grpc.Context empty(io.grpc.Context context)

Uses the provided Context. Returns a new Context with "map" key, which will contain an empty Map.

Parameters:

context -

Returns:

export

public static java.util.Map<java.lang.String,java.lang.String> export(io.grpc.Context context)

Returns an immutable copy of the KEY contents from the given Context.

Parameters:

context -

Returns:

export

public static java.util.Map<java.lang.String,java.lang.String> export()

Returns an immutable copy of the KEY contents from the current Context.

Returns:

with

public static io.grpc.Context with(io.grpc.Context context,
                                   java.util.Map<java.lang.String,java.lang.String> map)

Accepts a Context and applies the provided map to the KEY.

Parameters:

context -

map -

Returns:

run

public static void run(io.grpc.Context context,
                       java.lang.Runnable runnable)

Accepts a Context and execute the provided runnable with this context.

Parameters:

context -

runnable -

call

public static <V> V call(io.grpc.Context context,
                         java.util.concurrent.Callable<V> callable)
                  throws java.lang.Exception

Accepts a Context and execute the provided callable with this context.

Parameters:

context -

callable -

Throws:

java.lang.Exception

wrap

public static <V> java.util.function.Supplier<V> wrap(io.grpc.Context context,
                                                      java.util.function.Supplier<V> supplier)

wrap

public static <V> java.util.function.Supplier<V> wrap(java.util.function.Supplier<V> supplier)

wrap

public static <V> java.util.function.Consumer<V> wrap(io.grpc.Context context,
                                                      java.util.function.Consumer<V> consumer)

wrap

public static <V> java.util.function.Consumer<V> wrap(java.util.function.Consumer<V> consumer)

wrap

public static java.lang.Runnable wrap(java.lang.Runnable r)

wrap

public static java.lang.Runnable wrap(io.grpc.Context context,
                                      java.lang.Runnable r)

getContext

public static io.grpc.Context getContext(ConnectorConfig config)

Get a Context for the provided config

Parameters:

config -

Returns:

isDiagnosticsEnabled

public static boolean isDiagnosticsEnabled()

diagnostics

public static void diagnostics(java.lang.Runnable runnable)

Execute the provided runnable stuff only if datasource property 'diagnosticLogging' is set to true. Add a thread-context value 'diagnostic=true' for the logging requests in the runnable stuff

Parameters:

runnable, - stuff with logging requests

with

public static io.grpc.Context with(java.util.Map<java.lang.String,java.lang.String> map)

Applies the provided Map to the current Context.

Parameters:

map -

Returns:

with

public static io.grpc.Context with(io.grpc.Context context,
                                   java.lang.String k1,
                                   java.lang.String v1)

Applies the provided key-value pairs as a map to the given Context.

Parameters:

context -

k1 -

v1 -

Returns:

with

public static io.grpc.Context with(java.lang.String k1,
                                   java.lang.String v1)

Applies the provided key-value pairs as a map to the current Context.

Parameters:

k1 -

v1 -

Returns:

with

public static io.grpc.Context with(io.grpc.Context context,
                                   java.lang.String k1,
                                   java.lang.String v1,
                                   java.lang.String k2,
                                   java.lang.String v2)

Applies the provided key-value pairs as a map to the given Context.

Parameters:

context -

k1 -

v1 -

k2 -

v2 -

Returns:

with

public static io.grpc.Context with(java.lang.String k1,
                                   java.lang.String v1,
                                   java.lang.String k2,
                                   java.lang.String v2)

Applies the provided key-value pairs as a map to the current Context.

Parameters:

k1 -

v1 -

k2 -

v2 -

Returns:

with

public static io.grpc.Context with(io.grpc.Context context,
                                   java.lang.String k1,
                                   java.lang.String v1,
                                   java.lang.String k2,
                                   java.lang.String v2,
                                   java.lang.String k3,
                                   java.lang.String v3)

Applies the provided key-value pairs as a map to the given Context.

Parameters:

context -

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

Returns:

with

public static io.grpc.Context with(java.lang.String k1,
                                   java.lang.String v1,
                                   java.lang.String k2,
                                   java.lang.String v2,
                                   java.lang.String k3,
                                   java.lang.String v3)

Applies the provided key-value pairs as a map to the current Context.

Parameters:

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

Returns:

with

public static io.grpc.Context with(io.grpc.Context context,
                                   java.lang.String k1,
                                   java.lang.String v1,
                                   java.lang.String k2,
                                   java.lang.String v2,
                                   java.lang.String k3,
                                   java.lang.String v3,
                                   java.lang.String k4,
                                   java.lang.String v4)

Applies the provided key-value pairs as a map to the given Context.

Parameters:

context -

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

k4 -

v4 -

Returns:

with

public static io.grpc.Context with(java.lang.String k1,
                                   java.lang.String v1,
                                   java.lang.String k2,
                                   java.lang.String v2,
                                   java.lang.String k3,
                                   java.lang.String v3,
                                   java.lang.String k4,
                                   java.lang.String v4)

Applies the provided key-value pairs as a map to the current Context.

Parameters:

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

k4 -

v4 -

Returns:

with

public static io.grpc.Context with(io.grpc.Context context,
                                   java.lang.String k1,
                                   java.lang.String v1,
                                   java.lang.String k2,
                                   java.lang.String v2,
                                   java.lang.String k3,
                                   java.lang.String v3,
                                   java.lang.String k4,
                                   java.lang.String v4,
                                   java.lang.String k5,
                                   java.lang.String v5)

Applies the provided key-value pairs as a map to the given Context.

Parameters:

context -

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

k4 -

v4 -

k5 -

v5 -

Returns:

with

public static io.grpc.Context with(java.lang.String k1,
                                   java.lang.String v1,
                                   java.lang.String k2,
                                   java.lang.String v2,
                                   java.lang.String k3,
                                   java.lang.String v3,
                                   java.lang.String k4,
                                   java.lang.String v4,
                                   java.lang.String k5,
                                   java.lang.String v5)

Applies the provided key-value pairs as a map to the current Context.

Parameters:

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

k4 -

v4 -

k5 -

v5 -

Returns: