Spring Framework

org.springframework.remoting.rmi
Class JndiRmiClientInterceptor

java.lang.Object
  extended by org.springframework.jndi.JndiAccessor
      extended by org.springframework.jndi.JndiLocatorSupport
          extended by org.springframework.jndi.JndiObjectLocator
              extended by org.springframework.remoting.rmi.JndiRmiClientInterceptor
All Implemented Interfaces:
org.aopalliance.aop.Advice, org.aopalliance.intercept.Interceptor, org.aopalliance.intercept.MethodInterceptor, InitializingBean
Direct Known Subclasses:
JndiRmiProxyFactoryBean

public class JndiRmiClientInterceptor
extends JndiObjectLocator
implements org.aopalliance.intercept.MethodInterceptor, InitializingBean

MethodInterceptor for accessing RMI services from JNDI. Typically used for RMI-IIOP (CORBA), but can also be used for EJB home objects (for example, a Stateful Session Bean home). In contrast to a plain JNDI lookup, this accessor also performs narrowing through PortableRemoteObject.

With conventional RMI services, this invoker is typically used with the RMI service interface. Alternatively, this invoker can also proxy a remote RMI service with a matching non-RMI business interface, i.e. an interface that mirrors the RMI service methods but does not declare RemoteExceptions. In the latter case, RemoteExceptions thrown by the RMI stub will automatically get converted to Spring's unchecked RemoteAccessException.

The JNDI environment can be specified as "jndiEnvironment" property, or be configured in a jndi.properties file or as system properties. For example:

<property name="jndiEnvironment">
         <props>
                 <prop key="java.naming.factory.initial">com.sun.jndi.cosnaming.CNCtxFactory</prop>
                 <prop key="java.naming.provider.url">iiop://localhost:1050</prop>
         </props>
 </property>

Since:
1.1
Author:
Juergen Hoeller
See Also:
JndiAccessor.setJndiTemplate(org.springframework.jndi.JndiTemplate), JndiAccessor.setJndiEnvironment(java.util.Properties), JndiObjectLocator.setJndiName(java.lang.String), JndiRmiServiceExporter, JndiRmiProxyFactoryBean, RemoteAccessException, RemoteException, Remote, PortableRemoteObject.narrow(java.lang.Object, java.lang.Class)

Field Summary
 
Fields inherited from class org.springframework.jndi.JndiLocatorSupport
CONTAINER_PREFIX
 
Fields inherited from class org.springframework.jndi.JndiAccessor
logger
 
Constructor Summary
JndiRmiClientInterceptor()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
protected  RemoteInvocation createRemoteInvocation(org.aopalliance.intercept.MethodInvocation methodInvocation)
          Create a new RemoteInvocation object for the given AOP method invocation.
protected  java.lang.Object doInvoke(org.aopalliance.intercept.MethodInvocation invocation, java.lang.Object stub)
          Perform the given invocation on the given RMI stub.
protected  java.lang.Object doInvoke(org.aopalliance.intercept.MethodInvocation methodInvocation, RmiInvocationHandler invocationHandler)
          Apply the given AOP method invocation to the given RmiInvocationHandler.
 RemoteInvocationFactory getRemoteInvocationFactory()
          Return the RemoteInvocationFactory used by this accessor.
 java.lang.Class getServiceInterface()
          Return the interface of the service to access.
protected  java.lang.Object getStub()
          Return the RMI stub to use.
 java.lang.Object invoke(org.aopalliance.intercept.MethodInvocation invocation)
          Fetches an RMI stub and delegates to doInvoke(org.aopalliance.intercept.MethodInvocation, java.lang.Object).
protected  boolean isConnectFailure(java.rmi.RemoteException ex)
          Determine whether the given RMI exception indicates a connect failure.
protected  boolean isConnectFailure(org.omg.CORBA.SystemException ex)
          Determine whether the given CORBA exception indicates a connect failure.
protected  java.lang.Object lookupStub()
          Create the RMI stub, typically by looking it up.
 void prepare()
          Fetches the RMI stub on startup, if necessary.
