Skip to main content

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check.
  • havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false.
  • matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment.
  • name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "property.name" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"}
  • prefix - It can be use when you want to apply some prefix to all properties. For example in case of above properties we can mention like (prefix="prop", name={"name1","name2"}.
Below are some cases for the property value checks which I copied from Spring java documentation.
The havingValue attribute can be used to specify the value that the property should have. The table below shows when a condition matches according to the property value and the havingValue() attribute: Having values
Property ValuehavingValue=""havingValue="true"havingValue="false"havingValue="foo"
"true"yesyesnono
"false"nonoyesno
"foo"yesnonoyes

Here we will learn how to enable disable JAX-RS service basis on a property value, like enable JAX-RS service registration when that property is having true value. If property has false value then JAX-RS service registration will not happen and those REST resources will not be accessible even though our service class is present.

application.properties

Add below key/value pair to this property file.
jaxrs.enabled=false

AppConfig.java

This is our spring configuration class. Here we are creating a bean to register the JAX-RS services where we have put the @ConditionalOnProperty annotation to check the specified property and if this property is not available then Spring will not create the bean itself.
@Configuration
public class AppConfig{

    @Bean
    @ConditionalOnProperty(name="jaxrs.enabled", havingValue="true")
    public ResourceConfig jaxrsResourceConfig(){
        return new ResourceConfig().packages("com.ttj.demo.rest");
    }
}

HelloServiceClient.java

This client code will execute once application is up and ready to serve. It will test the endpoints which should be publish by our JAX-RS rest service.
@Component
public class HelloServiceClient {
    //this annotation guarantees the invocation of this method 
    //once the spring boot application is up and running 
    @EventListener(ApplicationReadyEvent.class)
    public void clientHello() throws IOException {
        Client client = ClientBuilder.newClient();
        
        Response resp = client.target("http://localhost:8080/jaxrs/")
                .path("hello")
                .path("Test user")
                .request(MediaType.APPLICATION_JSON)
                .get();
        
        StatusType status = resp.getStatusInfo();
        
        System.out.println("Response status code: "+status.getStatusCode());
        System.out.println("Response status: "+status.getReasonPhrase());
        System.out.println(resp.readEntity(String.class));
    }
}

Output:

Below is the output for two scenarios when property is true and then when it is false.
When property has "false" value
Response status code: 404
Response status: Not Found
Response: {"timestamp":"2019-11-10T04:26:17.011+0000","status":404,"error":"Not Found","message":"No message available","path":"/jaxrs/hello/Test%20user"}
When property has "true" value
Response status code: 200
Response status: OK
Response: Hello Test user

You might be interested in my other post on Spring boot Retry example.
https://www.thetechnojournals.com/2020/02/spring-boot-retry-tutorial.html

Comments

Popular Posts

Asynchronous REST service implementation in Spring boot

In this tutorial we will see how to create an asynchronous REST service endpoint using Spring boot application.
Asynchronous service works in a way that it will not block the client request and do the processing in separate thread. When work is complete the response returned to the client so our service will be able to handle more client requests at the same time, compare to synchronous processing model.
Let's understand how it is working in synchronous mode. In such server/client application at server side it has a pool of threads which are serving the request. If a request received by a thread then it will be blocked until it send the response back to client. In this case if processing doesn't take much time it will be able to process it quickly and accept other client requests but there could be one situation when all threads are busy and not able to accept the new client requests.

To overcome of such problems, asynchronous processing model introduced for REST services. In…

Entity to DTO conversion in Java using Jackson

It's very common to have the DTO class for a given entity in any application. When persisting data, we use entity objects and when we need to provide the data to end user/application we use DTO class. Due to this we may need to have similar properties on DTO class as we have in our Entity class and to share the data we populate DTO objects using entity objects. To do this we may need to call getter on entity and then setter on DTO for the same data which increases number of code line. Also if number of DTOs are high then we need to write lot of code to just get and set the values or vice-versa.
To overcome this problem we are going to use Jackson API and will see how to do it with minimal code only.
Maven dependency <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.9</version> </dependency> Entity class Below is our ent…

Web scraper using JSoup and Spring Boot

What is webscraping Webscraping is a technique to extract or pull the data from a website to gather required information by parsing the HTML source of their websites, such as articles from news or books site, products information from online shopping sites or course information from education sites. There are many organisations who uses web scraper to provide the best experience to their customers, for example extract the price for a smartphone from multiple online websites and show their customers the best and cheap product URL.
We will learn here how to code a web scraper by developing a simple new scraper service.
News scraper News scraper is used to extract the news articles or other related contents from a news site. Here we are going to create a web scraper application to pull the articles from news site.
Below are the operations provided by our news scraper service.
List all the authorsSearch articles by author nameSearch articles by article titleSearch articles by article desc…