Package org.hansken.plugin.extraction.runtime.grpc.common

Class Unpack

java.lang.Object

org.hansken.plugin.extraction.runtime.grpc.common.Unpack

public final class Unpack
extends Object

Utility class to convert from gRPC messages to their native Java or plugin API counterparts. For the other way around, see Pack.

Method Summary

Modifier and Type	Method	Description
static <T extends com.google.protobuf.Message> T	any(com.google.protobuf.Any any, Class<T> messageType)	Upack an Any containing a message of given message type.
static Author	author(RpcAuthor author)	Convert given RpcAuthor to their Author counterpart.
static byte[]	bytes(com.google.protobuf.Any any)	Convert primitive RpcBytes message to the native Java byte[] counterpart.
static RpcFinish	finish(com.google.protobuf.Any any)	Unpack an Any containing an RpcFinish message.
static List<Object>	genericList(RpcList list)	Unpacks a generic non-homogenous list into a native Java List.
static Map<String,Object>	genericMap(RpcMap map)	Unpacks a generic non-homogenous map into a native Java Map.
static MaturityLevel	maturityLevel(RpcMaturity maturity)	Convert given RpcMaturity to their MaturityLevel counterpart.
static String	pluginApiVersion(RpcPluginInfo rpcPluginInfo)	Returns the API version contained in the RpcPluginInfo instance.
static PluginId	pluginId(RpcPluginIdentifier rpcPluginIdentifier)
static PluginInfo	pluginInfo(RpcPluginInfo rpcPluginInfo)	Convert given RpcPluginInfo to their PluginInfo counterpart.
static PluginResources	pluginResources(RpcPluginResources rpcPluginResources)	Convert given RpcPluginResources to their PluginResources counterpart.
static PluginType	pluginType(RpcPluginType type)	Convert given RpcPluginType to their PluginType counterpart.
static Object	primitive(com.google.protobuf.Any any)	Convert given primitive message to their native Java counterpart.
static TraceSearcher.SearchScope	searchScope(RpcSearchScope scope)
static RpcStart	start(com.google.protobuf.Any any)	Unpack an Any containing an RpcStart message.
static Trace.Tracelet	tracelet(RpcTracelet rpcTracelet)	Convert given RpcTracelet to their Trace.Tracelet counterpart.
static List<DataTransformation>	transformations(List<RpcTransformation> rpcDataTransformations)
static Object	transformerArgument(RpcTransformerArgument response)	Convert a RpcTransformerArgument into a Java native type.
static RpcTransformerArgument	transformerResponse(RpcTransformerResponse response)	Retrieve the response value from RpcTransformerResponse.
static List<TransformerLabel>	transformers(List<RpcTransformer> transformers)

Methods inherited from class java.lang.Object

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

Method Details

start

public static RpcStart start(com.google.protobuf.Any any)

Unpack an Any containing an RpcStart message.

Parameters:

any - the any to unpack

Returns:

the start message

Throws:

IllegalArgumentException - if the any does not contain a message of type RpcStart

finish

public static RpcFinish finish(com.google.protobuf.Any any)

Unpack an Any containing an RpcFinish message.

Parameters:

any - the any to unpack

Returns:

the finish message

Throws:

IllegalArgumentException - if the any does not contain a message of type RpcFinish

any

public static <T extends com.google.protobuf.Message>
T any(com.google.protobuf.Any any,
 Class<T> messageType)

Upack an Any containing a message of given message type.

Type Parameters:

T - the type of the message contained in the any

Parameters:

any - the any to unpack

messageType - class of the message contained in the any

Returns:

the message

Throws:

IllegalArgumentException - if the any does not contain a message of given type

primitive

public static Object primitive(com.google.protobuf.Any any)

Convert given primitive message to their native Java counterpart.

Parameters:

any - the any container of the primitive message

Returns:

the unpacked primitive

Throws:

IllegalArgumentException - if the any is not of an expected primitive message type

bytes

public static byte[] bytes(com.google.protobuf.Any any)

