org.springframework.jmx.support
Class WebLogicJndiMBeanServerFactoryBean

java.lang.Object
  org.springframework.jndi.JndiAccessor
      org.springframework.jndi.JndiLocatorSupport
          org.springframework.jmx.support.WebLogicJndiMBeanServerFactoryBean

All Implemented Interfaces:

FactoryBean, InitializingBean

public class WebLogicJndiMBeanServerFactoryBean
extends JndiLocatorSupport
implements FactoryBean, InitializingBean

FactoryBean that obtains a specified WebLogic MBeanServer reference through a WebLogic MBeanHome obtained via a JNDI lookup. By default, the server's local MBeanHome will be obtained.

Exposes the MBeanServer for bean references. This FactoryBean is a direct alternative to MBeanServerFactoryBean, which uses standard JMX 1.2 API to access the platform's MBeanServer.

Note: There is also a more general WebLogicMBeanServerFactoryBean for accessing any specified WebLogic MBeanServer, potentially a remote one.

NOTE: This class is only intended for use with WebLogic 8.1. On WebLogic 9.x, simply obtain the MBeanServer directly from the JNDI location "java:comp/env/jmx/runtime", for example through the following configuration:

 <bean class="org.springframework.jndi.JndiObjectFactoryBean">
   <property name="jndiName" value="java:comp/env/jmx/runtime"/>
 </bean>

Since:

1.2.6

Author:

Rob Harrop, Juergen Hoeller

See Also:

weblogic.management.MBeanHome#LOCAL_JNDI_NAME, weblogic.management.MBeanHome#getMBeanServer(), MBeanServer, MBeanServerFactoryBean, WebLogicMBeanServerFactoryBean

Field Summary

Fields inherited from class org.springframework.jndi.JndiLocatorSupport

CONTAINER_PREFIX

Fields inherited from class org.springframework.jndi.JndiAccessor

logger

Constructor Summary

WebLogicJndiMBeanServerFactoryBean()

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 object managed by this factory a singleton?
void	setMbeanHomeName(String mbeanHomeName) Specify the JNDI name of the WebLogic MBeanHome object to use for creating the JMX MBeanServer reference.

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

WebLogicJndiMBeanServerFactoryBean

public WebLogicJndiMBeanServerFactoryBean()

Method Detail

setMbeanHomeName

public void setMbeanHomeName(String mbeanHomeName)

Specify the JNDI name of the WebLogic MBeanHome object to use for creating the JMX MBeanServer reference.

Default is MBeanHome.LOCAL_JNDI_NAME

See Also:

weblogic.management.MBeanHome#LOCAL_JNDI_NAME

afterPropertiesSet

public void afterPropertiesSet()
                        throws MBeanServerNotFoundException

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

Throws:

MBeanServerNotFoundException

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 object managed by this factory a singleton? That is, will FactoryBean.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 SmartFactoryBean.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.

Specified by:

isSingleton in interface FactoryBean

Returns:

if the exposed object is a singleton

See Also:

FactoryBean.getObject(), SmartFactoryBean.isPrototype()