Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

JaxRpcPortProxyFactoryBean

extends JaxRpcPortClientInterceptor
implements BeanClassLoaderAware FactoryBean<T>

java.lang.Object
↳	org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactory
	↳	org.springframework.remoting.jaxrpc.JaxRpcPortClientInterceptor
		↳	org.springframework.remoting.jaxrpc.JaxRpcPortProxyFactoryBean

This class is deprecated.
in favor of JAX-WS support in org.springframework.remoting.jaxws

Class Overview

FactoryBean for a specific port of a JAX-RPC service. Exposes a proxy for the port, to be used for bean references. Inherits configuration properties from JaxRpcPortClientInterceptor.

This factory is typically used with an RMI service interface. Alternatively, this factory can also proxy a JAX-RPC 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 JAX-RPC stub will automatically get converted to Spring's unchecked RemoteAccessException.

If exposing the JAX-RPC port interface (i.e. an RMI interface) directly, setting "serviceInterface" is sufficient. If exposing a non-RMI business interface, the business interface needs to be set as "serviceInterface", and the JAX-RPC port interface as "portInterface".

Summary

[Expand]

Inherited Fields

From class org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactory

Public Constructors
	JaxRpcPortProxyFactoryBean()

Public Methods
void	afterPropertiesSet() Prepares the JAX-RPC service and port if the "lookupServiceOnStartup" is turned on (which it is by default).
Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
Class<?>	getObjectType() Return the type of object that this FactoryBean creates, or `null` if not known in advance.
boolean	isSingleton() Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory.
void	setBeanClassLoader(ClassLoader classLoader) Callback that supplies the bean `class loader` to a bean instance.

[Expand]

Inherited Methods

From class org.springframework.remoting.jaxrpc.JaxRpcPortClientInterceptor

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).
boolean	alwaysUseJaxRpcCall() Return whether to always use JAX-RPC dynamic calls.
Object	doInvoke(MethodInvocation invocation, Remote portStub) Perform a JAX-RPC service invocation on the given port stub.
Object	doInvoke(MethodInvocation invocation) Perform a JAX-RPC service invocation based on the given method invocation.
Map<String, Object>	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.
final QName	getPortQName() Return the prepared QName for the port.
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.
Throwable	handleRemoteException(Method method, RemoteException ex) Handle the given RemoteException that was thrown from a JAX-RPC port stub or JAX-RPC call invocation.
Object	invoke(MethodInvocation invocation) Translates the method invocation into a JAX-RPC service invocation.
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.
boolean	isPrepared() Return whether this client interceptor has already been prepared, i.e.
Object	performJaxRpcCall(MethodInvocation invocation, Service service) Perform a JAX-RPC dynamic call for the given AOP method invocation.
void	postProcessJaxRpcCall(Call call, MethodInvocation invocation) Post-process the given JAX-RPC call.
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.
void	prepareJaxRpcCall(Call call) Prepare the given JAX-RPC call, applying properties to it.
void	preparePortStub(Stub stub) Prepare the given JAX-RPC port stub, applying properties to it.
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<String, Object> 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.

From class org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactory

Service	createJaxRpcService() Create a JAX-RPC Service according to the parameters of this factory.
Service	createService(ServiceFactory serviceFactory) Actually create the JAX-RPC Service instance, based on this factory's settings.
ServiceFactory	createServiceFactory() Create a JAX-RPC ServiceFactory, either of the specified class or the default.
Class	getJaxRpcServiceInterface() Return the JAX-RPC service interface to use for looking up the service.
Properties	getJaxRpcServiceProperties() Return JAX-RPC service properties to be passed to the ServiceFactory, if any.
String	getNamespaceUri() Return the namespace URI of the service.
QName	getQName(String name) Return a QName for the given name, relative to the namespace URI of this factory, if given.
ServiceFactory	getServiceFactory() Return the specified ServiceFactory instance, if any.
Class	getServiceFactoryClass() Return the ServiceFactory class to use, or `null` if default.
String	getServiceName() Return the name of the service.
JaxRpcServicePostProcessor[]	getServicePostProcessors() Return the JaxRpcServicePostProcessors to be applied to JAX-RPC Service instances created by this factory.
URL	getWsdlDocumentUrl() Return the URL of the WSDL document that describes the service.
void	postProcessJaxRpcService(Service service) Post-process the given JAX-RPC Service.
void	setJaxRpcServiceInterface(Class jaxRpcServiceInterface) Set the JAX-RPC service interface to use for looking up the service.
void	setJaxRpcServiceProperties(Properties jaxRpcServiceProperties) Set JAX-RPC service properties to be passed to the ServiceFactory, if any.
void	setNamespaceUri(String namespaceUri) Set the namespace URI of the service.
void	setServiceFactory(ServiceFactory serviceFactory) Set the ServiceFactory instance to use.
void	setServiceFactoryClass(Class serviceFactoryClass) Set the ServiceFactory class to use, for example "org.apache.axis.client.ServiceFactory".
void	setServiceName(String serviceName) Set the name of the service to look up.
void	setServicePostProcessors(JaxRpcServicePostProcessor[] servicePostProcessors) Set the JaxRpcServicePostProcessors to be applied to JAX-RPC Service instances created by this factory.
void	setWsdlDocumentUrl(URL wsdlDocumentUrl) Set the URL of the WSDL document that describes the service.

From class java.lang.Object

From interface org.springframework.beans.factory.BeanClassLoaderAware

From interface org.springframework.beans.factory.FactoryBean

From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public JaxRpcPortProxyFactoryBean ()

Public Methods

public void afterPropertiesSet ()

Prepares the JAX-RPC service and port if the "lookupServiceOnStartup" is turned on (which it is by default).

public Object getObject ()

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns

an instance of the bean (can be null)

public Class<?> getObjectType ()

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns

the type of object that this FactoryBean creates, or null if not known at the time of the call

public boolean isSingleton ()

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

Returns

whether the exposed object is a singleton

public void setBeanClassLoader (ClassLoader classLoader)

Callback that supplies the bean class loader to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's afterPropertiesSet() method or a custom init-method.

Parameters

classLoader	the owning class loader; may be `null` in which case a default `ClassLoader` must be used, for example the `ClassLoader` obtained via `getDefaultClassLoader()`

Interfaces

Classes

Exceptions

JaxRpcPortProxyFactoryBean

Class Overview

See Also

Summary

Public Constructors

public JaxRpcPortProxyFactoryBean ()

Public Methods

public void afterPropertiesSet ()

public Object getObject ()

Returns

public Class<?> getObjectType ()

Returns

public boolean isSingleton ()

Returns

public void setBeanClassLoader (ClassLoader classLoader)

Parameters