Package com.illumon.iris.controller.utils

Class ControllerGrpcHelper

java.lang.Object

com.illumon.iris.controller.utils.ControllerGrpcHelper

public final class ControllerGrpcHelper
extends Object

This class contains utilities for packing and unpacking objects for gRPC communication.

Method Summary

Modifier and Type	Method	Description
static int	getReplicaNum(@NotNull ReplicaSpecifier specifier)
static ControllerConfigurationMessage	makeControllerConfigMessage(@NotNull UserContext userContext, @NotNull IrisGroupProvider groupProvider, @NotNull PersistentQueryControllerConfiguration serverConfiguration, @NotNull Predicate<ConsoleConfigurationType> configTypePredicate, @NotNull Predicate<WorkerKind> workerKindPredicate)	Serialize a PersistentQueryControllerConfiguration for gRPC
static PersistentQueryDbServerConfig	makeDbServerConfig(PQDBServerConfigMessage configMessage)	Deserialize a PersistentQueryDbServerConfig from gRPC.
static ExportedObjectInfo	makeExportedObjectInfo(ExportedObjectInfoMessage eo)	Deserialize an ExportedObjectInfo from gRPC.
static ExportedObjectInfoMessage	makeExportedObjectInfoMessage(@NotNull String name, @NotNull ExportedObjectInfo type)	Make an ExportedObjectInfoMessage from a name and ExportedObjectInfo
static NamedStringList	makeNamedStringList(@NotNull String name, @Nullable String[] list)	Create a NamedStringList object from a string array and name.
static @NotNull NamedStringList	makeNamedStringList(@NotNull String name, @Nullable Collection<String> list)	Create a NamedStringList object from a collection of strings and name.
static PersistentQueryControllerConfiguration	makePersistentQueryControllerConfiguration(@NotNull ControllerConfigurationMessage response)	Deserialize a PersistentQueryControllerConfiguration from gRPC
static PQDBServerConfigMessage	makePQDBServerConfigMessage(@NotNull UserContext userContext, @NotNull IrisGroupProvider groupProvider, @NotNull PersistentQueryControllerConfiguration serverConfiguration, @NotNull PersistentQueryDbServerConfig config)	Serialize a PersistentQueryDbServerConfig object for gRPC
static PersistentQueryConfiguration	makeQueryConfig(PersistentQueryConfigMessage configMessage)	Deserialize a PersistentQueryConfiguration from gRPC.
static PersistentQueryConfigMessage	makeQueryConfigMessage(@NotNull PersistentQueryConfiguration config)	Serialize a PersistentQueryConfiguration object for gRPC.
static PersistentQueryInfo	makeQueryInfo(@NotNull PersistentQueryInfoMessage infoMessage)	Deserialize a PersistentQueryInfo from gRPC.
static PersistentQueryInfoMessage	makeQueryInfoMessage(@NotNull PersistentQueryInfo info, @Nullable UserContext forUser, @Nullable IrisGroupProvider groupProvider, int designatedSlot)	Serialize a PersistentQueryInfo object for gRPC.
static PersistentQueryState	makeQueryState(@NotNull PersistentQueryStateMessage stateMessage)
static PersistentQueryStateMessage	makeStateMessageForPresenceKv(@NotNull PersistentQueryState state)	Creates a PersistetQueryStateMessage with the PersistentQueryState provided.
static PersistentQueryState.Status	makeStatus(@NotNull PersistentQueryStatusEnum grpcStatus)	Deserialize a PersistentQueryState.Status from gRPC.
static TableDefinition	makeTableDefinition(@NotNull ExportedObjectInfoMessage message)	Deserialize a TableDefinition from gRPC.
static WorkerProtocol	makeWorkerProtocol(@NotNull WorkerProtocolMessage protocolMessage)	Deserialize a WorkerProtocol from gRPC.

Methods inherited from class java.lang.Object

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

Method Details

makeQueryInfoMessage

public static PersistentQueryInfoMessage makeQueryInfoMessage(@NotNull
 @NotNull PersistentQueryInfo info,
 @Nullable
 @Nullable UserContext forUser,
 @Nullable
 @Nullable IrisGroupProvider groupProvider,
 int designatedSlot)
                                                       throws ControllerSerializationException

Serialize a PersistentQueryInfo object for gRPC.

Parameters:

info - the object to serialize

forUser - the user this is destined for

groupProvider - the group provider for determining filters and access.

designatedSlot - the worker slot the user will be assigned to.

Returns:

the serialized PersistentQueryInfoMessage

Throws:

ControllerSerializationException - if a problem occurred converting the message to gRPC

makeQueryConfigMessage

public static PersistentQueryConfigMessage makeQueryConfigMessage(@NotNull
 @NotNull PersistentQueryConfiguration config)
                                                           throws ControllerSerializationException

Serialize a PersistentQueryConfiguration object for gRPC.

Parameters:

config - the object to serialize

Returns:

the serialized PersistentQueryConfigMessage

Throws:

ControllerSerializationException - if a problem occurred converting the message to gRPC

makeStateMessageForPresenceKv

public static PersistentQueryStateMessage makeStateMessageForPresenceKv(@NotNull
 @NotNull PersistentQueryState state)
                                                                 throws ControllerSerializationException

Creates a PersistetQueryStateMessage with the PersistentQueryState provided.

Parameters:

state - the state to use as data to populate the returned message

Returns:

a new state message matching the supplied data

Throws:

ControllerSerializationException - if there are any errors during serialization

makeNamedStringList

public static NamedStringList makeNamedStringList(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable String[] list)

Create a NamedStringList object from a string array and name.

Parameters:

name - the name to use

list - the array of values

Returns:

a new NamedStringList

makeNamedStringList

