Package org.creekservice.api.system.test.gradle.plugin

Class DebugExtension

java.lang.Object

org.creekservice.api.system.test.gradle.plugin.DebugExtension

public abstract class DebugExtension
extends Object

Extension for configuring information about debugging.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_ATTACH_ME_PORT	The default attachMe port that the IntelliJ attachMe plugin uses.
static final int	DEFAULT_BASE_DEBUG_PORT	The start of the default range of ports on the local machine that services will listen on for the debugger.

Constructor Summary

Constructors

Constructor	Description
DebugExtension()

Method Summary

Modifier and Type	Method	Description
abstract org.gradle.api.provider.Property<Integer>	getAttachMePort()	The port on which the attachMe plugin is listening on.
abstract org.gradle.api.provider.Property<Integer>	getBaseServicePort()	The base debug port.
abstract org.gradle.api.provider.SetProperty<String>	getServiceInstanceNames()	The set of service instances to be debugged.
abstract org.gradle.api.provider.SetProperty<String>	getServiceNames()	The set of services to be debugged.
void	serviceInstanceNames(String... names)	Set service names to debug
void	serviceNames(String... names)	Set service names to debug

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ATTACH_ME_PORT

public static final int DEFAULT_ATTACH_ME_PORT

The default attachMe port that the IntelliJ attachMe plugin uses.

See Also:

• Constant Field Values

DEFAULT_BASE_DEBUG_PORT

public static final int DEFAULT_BASE_DEBUG_PORT

The start of the default range of ports on the local machine that services will listen on for the debugger.

See Also:

• Constant Field Values

Constructor Details

DebugExtension

public DebugExtension()

Method Details

getAttachMePort

public abstract org.gradle.api.provider.Property<Integer> getAttachMePort()

The port on which the attachMe plugin is listening on.

This is the port the attachMe agent running within the microservice's process will call out on to ask the debugger to attach.

Returns:

the port the attachMe plugin is listening on.

getBaseServicePort

public abstract org.gradle.api.provider.Property<Integer> getBaseServicePort()

The base debug port.

The port the first service being debugged will listen on for the debugger to attach. Subsequent services being debugged will use sequential port numbers.

Returns:

the base port number used for debugging.

getServiceNames

public abstract org.gradle.api.provider.SetProperty<String> getServiceNames()

The set of services to be debugged.

Returns:

set of services to debug.

serviceNames

public void serviceNames(String... names)

Set service names to debug

Parameters:

names - the service names to debug

getServiceInstanceNames

public abstract org.gradle.api.provider.SetProperty<String> getServiceInstanceNames()

The set of service instances to be debugged.

An instance name is the name of the service with a dash and the instance number appended, e.g. my-service-1.

Returns:

set of service instances to debug.

serviceInstanceNames

public void serviceInstanceNames(String... names)

Set service names to debug

Parameters:

names - the service instance names to debug