org.apache.juneau.rest.client.remote

Class RemoteMethodMeta

java.lang.Object

org.apache.juneau.rest.client.remote.RemoteMethodMeta

public class RemoteMethodMeta
extends Object

Contains the meta-data about a Java method on a REST proxy class.

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

• Overview > juneau-rest-client > REST Proxies

Constructor Summary

Constructors

Constructor and Description
RemoteMethodMeta(String parentPath, Method m, boolean useMethodSignatures, String defaultMethod) Constructor.

Method Summary

Modifier and Type	Method and Description
RemoteMethodArg	getBodyArg() Returns the argument annotated with @Body.
Class<?>[]	getExceptions() Returns the exceptions thrown by this method.
RemoteMethodArg[]	getFormDataArgs() Returns the @FormData annotated arguments on this Java method.
String	getFullPath() Returns the absolute URL of the REST interface invoked by 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.
Method	getJavaMethod() Returns the underlying Java method that this metadata is about.
RemoteMethodArg[]	getOtherArgs() Returns the remaining non-annotated arguments on this Java method.
String	getPath() Returns the HTTP path of this method.
RemoteMethodArg[]	getPathArgs() Returns the @Path annotated arguments on this Java method.
RemoteMethodArg[]	getQueryArgs() Returns the @Query annotated arguments on this Java method.
RemoteMethodBeanArg[]	getRequestArgs() Returns the @Request annotated arguments on this Java method.
RemoteMethodReturn	getReturns() Returns whether the method returns the HTTP response body or status code.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteMethodMeta

public RemoteMethodMeta(String parentPath,
                        Method m,
                        boolean useMethodSignatures,
                        String defaultMethod)

Constructor.

Parameters:

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

m - The Java method.

useMethodSignatures - If true then the default path for the method should be the full method signature.

defaultMethod - The default HTTP method if not specified through annotation.

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.

getFullPath

public String getFullPath()

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.

getRequestArgs

public RemoteMethodBeanArg[] getRequestArgs()

Returns the @Request annotated arguments on this Java method.

Returns:

A list of zero-indexed argument indices.

getOtherArgs

public RemoteMethodArg[] getOtherArgs()

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

Returns:

A list of zero-indexed argument indices.

getBodyArg

public RemoteMethodArg 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 RemoteMethodReturn 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.

getPath

public String getPath()

Returns the HTTP path of this method.

Returns:

The HTTP path of this method relative to the parent interface.
Never null.
Never has leading or trailing slashes.

getJavaMethod

public Method getJavaMethod()

Returns the underlying Java method that this metadata is about.

Returns:

The underlying Java method that this metadata is about.
Never null.

getExceptions

public Class<?>[] getExceptions()

Returns the exceptions thrown by this method.

Returns:

The exceptions thrown by this method. Never null.