You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/12/31 20:09:50 UTC
juneau git commit: RestContext cleanup.
Repository: juneau
Updated Branches:
refs/heads/master 1720ba6b3 -> 98426131a
RestContext cleanup.
Project: http://git-wip-us.apache.org/repos/asf/juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/juneau/commit/98426131
Tree: http://git-wip-us.apache.org/repos/asf/juneau/tree/98426131
Diff: http://git-wip-us.apache.org/repos/asf/juneau/diff/98426131
Branch: refs/heads/master
Commit: 98426131a869e7978a4feed3cde39645a258c205
Parents: 1720ba6
Author: JamesBognar <ja...@apache.org>
Authored: Sun Dec 31 15:09:46 2017 -0500
Committer: JamesBognar <ja...@apache.org>
Committed: Sun Dec 31 15:09:46 2017 -0500
----------------------------------------------------------------------
juneau-doc/src/main/javadoc/overview.html | 12 +++--
.../juneau/examples/rest/DirectoryResource.java | 2 +-
.../examples/rest/SampleRemoteableServlet.java | 2 +-
.../rest/addressbook/AddressBookResource.java | 2 +-
.../microservice/resources/DebugResource.java | 2 +-
.../resources/DirectoryResource.java | 2 +-
.../microservice/resources/LogsResource.java | 2 +-
.../juneau/rest/test/ContentResource.java | 2 +-
.../apache/juneau/rest/test/ParamsResource.java | 2 +-
.../org/apache/juneau/rest/RestContext.java | 54 +++++++++++++++-----
.../apache/juneau/rest/RestContextBuilder.java | 50 ++++++++++++------
.../apache/juneau/rest/RestServletDefault.java | 2 +-
.../juneau/rest/annotation/RestResource.java | 21 ++++----
.../java/org/apache/juneau/rest/package.html | 8 +--
.../apache/juneau/rest/remoteable/package.html | 7 ++-
15 files changed, 106 insertions(+), 64 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-doc/src/main/javadoc/overview.html
----------------------------------------------------------------------
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 00f77f9..8b5cc30 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -5678,7 +5678,7 @@
),
<jc>// Allow INIT as a method parameter.</jc>
- allowMethodParam=<js>"*"</js>,
+ allowedMethodParams=<js>"*"</js>,
<jc>// Properties that get applied to all serializers and parsers.</jc>
properties={
@@ -6360,7 +6360,7 @@
</p>
<p>
The ability to overload methods is enabled through the
- {@link org.apache.juneau.rest.annotation.RestResource#allowMethodParam()} setting.
+ <code><del>RestResource.allowMethodParam()</del></code> setting.
</p>
</div>
</div>
@@ -6402,7 +6402,7 @@
}
),
<jc>// Allow us to use method=POST from a browser.</jc>
- allowMethodParam=<js>"*"</js>
+ allowedMethodParams=<js>"*"</js>
)
<jk>public class</jk> SampleRemoteableServlet <jk>extends</jk> RemoteableServlet {
@@ -7963,6 +7963,8 @@
Eliminated the <code>RestMatcherReflecting</code> class.
<br>You can now simply create a {@link org.apache.juneau.rest.RestMatcher} that has a public constructor that
takes in the server and method arguments.
+ <li>
+ <code>RestResource.allowMethodParam</code> renamed to {@link org.apache.juneau.rest.annotation.RestResource#allowedMethodParams}.
</ul>
<h6 class='topic'>juneau-rest-client</h6>
@@ -8561,7 +8563,7 @@
<br>Allows you to override the context path value inherited from the servlet container.
<li>{@link org.apache.juneau.rest.annotation.RestResource#allowHeaderParams() allowHeaderParams()} -
<br>Replaces the <code>RestContext.REST_allowHeaderParams</code> setting.
- <li>{@link org.apache.juneau.rest.annotation.RestResource#allowMethodParam() allowMethodParam()} -
+ <li><code><del>RestResource.allowMethodParam()</del></code> -
<br>Replaces the <code>RestContext.REST_allowMethodParam</code> setting.
<li>{@link org.apache.juneau.rest.annotation.RestResource#allowBodyParam() allowBodyParam()} -
<br>Replaces the <code>RestContext.REST_allowBodyParam</code> setting.
@@ -10900,7 +10902,7 @@
<ul class='spaced-list'>
<li>Added a default OPTIONS page to {@link org.apache.juneau.rest.RestServletDefault} and <code><del>RestServletJenaDefault</del></code>.
<li><code>RestServletProperties.REST_allowMethodParam</code> has been enhanced to allow you to
- explicitely specify which HTTP methods can be used in the <code>&method</code> parameter.
+ explicitly specify which HTTP methods can be used in the <code>&method</code> parameter.
<li>New methods added to {@link org.apache.juneau.rest.RestRequest}:
<ul>
<li><code><del>RestRequest.getParser()</del></code>
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/DirectoryResource.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/DirectoryResource.java b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/DirectoryResource.java
index ee11e9d..fc16748 100644
--- a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/DirectoryResource.java
+++ b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/DirectoryResource.java
@@ -50,7 +50,7 @@ import org.apache.juneau.utils.*;
"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/$R{servletClassSimple}.java"
}
),
- allowMethodParam="*",
+ allowedMethodParams="*",
properties={
@Property(name=HTML_uriAnchorText, value="PROPERTY_NAME"),
@Property(name="rootDir", value="$S{java.io.tmpdir}"),
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/SampleRemoteableServlet.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/SampleRemoteableServlet.java b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/SampleRemoteableServlet.java
index 6d61e7c..55cd0f51 100644
--- a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/SampleRemoteableServlet.java
+++ b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/SampleRemoteableServlet.java
@@ -43,7 +43,7 @@ import org.apache.juneau.rest.remoteable.*;
}
),
// Allow us to use method=POST from a browser.
- allowMethodParam="*",
+ allowedMethodParams="*",
config="$S{juneau.configFile}" // So we can resolve $C{Source/gitHub} above.
)
public class SampleRemoteableServlet extends RemoteableServlet {
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java
index 769bf82..8dd6cf2 100644
--- a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java
+++ b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java
@@ -83,7 +83,7 @@ import org.apache.juneau.utils.*;
),
// Allow INIT as a method parameter.
- allowMethodParam="*",
+ allowedMethodParams="*",
// Properties that get applied to all serializers and parsers.
properties={
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DebugResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DebugResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DebugResource.java
index 9ef573d..8757c08 100644
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DebugResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DebugResource.java
@@ -36,7 +36,7 @@ import org.apache.juneau.rest.labels.*;
"options: servlet:/?method=OPTIONS"
}
),
- allowMethodParam="OPTIONS,POST"
+ allowedMethodParams="OPTIONS,POST"
)
@SuppressWarnings("javadoc")
public class DebugResource extends Resource {
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
index a4c3bf6..e0e7b74 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
@@ -69,7 +69,7 @@ import org.apache.juneau.utils.*;
"options: servlet:/?method=OPTIONS"
}
),
- allowMethodParam="*",
+ allowedMethodParams="*",
properties={
@Property(name=HTML_uriAnchorText, value="PROPERTY_NAME"),
@Property(name="DirectoryResource.rootDir", value="")
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
index 2f51c6d..c5f9932 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
@@ -44,7 +44,7 @@ import org.apache.juneau.transforms.*;
properties={
@Property(name=HTML_uriAnchorText, value="PROPERTY_NAME"),
},
- allowMethodParam="*",
+ allowedMethodParams="*",
pojoSwaps={
IteratorSwap.class, // Allows Iterators and Iterables to be serialized.
DateSwap.ISO8601DT.class // Serialize Date objects as ISO8601 strings.
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ContentResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ContentResource.java b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ContentResource.java
index 3fcf5f5..f719721 100644
--- a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ContentResource.java
+++ b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ContentResource.java
@@ -24,7 +24,7 @@ import org.apache.juneau.rest.annotation.*;
*/
@RestResource(
path="/testContent",
- allowMethodParam="*"
+ allowedMethodParams="*"
)
public class ContentResource extends RestServletDefault {
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ParamsResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ParamsResource.java b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ParamsResource.java
index 4015a84..3e50752 100644
--- a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ParamsResource.java
+++ b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/ParamsResource.java
@@ -44,7 +44,7 @@ import org.apache.juneau.utils.*;
@RestResource(
path="/testParams",
serializers=PlainTextSerializer.class,
- allowMethodParam="*",
+ allowedMethodParams="*",
pojoSwaps={CalendarSwap.DateMedium.class},
messages="ParamsResource"
)
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/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 1675faa..caccd9f 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
@@ -117,6 +117,39 @@ public final class RestContext extends Context {
public static final String REST_allowBodyParam = PREFIX + "allowBodyParam.b";
/**
+ * <b>Configuration property:</b> Allowed method parameters.
+ *
+ * <ul>
+ * <li><b>Name:</b> <js>"RestContext.allowedMethodParams.s"</js>
+ * <li><b>Data type:</b> <code>String</code>
+ * <li><b>Default:</b> <js>"HEAD,OPTIONS"</js>
+ * <li><b>Session-overridable:</b> <jk>false</jk>
+ * </ul>
+ *
+ * <p>
+ * When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular
+ * GET request.
+ * <br>
+ * For example: <js>"?method=OPTIONS"</js>
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>Property: {@link RestContext#REST_allowedMethodParams}
+ * <li>Annotation: {@link RestResource#allowedMethodParams()}
+ * <li>Method: {@link RestContextBuilder#allowedMethodParams(String...)}
+ * <li>Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter.
+ * <li>Parameter name is case-insensitive.
+ * <li>Use "*" to represent all methods.
+ * </ul>
+ *
+ * <p>
+ * Note that per the <a class="doclink"
+ * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">HTTP specification</a>, special care should
+ * be taken when allowing non-safe (POST, PUT, DELETE) methods to be invoked through GET requests.
+ */
+ public static final String REST_allowedMethodParams = PREFIX + "allowedMethodParams.s";
+
+ /**
* <b>Configuration property:</b> Render response stack traces in responses.
*
* <ul>
@@ -235,7 +268,7 @@ public final class RestContext extends Context {
private final Map<String,Widget> widgets;
- private final Set<String> allowMethodParams;
+ private final Set<String> allowedMethodParams;
private final ObjectMap properties;
private final Class<?>[]
@@ -311,21 +344,22 @@ public final class RestContext extends Context {
RestException _initException = null;
ServletContext servletContext = builder.servletContext;
+ this.resource = builder.resource;
+ this.builder = builder;
+ this.parentContext = builder.parentContext;
+
allowHeaderParams = getProperty(REST_allowHeaderParams, boolean.class, true);
allowBodyParam = getProperty(REST_allowBodyParam, boolean.class, true);
+ allowedMethodParams = Collections.unmodifiableSet(new LinkedHashSet<>(Arrays.asList(StringUtils.split(getProperty(REST_allowedMethodParams, String.class, "HEAD,OPTIONS")))));
renderResponseStackTraces = getProperty(REST_renderResponseStackTraces, boolean.class, false);
useStackTraceHashes = getProperty(REST_useStackTraceHashes, boolean.class, true);
defaultCharset = getProperty(REST_defaultCharset, String.class, "utf-8");
maxInput = getProperty(REST_maxInput, long.class, 100_000_000l);
try {
- this.resource = builder.resource;
- this.builder = builder;
this.resourceFinder = new ResourceFinder(resource.getClass());
- this.parentContext = builder.parentContext;
Builder b = new Builder(builder);
- this.allowMethodParams = Collections.unmodifiableSet(b.allowMethodParams);
this.varResolver = b.varResolver;
this.configFile = b.configFile;
this.properties = b.properties;
@@ -633,7 +667,6 @@ public final class RestContext extends Context {
Map<String,String> staticFilesMap;
String[] staticFilesPrefixes;
MessageBundle messageBundle;
- Set<String> allowMethodParams = new LinkedHashSet<>();
RestLogger logger;
String fullPath;
Map<String,Widget> widgets;
@@ -649,13 +682,6 @@ public final class RestContext extends Context {
resourceResolver = rcb.resourceResolver;
- String amp = getString(rcb.allowMethodParam, "juneau.allowMethodParam", "HEAD,OPTIONS");
- if ("true".equals(amp))
- amp = "*";// For backwards compatibility when this was a boolean field.
- else
- amp = amp.toUpperCase();
- allowMethodParams.addAll(Arrays.asList(StringUtils.split(amp)));
-
varResolver = rcb.varResolverBuilder
.vars(FileVar.class, LocalizationVar.class, RequestVar.class, SerializedRequestAttrVar.class, ServletInitParamVar.class, UrlVar.class, UrlEncodeVar.class, WidgetVar.class)
.build()
@@ -1322,7 +1348,7 @@ public final class RestContext extends Context {
* @return <jk>true</jk> if this resource allows the specified method to be overridden.
*/
protected boolean allowMethodParam(String m) {
- return (! isEmpty(m) && (allowMethodParams.contains(m) || allowMethodParams.contains("*")));
+ return (! isEmpty(m) && (allowedMethodParams.contains(m) || allowedMethodParams.contains("*")));
}
/**
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/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 a1ea4b7..ca1026c 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
@@ -121,7 +121,6 @@ public class RestContextBuilder extends ContextBuilder implements ServletConfig
String contextPath;
HtmlDocBuilder htmlDocBuilder;
List<Class<? extends Widget>> widgets = new ArrayList<>();
- Object allowMethodParam;
Object resourceResolver = RestResourceResolverSimple.class;
Object logger = RestLogger.Normal.class;
@@ -240,8 +239,8 @@ public class RestContextBuilder extends ContextBuilder implements ServletConfig
infoProvider(r.infoProvider());
if (! r.allowHeaderParams().isEmpty())
allowHeaderParams(Boolean.valueOf(vr.resolve(r.allowHeaderParams())));
- if (! r.allowMethodParam().isEmpty())
- allowMethodParam(vr.resolve(r.allowMethodParam()));
+ if (! r.allowedMethodParams().isEmpty())
+ allowedMethodParams(vr.resolve(r.allowedMethodParams()));
if (! r.allowBodyParam().isEmpty())
allowBodyParam(Boolean.valueOf(vr.resolve(r.allowBodyParam())));
if (! r.renderResponseStackTraces().isEmpty())
@@ -1133,20 +1132,6 @@ public class RestContextBuilder extends ContextBuilder implements ServletConfig
}
/**
- * Sets the <code>allowMethodParam</code> setting on this resource.
- *
- * <p>
- * This is the programmatic equivalent to the {@link RestResource#allowMethodParam() RestResource.allowMethodParam()} annotation.
- *
- * @param value The new value for this setting.
- * @return This object (for method chaining).
- */
- public RestContextBuilder allowMethodParam(String...value) {
- this.allowMethodParam = StringUtils.join(value, ',');
- return this;
- }
-
- /**
* Sets the URL path of the resource <js>"/foobar"</js>.
*
* <p>
@@ -1404,6 +1389,7 @@ public class RestContextBuilder extends ContextBuilder implements ServletConfig
* <li>Property: {@link RestContext#REST_allowHeaderParams}
* <li>Annotation: {@link RestResource#allowHeaderParams()}
* <li>Method: {@link RestContextBuilder#allowHeaderParams(boolean)}
+ * <li>Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter.
* <li>Parameter name is case-insensitive.
* <li>Useful for debugging REST interface using only a browser.
* <li>This is equivalent to calling <code>set(<jsf>REST_allowHeaderParams</jsf>, value)</code>.
@@ -1450,6 +1436,36 @@ public class RestContextBuilder extends ContextBuilder implements ServletConfig
}
/**
+ * <b>Configuration property:</b> Allowed method parameters.
+ *
+ * <p>
+ * When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular
+ * GET request.
+ * <br>
+ * For example: <js>"?method=OPTIONS"</js>
+ *
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>Property: {@link RestContext#REST_allowedMethodParams}
+ * <li>Annotation: {@link RestResource#allowedMethodParams()}
+ * <li>Method: {@link RestContextBuilder#allowedMethodParams(String...)}
+ * <li>Parameter name is case-insensitive.
+ * <li>Use "*" to represent all methods.
+ * </ul>
+ *
+ * <p>
+ * Note that per the <a class="doclink"
+ * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">HTTP specification</a>, special care should
+ * be taken when allowing non-safe (POST, PUT, DELETE) methods to be invoked through GET requests.
+ *
+ * @param value The new value for this setting.
+ * @return This object (for method chaining).
+ */
+ public RestContextBuilder allowedMethodParams(String...value) {
+ return set(REST_allowedMethodParams, StringUtils.join(value, ','));
+ }
+
+ /**
* <b>Configuration property:</b> Render response stack traces in responses.
*
* <p>
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java
index 72740c1..2c6d8f1 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java
@@ -187,7 +187,7 @@ import org.apache.juneau.xml.*;
// URI-resolution is disabled by default. Need to enable it.
@Property(name=SERIALIZER_uriResolution, value="ROOT_RELATIVE")
},
- allowMethodParam="OPTIONS",
+ allowedMethodParams="OPTIONS",
htmldoc=@HtmlDoc(
header={
"<h1>$R{servletTitle}</h1>",
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
index 404b08b..7418c96 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
@@ -744,32 +744,31 @@ public @interface RestResource {
String allowHeaderParams() default "";
/**
- * Enable <js>"method"</js> URL parameter for specific HTTP methods.
+ * <b>Configuration property:</b> Allowed method parameters.
*
* <p>
* When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular
* GET request.
+ * <br>
* For example: <js>"?method=OPTIONS"</js>
*
- * <p>
- * Example: <js>"HEAD,OPTIONS"</js>
- *
- * <ul>
+ * <h5 class='section'>Notes:</h5>
+ * <ul class='spaced-list'>
+ * <li>Property: {@link RestContext#REST_allowedMethodParams}
+ * <li>Annotation: {@link RestResource#allowedMethodParams()}
+ * <li>Method: {@link RestContextBuilder#allowedMethodParams(String...)}
* <li>Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter.
- * <li>Defaults to system property <js>"juneau.allowMethodParam"</js>, or <js>"HEAD,OPTIONS"</js> if not specified.
- * <li>Boolean value.
- * <li>Can contain variables.
* <li>Parameter name is case-insensitive.
+ * <li>Can contain variables.
* <li>Use "*" to represent all methods.
- * <li>For backwards compatibility, "true" also means "*".
- * </ul>
+ * </ul>
*
* <p>
* Note that per the <a class="doclink"
* href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">HTTP specification</a>, special care should
* be taken when allowing non-safe (POST, PUT, DELETE) methods to be invoked through GET requests.
*/
- String allowMethodParam() default "";
+ String allowedMethodParams() default "";
/**
* <b>Configuration property:</b> Allow body URL parameter.
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/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 e46381d..d8f667b 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
@@ -3132,13 +3132,13 @@
}
</p>
<p>
- To support overloaded methods, the {@link org.apache.juneau.rest.annotation.RestResource#allowMethodParam()}
+ To support overloaded methods, the {@link org.apache.juneau.rest.annotation.RestResource#allowedMethodParams()}
setting must be enabled on your servlet.
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
<jc>// Allow &method parameter on BAR requests</jc>
- allowMethodParam=<js>"BAR"</js>
+ allowedMethodParams=<js>"BAR"</js>
)
</p>
</div>
@@ -3181,7 +3181,7 @@
<td class='code'>&method=X</td>
<td>
Overload the HTTP method as a GET parameter (e.g <l>"POST"</l>).
- <br>Must be enabled via {@link org.apache.juneau.rest.annotation.RestResource#allowMethodParam()} setting.
+ <br>Must be enabled via {@link org.apache.juneau.rest.annotation.RestResource#allowedMethodParams()} setting.
</td>
</tr>
<tr>
@@ -3547,7 +3547,7 @@
),
<jc>// Allow INIT as a method parameter.</jc>
- allowMethodParam=<js>"*"</js>,
+ allowedMethodParams=<js>"*"</js>,
<jc>// Properties that get applied to all serializers and parsers.</jc>
properties={
http://git-wip-us.apache.org/repos/asf/juneau/blob/98426131/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/package.html
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/package.html b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/package.html
index 2747c3a..509933c 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/package.html
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/package.html
@@ -291,10 +291,9 @@
<p class='bcode'>
<ja>@RestResource</ja>(
path=<js>"/remoteable"</js>,
- properties={
- <jc>// Allow us to use method=POST from a browser.</jc>
- <ja>@Property</ja>(name=<jsf>REST_allowMethodParam</jsf>, value=<js>"*"</js>)
- }
+
+ <jc>// Allow us to use method=POST from a browser.</jc>
+ allowedMethodParams=<js>"*"</js>
)
<jk>public class</jk> SampleRemoteableServlet <jk>extends</jk> RemoteableServlet {
</p>