Index (client 0.9.6 API)

A B C D E G H I M N O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

adapter(ClientTrace, ClientDataContext, TraceSearcher) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Returns an adapter that translates gRPC protocol messages to clean API calls.
await() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ProtocolHandler: Blocks and waits for the processing of the trace to be finished, whether or not due to an error.

B

backOffMultiplier(double) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.RetryPolicy: The factor to multiply the maximum backoff value with on each iteration.

C

ClientDataContext - Interface in org.hansken.plugin.extraction.runtime.grpc.client.api: ClientDataContext with an added method to retrieve data for any trace.
ClientTrace - Interface in org.hansken.plugin.extraction.runtime.grpc.client.api: Trace for client side implementations.
close() - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace: Default implementation which calls ClientTrace.save().
close() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient
createTransformerArgument(String, String) - Static method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient

D

data(String, String) - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.ClientDataContext: Retrieve data corresponding to the dataType of a specific trace.
deserializeJsonArguments(TransformerLabel, Map<String, String>) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient

E

error() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginGrpcAdapter: Returns the error set, if any.
error(Throwable) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginGrpcAdapter: Callback for errors.
error(Throwable, String) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginGrpcAdapter: Callback for errors.
execute(Any) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginGrpcAdapter: Processes a gRPC message, and calls the corresponding clean API.
ExtractionPluginClient - Class in org.hansken.plugin.extraction.runtime.grpc.client: Client to connect to a running Extraction Plugin (server).
ExtractionPluginClient(String) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Same as ExtractionPluginClient(String, int), but with a target string instead.
ExtractionPluginClient(String, int) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Constructor for the Extraction Plugin client.
ExtractionPluginClient(String, int, RetryPolicy) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: See ExtractionPluginClient(String, int), but with a RetryPolicy.
ExtractionPluginClient(String, RetryPolicy) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Same as ExtractionPluginClient(String, RetryPolicy), but with a target string instead.
ExtractionPluginClient(String, RetryPolicy, String) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Same as ExtractionPluginClient(String, RetryPolicy), but with a pluginId parameter for routing.
ExtractionPluginDataReader - Class in org.hansken.plugin.extraction.runtime.grpc.client: This class is used to read trace data.
ExtractionPluginDataReader(ClientDataContext) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginDataReader
ExtractionPluginException - Exception Class in org.hansken.plugin.extraction.runtime.grpc.client: Used for exceptions thrown by the actual Extraction Plugins code.
ExtractionPluginException(String, Throwable, boolean, boolean) - Constructor for exception class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginException
ExtractionPluginGrpcAdapter - Class in org.hansken.plugin.extraction.runtime.grpc.client: Adapter that transforms incoming gRPC messages to clean API calls.
ExtractionPluginGrpcAdapter(ClientTrace, ClientDataContext, ExtractionPluginDataReader) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginGrpcAdapter
ExtractionPluginGrpcAdapter(ClientTrace, ClientDataContext, ExtractionPluginDataReader, TraceSearcher) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginGrpcAdapter

G

getDoubles() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.PluginRunProfile: Returns all Double floating points reported in the run profile.
getHealthBlockingStub(String) - Static method in class org.hansken.plugin.extraction.runtime.grpc.client.HealthUtil: Get a HealthGrpc.HealthBlockingStub.
getInstanceWithoutStacktrace(String) - Static method in exception class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginException: Get an instance of ExtractionPluginException that won't print its stacktrace.
getIntegers() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.PluginRunProfile: Returns all Long integers reported in the run profile.
getPluginApiVersion() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Returns the API version of the Remote Extraction Plugin.
getTarget() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Gets the client's connection target, a String which consists of a host and port.

H

handler(ClientTrace, ClientDataContext, TraceSearcher, ReplyStream) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Returns a handler for orchestrating the processing of a trace over gRPC.
HealthUtil - Class in org.hansken.plugin.extraction.runtime.grpc.client: Health service utilities.

I

init(StreamObserver<Any>) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ReplyStream: Create a replier which communicates on a given stream.
initialBackoffMs(Duration) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.RetryPolicy: The initial wait time bound of the first retry iteration.
invokeTransformer(RpcTransformerRequest) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Invoke a transformer with a given request.
isCompatible() - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.RemoteExtractionPlugin: Checks that the API implemented by the remote plugin is compatible with the currently loaded (runtime) Extraction Plugin SDK version.
isCompatible() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient

