org.apache.juneau.remoteable

Annotation Type Path

Deprecated.

Use Path

@Deprecated
 @Documented
 @Target(value={PARAMETER,FIELD,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
public @interface Path

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name Deprecated. The path parameter name.
Class<? extends HttpPartSerializer>	serializer Deprecated. Specifies the HttpPartSerializer class used for serializing values to strings.
String	value Deprecated. A synonym for name().

Element Detail

name

public abstract String name

Deprecated.

The path parameter name.

Note that name() and value() are synonyms.

The value should be either "*" to represent multiple name/value pairs, or a label that defines the path variable name.

A blank value (the default) has the following behavior:

• If the data type is NameValuePairs, Map, or a bean, then it's the equivalent to "*" which will cause the value to be treated as name/value pairs.

  Example:

  // When used on a remote method parameter @Remoteable(path="/myproxy") public interface MyProxy { // Equivalent to @Path("*") @RemoteMethod(path="/mymethod/{foo}/{bar}") String myProxyMethod1(@FormData Map<String,Object> pathVars); } // When used on a request bean method public interface MyRequestBean { // Equivalent to @Path("*") @Path Map<String,Object> getPathVars(); }

• If used on a request bean method, uses the bean property name.

  Example:

  public interface MyRequestBean { // Equivalent to @Path("foo") @Path String getFoo(); }

Default:

""

value

public abstract String value

Deprecated.

A synonym for name().

Allows you to use shortened notation if you're only specifying the name.

Default:

""

serializer

public abstract Class<? extends HttpPartSerializer> serializer

Deprecated.

Specifies the HttpPartSerializer class used for serializing values to strings.

The default value defaults to the using the part serializer defined on the @RequestBean annotation, then on the client which by default is UrlEncodingSerializer.

This annotation is provided to allow values to be custom serialized.

Default:

org.apache.juneau.httppart.HttpPartSerializer.Null.class