io.micronaut.http.server.netty.configuration

Class NettyHttpServerConfiguration.NettyListenerConfiguration

java.lang.Object

io.micronaut.http.server.netty.configuration.NettyHttpServerConfiguration.NettyListenerConfiguration

Enclosing class:

NettyHttpServerConfiguration

@EachProperty(value="listeners")
public static final class NettyHttpServerConfiguration.NettyListenerConfiguration
extends Object

Netty listener configuration.

Since:

3.5.0

Author:

yawkat

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NettyHttpServerConfiguration.NettyListenerConfiguration.Family Address family enum.

Constructor Summary

Constructors

Constructor and Description
NettyListenerConfiguration()

Method Summary

Modifier and Type	Method and Description
static NettyHttpServerConfiguration.NettyListenerConfiguration	createTcp(String host, int port, boolean ssl) Create a TCP listener configuration.
NettyHttpServerConfiguration.NettyListenerConfiguration.Family	getFamily() The address family of this listener.
String	getHost() For TCP listeners, the host to bind to, or null to bind to all hosts.
String	getPath() For UNIX domain sockets, the path of the socket.
int	getPort() The TCP port to bind to.
boolean	isExposeDefaultRoutes() Whether to expose default routes on this listener.
boolean	isSsl() Whether to enable SSL on this listener.
void	setExposeDefaultRoutes(boolean exposeDefaultRoutes) Whether to expose default routes on this listener.
void	setFamily(NettyHttpServerConfiguration.NettyListenerConfiguration.Family family) The address family of this listener.
void	setHost(String host) For TCP listeners, the host to bind to, or null to bind to all hosts.
void	setPath(String path) For UNIX domain sockets, the path of the socket.
void	setPort(int port) The TCP port to bind to.
void	setSsl(boolean ssl) Whether to enable SSL on this listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyListenerConfiguration

public NettyListenerConfiguration()

Method Detail

createTcp

@Internal
public static NettyHttpServerConfiguration.NettyListenerConfiguration createTcp(@Nullable
                                                                                          String host,
                                                                                          int port,
                                                                                          boolean ssl)

Create a TCP listener configuration.

Parameters:

host - The host to bind to

port - The port to bind to

ssl - Whether to enable SSL

Returns:

The configuration with the given settings

getFamily

public NettyHttpServerConfiguration.NettyListenerConfiguration.Family getFamily()

The address family of this listener.

Returns:

The address family of this listener.

setFamily

public void setFamily(@NonNull
                      NettyHttpServerConfiguration.NettyListenerConfiguration.Family family)

The address family of this listener.

Parameters:

family - The address family of this listener.

isSsl

public boolean isSsl()

Whether to enable SSL on this listener. Also requires SslConfiguration.isEnabled() to be set.

Returns:

Whether to enable SSL on this listener.

setSsl

public void setSsl(boolean ssl)

Whether to enable SSL on this listener. Also requires SslConfiguration.isEnabled() to be set.

Parameters:

ssl - Whether to enable SSL on this listener.

getHost

@Nullable
public String getHost()

For TCP listeners, the host to bind to, or null to bind to all hosts.

Returns:

For TCP listeners, the host to bind to, or null to bind to all hosts.

setHost

public void setHost(@Nullable
                    String host)

For TCP listeners, the host to bind to, or null to bind to all hosts.

Parameters:

host - For TCP listeners, the host to bind to, or null to bind to all hosts.

getPort

public int getPort()

The TCP port to bind to. May be -1 to bind to a random port.

Returns:

The TCP port to bind to. May be -1 to bind to a random port.

setPort

public void setPort(int port)

The TCP port to bind to. May be -1 to bind to a random port.

Parameters:

port - The TCP port to bind to. May be -1 to bind to a random port.

getPath

public String getPath()

For UNIX domain sockets, the path of the socket. For abstract domain sockets, this should start with a NUL byte.

Returns:

For UNIX domain sockets, the path of the socket. For abstract domain sockets, this should start with a NUL byte.

setPath

public void setPath(String path)

For UNIX domain sockets, the path of the socket. For abstract domain sockets, this should start with a NUL byte.

Parameters:

path - For UNIX domain sockets, the path of the socket. For abstract domain sockets, this should start with a NUL byte.

isExposeDefaultRoutes

@Internal
public boolean isExposeDefaultRoutes()

Whether to expose default routes on this listener.

Returns:

Whether to expose default routes on this listener.

setExposeDefaultRoutes

@Internal
public void setExposeDefaultRoutes(boolean exposeDefaultRoutes)

Whether to expose default routes on this listener.

Parameters:

exposeDefaultRoutes - Whether to expose default routes on this listener.