Convert primitive RpcBytes message to the native Java byte[] counterpart.

Parameters:

any - the any container of the primitive rpc bytes message

Returns:

the packed bytes

Throws:

IllegalArgumentException - if given any does not contain an RpcBytes message

pluginInfo

public static PluginInfo pluginInfo(RpcPluginInfo rpcPluginInfo)

Convert given RpcPluginInfo to their PluginInfo counterpart.

The API version that is available in RpcPluginInfo is not returned in the PluginInfo instance, to get this value use pluginApiVersion(RpcPluginInfo).

Parameters:

rpcPluginInfo - the plugin info to convert

Returns:

the converted info

Throws:

IllegalArgumentException - when a property of given info is invalid as per the PluginInfo.Builder methods

pluginId

public static PluginId pluginId(RpcPluginIdentifier rpcPluginIdentifier)

transformers

public static List<TransformerLabel> transformers(List<RpcTransformer> transformers)

pluginApiVersion

public static String pluginApiVersion(RpcPluginInfo rpcPluginInfo)

Returns the API version contained in the RpcPluginInfo instance.

Parameters:

rpcPluginInfo - the plugin info that contains the API version

Returns:

API version

tracelet

public static Trace.Tracelet tracelet(RpcTracelet rpcTracelet)

Convert given RpcTracelet to their Trace.Tracelet counterpart.

Parameters:

rpcTracelet - the info to convert

Returns:

the converted info

Throws:

IllegalArgumentException - when a property of given info is invalid as per the PluginInfo.Builder methods

author

public static Author author(RpcAuthor author)

Convert given RpcAuthor to their Author counterpart.

Parameters:

author - the author to convert

Returns:

the converted author

Throws:

IllegalArgumentException - when a property of given author is invalid as per the Author.Builder methods

maturityLevel

public static MaturityLevel maturityLevel(RpcMaturity maturity)

Convert given RpcMaturity to their MaturityLevel counterpart.

Parameters:

maturity - the maturity to convert

Returns:

the converted maturity

Throws:

IllegalArgumentException - when the given maturity is not mappable

transformerResponse

public static RpcTransformerArgument transformerResponse(RpcTransformerResponse response)

Retrieve the response value from RpcTransformerResponse. Currently only primitives are supported as defined in TransformerArgument.allowedTypes.

Parameters:

response - The RpcTransformerResponse that we want to retrieve the response value from.

Returns:

The response value that is stored within the RpcTransformerResponse}.

genericMap

public static Map<String,Object> genericMap(RpcMap map)

Unpacks a generic non-homogenous map into a native Java Map.

Parameters:

map - The RpcMap that should be unpacked.

Returns:

The unpacked map.

genericList

public static List<Object> genericList(RpcList list)

Unpacks a generic non-homogenous list into a native Java List.

Parameters:

list - The RpcList that should be unpacked.

Returns:

The unpacked list.

transformerArgument

public static Object transformerArgument(RpcTransformerArgument response)

Convert a RpcTransformerArgument into a Java native type. Currently only primitives are supported as defined in PRIMITIVE_UNPACKER.

Parameters:

response - The RpcTransformerArgument that we want to unpack into a Java native value

Returns:

The response value that is stored within the RpcTransformerResponse}.

pluginType

public static PluginType pluginType(RpcPluginType type)

Convert given RpcPluginType to their PluginType counterpart.

Parameters:

type - the type to convert

Returns:

the converted type

Throws:

IllegalArgumentException - when the given type is not mappable

pluginResources

public static PluginResources pluginResources(RpcPluginResources rpcPluginResources)

Convert given RpcPluginResources to their PluginResources counterpart.

Parameters:

rpcPluginResources - the rpc plugin resources to convert

Returns:

the converted plugin resources

transformations

public static List<DataTransformation> transformations(List<RpcTransformation> rpcDataTransformations)

searchScope

public static TraceSearcher.SearchScope searchScope(RpcSearchScope scope)