org.apache.juneau.remoteable

Class RemoteableMethodMeta

java.lang.Object

org.apache.juneau.remoteable.RemoteableMethodMeta

public class RemoteableMethodMeta
extends Object

Contains the meta-data about a Java method on a remoteable interface.

Captures the information in @RemoteMethod annotations for caching and reuse.

See Also:

• Overview > juneau-rest-client > Interface Proxies Against 3rd-party REST Interfaces

Constructor Summary

Constructors

Constructor and Description
RemoteableMethodMeta(String restUrl, Method m) Constructor.

Method Summary

Modifier and Type	Method and Description
Integer	getBodyArg() Returns the argument annotated with @Body.
RemoteMethodArg[]	getFormDataArgs() Returns the @FormData annotated arguments on this Java method.
RemoteMethodArg[]	getHeaderArgs() Returns the @Header annotated arguments on this Java method.
String	getHttpMethod() Returns the value of the @RemoteMethod.httpMethod() annotation on this Java method.
Integer[]	getOtherArgs() Returns the remaining non-annotated arguments on this Java method.
RemoteMethodArg[]	getPathArgs() Returns the @Path annotated arguments on this Java method.
RemoteMethodArg[]	getQueryArgs() Returns the @Query annotated arguments on this Java method.
RemoteMethodArg[]	getRequestBeanArgs() Returns the @RequestBean annotated arguments on this Java method.
ReturnValue	getReturns() Returns whether the method returns the HTTP response body or status code.
String	getUrl() Returns the absolute URL of the REST interface invoked by this Java method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteableMethodMeta

public RemoteableMethodMeta(String restUrl,
                            Method m)

Constructor.

Parameters:

restUrl - The absolute URL of the REST interface backing the interface proxy.

m - The Java method.

Method Detail

getHttpMethod

public String getHttpMethod()

Returns the value of the @RemoteMethod.httpMethod() annotation on this Java method.

Returns:

The value of the annotation, never null.

getUrl

public String getUrl()

Returns the absolute URL of the REST interface invoked by this Java method.

Returns:

The absolute URL of the REST interface, never null.

getPathArgs

public RemoteMethodArg[] getPathArgs()

Returns the @Path annotated arguments on this Java method.

Returns:

A map of @Path.value() names to zero-indexed argument indices.

getQueryArgs

public RemoteMethodArg[] getQueryArgs()

Returns the @Query annotated arguments on this Java method.

Returns:

A map of @Query.value() names to zero-indexed argument indices.

getFormDataArgs

public RemoteMethodArg[] getFormDataArgs()

Returns the @FormData annotated arguments on this Java method.

Returns:

A map of @FormData.value() names to zero-indexed argument indices.

getHeaderArgs

public RemoteMethodArg[] getHeaderArgs()

Returns the @Header annotated arguments on this Java method.

Returns:

A map of @Header.value() names to zero-indexed argument indices.

getRequestBeanArgs

public RemoteMethodArg[] getRequestBeanArgs()

Returns the @RequestBean annotated arguments on this Java method.

Returns:

A list of zero-indexed argument indices.

getOtherArgs

public Integer[] getOtherArgs()

Returns the remaining non-annotated arguments on this Java method.

Returns:

A list of zero-indexed argument indices.

getBodyArg

public Integer getBodyArg()

Returns the argument annotated with @Body.

Returns:

A index of the argument with the @Body annotation, or null if no argument exists.

getReturns

public ReturnValue getReturns()

Returns whether the method returns the HTTP response body or status code.

Returns:

Whether the method returns the HTTP response body or status code.