Spring Context 6.1.4 · org.springframework.jmx.support.MBeanServerFactoryBean

Modifier and Type	Field and Description
private String	agentId
private String	defaultDomain
private boolean	locateExistingServerIfPossible
protected final Log	logger
private boolean	newlyRegistered
private boolean	registerWithFactory
private MBeanServer	server

Access	Constructor and Description
public	MBeanServerFactoryBean()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Creates the `MBeanServer` instance.
protected MBeanServer	createMBeanServer(String the default domain, or `null` if none defaultDomain, boolean whether to register the `MBeanServer` with the `MBeanServerFactory` registerWithFactory) Create a new `MBeanServer` instance and register it with the `MBeanServerFactory`, if desired.
public void	destroy() Implements org.springframework.beans.factory.DisposableBean.destroy. Unregisters the `MBeanServer` instance, if necessary.
public MBeanServer	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<? extends MBeanServer>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
protected MBeanServer	Returns: the `MBeanServer` if found locateMBeanServer(String the agent identifier of the MBeanServer to retrieve. If this parameter is `null`, all registered MBeanServers are considered. agentId) Attempt to locate an existing `MBeanServer`.
public void	setAgentId(String agentId) Set the agent id of the `MBeanServer` to locate.
public void	setDefaultDomain(String defaultDomain) Set the default domain to be used by the `MBeanServer`, to be passed to `MBeanServerFactory.createMBeanServer()` or `MBeanServerFactory.findMBeanServer()`.
public void	setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible) Set whether the `MBeanServerFactoryBean` should attempt to locate a running `MBeanServer` before creating one.
public void	setRegisterWithFactory(boolean registerWithFactory) Set whether to register the `MBeanServer` with the `MBeanServerFactory`, making it available through `MBeanServerFactory.findMBeanServer()`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

agentId	back to summary
private String agentId Annotations @Nullable

defaultDomain	back to summary
private String defaultDomain Annotations @Nullable

locateExistingServerIfPossible	back to summary
private boolean locateExistingServerIfPossible

logger	back to summary
protected final Log logger

newlyRegistered	back to summary
private boolean newlyRegistered

registerWithFactory	back to summary
private boolean registerWithFactory

server	back to summary
private MBeanServer server Annotations @Nullable

MBeanServerFactoryBean	back to summary
public MBeanServerFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() throws MBeanServerNotFoundException Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Creates the `MBeanServer` instance. Annotations @Override

public void afterPropertiesSet() throws MBeanServerNotFoundException

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Creates the MBeanServer instance.

Annotations

@Override

createMBeanServer back to summary

createMBeanServer	back to summary
protected MBeanServer createMBeanServer(String defaultDomain, boolean registerWithFactory) Create a new `MBeanServer` instance and register it with the `MBeanServerFactory`, if desired. Parameters defaultDomain:String the default domain, or `null` if none registerWithFactory:boolean whether to register the `MBeanServer` with the `MBeanServerFactory` See Also `javax.management.MBeanServerFactory#createMBeanServer`, `javax.management.MBeanServerFactory#newMBeanServer`

protected MBeanServer createMBeanServer(String defaultDomain, boolean registerWithFactory)

Create a new MBeanServer instance and register it with the MBeanServerFactory, if desired.

Parameters

defaultDomain:String: the default domain, or null if none
registerWithFactory:boolean: whether to register the MBeanServer with the MBeanServerFactory

destroy back to summary

destroy	back to summary
public void destroy() Implements org.springframework.beans.factory.DisposableBean.destroy. Unregisters the `MBeanServer` instance, if necessary. Annotations @Override

public void destroy()

Implements org.springframework.beans.factory.DisposableBean.destroy.

Unregisters the MBeanServer instance, if necessary.

Annotations

@Override

getObject back to summary

getObject	back to summary
public MBeanServer getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. 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. Returns:MBeanServer an instance of the bean (can be `null`) Annotations @Override @Nullable

public MBeanServer getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

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.

Returns:MBeanServer

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<? extends MBeanServer> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. 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. Returns:Class<? extends MBeanServer> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<? extends MBeanServer> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

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.

Returns:Class<? extends MBeanServer>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? 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. 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`. The default implementation returns `true`, since a `FactoryBean` typically manages a singleton instance. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? 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.

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.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

locateMBeanServer back to summary

locateMBeanServer	back to summary
protected MBeanServer locateMBeanServer(String agentId) throws MBeanServerNotFoundException Attempt to locate an existing `MBeanServer`. Called if `locateExistingServerIfPossible` is set to `true`. The default implementation attempts to find an `MBeanServer` using a standard lookup. Subclasses may override to add additional location logic. Parameters agentId:String the agent identifier of the MBeanServer to retrieve. If this parameter is `null`, all registered MBeanServers are considered. Returns:MBeanServer the `MBeanServer` if found Exceptions MBeanServerNotFoundException: if no `MBeanServer` could be found See Also `setLocateExistingServerIfPossible`, `JmxUtils#locateMBeanServer(String)`, `javax.management.MBeanServerFactory#findMBeanServer(String)`

protected MBeanServer locateMBeanServer(String agentId) throws MBeanServerNotFoundException

Attempt to locate an existing MBeanServer. Called if locateExistingServerIfPossible is set to true.

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

Parameters

agentId:String: the agent identifier of the MBeanServer to retrieve. If this parameter is null, all registered MBeanServers are considered.

Returns:MBeanServer

the MBeanServer if found

Exceptions

MBeanServerNotFoundException:: if no MBeanServer could be found

setAgentId back to summary

setAgentId	back to summary
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). Specifying the empty String indicates the platform MBeanServer. See Also `javax.management.MBeanServerFactory#findMBeanServer(String)`

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

Specifying the empty String indicates the platform MBeanServer.

See Also: javax.management.MBeanServerFactory#findMBeanServer(String)

setDefaultDomain back to summary

setDefaultDomain	back to summary
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 `javax.management.MBeanServerFactory#createMBeanServer(String)`, `javax.management.MBeanServerFactory#findMBeanServer(String)`

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: javax.management.MBeanServerFactory#createMBeanServer(String), javax.management.MBeanServerFactory#findMBeanServer(String)

setLocateExistingServerIfPossible back to summary

setLocateExistingServerIfPossible	back to summary
public void setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible) Set whether the `MBeanServerFactoryBean` should attempt to locate a running `MBeanServer` before creating one. Default is `false`.

public void setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible)

Set whether the MBeanServerFactoryBean should attempt to locate a running MBeanServer before creating one.

Default is false.

setRegisterWithFactory back to summary

setRegisterWithFactory	back to summary
public void setRegisterWithFactory(boolean registerWithFactory) Set whether to register the `MBeanServer` with the `MBeanServerFactory`, making it available through `MBeanServerFactory.findMBeanServer()`. Default is `true`. See Also `javax.management.MBeanServerFactory#createMBeanServer`, `javax.management.MBeanServerFactory#findMBeanServer`

public void setRegisterWithFactory(boolean registerWithFactory)

Set whether to register the MBeanServer with the MBeanServerFactory, making it available through MBeanServerFactory.findMBeanServer().

Default is true.

See Also: javax.management.MBeanServerFactory#createMBeanServer, javax.management.MBeanServerFactory#findMBeanServer

public Class MBeanServerFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail