org.apache.juneau.remote

Class RemoteInterfaceMeta

java.lang.Object

org.apache.juneau.remote.RemoteInterfaceMeta

public class RemoteInterfaceMeta
extends Object

Contains the meta-data about a remote proxy REST interface.

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

• Overview > juneau-rest-server > restRPC

Constructor Summary

Constructors

Constructor and Description
RemoteInterfaceMeta(Class<?> c, String uri) Constructor.

Method Summary

Modifier and Type	Method and Description
Class<?>	getJavaClass() Returns the Java class of this interface.
RemoteInterfaceMethod	getMethodMeta(Method m) Returns the metadata about the specified method on this interface proxy.
RemoteInterfaceMethod	getMethodMetaByPath(String p) Returns the metadata about the specified method on this interface proxy by the path defined on the method.
Map<String,RemoteInterfaceMethod>	getMethodsByPath() Returns a map of all methods on this interface proxy keyed by HTTP path.
String	getPath() Returns the HTTP path of this interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteInterfaceMeta

public RemoteInterfaceMeta(Class<?> c,
                           String uri)

Constructor.

Parameters:

c - The interface class annotated with a @RemoteInterface annotation.
Note that the annotations are optional.

uri - The absolute URL of the remote REST interface that implements this proxy interface.
This is only used on the client side.

Method Detail

getMethodsByPath

public Map<String,RemoteInterfaceMethod> getMethodsByPath()

Returns a map of all methods on this interface proxy keyed by HTTP path.

Returns:

A map of all methods on this remote interface keyed by HTTP path.
The keys never have leading slashes.
The map is never null.

getMethodMeta

public RemoteInterfaceMethod getMethodMeta(Method m)

Returns the metadata about the specified method on this interface proxy.

Parameters:

m - The method to look up.

Returns:

Metadata about the method or null if no metadata was found.

getMethodMetaByPath

public RemoteInterfaceMethod getMethodMetaByPath(String p)

Returns the metadata about the specified method on this interface proxy by the path defined on the method.

Parameters:

p - The HTTP path to look for.

Returns:

Metadata about the method or null if no metadata was found.

getJavaClass

public Class<?> getJavaClass()

Returns the Java class of this interface.

Returns:

The Java class of this interface.
Never null.

getPath

public String getPath()

Returns the HTTP path of this interface.

Returns:

The HTTP path of this interface.
Never null.
Never has leading or trailing slashes.