M

markDataAvailable(SearchTrace) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginDataReader: Mark the dataTypes of the provided trace as available.
maxAttempts(int) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.RetryPolicy: Set the maximum total attempts trying to connect.
maxBackOff(Duration) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.RetryPolicy: The maximum wait time bound for any iteration.

N

name() - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace: Get the name of the ClientTrace.
newChild(String) - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace: See Trace.newChild(String, ThrowingConsumer), but returns the new child trace.
newChild(String, ThrowingConsumer<Trace, IOException>) - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace: Implementation which by default throws an exception.

O

of(RpcProfile) - Static method in class org.hansken.plugin.extraction.runtime.grpc.client.PluginRunProfile: Constructs a PluginRunProfile from a RpcProfile.
onCompleted() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ProtocolHandler
onCompleted() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ReplyStream: Signal normal completion of the stream.
onError(Throwable) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ProtocolHandler: Callable that processes errors.
onError(Throwable) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ReplyStream: Signal erroneous completion of the stream.
onNext(Any) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ProtocolHandler
org.hansken.plugin.extraction.runtime.grpc.client - package org.hansken.plugin.extraction.runtime.grpc.client
org.hansken.plugin.extraction.runtime.grpc.client.api - package org.hansken.plugin.extraction.runtime.grpc.client.api

P

pluginInfo() - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient
PluginRunProfile - Class in org.hansken.plugin.extraction.runtime.grpc.client: A plugin profile report from the plugin perspective.
process(ClientTrace, ClientDataContext) - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.RemoteExtractionPlugin: See ExtractionPlugin.process(Trace, DataContext), but requires a special type of Trace.
process(ClientTrace, ClientDataContext) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient
processDeferred(ClientTrace, ClientDataContext, TraceSearcher) - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.RemoteExtractionPlugin: See ExtractionPlugin.process(Trace, DataContext), but requires a special type of Trace.
processDeferred(ClientTrace, ClientDataContext, TraceSearcher) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient
profile() - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace: Returns the PluginRunProfile returned by the plugin.
profile(PluginRunProfile) - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace: Set the PluginRunProfile at the end of an extraction.
ProtocolHandler - Class in org.hansken.plugin.extraction.runtime.grpc.client: Handler for orchestrating the processing of a trace over gRPC, which itself is an observer for a stream in order to receive messages from the server.
ProtocolHandler(ReplyStream, ExtractionPluginGrpcAdapter) - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ProtocolHandler: Initialize a handler for processing a trace over gRPC.

R

read(String, String, long, int) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginDataReader: Read count bytes of data starting on position from dataType of traceId.
RemoteExtractionPlugin - Interface in org.hansken.plugin.extraction.runtime.grpc.client.api: ExtractionPlugin for client side implementations.
reply(Any) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ReplyStream: Send a message over the stream.
ReplyStream - Class in org.hansken.plugin.extraction.runtime.grpc.client: A helper class to be used to send messages to the server.
ReplyStream() - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.ReplyStream
RetryPolicy - Class in org.hansken.plugin.extraction.runtime.grpc.client: A configurable exponential backoff policy which can be used by an ExtractionPluginClient for trying to connect when requesting the plugin information or processing a Trace, instead of failing directly due to unavailability.
RetryPolicy() - Constructor for class org.hansken.plugin.extraction.runtime.grpc.client.RetryPolicy

S

save() - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace: Save this child trace in the backing storage.
start(Trace, DataContext) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ProtocolHandler: Sends the START message sent over the communication streams.

T

transform(TransformerLabel, Map<String, String>) - Method in interface org.hansken.plugin.extraction.runtime.grpc.client.api.RemoteExtractionPlugin: Calls a transformer method of a remote extraction plugin.
transform(TransformerLabel, Map<String, String>) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient

V

validateTransformerRequest(TransformerLabel, Map<String, TransformerArgument>) - Method in class org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient: Validates if a transformer request given a transformer label and specific arguments is correct.

W

withDefaultSettings() - Static method in class org.hansken.plugin.extraction.runtime.grpc.client.RetryPolicy: Get a default policy, which has the following parameters: maxAttempts=10, initialBackoff=250ms, maxBackOff=10s, backOffMultiplier=2.

A B C D E G H I M N O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form