Package org.apache.juneau.rest.config

Interface BasicUniversalConfig

All Superinterfaces:

DefaultConfig, DefaultHtmlConfig

All Known Implementing Classes:

AtomFeedResource, BasicRestObject, BasicRestObjectGroup, BasicRestServlet, BasicRestServletGroup, BasicSpringRestServlet, BasicSpringRestServletGroup, ConfigResource, DirectoryResource, DtoExamples, HelloWorldResource, HtmlBeansResource, JsonSchemaResource, LogsResource, PhotosResource, RequestEchoResource, RootResources, RrpcServlet, SampleRootResource, ShutdownResource, UtilityBeansResource

public interface BasicUniversalConfig
extends DefaultConfig, DefaultHtmlConfig

Predefined configuration for a REST resource that supports all languages and provides common default configuration values.

Default settings defined:

• Rest:
  • serializers:
    • HtmlDocSerializer
    • HtmlStrippedDocSerializer
    • HtmlSchemaDocSerializer
    • JsonSerializer
    • Json5Serializer
    • JsonSchemaSerializer
    • XmlDocSerializer
    • UonSerializer
    • UrlEncodingSerializer
    • OpenApiSerializer
    • MsgPackSerializer
    • SoapXmlSerializer
    • PlainTextSerializer
  • parsers:
    • JsonParser
    • Json5Parser
    • XmlParser
    • HtmlParser
    • UonParser
    • UrlEncodingParser
    • OpenApiParser
    • MsgPackParser
    • PlainTextParser
  • config: "$S{juneau.configFile,SYSTEM_DEFAULT}"
• BeanConfig:
  • ignoreUnknownBeanProperties: "true"
• SerializerConfig:
  • uriResolution: "ROOT_RELATIVE"
• HtmlDocConfig:
  • header: "<h1>$RS{title}</h1><h2>$RS{operationSummary,description}</h2>$C{REST/header}"
  • navlinks: "up: request:/.."
  • stylesheet: "$C{REST/theme,servlet:/htdocs/themes/devops.css}"
  • head: "$C{REST/head}"
  • footer: "$C{REST/footer}"
  • nowrap: "true"

This annotation can be applied to REST resource classes to define common default configurations:

// Used on a top-level resource. @Rest public class MyResource extends RestServlet implements BasicUniversalConfig { ... }

// Used on a child resource. @Rest public class MyResource extends RestObject implements BasicUniversalConfig { ... }

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.

See Also:

• BasicRestServlet
• BasicRestServletGroup
• BasicRestObject
• BasicRestObjectGroup
• @Rest-Annotated Classes