From commits-return-4788-archive-asf-public=cust-asf.ponee.io@juneau.apache.org Sun Jan 7 20:32:47 2018 Return-Path: X-Original-To: archive-asf-public@eu.ponee.io Delivered-To: archive-asf-public@eu.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by mx-eu-01.ponee.io (Postfix) with ESMTP id AF3FA180654 for ; Sun, 7 Jan 2018 20:32:47 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 9ECF5160C2A; Sun, 7 Jan 2018 19:32:47 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id C4CD3160C14 for ; Sun, 7 Jan 2018 20:32:45 +0100 (CET) Received: (qmail 70590 invoked by uid 500); 7 Jan 2018 19:32:44 -0000 Mailing-List: contact commits-help@juneau.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@juneau.apache.org Delivered-To: mailing list commits@juneau.apache.org Received: (qmail 70581 invoked by uid 99); 7 Jan 2018 19:32:44 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 07 Jan 2018 19:32:44 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 3BA06C0508 for ; Sun, 7 Jan 2018 19:32:44 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -4.231 X-Spam-Level: X-Spam-Status: No, score=-4.231 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id 8LwsOn9zu87C for ; Sun, 7 Jan 2018 19:32:40 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id C934E5F635 for ; Sun, 7 Jan 2018 19:32:39 +0000 (UTC) Received: (qmail 70564 invoked by uid 99); 7 Jan 2018 19:32:33 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 07 Jan 2018 19:32:33 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id DEE2ADFCB5; Sun, 7 Jan 2018 19:32:32 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: jamesbognar@apache.org To: commits@juneau.incubator.apache.org Date: Sun, 07 Jan 2018 19:32:32 -0000 Message-Id: <5681b407e95c42dea73bd975d5bb4820@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [1/2] juneau git commit: Clean up javadocs. Repository: juneau Updated Branches: refs/heads/master 34c9be07d -> db1bfb1da http://git-wip-us.apache.org/repos/asf/juneau/blob/db1bfb1d/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java ---------------------------------------------------------------------- diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java index 283c2d6..3822053 100644 --- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java +++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java @@ -71,6 +71,14 @@ public final class RestContext extends BeanContext { *
  • Data type: Boolean *
  • Default: true *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#allowBodyParam()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#allowBodyParam(boolean)} + *
    * * *
    Description:
    @@ -82,15 +90,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_allowBodyParam} - *
    • Annotations: - *
        - *
      • {@link RestResource#allowBodyParam()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#allowBodyParam(boolean)} - *
      *
    • Parameter name is case-insensitive. *
    • Useful for debugging PUT and POST methods using only a browser. *
    @@ -106,6 +105,14 @@ public final class RestContext extends BeanContext { *
  • Data type: String *
  • Default: "HEAD,OPTIONS" *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#allowedMethodParams()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#allowedMethodParams(String...)} + *
    * * *
    Description:
    @@ -117,18 +124,9 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_allowedMethodParams} - *
    • Annotations: - *
        - *
      • {@link RestResource#allowedMethodParams()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#allowedMethodParams(String...)} - *
      *
    • Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter. *
    • Parameter name is case-insensitive. - *
    • Use "*" to represent all methods. + *
    • Use "*" to represent all methods. *
    * *

    @@ -147,6 +145,14 @@ public final class RestContext extends BeanContext { *

  • Data type: Boolean *
  • Default: true *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#allowHeaderParams()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#allowHeaderParams(boolean)} + *
    * * *
    Description:
    @@ -158,15 +164,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_allowHeaderParams} - *
    • Annotations: - *
        - *
      • {@link RestResource#allowHeaderParams()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#allowHeaderParams(boolean)} - *
      *
    • Parameter name is case-insensitive. *
    • Useful for debugging REST interface using only a browser. *
    @@ -182,27 +179,21 @@ public final class RestContext extends BeanContext { *
  • Data type: Class<? extends {@link RestCallHandler}> | {@link RestCallHandler} *
  • Default: {@link RestCallHandler} *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#callHandler()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#callHandler(Class)} + *
    • {@link RestContextBuilder#callHandler(RestCallHandler)} + *
    * * *
    Description:
    *

    * This class handles the basic lifecycle of an HTTP REST call. *
    Subclasses can be used to customize how these HTTP calls are handled. - - *

    - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_callHandler} - *
    • Annotations: - *
        - *
      • {@link RestResource#callHandler()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#callHandler(Class)} - *
      • {@link RestContextBuilder#callHandler(RestCallHandler)} - *
      - *
    */ public static final String REST_callHandler = PREFIX + "callHandler.o"; @@ -215,6 +206,16 @@ public final class RestContext extends BeanContext { *
  • Data type: List<Class | Object | {@link RestChild}> *
  • Default: empty list *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#children()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#child(String,Object)} + *
    • {@link RestContextBuilder#children(Class...)} + *
    • {@link RestContextBuilder#children(Object...)} + *
    * * *
    Description:
    @@ -262,17 +263,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_children} - *
    • Annotations: - *
        - *
      • {@link RestResource#children()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#child(String,Object)} - *
      • {@link RestContextBuilder#children(Class...)} - *
      • {@link RestContextBuilder#children(Object...)} - *
      *
    • When defined as classes, instances are resolved using the registered {@link #REST_resourceResolver} which * by default is {@link RestResourceResolverSimple} which requires the class have one of the following * constructors: @@ -281,6 +271,11 @@ public final class RestContext extends BeanContext { *
    • public T() *
    * + * + *
    Documentation:
    + * */ public static final String REST_children = PREFIX + "children.lo"; @@ -293,6 +288,15 @@ public final class RestContext extends BeanContext { *
  • Data type: {@link ClasspathResourceFinder} *
  • Default: {@link ClasspathResourceFinderBasic} *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#classpathResourceFinder()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#classpathResourceFinder(Class)} + *
    • {@link RestContextBuilder#classpathResourceFinder(ClasspathResourceFinder)} + *
    * * *
    Description:
    @@ -301,16 +305,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_classpathResourceFinder} - *
    • Annotations: - *
        - *
      • {@link RestResource#classpathResourceFinder()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#classpathResourceFinder(Class)} - *
      • {@link RestContextBuilder#classpathResourceFinder(ClasspathResourceFinder)} - *
      *
    • * The default value is {@link ClasspathResourceFinderBasic} which provides basic support for finding localized * resources on the classpath and JVM working directory. @@ -330,6 +324,14 @@ public final class RestContext extends BeanContext { *
    • Data type: String *
    • Default: "X-Client-Version" *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#clientVersionHeader()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#clientVersionHeader(String)} + *
      *
    * *
    Description:
    @@ -339,20 +341,6 @@ public final class RestContext extends BeanContext { *

    * The client version is used to support backwards compatibility for breaking REST interface changes. *
    Used in conjunction with {@link RestMethod#clientVersion()} annotation. - * - *

    - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_clientVersionHeader} - *
    • Annotations: - *
        - *
      • {@link RestResource#clientVersionHeader()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#clientVersionHeader(String)} - *
      - *
    */ public static final String REST_clientVersionHeader = PREFIX + "clientVersionHeader.s"; @@ -365,6 +353,14 @@ public final class RestContext extends BeanContext { *
  • Data type: String *
  • Default: null *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#contextPath()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#contextPath(String)} + *
    * * *
    Description:
    @@ -376,20 +372,6 @@ public final class RestContext extends BeanContext { * the context path is not actually specified on the servlet container. * The net effect is that the {@link RestRequest#getContextPath()} and {@link RestRequest#getServletPath()} methods * will return this value instead of the actual context path of the web app. - * - *

    - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_contextPath} - *
    • Annotations: - *
        - *
      • {@link RestResource#contextPath()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#contextPath(String)} - *
      - *
    */ public static final String REST_contextPath = PREFIX + "contextPath.s"; @@ -402,6 +384,16 @@ public final class RestContext extends BeanContext { *
  • Data type: List<{@link RestConverter} | Class<? extends {@link RestConverter}>> *
  • Default: empty list *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#converters()} + *
    • {@link RestMethod#converters()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#converters(Class...)} + *
    • {@link RestContextBuilder#converters(RestConverter...)} + *
    * * *
    Description:
    @@ -413,21 +405,6 @@ public final class RestContext extends BeanContext { *

    * Can be used for performing post-processing on the response object before serialization. * - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_converters} - *
    • Annotations: - *
        - *
      • {@link RestResource#converters()} - *
      • {@link RestMethod#converters()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#converters(Class...)} - *
      • {@link RestContextBuilder#converters(RestConverter...)} - *
      - *
    - * *
    Documentation:
    *
      *
    • Converters @@ -444,25 +421,20 @@ public final class RestContext extends BeanContext { *
    • Data type: String *
    • Default: "utf-8" *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#defaultCharset()} + *
      • {@link RestMethod#defaultCharset()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#defaultCharset(String)} + *
      *
    * *
    Description:
    *

    * The default character encoding for the request and response if not specified on the request. - * - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_defaultCharset} - *
    • Annotations: - *
        - *
      • {@link RestResource#defaultCharset()} - *
      • {@link RestMethod#defaultCharset()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#defaultCharset(String)} - *
      - *
    */ public static final String REST_defaultCharset = PREFIX + "defaultCharset.s"; @@ -475,6 +447,16 @@ public final class RestContext extends BeanContext { *
  • Data type: Map<String,String> *
  • Default: empty map *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#defaultRequestHeaders()} + *
    • {@link RestMethod#defaultRequestHeaders()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#defaultRequestHeader(String,Object)} + *
    • {@link RestContextBuilder#defaultRequestHeaders(String...)} + *
    * * *
    Description:
    @@ -483,17 +465,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_defaultRequestHeaders} - *
    • Annotations: - *
        - *
      • {@link RestResource#defaultRequestHeaders()} - *
      • {@link RestMethod#defaultRequestHeaders()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#defaultRequestHeader(String,Object)} - *
      • {@link RestContextBuilder#defaultRequestHeaders(String...)} - *
      *
    • Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request. *
    • The most useful reason for this annotation is to provide a default Accept header when one is not * specified so that a particular default {@link Serializer} is picked. @@ -510,6 +481,15 @@ public final class RestContext extends BeanContext { *
    • Data type: Map<String,String> *
    • Default: empty map *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#defaultResponseHeaders()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#defaultResponseHeader(String,Object)} + *
      • {@link RestContextBuilder#defaultResponseHeaders(String...)} + *
      *
    * *
    Description:
    @@ -518,16 +498,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_defaultResponseHeaders} - *
    • Annotations: - *
        - *
      • {@link RestResource#defaultResponseHeaders()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#defaultResponseHeader(String,Object)} - *
      • {@link RestContextBuilder#defaultResponseHeaders(String...)} - *
      *
    • This is equivalent to calling {@link RestResponse#setHeader(String, String)} programmatically in each of * the Java methods. *
    • The header value will not be set if the header value has already been specified (hence the 'default' in the name). @@ -544,6 +514,16 @@ public final class RestContext extends BeanContext { *
    • Data type: List<Class <? extends Encoder> | Encoder> *
    • Default: empty list *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#encoders()} + *
      • {@link RestMethod#encoders()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#encoders(Class...)} + *
      • {@link RestContextBuilder#encoders(Encoder...)} + *
      *
    * *
    Description:
    @@ -561,17 +541,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_encoders} - *
    • Annotations: - *
        - *
      • {@link RestResource#encoders()} - *
      • {@link RestMethod#encoders()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#encoders(Class...)} - *
      • {@link RestContextBuilder#encoders(Encoder...)} - *
      *
    • Instance classes must provide a public no-arg constructor, or a public constructor that takes in a * {@link PropertyStore} object. *
    • Instance class can be defined as an inner class of the REST resource class. @@ -588,6 +557,16 @@ public final class RestContext extends BeanContext { *
    • Data type: List<RestGuard | Class<? extends RestGuard>> *
    • Default: empty list *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#guards()} + *
      • {@link RestMethod#guards()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#guards(Class...)} + *
      • {@link RestContextBuilder#guards(RestGuard...)} + *
      *
    * *
    Description:
    @@ -601,17 +580,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_guards} - *
    • Annotations: - *
        - *
      • {@link RestResource#guards()} - *
      • {@link RestMethod#guards()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#guards(Class...)} - *
      • {@link RestContextBuilder#guards(RestGuard...)} - *
      *
    • {@link RestGuard} classes must have either a no-arg or {@link PropertyStore} argument constructors. *
    */ @@ -626,6 +594,15 @@ public final class RestContext extends BeanContext { *
  • Data type: Class<? extends RestInfoProvider> | RestInfoProvider *
  • Default: {@link RestInfoProvider} *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#infoProvider()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#infoProvider(Class)} + *
    • {@link RestContextBuilder#infoProvider(RestInfoProvider)} + *
    * * *
    Description:
    @@ -634,21 +611,6 @@ public final class RestContext extends BeanContext { * *

    * Subclasses can be used to customize the documentation on a resource. - * - *

    - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_infoProvider} - *
    • Annotations: - *
        - *
      • {@link RestResource#infoProvider()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#infoProvider(Class)} - *
      • {@link RestContextBuilder#infoProvider(RestInfoProvider)} - *
      - *
    */ public static final String REST_infoProvider = PREFIX + "infoProvider.o"; @@ -661,6 +623,15 @@ public final class RestContext extends BeanContext { *
  • Data type: Class<? extends RestLogger> | RestLogger *
  • Default: {@link RestLogger.Normal} *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#logger()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#logger(Class)} + *
    • {@link RestContextBuilder#logger(RestLogger)} + *
    * * *
    Description:
    @@ -671,15 +642,6 @@ public final class RestContext extends BeanContext { *
    Notes:
    *
      *
    • Property: {@link RestContext#REST_logger} - *
    • Annotations: - *
        - *
      • {@link RestResource#logger()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#logger(Class)} - *
      • {@link RestContextBuilder#logger(RestLogger)} - *
      *
    • The {@link RestLogger.Normal} logger can be used to provide basic error logging to the Java logger. *
    */ @@ -694,6 +656,15 @@ public final class RestContext extends BeanContext { *
  • Data type: String *
  • Default: "100M" *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#maxInput()} + *
    • {@link RestMethod#maxInput()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#maxInput(String)} + *
    * * *
    Description:
    @@ -703,16 +674,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_maxInput} - *
    • Annotations: - *
        - *
      • {@link RestResource#maxInput()} - *
      • {@link RestMethod#maxInput()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#maxInput(String)} - *
      *
    • String value that gets resolved to a long. *
    • Can be suffixed with any of the following representing kilobytes, megabytes, and gigabytes: * 'K', 'M', 'G'. @@ -730,6 +691,16 @@ public final class RestContext extends BeanContext { *
    • Data type: List<MessageBundleLocation> *
    • Default: null *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#messages()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#messages(String)}, + *
      • {@link RestContextBuilder#messages(Class,String)} + *
      • {@link RestContextBuilder#messages(MessageBundleLocation...)} + *
      *
    * *
    Description:
    @@ -753,17 +724,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_messages} - *
    • Annotations: - *
        - *
      • {@link RestResource#messages()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#messages(String)}, - *
      • {@link RestContextBuilder#messages(Class,String)} - *
      • {@link RestContextBuilder#messages(MessageBundleLocation...)} - *
      *
    • Mappings are cumulative from parent to child. *
    */ @@ -778,6 +738,14 @@ public final class RestContext extends BeanContext { *
  • Data type: Set<String> *
  • Default: empty list *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#mimeTypes()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#mimeTypes(String...)} + *
    * * *
    Description:
    @@ -798,15 +766,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_mimeTypes} - *
    • Annotations: - *
        - *
      • {@link RestResource#mimeTypes()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#mimeTypes(String...)} - *
      *
    • Values are .mime.types formatted entry string. *
      Example: "image/svg+xml svg" *
    @@ -822,6 +781,14 @@ public final class RestContext extends BeanContext { *
  • Data type: List<RestParam | Class<? extends RestParam>> *
  • Default: empty list *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#paramResolvers()} + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#paramResolvers(Class...)} + *
      • {@link RestContextBuilder#paramResolvers(RestParam...)} + *
      *
    * *
    Description:
    @@ -852,15 +819,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_paramResolvers} - *
    • Annotations: - *
        - *
      • {@link RestResource#paramResolvers()} - *
      • Methods: - *
          - *
        • {@link RestContextBuilder#paramResolvers(Class...)} - *
        • {@link RestContextBuilder#paramResolvers(RestParam...)} - *
        *
      • {@link RestParam} classes must have either a no-arg or {@link PropertyStore} argument constructors. *
      */ @@ -875,6 +833,17 @@ public final class RestContext extends BeanContext { *
    • Data type: List<Class <? extends Parser> | Parser> *
    • Default: empty list *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#parsers()} + *
      • {@link RestMethod#parsers()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#parsers(Object...)} + *
      • {@link RestContextBuilder#parsers(Class...)} + *
      • {@link RestContextBuilder#parsers(boolean,Object...)} + *
      *
    * *
    Description:
    @@ -883,18 +852,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_parsers} - *
    • Annotations: - *
        - *
      • {@link RestResource#parsers()} - *
      • {@link RestMethod#parsers()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#parsers(Object...)} - *
      • {@link RestContextBuilder#parsers(Class...)} - *
      • {@link RestContextBuilder#parsers(boolean,Object...)} - *
      *
    • When defined as a class, properties/transforms defined on the resource/method are inherited. *
    • When defined as an instance, properties/transforms defined on the resource/method are NOT inherited. *
    @@ -915,6 +872,15 @@ public final class RestContext extends BeanContext { *
  • Data type: Class <? extends HttpPartParser> | HttpPartParser *
  • Default: {@link UonPartParser} *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#partParser()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#partParser(Class)} + *
    • {@link RestContextBuilder#partParser(HttpPartParser)} + *
    * * *
    Description:
    @@ -923,16 +889,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_partParser} - *
    • Annotations: - *
        - *
      • {@link RestResource#partParser()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#partParser(Class)} - *
      • {@link RestContextBuilder#partParser(HttpPartParser)} - *
      *
    • When defined as a class, properties/transforms defined on the resource/method are inherited. *
    • When defined as an instance, properties/transforms defined on the resource/method are NOT inherited. *
    @@ -948,6 +904,15 @@ public final class RestContext extends BeanContext { *
  • Data type: Class <? extends HttpPartSerializer> | HttpPartSerializer *
  • Default: {@link SimpleUonPartSerializer} *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#partSerializer()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#partSerializer(Class)} + *
    • {@link RestContextBuilder#partSerializer(HttpPartSerializer)} + *
    * * *
    Description:
    @@ -956,16 +921,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_partSerializer} - *
    • Annotations: - *
        - *
      • {@link RestResource#partSerializer()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#partSerializer(Class)} - *
      • {@link RestContextBuilder#partSerializer(HttpPartSerializer)} - *
      *
    • When defined as a class, properties/transforms defined on the resource/method are inherited. *
    • When defined as an instance, properties/transforms defined on the resource/method are NOT inherited. *
    @@ -981,6 +936,14 @@ public final class RestContext extends BeanContext { *
  • Data type: String *
  • Default: null *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#path()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#path(String)} + *
    * * *
    Description:
    @@ -990,15 +953,6 @@ public final class RestContext extends BeanContext { *

    *

    Notes:
    *
      - *
    • Property: {@link RestContext#REST_path} - *
    • Annotations: - *
        - *
      • {@link RestResource#path()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#path(String)} - *
      *
    • This annotation is ignored on top-level servlets (i.e. servlets defined in web.xml files). *
      Therefore, implementers can optionally specify a path value for documentation purposes. *
    • Typically, this setting is only applicable to resources defined as children through the @@ -1017,6 +971,14 @@ public final class RestContext extends BeanContext { *
    • Data type: Boolean *
    • Default: false *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#renderResponseStackTraces()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#renderResponseStackTraces(boolean)} + *
      *
    * *
    Description:
    @@ -1025,15 +987,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_renderResponseStackTraces} - *
    • Annotations: - *
        - *
      • {@link RestResource#renderResponseStackTraces()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#renderResponseStackTraces(boolean)} - *
      *
    • Useful for debugging, although allowing stack traces to be rendered may cause security concerns so use * caution when enabling. *
    @@ -1049,6 +1002,15 @@ public final class RestContext extends BeanContext { *
  • Data type: Class<? extends RestResourceResolver> | RestResourceResolver *
  • Default: {@link RestResourceResolverSimple} *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#resourceResolver()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#resourceResolver(Class)} + *
    • {@link RestContextBuilder#resourceResolver(RestResourceResolver)} + *
    * * *
    Description:
    @@ -1061,16 +1023,6 @@ public final class RestContext extends BeanContext { *

    *

    Notes:
    *
      - *
    • Property: {@link RestContext#REST_resourceResolver} - *
    • Annotations: - *
        - *
      • {@link RestResource#resourceResolver()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#resourceResolver(Class)} - *
      • {@link RestContextBuilder#resourceResolver(RestResourceResolver)} - *
      *
    • Unless overridden, resource resolvers are inherited from parent resources. *
    */ @@ -1085,6 +1037,15 @@ public final class RestContext extends BeanContext { *
  • Data type: List<Class<? extends ResponseHandler>> *
  • Default: empty list *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#responseHandlers()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#responseHandlers(Class...)} +
    • {@link RestContextBuilder#responseHandlers(ResponseHandler...)} +
    * * *
    Description:
    @@ -1106,16 +1067,6 @@ public final class RestContext extends BeanContext { *

    *

    Notes:
    *
      - *
    • Property: {@link RestContext#REST_responseHandlers} - *
    • Annotations: - *
        - *
      • {@link RestResource#responseHandlers()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#responseHandlers(Class...)} -
      • {@link RestContextBuilder#responseHandlers(ResponseHandler...)} -
      *
    • {@link ResponseHandler} classes must have either a no-arg or {@link PropertyStore} argument constructors. *
    */ @@ -1130,6 +1081,17 @@ public final class RestContext extends BeanContext { *
  • Data type: List<Class <? extends Serializer> | Serializer> *
  • Default: empty list *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#serializers()} + *
    • {@link RestMethod#serializers()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#serializers(Object...)} + *
    • {@link RestContextBuilder#serializers(Class...)} + *
    • {@link RestContextBuilder#serializers(boolean,Object...)} + *
    * * *
    Description:
    @@ -1138,18 +1100,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_serializers} - *
    • Annotations: - *
        - *
      • {@link RestResource#serializers()} - *
      • {@link RestMethod#serializers()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#serializers(Object...)} - *
      • {@link RestContextBuilder#serializers(Class...)} - *
      • {@link RestContextBuilder#serializers(boolean,Object...)} - *
      *
    • When defined as a class, properties/transforms defined on the resource/method are inherited. *
    • When defined as an instance, properties/transforms defined on the resource/method are NOT inherited. *
    @@ -1170,26 +1120,21 @@ public final class RestContext extends BeanContext { *
  • Data type: Map<String,String> *
  • Default: {'Cache-Control': 'max-age=86400, public} *
  • Session-overridable: false - * - * - *
    Description:
    - *

    - * Used to customize the headers on responses returned for statically-served files. - * - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_staticFileResponseHeaders} - *
    • Annotations: + *
    • Annotations: *
        - *
      • {@link RestResource#staticFileResponseHeaders()} + *
      • {@link RestResource#staticFileResponseHeaders()} *
      - *
    • Methods: + *
    • Methods: *
        - *
      • {@link RestContextBuilder#staticFileResponseHeaders(boolean,Map)} - *
      • {@link RestContextBuilder#staticFileResponseHeaders(String...)} - *
      • {@link RestContextBuilder#staticFileResponseHeader(String,String)} + *
      • {@link RestContextBuilder#staticFileResponseHeaders(boolean,Map)} + *
      • {@link RestContextBuilder#staticFileResponseHeaders(String...)} + *
      • {@link RestContextBuilder#staticFileResponseHeader(String,String)} *
      *
    + * + *
    Description:
    + *

    + * Used to customize the headers on responses returned for statically-served files. */ public static final String REST_staticFileResponseHeaders = PREFIX + "staticFileResponseHeaders.omo"; @@ -1202,6 +1147,18 @@ public final class RestContext extends BeanContext { *

  • Data type: List<StaticFileMapping> *
  • Default: null *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#staticFiles()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#staticFiles(String)}, + *
    • {@link RestContextBuilder#staticFiles(Class,String)} + *
    • {@link RestContextBuilder#staticFiles(String,String)} + *
    • {@link RestContextBuilder#staticFiles(Class,String,String)} + *
    • {@link RestContextBuilder#staticFiles(StaticFileMapping...)} + *
    * * *
    Description:
    @@ -1235,19 +1192,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_staticFiles} - *
    • Annotations: - *
        - *
      • {@link RestResource#staticFiles()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#staticFiles(String)}, - *
      • {@link RestContextBuilder#staticFiles(Class,String)} - *
      • {@link RestContextBuilder#staticFiles(String,String)} - *
      • {@link RestContextBuilder#staticFiles(Class,String,String)} - *
      • {@link RestContextBuilder#staticFiles(StaticFileMapping...)} - *
      *
    • Mappings are cumulative from parent to child. *
    • Child resources can override mappings made on parent resources. *
    • The media type on the response is determined by the {@link org.apache.juneau.rest.RestContext#getMediaTypeForName(String)} method. @@ -1268,6 +1212,16 @@ public final class RestContext extends BeanContext { *
    • Data type: List<String> *
    • Default: empty list *
    • Session-overridable: false + *
    • Annotations: + *
        + *
      • {@link RestResource#supportedAcceptTypes()} + *
      • {@link RestMethod#supportedAcceptTypes()} + *
      + *
    • Methods: + *
        + *
      • {@link RestContextBuilder#supportedAcceptTypes(boolean,String...)} + *
      • {@link RestContextBuilder#supportedAcceptTypes(boolean,MediaType...)} + *
      *
    * *
    Description:
    @@ -1277,22 +1231,6 @@ public final class RestContext extends BeanContext { *

    * This affects the values returned by {@link RestRequest#getSupportedAcceptTypes()} and the supported accept * types shown in {@link RestInfoProvider#getSwagger(RestRequest)}. - * - *

    - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_supportedAcceptTypes} - *
    • Annotations: - *
        - *
      • {@link RestResource#supportedAcceptTypes()} - *
      • {@link RestMethod#supportedAcceptTypes()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#supportedAcceptTypes(boolean,String...)} - *
      • {@link RestContextBuilder#supportedAcceptTypes(boolean,MediaType...)} - *
      - *
    */ public static final String REST_supportedAcceptTypes = PREFIX + "supportedAcceptTypes.ls"; @@ -1305,6 +1243,16 @@ public final class RestContext extends BeanContext { *
  • Data type: List<String> *
  • Default: empty list *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#supportedContentTypes()} + *
    • {@link RestMethod#supportedContentTypes()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#supportedContentTypes(boolean,String...)} + *
    • {@link RestContextBuilder#supportedContentTypes(boolean,MediaType...)} + *
    * * *
    Description:
    @@ -1314,22 +1262,6 @@ public final class RestContext extends BeanContext { *

    * This affects the values returned by {@link RestRequest#getSupportedContentTypes()} and the supported content * types shown in {@link RestInfoProvider#getSwagger(RestRequest)}. - * - *

    - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_supportedContentTypes} - *
    • Annotations: - *
        - *
      • {@link RestResource#supportedContentTypes()} - *
      • {@link RestMethod#supportedContentTypes()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#supportedContentTypes(boolean,String...)} - *
      • {@link RestContextBuilder#supportedContentTypes(boolean,MediaType...)} - *
      - *
    */ public static final String REST_supportedContentTypes = PREFIX + "supportedContentTypes.ls"; @@ -1342,25 +1274,20 @@ public final class RestContext extends BeanContext { *
  • Data type: Boolean *
  • Default: true *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#useClasspathResourceCaching()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#useClasspathResourceCaching(boolean)} + *
    * * *
    Description:
    *

    * When enabled, resources retrieved via {@link RestContext#getClasspathResource(String, Locale)} (and related * methods) will be cached in memory to speed subsequent lookups. - * - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_useClasspathResourceCaching} - *
    • Annotations: - *
        - *
      • {@link RestResource#useClasspathResourceCaching()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#useClasspathResourceCaching(boolean)} - *
      - *
    */ public static final String REST_useClasspathResourceCaching = PREFIX + "useClasspathResourceCaching.b"; @@ -1373,25 +1300,20 @@ public final class RestContext extends BeanContext { *
  • Data type: Boolean *
  • Default: true *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link RestResource#useStackTraceHashes()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#useStackTraceHashes(boolean)} + *
    * * *
    Description:
    *

    * When enabled, the number of times an exception has occurred will be determined based on stack trace hashsums, * made available through the {@link RestException#getOccurrence()} method. - * - *

    Notes:
    - *
      - *
    • Property: {@link RestContext#REST_useStackTraceHashes} - *
    • Annotations: - *
        - *
      • {@link RestResource#useStackTraceHashes()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#useStackTraceHashes(boolean)} - *
      - *
    */ public static final String REST_useStackTraceHashes = PREFIX + "useStackTraceHashes.b"; @@ -1404,6 +1326,16 @@ public final class RestContext extends BeanContext { *
  • Data type: List<Class<? extends Widget> | Widget> *
  • Default: empty list *
  • Session-overridable: false + *
  • Annotations: + *
      + *
    • {@link HtmlDoc#widgets()} + *
    + *
  • Methods: + *
      + *
    • {@link RestContextBuilder#widgets(Class...)} + *
    • {@link RestContextBuilder#widgets(Widget...)} + *
    • {@link RestContextBuilder#widgets(boolean,Widget...)} + *
    * * *
    Description:
    @@ -1444,17 +1376,6 @@ public final class RestContext extends BeanContext { * *
    Notes:
    *
      - *
    • Property: {@link RestContext#REST_widgets} - *
    • Annotations: - *
        - *
      • {@link HtmlDoc#widgets()} - *
      - *
    • Methods: - *
        - *
      • {@link RestContextBuilder#widgets(Class...)} - *
      • {@link RestContextBuilder#widgets(Widget...)} - *
      • {@link RestContextBuilder#widgets(boolean,Widget...)} - *
      *
    • Widgets are inherited from parent to child, but can be overridden by reusing the widget name. *
    */ http://git-wip-us.apache.org/repos/asf/juneau/blob/db1bfb1d/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java index cbc7330..c52c1c5 100644 --- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java +++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java @@ -1927,12 +1927,6 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon } @Override /* BeanContextBuilder */ - public RestContextBuilder defaultParser(Class value) { - super.defaultParser(value); - return this; - } - - @Override /* BeanContextBuilder */ public RestContextBuilder locale(Locale value) { super.locale(value); return this; http://git-wip-us.apache.org/repos/asf/juneau/blob/db1bfb1d/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/package.html ---------------------------------------------------------------------- diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/package.html b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/package.html index 54ed29b..c279e99 100644 --- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/package.html +++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/package.html @@ -2065,19 +2065,23 @@ }

    - Children can also be defined programmatically using any of the following methods: + Children are defined through the following:

    -
      -
    • - {@link org.apache.juneau.rest.RestContextBuilder} +
        +
      • Properties: +
          +
        • {@link org.apache.juneau.rest.RestContext#REST_children} +
        +
      • Annotations: +
          +
        • {@link org.apache.juneau.rest.annotation.RestResource#children()} +
        +
      • Methods:
          -
        • - {@link org.apache.juneau.rest.RestContextBuilder#child(String,Object)} -
        • - {@link org.apache.juneau.rest.RestContextBuilder#children(Class[])} -
        • - {@link org.apache.juneau.rest.RestContextBuilder#children(Object[])} -
        +
      • {@link org.apache.juneau.rest.RestContextBuilder#child(String,Object)} +
      • {@link org.apache.juneau.rest.RestContextBuilder#children(Class...)} +
      • {@link org.apache.juneau.rest.RestContextBuilder#children(Object...)} +