@NotNull
public static @NotNull NamedStringList makeNamedStringList(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable Collection<String> list)

Create a NamedStringList object from a collection of strings and name.

Parameters:

name - the name to use

list - the collection of values

Returns:

a new NamedStringList

makeExportedObjectInfoMessage

public static ExportedObjectInfoMessage makeExportedObjectInfoMessage(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull ExportedObjectInfo type)
                                                               throws ControllerSerializationException

Make an ExportedObjectInfoMessage from a name and ExportedObjectInfo

Parameters:

name - the name of the object

type - the ExportedObjectInfo

Returns:

a new ExportedObjectInfoMessage

Throws:

ControllerSerializationException - if a problem occurred converting the message to gRPC

makePQDBServerConfigMessage

public static PQDBServerConfigMessage makePQDBServerConfigMessage(@NotNull
 @NotNull UserContext userContext,
 @NotNull
 @NotNull IrisGroupProvider groupProvider,
 @NotNull
 @NotNull PersistentQueryControllerConfiguration serverConfiguration,
 @NotNull
 @NotNull PersistentQueryDbServerConfig config)
                                                           throws ControllerSerializationException

Serialize a PersistentQueryDbServerConfig object for gRPC

Parameters:

config - the configuration to serialize

Returns:

a new PersistentQueryDbServerConfig

Throws:

ControllerSerializationException - if a problem occurred converting the message to gRPC

makeControllerConfigMessage

public static ControllerConfigurationMessage makeControllerConfigMessage(@NotNull
 @NotNull UserContext userContext,
 @NotNull
 @NotNull IrisGroupProvider groupProvider,
 @NotNull
 @NotNull PersistentQueryControllerConfiguration serverConfiguration,
 @NotNull
 @NotNull Predicate<ConsoleConfigurationType> configTypePredicate,
 @NotNull
 @NotNull Predicate<WorkerKind> workerKindPredicate)
                                                                  throws ControllerSerializationException

Serialize a PersistentQueryControllerConfiguration for gRPC

Parameters:

serverConfiguration - the configuration to serialize

Returns:

a new ControllerConfigurationMessage

Throws:

ControllerSerializationException - if a problem occurred converting the message to gRPC

makeQueryInfo

public static PersistentQueryInfo makeQueryInfo(@NotNull
 @NotNull PersistentQueryInfoMessage infoMessage)
                                         throws ControllerSerializationException

Deserialize a PersistentQueryInfo from gRPC.

Parameters:

infoMessage - the message to deserialize

Returns:

a new PersistentQueryInfo

Throws:

ControllerSerializationException - if a problem occurred deserializing gRPC message

makeQueryState

public static PersistentQueryState makeQueryState(@NotNull
 @NotNull PersistentQueryStateMessage stateMessage)
                                           throws ControllerSerializationException

Throws:

ControllerSerializationException

makeWorkerProtocol

public static WorkerProtocol makeWorkerProtocol(@NotNull
 @NotNull WorkerProtocolMessage protocolMessage)

Deserialize a WorkerProtocol from gRPC.

Parameters:

protocolMessage - the message to deserialize

Returns:

a new WorkerProtocol

makeQueryConfig

public static PersistentQueryConfiguration makeQueryConfig(PersistentQueryConfigMessage configMessage)
                                                    throws ControllerSerializationException

Deserialize a PersistentQueryConfiguration from gRPC.

Parameters:

configMessage - the message to deserialize

Returns:

a new PersistentQueryConfiguration

Throws:

ControllerSerializationException - if a problem occurred deserializing gRPC message

makeStatus

public static PersistentQueryState.Status makeStatus(@NotNull
 @NotNull PersistentQueryStatusEnum grpcStatus)
                                              throws ControllerSerializationException

Deserialize a PersistentQueryState.Status from gRPC.

Parameters:

grpcStatus - the message to deserialize

Returns:

a new PersistentQueryState.Status.

Throws:

ControllerSerializationException - if a problem occurred deserializing gRPC message

makeDbServerConfig

public static PersistentQueryDbServerConfig makeDbServerConfig(PQDBServerConfigMessage configMessage)
                                                        throws ControllerSerializationException

Deserialize a PersistentQueryDbServerConfig from gRPC.

Parameters:

configMessage - the message to deserialize

Returns:

a new PersistentQueryDbServerConfig

Throws:

ControllerSerializationException - if a problem occurred deserializing gRPC message

makePersistentQueryControllerConfiguration

public static PersistentQueryControllerConfiguration makePersistentQueryControllerConfiguration(@NotNull
 @NotNull ControllerConfigurationMessage response)
                                                                                         throws ControllerSerializationException

Deserialize a PersistentQueryControllerConfiguration from gRPC

Parameters:

response - the message to deserialize

Returns:

a new PersistentQueryControllerConfiguration

Throws:

ControllerSerializationException - if a problem occurred deserializing gRPC message

makeExportedObjectInfo

public static ExportedObjectInfo makeExportedObjectInfo(ExportedObjectInfoMessage eo)
                                                 throws ControllerSerializationException

Deserialize an ExportedObjectInfo from gRPC.

Parameters:

eo - the message to deserialize

Returns:

a new ExportedObjectInfo

Throws:

ControllerSerializationException - if a problem occurred deserializing gRPC message

makeTableDefinition

public static TableDefinition makeTableDefinition(@NotNull
 @NotNull ExportedObjectInfoMessage message)

Deserialize a TableDefinition from gRPC.

Parameters:

message - the message to deserialize

Returns:

a new TableDefinition or null if the message does not contain a table definition, or the table definition cannot be deserialized (for example a missing custom class)

getReplicaNum

public static int getReplicaNum(@NotNull
 @NotNull ReplicaSpecifier specifier)