org.apache.juneau.rest.remoteable

Class RemoteableServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.juneau.rest.RestServlet

org.apache.juneau.rest.BasicRestServlet

org.apache.juneau.rest.remoteable.RemoteableServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, BasicRestConfig

public abstract class RemoteableServlet
extends BasicRestServlet

Abstract class for defining Remoteable services.

Remoteable services are POJOs whose methods can be invoked remotely through proxy interfaces.

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

See Also:

• Overview > juneau-rest-server > Remoteable Proxies

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RemoteableServlet()

Method Summary

Modifier and Type	Method and Description
List<LinkString>	getInterfaces(RestRequest req) [GET /] - Get the list of all remote interfaces.
protected abstract Map<Class<?>,Object>	getServiceMap() Returns the list of interfaces to their implementation objects.
Object	invoke(RestRequest req, String javaInterface, String javaMethod) [POST /{javaInterface}/{javaMethod}] - Invoke the specified service method.
Collection<LinkString>	listMethods(RestRequest req, String javaInterface) [GET /{javaInterface] - Get the list of all remoteable methods on the specified interface name.
Div	showEntryForm(RestRequest req, String javaInterface, String javaMethod) [GET /{javaInterface] - Get the list of all remoteable methods on the specified interface name.

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

getOptions

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

destroy, getContext, getProperties, getServletConfig, init, log, log, log, log, logObjects, service

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

RemoteableServlet

public RemoteableServlet()

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="/")
public List<LinkString> getInterfaces(RestRequest req)
                                                                             throws Exception

[GET /] - Get the list of all remote interfaces.

Parameters:

req - The HTTP servlet request.

Returns:

The list of links to the remote interfaces.

Throws:

Exception

listMethods

@RestMethod(name="GET",
            path="/{javaInterface}",
            summary="List of available methods on $RP{javaInterface}.")
public Collection<LinkString> listMethods(RestRequest req,
                                                                                                                                                                               @Path(value="javaInterface")
                                                                                                                                                                               String javaInterface)
                                                                                                                                                                        throws Exception

[GET /{javaInterface] - Get the list of all remoteable methods on the specified interface name.

Parameters:

req - The HTTP servlet request.

javaInterface - The Java interface name.

Returns:

The methods defined on the interface.

Throws:

Exception

showEntryForm

@RestMethod(name="GET",
            path="/{javaInterface}/{javaMethod}",
            summary="Form entry for method $RP{javaMethod} on interface $RP{javaInterface}")
public Div showEntryForm(RestRequest req,
                                                                                                                                                                                                @Path(value="javaInterface")
                                                                                                                                                                                                String javaInterface,
                                                                                                                                                                                                @Path(value="javaMethod")
                                                                                                                                                                                                String javaMethod)
                                                                                                                                                                                         throws Exception

[GET /{javaInterface] - Get the list of all remoteable methods on the specified interface name.

Parameters:

req - The HTTP servlet request.

javaInterface - The Java interface name.

javaMethod - The Java method name or signature.

Returns:

A simple form entry page for invoking a remoteable method.

Throws:

Exception

invoke

@RestMethod(name="POST",
            path="/{javaInterface}/{javaMethod}")
public Object invoke(RestRequest req,
                                                                                                @Path
                                                                                                String javaInterface,
                                                                                                @Path
                                                                                                String javaMethod)
                                                                                         throws Exception

[POST /{javaInterface}/{javaMethod}] - Invoke the specified service method.

Parameters:

req - The HTTP request.

javaInterface - The Java interface name.

javaMethod - The Java method name or signature.

Returns:

The results from invoking the specified Java method.

Throws:

Exception