| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>BasicJsonConfig (Apache Juneau 9.0.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BasicJsonConfig (Apache Juneau 9.0.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/juneau/rest/config/BasicJsonHtmlConfig.html" title="interface in org.apache.juneau.rest.config"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juneau/rest/config/BasicJsonConfig.html" target="_top">Frames</a></li> |
| <li><a href="BasicJsonConfig.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.juneau.rest.config</div> |
| <h2 title="Interface BasicJsonConfig" class="title">Interface BasicJsonConfig</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/juneau/rest/config/DefaultConfig.html" title="interface in org.apache.juneau.rest.config">DefaultConfig</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/juneau/examples/rest/dto/AtomFeedResource.html" title="class in org.apache.juneau.examples.rest.dto">AtomFeedResource</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html" title="class in org.apache.juneau.rest.servlet">BasicRestObject</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObjectGroup.html" title="class in org.apache.juneau.rest.servlet">BasicRestObjectGroup</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html" title="class in org.apache.juneau.rest.servlet">BasicRestServlet</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServletGroup.html" title="class in org.apache.juneau.rest.servlet">BasicRestServletGroup</a>, <a href="../../../../../org/apache/juneau/rest/springboot/BasicSpringRestServlet.html" title="class in org.apache.juneau.rest.springboot">BasicSpringRestServlet</a>, <a href="../../../../../org/apache/juneau/rest/springboot/BasicSpringRestServletGroup.html" title="class in org.apache.juneau.rest.springboot">BasicSpringRestServletGroup</a>, <a href="../../../../../org/apache/juneau/microservice/resources/ConfigResource.html" title="class in org.apache.juneau.microservice.resources">ConfigResource</a>, <a href="../../../../../org/apache/juneau/microservice/jetty/resources/DebugResource.html" title="class in org.apache.juneau.microservice.jetty.resources">DebugResource</a>, <a href="../../../../../org/apache/juneau/microservice/resources/DirectoryResource.html" title="class in org.apache.juneau.microservice.resources">DirectoryResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/dto/DtoExamples.html" title="class in org.apache.juneau.examples.rest.dto">DtoExamples</a>, <a href="../../../../../org/apache/juneau/microservice/jetty/template/HelloWorldResource.html" title="class in org.apache.juneau.microservice.jetty.template">HelloWorldResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/HelloWorldResource.html" title="class in org.apache.juneau.examples.rest">HelloWorldResource</a>, <a href="../../../../../org/apache/juneau/microservice/springboot/template/HelloWorldResource.html" title="class in org.apache.juneau.microservice.springboot.template">HelloWorldResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/springboot/HelloWorldResource.html" title="class in org.apache.juneau.examples.rest.springboot">HelloWorldResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/HtmlBeansResource.html" title="class in org.apache.juneau.examples.rest">HtmlBeansResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/dto/JsonSchemaResource.html" title="class in org.apache.juneau.examples.rest.dto">JsonSchemaResource</a>, <a href="../../../../../org/apache/juneau/microservice/resources/LogsResource.html" title="class in org.apache.juneau.microservice.resources">LogsResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/PhotosResource.html" title="class in org.apache.juneau.examples.rest">PhotosResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/RequestEchoResource.html" title="class in org.apache.juneau.examples.rest">RequestEchoResource</a>, <a href="../../../../../org/apache/juneau/microservice/jetty/template/RootResources.html" title="class in org.apache.juneau.microservice.jetty.template">RootResources</a>, <a href="../../../../../org/apache/juneau/examples/rest/RootResources.html" title="class in org.apache.juneau.examples.rest">RootResources</a>, <a href="../../../../../org/apache/juneau/microservice/springboot/template/RootResources.html" title="class in org.apache.juneau.microservice.springboot.template">RootResources</a>, <a href="../../../../../org/apache/juneau/examples/rest/springboot/RootResources.html" title="class in org.apache.juneau.examples.rest.springboot">RootResources</a>, <a href="../../../../../org/apache/juneau/rest/remote/RrpcServlet.html" title="class in org.apache.juneau.rest.remote">RrpcServlet</a>, <a href="../../../../../org/apache/juneau/microservice/resources/SampleRootResource.html" title="class in org.apache.juneau.microservice.resources">SampleRootResource</a>, <a href="../../../../../org/apache/juneau/microservice/resources/ShutdownResource.html" title="class in org.apache.juneau.microservice.resources">ShutdownResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/UtilityBeansResource.html" title="class in org.apache.juneau.examples.rest">UtilityBeansResource</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/juneau/rest/config/BasicJsonConfig.html#line.98">BasicJsonConfig</a> |
| extends <a href="../../../../../org/apache/juneau/rest/config/DefaultConfig.html" title="interface in org.apache.juneau.rest.config">DefaultConfig</a></pre> |
| <div class="block">Basic configuration for a REST resource that supports JSON transport. |
| |
| <p> |
| Default settings defined: |
| </p> |
| <ul class='spaced-list'> |
| <li class='ja'><a href="../../../../../org/apache/juneau/rest/annotation/Rest.html" title="annotation in org.apache.juneau.rest.annotation"><code>Rest</code></a>: |
| <ul> |
| <li class='jma'><a href="../../../../../org/apache/juneau/rest/annotation/Rest.html#serializers--"><code>serializers</code></a>: |
| <ul class='javatree'> |
| <li class='jc'><a href="../../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a> |
| <li class='jc'><a href="../../../../../org/apache/juneau/json/SimpleJsonSerializer.html" title="class in org.apache.juneau.json"><code>SimpleJsonSerializer</code></a> |
| </ul> |
| </li> |
| <li class='jma'><a href="../../../../../org/apache/juneau/rest/annotation/Rest.html#parsers--"><code>parsers</code></a>: |
| <ul class='javatree'> |
| <li class='jc'><a href="../../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json"><code>JsonParser</code></a> |
| <li class='jc'><a href="../../../../../org/apache/juneau/json/SimpleJsonParser.html" title="class in org.apache.juneau.json"><code>SimpleJsonParser</code></a> |
| </ul> |
| </li> |
| <li class='jma'><a href="../../../../../org/apache/juneau/rest/annotation/Rest.html#defaultAccept--"><code>defaultAccept</code></a>: <js>"text/json"</js> |
| <li class='jma'><a href="../../../../../org/apache/juneau/rest/annotation/Rest.html#config--"><code>config</code></a>: <js>"$S{juneau.configFile,SYSTEM_DEFAULT}"</js> |
| </ul> |
| </li> |
| <li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html" title="annotation in org.apache.juneau.annotation"><code>BeanConfig</code></a>: |
| <ul> |
| <li class='jma'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#ignoreUnknownBeanProperties--"><code>ignoreUnknownBeanProperties</code></a>: <js>"true"</js> |
| </ul> |
| </li> |
| <li class='ja'><a href="../../../../../org/apache/juneau/serializer/annotation/SerializerConfig.html" title="annotation in org.apache.juneau.serializer.annotation"><code>SerializerConfig</code></a>: |
| <ul> |
| <li class='jma'><a href="../../../../../org/apache/juneau/serializer/annotation/SerializerConfig.html#uriResolution--"><code>uriResolution</code></a>: <js>"ROOT_RELATIVE"</js> |
| </ul> |
| </li> |
| </ul> |
| |
| <p> |
| This annotation can be applied to REST resource classes to define common JSON default configurations: |
| </p> |
| <p class='bjava'> |
| <jc>// Used on a top-level resource.</jc> |
| <ja>@Rest</ja> |
| <jk>public class</jk> MyResource <jk>extends</jk> RestServlet <jk>implements</jk> BasicJsonConfig { ... } |
| </p> |
| <p class='bjava'> |
| <jc>// Used on a child resource.</jc> |
| <ja>@Rest</ja> |
| <jk>public class</jk> MyResource <jk>extends</jk> RestObject <jk>implements</jk> BasicJsonConfig { ... } |
| </p> |
| |
| <p> |
| Note that the framework will aggregate annotations defined on all classes in the class hierarchy with |
| values defined on child classes overriding values defined on parent classes. That allows any values defined |
| on this interface to be overridden by annotations defined on the implemented class. |
| </p> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.jrs.AnnotatedClasses'>Overview > juneau-rest-server > @Rest-Annotated Classes</a> |
| <li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/config/BasicJsonConfig.java'>Source</a> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/juneau/rest/config/BasicJsonHtmlConfig.html" title="interface in org.apache.juneau.rest.config"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juneau/rest/config/BasicJsonConfig.html" target="_top">Frames</a></li> |
| <li><a href="BasicJsonConfig.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
