Package io.micronaut.scheduling.io.watch

Class DefaultWatchThread

java.lang.Object

io.micronaut.scheduling.io.watch.DefaultWatchThread

All Implemented Interfaces:

LifeCycle<DefaultWatchThread>, Closeable, AutoCloseable

Direct Known Subclasses:

MacOsWatchThread

@Requires(property="micronaut.io.watch.paths") @Requires(property="micronaut.io.watch.enabled",value="true",defaultValue="false") @Requires(condition=FileWatchCondition.class) @Requires(notEnv={"function","android"}) @Requires(beans=java.nio.file.WatchService.class)
@Parallel
@Singleton
public class DefaultWatchThread
extends Object
implements LifeCycle<DefaultWatchThread>

Simple watch service that simply stops the server if any changes occur. It is up to an external tool to watch the server.

For example with Gradle you use ./gradlew run --continuous

Since:

1.1.0

Author:

graemerocher

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultWatchThread(ApplicationEventPublisher eventPublisher, FileWatchConfiguration configuration, WatchService watchService)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Delegates to LifeCycle.stop().
protected void	closeWatchService()	Closes the watch service.
@NonNull WatchService	getWatchService()
boolean	isRunning()
protected @NonNull WatchKey	registerPath(@NonNull Path dir)	Registers a patch to watch.
DefaultWatchThread	start()	Starts the lifecyle component.
DefaultWatchThread	stop()	Stops the life cycle component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.context.LifeCycle

refresh

Constructor Details

DefaultWatchThread

protected DefaultWatchThread(ApplicationEventPublisher eventPublisher,
 FileWatchConfiguration configuration,
 WatchService watchService)

Default constructor.

Parameters:

eventPublisher - The event publisher

configuration - the configuration

watchService - the watch service

Method Details

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle<DefaultWatchThread>

Returns:

Whether the component is running

start

@PostConstruct
public DefaultWatchThread start()

Description copied from interface: LifeCycle

Starts the lifecyle component.

Specified by:

start in interface LifeCycle<DefaultWatchThread>

Returns:

This lifecycle component

stop

public DefaultWatchThread stop()

Description copied from interface: LifeCycle

Stops the life cycle component.

Specified by:

stop in interface LifeCycle<DefaultWatchThread>

Returns:

This lifecycle component

close

@PreDestroy
public void close()

Description copied from interface: LifeCycle

Delegates to LifeCycle.stop().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface LifeCycle<DefaultWatchThread>

getWatchService

@NonNull
public @NonNull WatchService getWatchService()

Returns:

The watch service used.

closeWatchService

protected void closeWatchService()

Closes the watch service.

registerPath

@NonNull
protected @NonNull WatchKey registerPath(@NonNull
 @NonNull Path dir)
                                  throws IOException

Registers a patch to watch.

Parameters:

dir - The directory to watch

Returns:

The watch key

Throws:

IOException - if an error occurs.