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

  1. Thanks for suggesting good list. I appreciate your work this is really helpful for everyone. Get more information at For Sale By Owner in ACT. Keep posting such useful information.

    ReplyDelete
  2. A charming conversation is worth remark. I believe that you should distribute more on this topic, it probably won't be an untouchable issue yet for the most part individuals don't examine these issues. To the following! Kind respects!!
    live

    ReplyDelete
  3. สตีฟ บรูซ ได้รับรางวัลผู้จัดการทีมยอดเยี่ยม พรีเมียร์ลีก ประจำเดือนเมษายน ผู้จัดการทีม นิวคาสเซิล ยูไนเต็ด นำทีมของเขาเก็บไปได้ 8 แต้มจากการแข่งขันทั้ง 4 นัดโดยไม่เลยแม้แต่เกมเดียวช่วยให้ทีมของเขาการันตีการอยู่รอดบนลีกสูงสุดไปต่อได้อีกฤดูกาล เดอะ แม็กพายส์ ตามตีเสมอ...ufa

    ReplyDelete
  4. After hiring, they undergo fresh top security companies in London
    training so they can know how to protect our high- profile clients like eminent sports personalities, celebrities, industrialists, or any other person exposed to a security threat.

    ReplyDelete
  5. I generally check this kind of article and I found your article which is related to my interest. Genuinely, it is good and instructive information aboutproperty valuation companies Thanks for sharing an amazing article here.

    ReplyDelete
  6. It is a proficient article that you have shared here.House painters in Bakersfield, CA I got some different kind of information from your article which I will be sharing with my friends who need this info. Thankful to you for sharing an article like this.

    ReplyDelete
  7. Nice blog! Actually, I am getting more information to read your great post. Thank you. Discover the ultimate resource for Article Submission Sites! Edtech Reader presents a meticulously curated list of high DA PA Article Submission Sites that can turbocharge your content marketing efforts.
    For more info visit Article Submission Sites list

    ReplyDelete
  8. APTRON, the leading Java Training Institute in Gurgaon, stands as a beacon of excellence in the realm of technology education. With a steadfast commitment to nurturing future Java developers, APTRON goes beyond conventional training, offering an immersive and hands-on learning experience.

    ReplyDelete

Post a Comment

Popular Posts

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&

Multiple data source with Spring boot, batch and cloud task

Here we will see how we can configure different datasource for application and batch. By default, Spring batch stores the job details and execution details in database. If separate data source is not configured for spring batch then it will use the available data source in your application if configured and create batch related tables there. Which may be the unwanted burden on application database and we would like to configure separate database for spring batch. To overcome this situation we will configure the different datasource for spring batch using in-memory database, since we don't want to store batch job details permanently. Other thing is the configuration of  spring cloud task in case of multiple datasource and it must point to the same data source which is pointed by spring batch. In below sections, we will se how to configure application, batch and cloud task related data sources. Application Data Source Define the data source in application properties or yml con

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