站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > Spring Framework 1.2.9 API 文档英文版

MBeanServerFactoryBean (Spring Framework) - Spring Framework 1.2.9 API 文档英文版

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.springframework.jmx.support
Class MBeanServerFactoryBean

java.lang.Object
  extended by org.springframework.jmx.support.MBeanServerFactoryBean
All Implemented Interfaces:
DisposableBean, FactoryBean, InitializingBean
public class MBeanServerFactoryBean
extends Object
implements FactoryBean, InitializingBean, DisposableBean

FactoryBean that obtains an MBeanServer reference through the standard JMX 1.2 MBeanServerFactory API (which is available on JDK 1.5 or as part of a JMX 1.2 provider). Exposes the MBeanServer for bean references.

By default, MBeanServerFactoryBean will always create a new MBeanServer even if one is already running. To have the MBeanServerFactoryBean attempt to locate a running MBeanServer first, set the value of the "locateExistingServerIfPossible" property to "true".

Since:
1.2
Author:
Rob Harrop, Juergen Hoeller
See Also:
setLocateExistingServerIfPossible(boolean), locateMBeanServer(java.lang.String), MBeanServer, MBeanServerFactory.findMBeanServer(java.lang.String), MBeanServerFactory.createMBeanServer(), MBeanServerFactory.newMBeanServer(), MBeanServerConnectionFactoryBean, ConnectorServerFactoryBean

Field Summary
protected  Log logger
           
 
Constructor Summary
MBeanServerFactoryBean()
           
 
Method Summary
 void afterPropertiesSet()
          Creates the MBeanServer instance.
protected  MBeanServer createMBeanServer(String defaultDomain, boolean registerWithFactory)
          Create a new MBeanServer instance and register it with the MBeanServerFactory, if desired.
 void destroy()
          Unregisters the MBeanServer instance, if necessary.
 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?
protected  MBeanServer locateMBeanServer(String agentId)
          Attempt to locate an existing MBeanServer.
 void setAgentId(String agentId)
          Set the agent id of the MBeanServer to locate.
 void setDefaultDomain(String defaultDomain)
          Set the default domain to be used by the MBeanServer, to be passed to MBeanServerFactory.createMBeanServer() or MBeanServerFactory.findMBeanServer().
 void setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible)
          Set whether or not the MBeanServerFactoryBean should attempt to locate a running MBeanServer before creating one.
 void setRegisterWithFactory(boolean registerWithFactory)
          Set whether to register the MBeanServer with the MBeanServerFactory, making it available through MBeanServerFactory.findMBeanServer().
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected final Log logger
Constructor Detail

MBeanServerFactoryBean

public MBeanServerFactoryBean()
Method Detail

setLocateExistingServerIfPossible

public void setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible)
Set whether or not the MBeanServerFactoryBean should attempt to locate a running MBeanServer before creating one.

Default is false.

setAgentId

public void setAgentId(String agentId)
Set the agent id of the MBeanServer to locate.

Default is none. If specified, this will result in an automatic attempt being made to locate the attendant MBeanServer, and (importantly) if said MBeanServer cannot be located no attempt will be made to create a new MBeanServer (and an MBeanServerNotFoundException will be thrown at resolution time).

See Also:
MBeanServerFactory.findMBeanServer(String)

setDefaultDomain

public void setDefaultDomain(String defaultDomain)
Set the default domain to be used by the MBeanServer, to be passed to MBeanServerFactory.createMBeanServer() or MBeanServerFactory.findMBeanServer().

Default is none.

See Also:
MBeanServerFactory.createMBeanServer(String), MBeanServerFactory.findMBeanServer(String)

setRegisterWithFactory

public void setRegisterWithFactory(boolean registerWithFactory)
Set whether to register the MBeanServer with the MBeanServerFactory, making it available through MBeanServerFactory.findMBeanServer().

See Also:
MBeanServerFactory.createMBeanServer(), MBeanServerFactory.findMBeanServer(java.lang.String)

afterPropertiesSet

public void afterPropertiesSet()
                        throws MBeanServerNotFoundException
Creates the MBeanServer instance.

Specified by:
afterPropertiesSet in interface InitializingBean
Throws:
MBeanServerNotFoundException

locateMBeanServer

protected MBeanServer locateMBeanServer(String agentId)
                                 throws MBeanServerNotFoundException
Attempt to locate an existing MBeanServer. Called if locateExistingServerIfPossible is set to true.

Default implementation attempts to find an MBeanServer using a standard lookup. Subclasses may override to add additional location logic.

Parameters:
agentId - the agent identifier of the MBeanServer to retrieve. If this parameter is null, all registered MBeanServers are considered.
Returns:
the MBeanServer if found
Throws:
MBeanServerNotFoundException - if no MBeanServer could be found
See Also:
setLocateExistingServerIfPossible(boolean), JmxUtils.locateMBeanServer(String), MBeanServerFactory.findMBeanServer(String)

createMBeanServer

protected MBeanServer createMBeanServer(String defaultDomain,
                                        boolean registerWithFactory)
Create a new MBeanServer instance and register it with the MBeanServerFactory, if desired.

Parameters:
defaultDomain - the default domain, or null if none
registerWithFactory - whether to register the MBeanServer with the MBeanServerFactory
See Also:
MBeanServerFactory.createMBeanServer(), MBeanServerFactory.newMBeanServer()

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

destroy

public void destroy()
Unregisters the MBeanServer instance, if necessary.

Specified by:
destroy in interface DisposableBean
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright (c) 2002-2007 The Spring Framework Project.