Package org.apache.juneau.rest.client.remote

Class RemoteOperationMeta

java.lang.Object

org.apache.juneau.rest.client.remote.RemoteOperationMeta

public class RemoteOperationMeta
extends Object

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

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

See Also:

• REST Proxy Basics
• juneau-rest-client Basics

Constructor Summary

Constructors

Constructor	Description
RemoteOperationMeta(String parentPath, Method m, String defaultMethod)	Constructor.

Method Summary

Modifier and Type	Method	Description
RemoteOperationMeta	forEachException(Consumer<Class<?>> action)	Performs an action on the exceptions thrown by this method.
RemoteOperationMeta	forEachFormDataArg(Consumer<RemoteOperationArg> action)	Performs an action on the @FormData annotated arguments on this Java method.
RemoteOperationMeta	forEachHeaderArg(Consumer<RemoteOperationArg> action)	Performs an action on the @Header annotated arguments on this Java method.
RemoteOperationMeta	forEachPathArg(Consumer<RemoteOperationArg> action)	Performs an action on the @Path annotated arguments on this Java method.
RemoteOperationMeta	forEachQueryArg(Consumer<RemoteOperationArg> action)	Performs an action on the @Query annotated arguments on this Java method.
RemoteOperationMeta	forEachRequestArg(Consumer<RemoteOperationBeanArg> action)	Performs an action on the @Request annotated arguments on this Java method.
RemoteOperationArg	getContentArg()	Returns the argument annotated with @Content.
String	getFullPath()	Returns the absolute URI of the REST interface invoked by this Java method.
String	getHttpMethod()	Returns the value of the @RemoteOp(method) annotation on this Java method.
RemoteOperationReturn	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 Details

RemoteOperationMeta

public RemoteOperationMeta(String parentPath,
 Method m,
 String defaultMethod)

Constructor.

Parameters:

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

m - The Java method.

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

Method Details

getHttpMethod

public String getHttpMethod()

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

Returns:

The value of the annotation, never null.

getFullPath

public String getFullPath()

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

Returns:

The absolute URI of the REST interface, never null.

forEachPathArg

public RemoteOperationMeta forEachPathArg(Consumer<RemoteOperationArg> action)

Performs an action on the @Path annotated arguments on this Java method.

Parameters:

action - The action to perform.

Returns:

This object.

forEachQueryArg

public RemoteOperationMeta forEachQueryArg(Consumer<RemoteOperationArg> action)

Performs an action on the @Query annotated arguments on this Java method.

Parameters:

action - The action to perform.

Returns:

This object.

forEachFormDataArg

public RemoteOperationMeta forEachFormDataArg(Consumer<RemoteOperationArg> action)

Performs an action on the @FormData annotated arguments on this Java method.

Parameters:

action - The action to perform.

Returns:

This object.

forEachHeaderArg

public RemoteOperationMeta forEachHeaderArg(Consumer<RemoteOperationArg> action)

Performs an action on the @Header annotated arguments on this Java method.

Parameters:

action - The action to perform.

Returns:

This object.

forEachRequestArg

public RemoteOperationMeta forEachRequestArg(Consumer<RemoteOperationBeanArg> action)

Performs an action on the @Request annotated arguments on this Java method.

Parameters:

action - The action to perform.

Returns:

This object.

getContentArg

public RemoteOperationArg getContentArg()

Returns the argument annotated with @Content.

Returns:

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

getReturns

public RemoteOperationReturn 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.

forEachException

public RemoteOperationMeta forEachException(Consumer<Class<?>> action)

Performs an action on the exceptions thrown by this method.

Parameters:

action - The action to perform.

Returns:

This object.