org.apache.juneau.rest.remote

Class RrpcServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.juneau.rest.RestServlet

org.apache.juneau.rest.BasicRestServlet

org.apache.juneau.rest.remote.RrpcServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig, BasicRestConfig

public abstract class RrpcServlet
extends BasicRestServlet

Abstract class for defining Remote Interface Services.

Remote Interface Services are POJOs whose methods can be invoked remotely through proxy interfaces.

To implement a remote interface service, developers must simply subclass from this class and implement the getServiceMap() method that maps java interfaces to POJO instances.

• Overview > juneau-rest-server > restRPC

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RrpcServlet()

Method Summary

Modifier and Type	Method and Description
List<LinkString>	getInterfaces()
protected abstract Map<Class<?>,Object>	getServiceMap() Returns the list of interfaces to their implementation objects.
Object	invoke(Reader r, ReaderParser p, ContentType contentType, String javaInterface, String javaMethod)
Collection<LinkString>	listMethods(String javaInterface)
Div	showEntryForm(String javaInterface, String javaMethod)

Methods inherited from class org.apache.juneau.rest.BasicRestServlet

getOptions

Methods inherited from class org.apache.juneau.rest.RestServlet

destroy, getContext, getPath, getProperties, getRequest, getResponse, getServletConfig, init, log, log, log, log, logObjects, service, setContext, setRestResourceResolver

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletContext, getServletInfo, getServletName, init

Methods inherited from class java.lang.Object

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

Constructor Detail

RrpcServlet

public RrpcServlet()

Method Detail

getServiceMap

protected abstract Map<Class<?>,Object> getServiceMap()
                                               throws Exception

Returns the list of interfaces to their implementation objects.

This class is called often and not cached, so any caching should occur in the subclass if necessary.

Returns:

The service map.

Throws:

Exception

getInterfaces

@RestMethod(name="GET",
            path="/",
            summary="List of available remote interfaces",
            description="Shows a list of the interfaces registered with this remote interface servlet.")
public List<LinkString> getInterfaces()
                                                                                                                                                                                                                                                 throws Exception

Throws:

Exception

listMethods

@RestMethod(name="GET",
            path="/{javaInterface}",
            summary="List of available methods on interface",
            description="Shows a list of all the exposed methods on an interface.")
 @HtmlDocConfig(nav="<h5>Interface:  $RP{javaInterface}</h5>")
public Collection<LinkString> listMethods(@Path(name="javaInterface",description="Java interface name",example="com.foo.MyInterface")
                                                                                                                                                                                                                                                                                                                        String javaInterface)
                                                                                                                                                                                                                                                                                                                 throws Exception

Throws:

Exception

showEntryForm

@RestMethod(name="GET",
            path="/{javaInterface}/{javaMethod}",
            summary="Form entry for interface method call",
            description="Shows a form entry page for executing a remote interface method.")
 @HtmlDocConfig(nav={"<h5>Interface:  $RP{javaInterface}</h5>","<h5>Method:  $RP{javaMethod}</h5>"})
public Div showEntryForm(@Path(name="javaInterface",description="Java interface name",example="com.foo.MyInterface")
                                                                                                                                                                                                                                                                                                                                                                String javaInterface,
                                                                                                                                                                                                                                                                                                                                                                @Path(name="javaMethod",description="Java method name",example="myMethod")
                                                                                                                                                                                                                                                                                                                                                                String javaMethod)
                                                                                                                                                                                                                                                                                                                                                         throws NotFound,
                                                                                                                                                                                                                                                                                                                                                                Exception

Throws:

NotFound

Exception

invoke

@RestMethod(name="POST",
            path="/{javaInterface}/{javaMethod}",
            summary="Invoke an interface method",
            description="Invoke a Java method by passing in the arguments as an array of serialized objects.\nThe returned object is then serialized to the response.",
            swagger=)
 @HtmlDocConfig(nav={"<h5>Interface:  $RP{javaInterface}</h5>","<h5>Method:  $RP{javaMethod}</h5>"})
public Object invoke(Reader r,
                                                                                                                                                                                                                                                                                                                                                                                                                                                     ReaderParser p,
                                                                                                                                                                                                                                                                                                                                                                                                                                                     @Header(value="Content-Type")
                                                                                                                                                                                                                                                                                                                                                                                                                                                     ContentType contentType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                     @Path(name="javaInterface",description="Java interface name",example="com.foo.MyInterface")
                                                                                                                                                                                                                                                                                                                                                                                                                                                     String javaInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                     @Path(name="javaMethod",description="Java method name",example="myMethod")
                                                                                                                                                                                                                                                                                                                                                                                                                                                     String javaMethod)
                                                                                                                                                                                                                                                                                                                                                                                                                                              throws UnsupportedMediaType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                     NotFound,
                                                                                                                                                                                                                                                                                                                                                                                                                                                     Exception

Throws:

UnsupportedMediaType

NotFound

Exception