berlin.yuna.natsserver.embedded.annotation

Annotation Type EnableNatsServer

@Retention(value=RUNTIME)
 @Target(value=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:

 @org.springframework.boot.test.context.SpringBootTest
 @EnableNatsServer
 public class MyNatsTests {

    @org.springframework.beans.factory.annotation.Autowired
    private NatsServer natsServer;

 }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	binaryFile File to nats server binary so no download will be needed
String[]	config Passes the original parameters to Nats.config(String...) for startup NatsConfig
String	configFile Config file
String	downloadUrl Custom download URL
int	port Sets nats port -1 means random port
long	timeoutMs Defines the startup and teardown timeout

Element Detail

port

public abstract int port

Sets nats port -1 means random port

Default:

4222

timeoutMs

public abstract long timeoutMs

Defines the startup and teardown timeout

Default:

10000L

configFile

public abstract String configFile

Config file

Default:

""

downloadUrl

public abstract String downloadUrl

Custom download URL

Default:

""

binaryFile

public abstract String binaryFile

File to nats server binary so no download will be needed

Default:

""

config

public abstract String[] config

Passes the original parameters to Nats.config(String...) for startup NatsConfig

Default:

{}