protected  java.lang.Object refreshAndRetry(org.aopalliance.intercept.MethodInvocation invocation)
          Refresh the RMI stub and retry the given invocation.
 void setCacheStub(boolean cacheStub)
          Set whether to cache the RMI stub once it has been located.
 void setLookupStubOnStartup(boolean lookupStubOnStartup)
          Set whether to look up the RMI stub on startup.
 void setRefreshStubOnConnectFailure(boolean refreshStubOnConnectFailure)
          Set whether to refresh the RMI stub on connect failure.
 void setRemoteInvocationFactory(RemoteInvocationFactory remoteInvocationFactory)
          Set the RemoteInvocationFactory to use for this accessor.
 void setServiceInterface(java.lang.Class serviceInterface)
          Set the interface of the service to access.
 
Methods inherited from class org.springframework.jndi.JndiObjectLocator
getExpectedType, getJndiName, lookup, setExpectedType, setJndiName
 
Methods inherited from class org.springframework.jndi.JndiLocatorSupport
convertJndiName, isResourceRef, lookup, lookup, setResourceRef
 
Methods inherited from class org.springframework.jndi.JndiAccessor
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JndiRmiClientInterceptor

public JndiRmiClientInterceptor()
Method Detail

setServiceInterface

public void setServiceInterface(java.lang.Class serviceInterface)
Set the interface of the service to access. The interface must be suitable for the particular service and remoting tool.

Typically required to be able to create a suitable service proxy, but can also be optional if the lookup returns a typed stub.


getServiceInterface

public java.lang.Class getServiceInterface()
Return the interface of the service to access.


setRemoteInvocationFactory

public void setRemoteInvocationFactory(RemoteInvocationFactory remoteInvocationFactory)
Set the RemoteInvocationFactory to use for this accessor. Default is a DefaultRemoteInvocationFactory.

A custom invocation factory can add further context information to the invocation, for example user credentials.


getRemoteInvocationFactory

public RemoteInvocationFactory getRemoteInvocationFactory()
Return the RemoteInvocationFactory used by this accessor.


setLookupStubOnStartup

public void setLookupStubOnStartup(boolean lookupStubOnStartup)
Set whether to look up the RMI stub on startup. Default is "true".

Can be turned off to allow for late start of the RMI server. In this case, the RMI stub will be fetched on first access.

See Also:
setCacheStub(boolean)

setCacheStub

public void setCacheStub(boolean cacheStub)
Set whether to cache the RMI stub once it has been located. Default is "true".

Can be turned off to allow for hot restart of the RMI server. In this case, the RMI stub will be fetched for each invocation.

See Also:
setLookupStubOnStartup(boolean)

setRefreshStubOnConnectFailure

public void setRefreshStubOnConnectFailure(boolean refreshStubOnConnectFailure)
Set whether to refresh the RMI stub on connect failure. Default is "false".

Can be turned on to allow for hot restart of the RMI server. If a cached RMI stub throws an RMI exception that indicates a remote connect failure, a fresh proxy will be fetched and the invocation will be retried.

See Also:
ConnectException, ConnectIOException, NoSuchObjectException

afterPropertiesSet

public void afterPropertiesSet()
                        throws javax.naming.NamingException
Description copied from interface: InitializingBean
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:
afterPropertiesSet in interface InitializingBean
Overrides:
afterPropertiesSet in class JndiObjectLocator
Throws:
javax.naming.NamingException

prepare

public void prepare()
             throws RemoteLookupFailureException
Fetches the RMI stub on startup, if necessary.

Throws:
RemoteLookupFailureException - if RMI stub creation failed
See Also:
setLookupStubOnStartup(boolean), lookupStub()

lookupStub

protected java.lang.Object lookupStub()
                               throws RemoteLookupFailureException
Create the RMI stub, typically by looking it up.

Called on interceptor initialization if "cacheStub" is "true"; else called for each invocation by getStub().

The default implementation retrieves the service from the JNDI environment. This can be overridden in subclasses.

Returns:
the RMI stub to store in this interceptor
Throws:
RemoteLookupFailureException - if RMI stub creation failed
See Also:
setCacheStub(boolean), JndiObjectLocator.lookup()

getStub

protected java.lang.Object getStub()
                            throws javax.naming.NamingException,
                                   RemoteLookupFailureException
Return the RMI stub to use. Called for each invocation.

The default implementation returns the stub created on initialization, if any. Else, it invokes lookupStub() to get a new stub for each invocation. This can be overridden in subclasses, for example in order to cache a stub for a given amount of time before recreating it, or to test the stub whether it is still alive.

Returns:
the RMI stub to use for an invocation
Throws:
javax.naming.NamingException - if stub creation failed
RemoteLookupFailureException - if RMI stub creation failed

invoke

public java.lang.Object invoke(org.aopalliance.intercept.MethodInvocation invocation)
                        throws java.lang.Throwable
Fetches an RMI stub and delegates to doInvoke(org.aopalliance.intercept.MethodInvocation, java.lang.Object). If configured to refresh on connect failure, it will call refreshAndRetry(org.aopalliance.intercept.MethodInvocation) on corresponding RMI exceptions.

Specified by:
invoke in interface org.aopalliance.intercept.MethodInterceptor
Throws:
java.lang.Throwable
See Also:
getStub(), doInvoke(org.aopalliance.intercept.MethodInvocation, java.lang.Object), refreshAndRetry(org.aopalliance.intercept.MethodInvocation), ConnectException, ConnectIOException, NoSuchObjectException

isConnectFailure

protected boolean isConnectFailure(java.rmi.RemoteException ex)
Determine whether the given RMI exception indicates a connect failure.

The default implementation delegates to RmiClientInterceptorUtils.isConnectFailure(java.rmi.RemoteException).

Parameters:
ex - the RMI exception to check
Returns:
whether the exception should be treated as connect failure

isConnectFailure

protected boolean isConnectFailure(org.omg.CORBA.SystemException ex)
Determine whether the given CORBA exception indicates a connect failure.

The default implementation checks for CORBA's OBJECT_NOT_EXIST exception.

Parameters:
ex - the RMI exception to check
Returns:
whether the exception should be treated as connect failure

refreshAndRetry

protected java.lang.Object refreshAndRetry(org.aopalliance.intercept.MethodInvocation invocation)
                                    throws java.lang.Throwable
Refresh the RMI stub and retry the given invocation. Called by invoke on connect failure.

Parameters:
invocation - the AOP method invocation
Returns:
the invocation result, if any
Throws:
java.lang.Throwable - in case of invocation failure
See Also:
invoke(org.aopalliance.intercept.MethodInvocation)

doInvoke

protected java.lang.Object doInvoke(org.aopalliance.intercept.MethodInvocation invocation,
                                    java.lang.Object stub)
                             throws java.lang.Throwable
Perform the given invocation on the given RMI stub.

Parameters:
invocation - the AOP method invocation
stub - the RMI stub to invoke
Returns:
the invocation result, if any
Throws:
java.lang.Throwable - in case of invocation failure

doInvoke

protected java.lang.Object doInvoke(org.aopalliance.intercept.MethodInvocation methodInvocation,
                                    RmiInvocationHandler invocationHandler)
                             throws java.rmi.RemoteException,
                                    java.lang.NoSuchMethodException,
                                    java.lang.IllegalAccessException,
                                    java.lang.reflect.InvocationTargetException
Apply the given AOP method invocation to the given RmiInvocationHandler.

The default implementation delegates to createRemoteInvocation(org.aopalliance.intercept.MethodInvocation).

Parameters:
methodInvocation - the current AOP method invocation
invocationHandler - the RmiInvocationHandler to apply the invocation to
Returns:
the invocation result
Throws:
java.rmi.RemoteException - in case of communication errors
java.lang.NoSuchMethodException - if the method name could not be resolved
java.lang.IllegalAccessException - if the method could not be accessed
java.lang.reflect.InvocationTargetException - if the method invocation resulted in an exception
See Also:
RemoteInvocation

createRemoteInvocation

protected RemoteInvocation createRemoteInvocation(org.aopalliance.intercept.MethodInvocation methodInvocation)
Create a new RemoteInvocation object for the given AOP method invocation.

The default implementation delegates to the configured RemoteInvocationFactory. This can be overridden in subclasses in order to provide custom RemoteInvocation subclasses, containing additional invocation parameters (e.g. user credentials).

Note that it is preferable to build a custom RemoteInvocationFactory as a reusable strategy, instead of overriding this method.

Parameters:
methodInvocation - the current AOP method invocation
Returns:
the RemoteInvocation object
See Also:
RemoteInvocationFactory.createRemoteInvocation(org.aopalliance.intercept.MethodInvocation)

Spring Framework