public final class

AdminBeanFactory

extends AbstractLocalBeanFactory
java.lang.Object
   ↳ com.microstrategy.web.beans.AbstractLocalBeanFactory
     ↳ com.microstrategy.web.admin.beans.AdminBeanFactory

Class Overview

AdminBeanFactory is a factory class for instantiating beans in the com.microstrategy.web.admin.beans package. Note that most methods on this class are deprecated; we now provide the BeanFactory class for programmatic bean creation. Please create beans using the BeanFactory instead of using this class directly.

Summary

Public Methods
static Class getBeanInterface(int appBeanType)
This method is deprecated. Reference bean interface classes directly rather than calling this method. If you need to use reflection to get/set properties on a bean, consider using the ReflectionHelper class.
static AdminBeanFactory getInstance()
Returns an instance of the AdminBeanFactory object.
AdminBean newAdminBean()
This method is deprecated. Use newBean(String) instead. Note that that method will return a bean that has been initialized with an event handler.
AppComponent newAppAdminBean(int appBeanType)
This method is deprecated. Use newBean(String) instead. Note that that method will return a bean that has been initialized with an event handler.
DiagnosticsBean newDiagnosticsBean()
This method is deprecated. Use newBean(String) instead. Note that that method will return a bean that has been initialized with an event handler.
Protected Methods
WebComponent createBeanInstance(Class beanClass)
Create an instance of beanClass.
String getBeanPackage()
Returns the full name of the package associated with this factory (ex: "com.microstrategy.web.beans").
[Expand]
Inherited Methods
From class com.microstrategy.web.beans.AbstractLocalBeanFactory
From class java.lang.Object
From interface com.microstrategy.web.beans.LocalBeanFactory

Public Methods

public static Class getBeanInterface (int appBeanType)

This method is deprecated.
Reference bean interface classes directly rather than calling this method. If you need to use reflection to get/set properties on a bean, consider using the ReflectionHelper class.

Returns the main interface that an application admin bean implements.
Usually the bean implements an interface, and the methods of the implementation are protected, while the methods of the interface are public. This returns the interface so the client can use reflection to invoke the instance methods.

Parameters
appBeanType the bean type to create
Returns
  • A Class instance of the main interface of the bean.

public static AdminBeanFactory getInstance ()

Returns an instance of the AdminBeanFactory object. This is the only way to get the factory object and is the entry point to the various App Admin Beans.

Returns
  • A AdminBeanFactory instance.

public AdminBean newAdminBean ()

This method is deprecated.
Use newBean(String) instead. Note that that method will return a bean that has been initialized with an event handler.

Returns an instance of a AdminBean object. Note that the returned bean will not be initialized with an event handler.

Returns

public AppComponent newAppAdminBean (int appBeanType)

This method is deprecated.
Use newBean(String) instead. Note that that method will return a bean that has been initialized with an event handler.

Returns an instance of an application admin bean. Note that the returned bean will not be initialized with an event handler.

Parameters
appBeanType the bean type to create
Returns

public DiagnosticsBean newDiagnosticsBean ()

This method is deprecated.
Use newBean(String) instead. Note that that method will return a bean that has been initialized with an event handler.

Returns an instance of a DiagnosticsBean object. Note that the returned bean will not be initialized with an event handler.

Returns

Protected Methods

protected WebComponent createBeanInstance (Class beanClass)

Create an instance of beanClass. This implementation simply calls beanClass.newInstance(). Override this method in a derived class to create instances of non-public bean classes. Throws the same exceptions as newInstance().

Parameters
beanClass The class of the desired bean.
Returns
  • An instance of the desired bean class.
Throws
IllegalAccessException
InstantiationException

protected String getBeanPackage ()

Returns the full name of the package associated with this factory (ex: "com.microstrategy.web.beans").

Returns
  • The name of the package associated with this factory.