类 MBeanServerFactoryBean
- java.lang.Object
- org.springframework.jmx.support.MBeanServerFactoryBean
- 所有已实现的接口:
DisposableBean
,FactoryBean<MBeanServer>
,InitializingBean
public class MBeanServerFactoryBean extends Object implements FactoryBean<MBeanServer>, InitializingBean, DisposableBean
FactoryBean
that obtains aMBeanServer
reference through the standard JMX 1.2MBeanServerFactory
API.Exposes the
MBeanServer
for bean references.By default,
MBeanServerFactoryBean
will always create a newMBeanServer
even if one is already running. To have theMBeanServerFactoryBean
attempt to locate a runningMBeanServer
first, set the value of the "locateExistingServerIfPossible" property to "true".- 从以下版本开始:
- 1.2
- 作者:
- Rob Harrop, Juergen Hoeller
- 另请参阅:
setLocateExistingServerIfPossible(boolean)
,locateMBeanServer(java.lang.String)
,MBeanServer
,MBeanServerFactory.findMBeanServer(java.lang.String)
,MBeanServerFactory.createMBeanServer()
,MBeanServerFactory.newMBeanServer()
,MBeanServerConnectionFactoryBean
,ConnectorServerFactoryBean
字段概要
从接口继承的字段 org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTE
构造器概要
构造器 构造器 说明 MBeanServerFactoryBean()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Creates theMBeanServer
instance.protected MBeanServer
createMBeanServer(String defaultDomain, boolean registerWithFactory)
Create a newMBeanServer
instance and register it with theMBeanServerFactory
, if desired.void
destroy()
Unregisters theMBeanServer
instance, if necessary.MBeanServer
getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<? extends MBeanServer>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.boolean
isSingleton()
Is the object managed by this factory a singleton?protected MBeanServer
locateMBeanServer(String agentId)
Attempt to locate an existingMBeanServer
.void
setAgentId(String agentId)
Set the agent id of theMBeanServer
to locate.void
setDefaultDomain(String defaultDomain)
Set the default domain to be used by theMBeanServer
, to be passed toMBeanServerFactory.createMBeanServer()
orMBeanServerFactory.findMBeanServer()
.void
setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible)
Set whether or not theMBeanServerFactoryBean
should attempt to locate a runningMBeanServer
before creating one.void
setRegisterWithFactory(boolean registerWithFactory)
Set whether to register theMBeanServer
with theMBeanServerFactory
, making it available throughMBeanServerFactory.findMBeanServer()
.
构造器详细资料
MBeanServerFactoryBean
public MBeanServerFactoryBean()
方法详细资料
setLocateExistingServerIfPossible
public void setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible)
Set whether or not theMBeanServerFactoryBean
should attempt to locate a runningMBeanServer
before creating one.Default is
false
.
setAgentId
public void setAgentId(String agentId)
Set the agent id of theMBeanServer
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).
Specifying the empty String indicates the platform MBeanServer.
setDefaultDomain
public void setDefaultDomain(String defaultDomain)
Set the default domain to be used by theMBeanServer
, to be passed toMBeanServerFactory.createMBeanServer()
orMBeanServerFactory.findMBeanServer()
.Default is none.
setRegisterWithFactory
public void setRegisterWithFactory(boolean registerWithFactory)
Set whether to register theMBeanServer
with theMBeanServerFactory
, making it available throughMBeanServerFactory.findMBeanServer()
.Default is
true
.
afterPropertiesSet
public void afterPropertiesSet() throws MBeanServerNotFoundException
Creates theMBeanServer
instance.
locateMBeanServer
protected MBeanServer locateMBeanServer(@Nullable String agentId) throws MBeanServerNotFoundException
Attempt to locate an existingMBeanServer
. Called iflocateExistingServerIfPossible
is set totrue
.The default implementation attempts to find an
MBeanServer
using a standard lookup. Subclasses may override to add additional location logic.- 参数:
agentId
- the agent identifier of the MBeanServer to retrieve. If this parameter isnull
, all registered MBeanServers are considered.- 返回:
- the
MBeanServer
if found - 抛出:
MBeanServerNotFoundException
- if noMBeanServer
could be found- 另请参阅:
setLocateExistingServerIfPossible(boolean)
,JmxUtils.locateMBeanServer(String)
,MBeanServerFactory.findMBeanServer(String)
createMBeanServer
protected MBeanServer createMBeanServer(@Nullable String defaultDomain, boolean registerWithFactory)
Create a newMBeanServer
instance and register it with theMBeanServerFactory
, if desired.- 参数:
defaultDomain
- the default domain, ornull
if noneregisterWithFactory
- whether to register theMBeanServer
with theMBeanServerFactory
- 另请参阅:
MBeanServerFactory.createMBeanServer()
,MBeanServerFactory.newMBeanServer()
getObject
@Nullable public MBeanServer getObject()
从接口复制的说明: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.- 指定者:
getObject
在接口中FactoryBean<MBeanServer>
- 返回:
- an instance of the bean (can be
null
) - 另请参阅:
FactoryBeanNotInitializedException
getObjectType
public Class<? extends MBeanServer> getObjectType()
从接口复制的说明:FactoryBean
Return the type of object that this FactoryBean creates, ornull
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.- 指定者:
getObjectType
在接口中FactoryBean<MBeanServer>
- 返回:
- the type of object that this FactoryBean creates, or
null
if not known at the time of the call - 另请参阅:
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
isSingleton
public boolean isSingleton()
从接口复制的说明:FactoryBean
Is the object managed by this factory a singleton? That is, willFactoryBean.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 returntrue
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 extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.The default implementation returns
true
, since aFactoryBean
typically manages a singleton instance.- 指定者:
isSingleton
在接口中FactoryBean<MBeanServer>
- 返回:
- whether the exposed object is a singleton
- 另请参阅:
FactoryBean.getObject()
,SmartFactoryBean.isPrototype()
destroy
public void destroy()
Unregisters theMBeanServer
instance, if necessary.- 指定者:
destroy
在接口中DisposableBean