dev.jacomet.gradle.plugins.logging.extension

Class LoggingCapabilitiesExtension

java.lang.Object

dev.jacomet.gradle.plugins.logging.extension.LoggingCapabilitiesExtension

public class LoggingCapabilitiesExtension
extends java.lang.Object

Project extension that enables expressing preference over potential logging capabilities conflicts.

Constructor Summary

Constructors

Constructor and Description
LoggingCapabilitiesExtension(org.gradle.api.artifacts.ConfigurationContainer configurations, org.gradle.api.artifacts.dsl.DependencyHandler dependencies)

Method Summary

Modifier and Type	Method and Description
void	enforceLog4J2() Selects log4j-slf4j-impl as the Slf4J binding and makes sure all other supported logging frameworks end up in Log4J 2 as well.
void	enforceLog4J2(java.lang.String configurationName) Selects log4j-slf4j-impl as the Slf4J binding and makes sure all other supported logging frameworks end up in Log4J 2 as well for the resolution of the given configuration.
void	enforceLogback() Selects logback as the Slf4J binding and makes sure all other supported logging frameworks end up in logback as well.
void	enforceLogback(java.lang.String configurationName) Selects logback as the Slf4J binding and makes sure all other supported logging frameworks end up in logback as well for the resolution of the given configuration.
void	enforceSlf4JSimple() Selects slf4j-simple as the Slf4J binding and makes sure all other supported logging frameworks end up in it as well.
void	enforceSlf4JSimple(java.lang.String configurationName) Selects slf4j-simple as the Slf4J binding and makes sure all other supported logging frameworks end up in it as well for the resolution of the given configuration.
void	selectJCLImplementation(java.lang.Object dependencyNotation) Selects the provided module as the commons-logging implementation to use.
void	selectJCLImplementation(java.lang.String configurationName, java.lang.Object dependencyNotation) Selects the provided module as the commons-logging implementation to use for the resolution of the given configuration.
void	selectJulDelegation(java.lang.Object dependencyNotation) Selects the provided module as the java util logging delegation to use.
void	selectJulDelegation(java.lang.String configurationName, java.lang.Object dependencyNotation) Selects the provided module as the java util logging delegation to use for the resolution of the given configuration.
void	selectLog4J12Implementation(java.lang.Object dependencyNotation) Selects the provided module as the Log4J 1.2 implementation to use.
void	selectLog4J12Implementation(java.lang.String configurationName, java.lang.Object dependencyNotation) Selects the provided module as the Log4J 1.2 implementation to use for the resolution of the given configuration.
void	selectSlf4JBinding(java.lang.Object dependencyNotation) Selects the provided module as the Slf4J binding to use.
void	selectSlf4JBinding(java.lang.String configurationName, java.lang.Object dependencyNotation) Selects the provided module as the Slf4J binding to use for the resolution of the given configuration.
void	selectSlf4JLog4J2Interaction(java.lang.Object dependencyNotation) Selects the provided module as the Slf4J / Log4J 2 interaction to use.
void	selectSlf4JLog4J2Interaction(java.lang.String configurationName, java.lang.Object dependencyNotation) Selects the provided module as the Slf4J / Log4J 2 interaction to use for the resolution of the given configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingCapabilitiesExtension

public LoggingCapabilitiesExtension(org.gradle.api.artifacts.ConfigurationContainer configurations,
                                    org.gradle.api.artifacts.dsl.DependencyHandler dependencies)

Method Detail

selectSlf4JBinding

public void selectSlf4JBinding(java.lang.Object dependencyNotation)

Selects the provided module as the Slf4J binding to use.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

dependencyNotation - the Slf4J binding module as a dependency or group:name:version notation

selectSlf4JBinding

public void selectSlf4JBinding(java.lang.String configurationName,
                               java.lang.Object dependencyNotation)

Selects the provided module as the Slf4J binding to use for the resolution of the given configuration.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

configurationName - the configuration to be setup

dependencyNotation - the Slf4J binding module as a dependency or group:name:version notation

selectLog4J12Implementation

public void selectLog4J12Implementation(java.lang.Object dependencyNotation)

Selects the provided module as the Log4J 1.2 implementation to use.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

dependencyNotation - the Log4J 1.2 implementation module as a dependency or group:name:version notation

selectLog4J12Implementation

public void selectLog4J12Implementation(java.lang.String configurationName,
                                        java.lang.Object dependencyNotation)

Selects the provided module as the Log4J 1.2 implementation to use for the resolution of the given configuration.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

configurationName - the configuration to be setup

dependencyNotation - the Log4J 1.2 implementation module as a dependency or group:name:version notation

