@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.
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
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.
When property has "false" value
You might be interested in my other post on Spring boot Retry example.
https://www.thetechnojournals.com/2020/02/spring-boot-retry-tutorial.html
- 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"}.
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 Value | havingValue="" | havingValue="true" | havingValue="false" | havingValue="foo" |
---|---|---|---|---|
"true" | yes | yes | no | no |
"false" | no | no | yes | no |
"foo" | yes | no | no | yes |
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
Excellent post, thanks for this. I gathered lots of information from this and I am happy about it. Do share more updates.
ReplyDeletePHP Training in Chennai
Best PHP Training Institute in Chennai
PHP Institute in Chennai
Angular Training in Chennai
Web Designing Training in Chennai
Salesforce Training in Chennai
Tally course in Chennai
Machine Learning course in Chennai
Salesforce course in Chennai
PHP and MYSQL Interview Questions
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.
ReplyDeleteThanks for sharing such a good and informative content to all of us
ReplyDeleteMicroservices Online Training
Microservices Training in Hyderabad
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!!
ReplyDeletelive
สตีฟ บรูซ ได้รับรางวัลผู้จัดการทีมยอดเยี่ยม พรีเมียร์ลีก ประจำเดือนเมษายน ผู้จัดการทีม นิวคาสเซิล ยูไนเต็ด นำทีมของเขาเก็บไปได้ 8 แต้มจากการแข่งขันทั้ง 4 นัดโดยไม่เลยแม้แต่เกมเดียวช่วยให้ทีมของเขาการันตีการอยู่รอดบนลีกสูงสุดไปต่อได้อีกฤดูกาล เดอะ แม็กพายส์ ตามตีเสมอ...ufa
ReplyDeleteAfter hiring, they undergo fresh top security companies in London
ReplyDeletetraining 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.
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.
ReplyDeleteIt 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.
ReplyDeletegreat post, keep posting Spoken English Classes In Pune
ReplyDeleteNice 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.
ReplyDeleteFor more info visit Article Submission Sites list