org.springframework.remoting.jaxrpc
Class JaxRpcPortProxyFactoryBean

java.lang.Object
  extended by org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactory
      extended by org.springframework.remoting.jaxrpc.JaxRpcPortClientInterceptor
          extended by org.springframework.remoting.jaxrpc.JaxRpcPortProxyFactoryBean
All Implemented Interfaces:
Advice, Interceptor, MethodInterceptor, FactoryBean, InitializingBean

public class JaxRpcPortProxyFactoryBean
extends JaxRpcPortClientInterceptor
implements FactoryBean

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".

Since:
15.12.2003
Author:
Juergen Hoeller
See Also:
JaxRpcPortClientInterceptor.setServiceInterface(java.lang.Class), JaxRpcPortClientInterceptor.setPortInterface(java.lang.Class), LocalJaxRpcServiceFactoryBean

Field Summary
 
Fields inherited from class org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactory
logger
 
Constructor Summary
JaxRpcPortProxyFactoryBean()
           
 
Method Summary
 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 bean managed by this factory a singleton or a prototype?
 
Methods inherited from class org.springframework.remoting.jaxrpc.JaxRpcPortClientInterceptor
alwaysUseJaxRpcCall, getCustomProperties, getEndpointAddress, getJaxRpcService, getPassword, getPortInterface, getPortName, getPortQName, getPortStub, getServiceInterface, getUsername, invoke, isMaintainSession, isPrepared, performJaxRpcCall, postProcessJaxRpcCall, postProcessPortStub, prepare, prepareJaxRpcCall, preparePortStub, setCustomProperties, setEndpointAddress, setJaxRpcService, setLookupServiceOnStartup, setMaintainSession, setPassword, setPortInterface, setPortName, setServiceInterface, setUsername
 
Methods inherited from class org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactory
createJaxRpcService, createService, createServiceFactory, getJaxRpcServiceInterface, getJaxRpcServiceProperties, getNamespaceUri, getQName, getServiceFactoryClass, getServiceName, getServicePostProcessors, getWsdlDocumentUrl, postProcessJaxRpcService, setJaxRpcServiceInterface, setJaxRpcServiceProperties, setNamespaceUri, setServiceFactoryClass, setServiceName, setServicePostProcessors, setWsdlDocumentUrl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JaxRpcPortProxyFactoryBean

public JaxRpcPortProxyFactoryBean()
Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws ServiceException
Description copied from class: JaxRpcPortClientInterceptor
Prepares the JAX-RPC service and port if the "lookupServiceOnStartup" is turned on (which it is by default).

Specified by:
afterPropertiesSet in interface InitializingBean
Overrides:
afterPropertiesSet in class JaxRpcPortClientInterceptor
Throws:
ServiceException

getObject

public Object getObject()
Description copied from interface: FactoryBean
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 method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:
getObject in interface FactoryBean
Returns:
an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)
See Also:
FactoryBeanNotInitializedException

getObjectType

public Class getObjectType()
Description copied from interface: FactoryBean
Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this 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.

Specified by:
getObjectType in interface FactoryBean
Returns:
the type of object that this FactoryBean creates, or null if not known at the time of the call
See Also:
ListableBeanFactory.getBeansOfType(java.lang.Class)

isSingleton

public boolean isSingleton()
Description copied from interface: FactoryBean
Is the bean managed by this factory a singleton or a prototype? 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.

Specified by:
isSingleton in interface FactoryBean
Returns:
if this bean is a singleton
See Also:
FactoryBean.getObject()


Copyright (c) 2002-2007 The Spring Framework Project.