Package org.rribbit.processing

Class RmiRequestProcessorImpl

java.lang.Object

org.rribbit.processing.RmiRequestProcessorImpl

All Implemented Interfaces:

Remote, RmiRequestProcessor

public class RmiRequestProcessorImpl
extends Object
implements RmiRequestProcessor

This RequestProcessor processes requests that it receives from an RmiRequestDispatcher and returns the result via RMI. In order to use this RequestProcessor, all parameters and return values must implement Serializable. Note that an RmiRequestProcessorImpl is not actually an RequestProcessor, because Java RMI does not allow non-remote methods in a remote interface. This is not a problem though, since an RmiRequestProcessorImpl receives its requests via RMI and not via a Java interface.

Users of this class must call shutdown() after use, to clean up the RMI Registry.

Author:

G.J. Schouten

Field Summary

Fields

Modifier and Type	Field	Description
protected Registry	registry
protected LocalRequestProcessor	requestProcessor

Fields inherited from interface org.rribbit.processing.RmiRequestProcessor

REGISTRY_KEY

Constructor Summary

Constructors

Constructor	Description
RmiRequestProcessorImpl(int portnumber)	Sets up a Registry on the specified portnumber that does NOT use SSL.
RmiRequestProcessorImpl(int portnumber, String keystoreLocation, String keystorePassword, String truststoreLocation, String truststorePassword)	Sets up a Registry on the specified portnumber that uses SSL with the supplied parameters.
RmiRequestProcessorImpl(int portnumber, String keystoreLocation, String keystorePassword, String truststoreLocation, String truststorePassword, ListenerObjectRetriever listenerObjectRetriever, ListenerObjectExecutor listenerObjectExecutor)	Sets up a Registry on the specified portnumber that uses SSL with the supplied parameters.
RmiRequestProcessorImpl(int portnumber, ListenerObjectRetriever listenerObjectRetriever, ListenerObjectExecutor listenerObjectExecutor)	Sets up a Registry on the specified portnumber that does NOT use SSL.

Method Summary

Modifier and Type	Method	Description
ListenerObjectExecutor	getListenerObjectExecutor()
ListenerObjectRetriever	getListenerObjectRetriever()
<T> Response<T>	processRequestViaRMI(Request request)	Processes a Request and returns the Response.
void	setListenerObjectExecutor(ListenerObjectExecutor listenerObjectExecutor)
void	setListenerObjectRetriever(ListenerObjectRetriever listenerObjectRetriever)
void	shutdown()	Call this method at application shutdown to make sure that the RMI Registry gets closed properly.

Methods inherited from class java.lang.Object

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

Field Details

requestProcessor

protected LocalRequestProcessor requestProcessor

registry

protected Registry registry

Constructor Details

RmiRequestProcessorImpl

public RmiRequestProcessorImpl(int portnumber)

Sets up a Registry on the specified portnumber that does NOT use SSL.

Whenever you use this constructor, be sure to set the ListenerObjectRetriever AND the ListenerObjectExecutor with the setters provided by this class. If you don't, runtime NullPointerExceptions will occur.

Parameters:

portnumber - The portnumber to use

RmiRequestProcessorImpl

public RmiRequestProcessorImpl(int portnumber,
 ListenerObjectRetriever listenerObjectRetriever,
 ListenerObjectExecutor listenerObjectExecutor)

Sets up a Registry on the specified portnumber that does NOT use SSL.

This constructor is recommended, since it forces you to specify the ListenerObjectRetriever and ListenerObjectExecutor. Passing a null value for either of these will result in a runtime NullPointerException whenever the RmiRequestProcessorImpl is used.

Parameters:

portnumber - The portnumber to use

listenerObjectRetriever -

listenerObjectExecutor -

RmiRequestProcessorImpl

public RmiRequestProcessorImpl(int portnumber,
 String keystoreLocation,
 String keystorePassword,
 String truststoreLocation,
 String truststorePassword)

Sets up a Registry on the specified portnumber that uses SSL with the supplied parameters. The following system properties will be set:

• javax.net.ssl.keyStore
• javax.net.ssl.keyStorePassword
• javax.net.ssl.trustStore

Whenever you use this constructor, be sure to set the ListenerObjectRetriever AND the ListenerObjectExecutor with the setters provided by this class. If you don't, runtime NullPointerExceptions will occur.

Parameters:

portnumber - The portnumber to use

keystoreLocation - The filepath that contains the SSL keystore, without file://

keystorePassword - The password of the SSL keystore

truststoreLocation - The filepath that contains the SSL truststore, without file://

truststorePassword - The password of the SSL truststore

RmiRequestProcessorImpl

public RmiRequestProcessorImpl(int portnumber,
 String keystoreLocation,
 String keystorePassword,
 String truststoreLocation,
 String truststorePassword,
 ListenerObjectRetriever listenerObjectRetriever,
 ListenerObjectExecutor listenerObjectExecutor)

Sets up a Registry on the specified portnumber that uses SSL with the supplied parameters. The following system properties will be set:

• javax.net.ssl.keyStore
• javax.net.ssl.keyStorePassword
• javax.net.ssl.trustStore

This constructor is recommended, since it forces you to specify the ListenerObjectRetriever and ListenerObjectExecutor. Passing a null value for either of these will result in a runtime NullPointerException whenever the RmiRequestProcessorImpl is used.

Parameters:

portnumber - The portnumber to use

keystoreLocation - The filepath that contains the SSL keystore, without file://

keystorePassword - The password of the SSL keystore

truststoreLocation - The filepath that contains the SSL truststore, without file://

truststorePassword - The password of the SSL truststore

listenerObjectRetriever -

listenerObjectExecutor -

Method Details

shutdown

public void shutdown()

Call this method at application shutdown to make sure that the RMI Registry gets closed properly. Pending requests will be allowed to finish before the Registry is killed.

processRequestViaRMI

public <T> Response<T> processRequestViaRMI(Request request)

Description copied from interface: RmiRequestProcessor

Processes a Request and returns the Response. This method should just call RequestProcessor.processRequest(Request), but is necessary, because Java RMI requires you to declare a RemoteException on remote methods.

Specified by:

processRequestViaRMI in interface RmiRequestProcessor

Parameters:

request - The Request to process

Returns:

The Response

getListenerObjectRetriever

public ListenerObjectRetriever getListenerObjectRetriever()

setListenerObjectRetriever

public void setListenerObjectRetriever(ListenerObjectRetriever listenerObjectRetriever)

getListenerObjectExecutor

public ListenerObjectExecutor getListenerObjectExecutor()

setListenerObjectExecutor

public void setListenerObjectExecutor(ListenerObjectExecutor listenerObjectExecutor)