selectJulDelegation

public void selectJulDelegation(java.lang.Object dependencyNotation)

Selects the provided module as the java util logging delegation to use.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

dependencyNotation - the JUL delegation module as a dependency or group:name:version notation

selectJulDelegation

public void selectJulDelegation(java.lang.String configurationName,
                                java.lang.Object dependencyNotation)

Selects the provided module as the java util logging delegation to use for the resolution of the given configuration.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

configurationName - the configuration to be setup

dependencyNotation - the JUL delegation module as a dependency or group:name:version notation

selectJCLImplementation

public void selectJCLImplementation(java.lang.Object dependencyNotation)

Selects the provided module as the commons-logging implementation to use.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

dependencyNotation - the commons-logging implementation module as a dependency or group:name:version notation

selectJCLImplementation

public void selectJCLImplementation(java.lang.String configurationName,
                                    java.lang.Object dependencyNotation)

Selects the provided module as the commons-logging implementation to use for the resolution of the given configuration.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

configurationName - the configuration to be setup

dependencyNotation - the commons-logging implementation module as a dependency or group:name:version notation

selectSlf4JLog4J2Interaction

public void selectSlf4JLog4J2Interaction(java.lang.Object dependencyNotation)

Selects the provided module as the Slf4J / Log4J 2 interaction to use.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

dependencyNotation - the Slf4J / Log4J 2 interaction module as a dependency or group:name:version notation

selectSlf4JLog4J2Interaction

public void selectSlf4JLog4J2Interaction(java.lang.String configurationName,
                                         java.lang.Object dependencyNotation)

Selects the provided module as the Slf4J / Log4J 2 interaction to use for the resolution of the given configuration.

This also resolves all other potential conflicts with the passed in module in favor of it.

Parameters:

configurationName - the configuration to be setup

dependencyNotation - the Slf4J / Log4J 2 interaction module as a dependency or group:name:version notation

enforceLogback

public void enforceLogback()

Selects logback as the Slf4J binding and makes sure all other supported logging frameworks end up in logback as well.

While having logback as a dependency is required for this to work, substitution is used for enforcing other selections that could cause missed events in logback because there are no conflicts. For example, commons-logging and log4j-jcl will be substituted with jcl-over-slf4j.

enforceLogback

public void enforceLogback(java.lang.String configurationName)

Selects logback as the Slf4J binding and makes sure all other supported logging frameworks end up in logback as well for the resolution of the given configuration.

While having logback as a dependency is required for this to work, substitution is used for enforcing other selections that could cause missed events in logback because there are no conflicts. For example, commons-logging and log4j-jcl will be substituted with jcl-over-slf4j.

Parameters:

configurationName - the configuration to be setup

enforceSlf4JSimple

public void enforceSlf4JSimple()

Selects slf4j-simple as the Slf4J binding and makes sure all other supported logging frameworks end up in it as well.

While having slf4j-simple as a dependency is required for this to work, substitution is used for enforcing other selections that could cause missed events in slf4j-simple because there are no conflicts. For example, commons-logging and log4j-jcl will be substituted with jcl-over-slf4j.

enforceSlf4JSimple

public void enforceSlf4JSimple(java.lang.String configurationName)

Selects slf4j-simple as the Slf4J binding and makes sure all other supported logging frameworks end up in it as well for the resolution of the given configuration.

While having slf4j-simple as a dependency is required for this to work, substitution is used for enforcing other selections that could cause missed events in slf4j-simple because there are no conflicts. For example, commons-logging and log4j-jcl will be substituted with jcl-over-slf4j.

Parameters:

configurationName - the configuration to be setup

enforceLog4J2

public void enforceLog4J2()

Selects log4j-slf4j-impl as the Slf4J binding and makes sure all other supported logging frameworks end up in Log4J 2 as well.

While having log4j-slf4j-impl as a dependency is required for this to work, substitution is used for enforcing other selections that could cause missed events in Log4J 2 because there are no conflicts. For example, commons-logging and log4j will be configured to end up in Log4J 2 as well.

enforceLog4J2

public void enforceLog4J2(java.lang.String configurationName)

Selects log4j-slf4j-impl as the Slf4J binding and makes sure all other supported logging frameworks end up in Log4J 2 as well for the resolution of the given configuration.

While having log4j-slf4j-impl as a dependency is required for this to work, substitution is used for enforcing other selections that could cause missed events in Log4J 2 because there are no conflicts. For example, commons-logging and log4j will be configured to end up in Log4J 2 as well.

Parameters:

configurationName - the configuration to be setup