|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactory org.springframework.remoting.jaxrpc.JaxRpcPortClientInterceptor
public class JaxRpcPortClientInterceptor
Interceptor for accessing a specific port of a JAX-RPC service.
Uses either LocalJaxRpcServiceFactory
's facilities underneath,
or takes an explicit reference to an existing JAX-RPC Service instance
(e.g. obtained via JndiObjectFactoryBean
).
Allows to set JAX-RPC's standard stub properties directly, via the "username", "password", "endpointAddress" and "maintainSession" properties. For typical usage, it is not necessary to specify those.
In standard JAX-RPC style, this invoker is used with an RMI service interface. Alternatively, this invoker can also proxy a JAX-RPC service with a matching non-RMI business interface, that is, an interface that declares the service methods without RemoteExceptions. In the latter case, RemoteExceptions thrown by JAX-RPC will automatically get converted to Spring's unchecked RemoteAccessException.
Setting "serviceInterface" is usually sufficient: The invoker will automatically use JAX-RPC "dynamic invocations" via the Call API in this case, no matter whether the specified interface is an RMI or non-RMI interface. Alternatively, a corresponding JAX-RPC port interface can be specified as "portInterface", which will turn this invoker into "static invocation" mode (operating on a standard JAX-RPC port stub).
setPortName(java.lang.String)
,
setServiceInterface(java.lang.Class)
,
setPortInterface(java.lang.Class)
,
Service.createCall(javax.xml.namespace.QName)
,
Service.getPort(javax.xml.namespace.QName, java.lang.Class)
,
RemoteAccessException
,
JndiObjectFactoryBean
Field Summary |
---|
Fields inherited from class org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactory |
---|
logger |
Constructor Summary | |
---|---|
JaxRpcPortClientInterceptor()
|
Method Summary | |
---|---|
void |
addCustomProperty(String name,
Object value)
Add a custom property to this JAX-RPC Stub/Call. |
void |
afterPropertiesSet()
Prepares the JAX-RPC service and port if the "lookupServiceOnStartup" is turned on (which it is by default). |
protected boolean |
alwaysUseJaxRpcCall()
Return whether to always use JAX-RPC dynamic calls. |
protected Object |
doInvoke(MethodInvocation invocation)
Perform a JAX-RPC service invocation based on the given method invocation. |
protected Object |
doInvoke(MethodInvocation invocation,
Remote portStub)
Perform a JAX-RPC service invocation based on the given port stub. |
Map |
getCustomPropertyMap()
Allow Map access to the custom properties to be set on the stub or call, with the option to add or override specific entries. |
String |
getEndpointAddress()
Return the endpoint address to specify on the stub or call. |
Service |
getJaxRpcService()
Return a reference to an existing JAX-RPC Service instance, if any. |
String |
getPassword()
Return the password to specify on the stub or call. |
Class |
getPortInterface()
Return the JAX-RPC port interface to use. |
String |
getPortName()
Return the name of the port. |
protected QName |
getPortQName()
Return the prepared QName for the port. |
protected Remote |
getPortStub()
Return the underlying JAX-RPC port stub that this interceptor delegates to for each method invocation on the proxy. |
Class |
getServiceInterface()
Return the interface of the service that this factory should create a proxy for. |
String |
getUsername()
Return the username to specify on the stub or call. |
Object |
invoke(MethodInvocation invocation)
Translates the method invocation into a JAX-RPC service invocation. |
protected boolean |
isConnectFailure(RemoteException ex)
Determine whether the given RMI exception indicates a connect failure. |
boolean |
isMaintainSession()
Return the maintain session flag to specify on the stub or call. |
protected boolean |
isPrepared()
Return whether this client interceptor has already been prepared, i.e. has already looked up the JAX-RPC service and port. |
protected Object |
performJaxRpcCall(MethodInvocation invocation)
Deprecated. as of Spring 2.0.3, in favor of the performJaxRpcCall
variant with an explicit Service argument |
protected Object |
performJaxRpcCall(MethodInvocation invocation,
Service service)
Perform a JAX-RPC dynamic call for the given AOP method invocation. |
protected void |
postProcessJaxRpcCall(Call call,
MethodInvocation invocation)
Post-process the given JAX-RPC call. |
protected void |
postProcessPortStub(Stub stub)
Post-process the given JAX-RPC port stub. |
void |
prepare()
Create and initialize the JAX-RPC service for the specified port. |
protected void |
prepareJaxRpcCall(Call call)
Prepare the given JAX-RPC call, applying properties to it. |
protected void |
preparePortStub(Stub stub)
Prepare the given JAX-RPC port stub, applying properties to it. |
protected void |
reset()
Reset the prepared service of this interceptor, allowing for reinitialization on next access. |
void |
setCustomProperties(Properties customProperties)
Set custom properties to be set on the stub or call. |
void |
setCustomPropertyMap(Map customProperties)
Set custom properties to be set on the stub or call. |
void |
setEndpointAddress(String endpointAddress)
Set the endpoint address to specify on the stub or call. |
void |
setJaxRpcService(Service jaxRpcService)
Set a reference to an existing JAX-RPC Service instance, for example obtained via JndiObjectFactoryBean . |
void |
setLookupServiceOnStartup(boolean lookupServiceOnStartup)
Set whether to look up the JAX-RPC service on startup. |
void |
setMaintainSession(boolean maintainSession)
Set the maintain session flag to specify on the stub or call. |
void |
setPassword(String password)
Set the password to specify on the stub or call. |
void |
setPortInterface(Class portInterface)
Set the JAX-RPC port interface to use. |
void |
setPortName(String portName)
Set the name of the port. |
void |
setRefreshServiceAfterConnectFailure(boolean refreshServiceAfterConnectFailure)
Set whether to refresh the JAX-RPC service on connect failure, that is, whenever a JAX-RPC invocation throws a RemoteException. |
void |
setServiceInterface(Class serviceInterface)
Set the interface of the service that this factory should create a proxy for. |
void |
setUsername(String username)
Set the username to specify on the stub or call. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JaxRpcPortClientInterceptor()
Method Detail |
---|
public void setJaxRpcService(Service jaxRpcService)
JndiObjectFactoryBean
.
If not set, LocalJaxRpcServiceFactory's properties have to be specified.
public Service getJaxRpcService()
public void setPortName(String portName)
public String getPortName()
public void setUsername(String username)
Stub.USERNAME_PROPERTY
,
Call.USERNAME_PROPERTY
public String getUsername()
public void setPassword(String password)
Stub.PASSWORD_PROPERTY
,
Call.PASSWORD_PROPERTY
public String getPassword()
public void setEndpointAddress(String endpointAddress)
public String getEndpointAddress()
public void setMaintainSession(boolean maintainSession)
public boolean isMaintainSession()
public void setCustomProperties(Properties customProperties)
Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.
public void setCustomPropertyMap(Map customProperties)
Can be populated with a "map" or "props" element in XML bean definitions.
public Map getCustomPropertyMap()
Useful for specifying entries directly, for example via "customPropertyMap[myKey]". This is particularly useful for adding or overriding entries in child bean definitions.
public void addCustomProperty(String name, Object value)
name
- the name of the attribute to exposevalue
- the attribute value to exposeStub._setProperty(java.lang.String, java.lang.Object)
,
Call.setProperty(java.lang.String, java.lang.Object)
public void setServiceInterface(Class serviceInterface)
Calls on the specified service interface will either be translated to the underlying RMI port interface (in case of a "portInterface" being specified) or to dynamic calls (using the JAX-RPC Dynamic Invocation Interface).
The dynamic call mechanism has the advantage that you don't need to maintain an RMI port interface in addition to an existing non-RMI business interface. In terms of configuration, specifying the business interface as "serviceInterface" will be enough; this interceptor will automatically use dynamic calls in such a scenario.
public Class getServiceInterface()
public void setPortInterface(Class portInterface)
The interface must be suitable for a JAX-RPC port, that is, it must be
an RMI service interface (that extends java.rmi.Remote
).
NOTE: Check whether your JAX-RPC provider returns thread-safe port stubs. If not, use the dynamic call mechanism instead, which will always be thread-safe. In particular, do not use JAX-RPC port stubs with Apache Axis, whose port stubs are known to be non-thread-safe.
public Class getPortInterface()
public void setLookupServiceOnStartup(boolean lookupServiceOnStartup)
Default is "true". Turn this flag off to allow for late start of the target server. In this case, the JAX-RPC service will be lazily fetched on first access.
public void setRefreshServiceAfterConnectFailure(boolean refreshServiceAfterConnectFailure)
Default is "false", keeping a reference to the JAX-RPC service in any case, retrying the next invocation on the same service even in case of failure. Turn this flag on to reinitialize the entire service in case of connect failures.
public void afterPropertiesSet() throws ServiceException
afterPropertiesSet
in interface InitializingBean
ServiceException
public void prepare() throws ServiceException, RemoteLookupFailureException
Prepares a JAX-RPC stub if possible (if an RMI interface is available);
falls back to JAX-RPC dynamic calls else. Using dynamic calls can be
enforced through overriding alwaysUseJaxRpcCall
to return true.
postProcessJaxRpcService
and postProcessPortStub
hooks are available for customization in subclasses. When using dynamic calls,
each can be post-processed via postProcessJaxRpcCall
.
Note: As of Spring 2.1, this method will always throw RemoteLookupFailureException and not declare ServiceException anymore.
ServiceException
- in case of service initialization failure
RemoteLookupFailureException
- if port stub creation failedalwaysUseJaxRpcCall()
,
LocalJaxRpcServiceFactory.postProcessJaxRpcService(javax.xml.rpc.Service)
,
postProcessPortStub(javax.xml.rpc.Stub)
,
postProcessJaxRpcCall(javax.xml.rpc.Call, org.aopalliance.intercept.MethodInvocation)
protected boolean alwaysUseJaxRpcCall()
afterPropertiesSet
.
Default is "false"; if an RMI interface is specified as "portInterface" or "serviceInterface", it will be used to create a JAX-RPC port stub.
Can be overridden to enforce the use of the JAX-RPC Call API, for example if there is a need to customize at the Call level. This just necessary if you you want to use an RMI interface as "serviceInterface", though; in case of only a non-RMI interface being available, this interceptor will fall back to the Call API anyway.
protected void reset()
protected boolean isPrepared()
protected QName getPortQName()
protected void preparePortStub(Stub stub)
afterPropertiesSet
.
Just applied when actually creating a JAX-RPC port stub, in case of a specified JAX-RPC-compliant port interface. Else, JAX-RPC dynamic calls will be used.
stub
- the current JAX-RPC port stubafterPropertiesSet()
,
setUsername(java.lang.String)
,
setPassword(java.lang.String)
,
setEndpointAddress(java.lang.String)
,
setMaintainSession(boolean)
,
setCustomProperties(java.util.Properties)
,
setPortInterface(java.lang.Class)
,
prepareJaxRpcCall(javax.xml.rpc.Call)
protected void postProcessPortStub(Stub stub)
prepare
.
Just applied when actually creating a JAX-RPC port stub, in case of a specified JAX-RPC-compliant port interface. Else, JAX-RPC dynamic calls will be used.
stub
- the current JAX-RPC port stub
(can be cast to an implementation-specific class if necessary)prepare()
,
setPortInterface(java.lang.Class)
,
postProcessJaxRpcCall(javax.xml.rpc.Call, org.aopalliance.intercept.MethodInvocation)
protected Remote getPortStub()
public Object invoke(MethodInvocation invocation) throws Throwable
Prepares the service on the fly, if necessary, in case of lazy lookup or a connect failure having happened.
invoke
in interface MethodInterceptor
Throwable
prepare()
,
doInvoke(org.aopalliance.intercept.MethodInvocation)
protected Object doInvoke(MethodInvocation invocation) throws Throwable
Uses traditional RMI stub invocation if a JAX-RPC port stub is available; falls back to JAX-RPC dynamic calls else.
invocation
- the AOP method invocation
Throwable
- in case of invocation failuregetPortStub()
,
doInvoke(org.aopalliance.intercept.MethodInvocation, java.rmi.Remote)
,
performJaxRpcCall(org.aopalliance.intercept.MethodInvocation, javax.xml.rpc.Service)
protected Object doInvoke(MethodInvocation invocation, Remote portStub) throws Throwable
invocation
- the AOP method invocationportStub
- the RMI port stub to invoke
Throwable
- in case of invocation failuregetPortStub()
,
doInvoke(org.aopalliance.intercept.MethodInvocation, java.rmi.Remote)
,
performJaxRpcCall(org.aopalliance.intercept.MethodInvocation)
protected Object performJaxRpcCall(MethodInvocation invocation) throws Throwable
performJaxRpcCall
variant with an explicit Service argument
protected Object performJaxRpcCall(MethodInvocation invocation, Service service) throws Throwable
prepareJaxRpcCall
and
postProcessJaxRpcCall
for setting up the call object.
Default implementation uses method name as JAX-RPC operation name and method arguments as arguments for the JAX-RPC call. Can be overridden in subclasses for custom operation names and/or arguments.
invocation
- the current AOP MethodInvocation that should
be converted to a JAX-RPC call
Throwable
- the exception thrown by the invocation, if anygetPortQName()
,
prepareJaxRpcCall(javax.xml.rpc.Call)
,
postProcessJaxRpcCall(javax.xml.rpc.Call, org.aopalliance.intercept.MethodInvocation)
protected void prepareJaxRpcCall(Call call)
invoke
.
Just applied when actually using JAX-RPC dynamic calls, i.e. if no JAX-RPC-compliant port interface was specified. Else, a JAX-RPC port stub will be used.
call
- the current JAX-RPC call objectinvoke(org.aopalliance.intercept.MethodInvocation)
,
setUsername(java.lang.String)
,
setPassword(java.lang.String)
,
setEndpointAddress(java.lang.String)
,
setMaintainSession(boolean)
,
setCustomProperties(java.util.Properties)
,
setPortInterface(java.lang.Class)
,
preparePortStub(javax.xml.rpc.Stub)
protected void postProcessJaxRpcCall(Call call, MethodInvocation invocation)
invoke
.
Just applied when actually using JAX-RPC dynamic calls, that is, if no JAX-RPC-compliant port interface was specified. Else, a JAX-RPC port stub will be used.
call
- the current JAX-RPC call object
(can be cast to an implementation-specific class if necessary)invocation
- the current AOP MethodInvocation that the call was
created for (can be used to check method name, method parameters
and/or passed-in arguments)invoke(org.aopalliance.intercept.MethodInvocation)
,
setPortInterface(java.lang.Class)
,
postProcessPortStub(javax.xml.rpc.Stub)
protected boolean isConnectFailure(RemoteException ex)
The default implementation always returns true
,
assuming that the JAX-RPC provider only throws RemoteException
in case of connect failures.
ex
- the RMI exception to check
RmiClientInterceptorUtils.isConnectFailure(java.rmi.RemoteException)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |