|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.jndi.JndiAccessor org.springframework.jndi.JndiLocatorSupport org.springframework.jndi.JndiObjectLocator org.springframework.remoting.rmi.JndiRmiClientInterceptor
public class JndiRmiClientInterceptor
Interceptor 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>
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(MethodInvocation methodInvocation)
Create a new RemoteInvocation object for the given AOP method invocation. |
protected Object |
doInvoke(MethodInvocation invocation,
Remote stub)
Perform the given invocation on the given RMI stub. |
protected Object |
doInvoke(MethodInvocation methodInvocation,
RmiInvocationHandler invocationHandler)
Apply the given AOP method invocation to the given RmiInvocationHandler . |
RemoteInvocationFactory |
getRemoteInvocationFactory()
Return the RemoteInvocationFactory used by this accessor. |
Class |
getServiceInterface()
Return the interface of the service to access. |
protected Remote |
getStub()
Return the RMI stub to use. |
Object |
invoke(MethodInvocation invocation)
Fetches an RMI stub and delegates to doInvoke(org.aopalliance.intercept.MethodInvocation, java.rmi.Remote) . |
protected boolean |
isConnectFailure(RemoteException ex)
Determine whether the given RMI exception indicates a connect failure. |
protected boolean |
isConnectFailure(SystemException ex)
Determine whether the given CORBA exception indicates a connect failure. |
protected Remote |
lookupStub()
Create the RMI stub, typically by looking it up. |
void |
prepare()
Fetches the RMI stub on startup, if necessary. |
protected Object |
refreshAndRetry(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(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 |
---|
public JndiRmiClientInterceptor()
Method Detail |
---|
public void setServiceInterface(Class serviceInterface)
Typically required to be able to create a suitable service proxy, but can also be optional if the lookup returns a typed stub.
public Class getServiceInterface()
public void setRemoteInvocationFactory(RemoteInvocationFactory remoteInvocationFactory)
DefaultRemoteInvocationFactory
.
A custom invocation factory can add further context information to the invocation, for example user credentials.
public RemoteInvocationFactory getRemoteInvocationFactory()
public void setLookupStubOnStartup(boolean lookupStubOnStartup)
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.
setCacheStub(boolean)
public void setCacheStub(boolean cacheStub)
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.
setLookupStubOnStartup(boolean)
public void setRefreshStubOnConnectFailure(boolean refreshStubOnConnectFailure)
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.
public void afterPropertiesSet() throws NamingException
InitializingBean
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.
afterPropertiesSet
in interface InitializingBean
afterPropertiesSet
in class JndiObjectLocator
NamingException
public void prepare() throws NamingException, RemoteLookupFailureException
Note: As of Spring 2.1, this method will always throw RemoteLookupFailureException and not declare NamingException anymore.
NamingException
- if the JNDI lookup failed
RemoteLookupFailureException
- if RMI stub creation failedsetLookupStubOnStartup(boolean)
,
lookupStub()
protected Remote lookupStub() throws NamingException, RemoteLookupFailureException
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.
NamingException
- if the JNDI lookup failed
RemoteLookupFailureException
- if RMI stub creation failedsetCacheStub(boolean)
,
JndiObjectLocator.lookup()
protected Remote getStub() throws NamingException, RemoteLookupFailureException
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.
NamingException
- if stub creation failed
RemoteLookupFailureException
- if RMI stub creation failedpublic Object invoke(MethodInvocation invocation) throws Throwable
doInvoke(org.aopalliance.intercept.MethodInvocation, java.rmi.Remote)
.
If configured to refresh on connect failure, it will call
refreshAndRetry(org.aopalliance.intercept.MethodInvocation)
on corresponding RMI exceptions.
invoke
in interface MethodInterceptor
protected boolean isConnectFailure(RemoteException ex)
The default implementation delegates to
RmiClientInterceptorUtils.isConnectFailure(java.rmi.RemoteException)
.
ex
- the RMI exception to check
protected boolean isConnectFailure(SystemException ex)
The default implementation checks for CORBA's
OBJECT_NOT_EXIST
exception.
ex
- the RMI exception to check
protected Object refreshAndRetry(MethodInvocation invocation) throws Throwable
invocation
- the AOP method invocation
Throwable
- in case of invocation failureinvoke(org.aopalliance.intercept.MethodInvocation)
protected Object doInvoke(MethodInvocation invocation, Remote stub) throws Throwable
invocation
- the AOP method invocationstub
- the RMI stub to invoke
Throwable
- in case of invocation failureprotected Object doInvoke(MethodInvocation methodInvocation, RmiInvocationHandler invocationHandler) throws RemoteException, NoSuchMethodException, IllegalAccessException, InvocationTargetException
RmiInvocationHandler
.
The default implementation delegates to createRemoteInvocation(org.aopalliance.intercept.MethodInvocation)
.
methodInvocation
- the current AOP method invocationinvocationHandler
- the RmiInvocationHandler to apply the invocation to
RemoteException
- in case of communication errors
NoSuchMethodException
- if the method name could not be resolved
IllegalAccessException
- if the method could not be accessed
InvocationTargetException
- if the method invocation resulted in an exceptionRemoteInvocation
protected RemoteInvocation createRemoteInvocation(MethodInvocation methodInvocation)
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.
methodInvocation
- the current AOP method invocation
RemoteInvocationFactory.createRemoteInvocation(org.aopalliance.intercept.MethodInvocation)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |