The Spring Framework

org.springframework.jms.remoting
Class JmsInvokerProxyFactoryBean

java.lang.Object
  extended by org.springframework.jms.remoting.JmsInvokerClientInterceptor
      extended by org.springframework.jms.remoting.JmsInvokerProxyFactoryBean
All Implemented Interfaces:
org.aopalliance.aop.Advice, org.aopalliance.intercept.Interceptor, org.aopalliance.intercept.MethodInterceptor, FactoryBean, InitializingBean

public class JmsInvokerProxyFactoryBean
extends JmsInvokerClientInterceptor
implements FactoryBean

Factory bean for JMS proxies.

Behaves like the proxied service when used as a bean reference, exposing the specified service interface.

For configuration details, see the JmsInvokerClientInterceptor javadoc.

Since:
2.0
Author:
Juergen Hoeller
See Also:
JmsInvokerClientInterceptor.setConnectionFactory(javax.jms.QueueConnectionFactory), JmsInvokerClientInterceptor.setQueueName(java.lang.String), JmsInvokerClientInterceptor, JmsInvokerServiceExporter

Constructor Summary
JmsInvokerProxyFactoryBean()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
 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?
 void setServiceInterface(Class serviceInterface)
          Set the interface that the proxy must implement.
 
Methods inherited from class org.springframework.jms.remoting.JmsInvokerClientInterceptor
createRemoteInvocation, createRequestMessage, executeRequest, extractInvocationResult, getConnectionFactory, invoke, onInvalidResponse, recreateRemoteInvocationResult, resolveQueue, resolveQueueName, setConnectionFactory, setDestinationResolver, setQueue, setQueueName, setRemoteInvocationFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JmsInvokerProxyFactoryBean

public JmsInvokerProxyFactoryBean()
Method Detail

setServiceInterface

public void setServiceInterface(Class serviceInterface)
Set the interface that the proxy must implement.

Parameters:
serviceInterface - the interface that the proxy must implement
Throws:
IllegalArgumentException - if the supplied serviceInterface is null, or if the supplied serviceInterface is not an interface type

afterPropertiesSet

public void afterPropertiesSet()
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 JmsInvokerClientInterceptor

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

Specified by:
getObject in interface FactoryBean
Returns:
an instance of the bean (can be null)
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 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.

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()

The Spring Framework

Copyright © 2002-2006 The Spring Framework.