Module io.helidon.microprofile.grpc.client

Package io.helidon.microprofile.grpc.client

Class GrpcChannelsProvider

java.lang.Object

io.helidon.microprofile.grpc.client.GrpcChannelsProvider

public class GrpcChannelsProvider
extends Object

GrpcChannelsProvider is a factory for pre-configured gRPC Channel instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GrpcChannelsProvider.Builder	Builder builds an instance of GrpcChannelsProvider.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHANNEL_NAME	A constant for holding the default channel configuration name (which is "default").
static final String	DEFAULT_HOST	A constant for holding the default host name (which is "localhost").
static final int	DEFAULT_PORT	A constant for holding the default port (which is "1408").

Method Summary

Modifier and Type	Method	Description
static GrpcChannelsProvider.Builder	builder()	Create a new GrpcChannelsProvider.Builder.
static GrpcChannelsProvider.Builder	builder(Config config)	Create a new GrpcChannelsProvider.Builder.
io.grpc.Channel	channel(String name)	Returns a Channel for the specified channel or host name.
static GrpcChannelsProvider	create()	Builds a new instance of GrpcChannelsProvider using default configuration.
static GrpcChannelsProvider	create(Config config)	Creates a GrpcChannelsProvider using the specified configuration.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CHANNEL_NAME

public static final String DEFAULT_CHANNEL_NAME

A constant for holding the default channel configuration name (which is "default").

See Also:

• Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

A constant for holding the default host name (which is "localhost").

See Also:

• Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

A constant for holding the default port (which is "1408").

See Also:

• Constant Field Values

Method Details

create

public static GrpcChannelsProvider create()

Builds a new instance of GrpcChannelsProvider using default configuration. The default configuration connects to "localhost:1408" without TLS.

Returns:

a new instance of GrpcChannelsProvider

create

public static GrpcChannelsProvider create(Config config)

Creates a GrpcChannelsProvider using the specified configuration.

Parameters:

config - The externalized configuration.

Returns:

a new instance of GrpcChannelsProvider

builder

public static GrpcChannelsProvider.Builder builder()

Create a new GrpcChannelsProvider.Builder.

Returns:

a new GrpcChannelsProvider.Builder

builder

public static GrpcChannelsProvider.Builder builder(Config config)

Create a new GrpcChannelsProvider.Builder.

Parameters:

config - the Config to bootstrap from

Returns:

a new GrpcChannelsProvider.Builder

channel

public io.grpc.Channel channel(String name)

Returns a Channel for the specified channel or host name.

If the specified channel name does not exist in the configuration, we will assume that it represents the name of the gRPC host to connect to and will create a plain text channel to the host with the specified name, on a default port (1408).

Parameters:

name - the name of the channel configuration as specified in the configuration file, or the name of the host to connect to

Returns:

a new instance of Channel

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name is empty