Package berlin.yuna.natsserver.embedded.annotation

Annotation Type EnableNatsServer

@Retention(RUNTIME)
@Target(TYPE)
@Documented
@Inherited
public @interface EnableNatsServer

Annotation that can be specified on a test class that runs Nats based tests. Provides the following features over and above the regular Spring TestContext Framework:

• Registers a NatsServer bean with the NatsServer bean name.

The typical usage of this annotation is like:

 @SpringBootTest
 @EnableNatsServer
 public class MyNatsTests {

    @Autowired
    private NatsServer natsServer;

 }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	config	Passes the original parameters to NatsServer#setConfig(String...) for startup NatsConfig
int	port	Passes port number to NatsServer#setConfig(String...)
boolean	randomPort	Random port
long	timeoutMs	Defines the startup and teardown timeout

Element Detail

port

int port

Passes port number to NatsServer#setConfig(String...)

Default:

4222

timeoutMs

long timeoutMs

Defines the startup and teardown timeout

Default:

10000L

randomPort

boolean randomPort

Random port

Default:

false

config

String[] config

Passes the original parameters to NatsServer#setConfig(String...) for startup NatsConfig

Default:

{}