Package org.apache.catalina.mbeans
Class MBeanFactory
java.lang.Object
org.apache.catalina.mbeans.MBeanFactory
- Author:
- Amy Roh
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptioncreateAjpConnector(String parent, String address, int port) Create a new AjpConnectorcreateDataSourceRealm(String parent, String dataSourceName, String roleNameCol, String userCredCol, String userNameCol, String userRoleTable, String userTable) Create a new DataSource Realm.createHttpConnector(String parent, String address, int port) Create a new HttpConnectorcreateHttpsConnector(String parent, String address, int port) Create a new HttpsConnectorcreateJNDIRealm(String parent) Create a new JNDI Realm.createMemoryRealm(String parent) Create a new Memory Realm.createStandardContext(String parent, String path, String docBase) Create a new StandardContext.createStandardContext(String parent, String path, String docBase, boolean xmlValidation, boolean xmlNamespaceAware) Create a new StandardContext.createStandardHost(String parent, String name, String appBase, boolean autoDeploy, boolean deployOnStartup, boolean deployXML, boolean unpackWARs) Create a new StandardHost.createStandardManager(String parent) Create a new StandardManager.createStandardServiceEngine(String domain, String defaultHost, String baseDir) Creates a new StandardService and StandardEngine.createUserDatabaseRealm(String parent, String resourceName) Create a new UserDatabaseRealm.createValve(String className, String parent) Create a new Valve and associate it with aContainer.createWebappLoader(String parent) Create a new Web Application Loader.voidremoveConnector(String name) Remove an existing Connector.voidremoveContext(String contextName) Remove an existing Context.voidremoveHost(String name) Remove an existing Host.voidremoveLoader(String name) Remove an existing Loader.voidremoveManager(String name) Remove an existing Manager.voidremoveRealm(String name) Remove an existing Realm.voidremoveService(String name) Remove an existing Service.voidremoveValve(String name) Remove an existing Valve.voidsetContainer(Object container) Set the container that this factory was created for.
- 
Field Details- 
sm
 
- 
- 
Constructor Details- 
MBeanFactorypublic MBeanFactory()
 
- 
- 
Method Details- 
setContainerSet the container that this factory was created for.- Parameters:
- container- The associated container
 
- 
createAjpConnectorCreate a new AjpConnector- Parameters:
- parent- MBean Name of the associated parent component
- address- The IP address on which to bind
- port- TCP port number to listen on
- Returns:
- the object name of the created connector
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createDataSourceRealmpublic String createDataSourceRealm(String parent, String dataSourceName, String roleNameCol, String userCredCol, String userNameCol, String userRoleTable, String userTable) throws Exception Create a new DataSource Realm.- Parameters:
- parent- MBean Name of the associated parent component
- dataSourceName- the datasource name
- roleNameCol- the column name for the role names
- userCredCol- the column name for the user credentials
- userNameCol- the column name for the user names
- userRoleTable- the table name for the roles table
- userTable- the table name for the users
- Returns:
- the object name of the created realm
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createHttpConnectorCreate a new HttpConnector- Parameters:
- parent- MBean Name of the associated parent component
- address- The IP address on which to bind
- port- TCP port number to listen on
- Returns:
- the object name of the created connector
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createHttpsConnectorCreate a new HttpsConnector- Parameters:
- parent- MBean Name of the associated parent component
- address- The IP address on which to bind
- port- TCP port number to listen on
- Returns:
- the object name of the created connector
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createJNDIRealmCreate a new JNDI Realm.- Parameters:
- parent- MBean Name of the associated parent component
- Returns:
- the object name of the created realm
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createMemoryRealmCreate a new Memory Realm.- Parameters:
- parent- MBean Name of the associated parent component
- Returns:
- the object name of the created realm
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createStandardContextCreate a new StandardContext.- Parameters:
- parent- MBean Name of the associated parent component
- path- The context path for this Context
- docBase- Document base directory (or WAR) for this Context
- Returns:
- the object name of the created context
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createStandardContextpublic String createStandardContext(String parent, String path, String docBase, boolean xmlValidation, boolean xmlNamespaceAware) throws Exception Create a new StandardContext.- Parameters:
- parent- MBean Name of the associated parent component
- path- The context path for this Context
- docBase- Document base directory (or WAR) for this Context
- xmlValidation- if XML descriptors should be validated
- xmlNamespaceAware- if the XML processor should namespace aware
- Returns:
- the object name of the created context
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createStandardHostpublic String createStandardHost(String parent, String name, String appBase, boolean autoDeploy, boolean deployOnStartup, boolean deployXML, boolean unpackWARs) throws Exception Create a new StandardHost.- Parameters:
- parent- MBean Name of the associated parent component
- name- Unique name of this Host
- appBase- Application base directory name
- autoDeploy- Should we auto deploy?
- deployOnStartup- Deploy on server startup?
- deployXML- Should we deploy Context XML config files property?
- unpackWARs- Should we unpack WARs when auto deploying?
- Returns:
- the object name of the created host
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createStandardServiceEnginepublic String createStandardServiceEngine(String domain, String defaultHost, String baseDir) throws Exception Creates a new StandardService and StandardEngine.- Parameters:
- domain- Domain name for the container instance
- defaultHost- Name of the default host to be used in the Engine
- baseDir- Base directory value for Engine
- Returns:
- the object name of the created service
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createStandardManagerCreate a new StandardManager.- Parameters:
- parent- MBean Name of the associated parent component
- Returns:
- the object name of the created manager
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createUserDatabaseRealmCreate a new UserDatabaseRealm.- Parameters:
- parent- MBean Name of the associated parent component
- resourceName- Global JNDI resource name of the associated UserDatabase
- Returns:
- the object name of the created realm
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createValveCreate a new Valve and associate it with aContainer.- Parameters:
- className- The fully qualified class name of the- Valveto create
- parent- The MBean name of the associated parent- Container.
- Returns:
- The MBean name of the Valvethat was created ornullif theValvedoes not implementJmxEnabled.
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
createWebappLoaderCreate a new Web Application Loader.- Parameters:
- parent- MBean Name of the associated parent component
- Returns:
- the object name of the created loader
- Throws:
- Exception- if an MBean cannot be created or registered
 
- 
removeConnectorRemove an existing Connector.- Parameters:
- name- MBean Name of the component to remove
- Throws:
- Exception- if a component cannot be removed
 
- 
removeContextRemove an existing Context.- Parameters:
- contextName- MBean Name of the component to remove
- Throws:
- Exception- if a component cannot be removed
 
- 
removeHostRemove an existing Host.- Parameters:
- name- MBean Name of the component to remove
- Throws:
- Exception- if a component cannot be removed
 
- 
removeLoaderRemove an existing Loader.- Parameters:
- name- MBean Name of the component to remove
- Throws:
- Exception- if a component cannot be removed
 
- 
removeManagerRemove an existing Manager.- Parameters:
- name- MBean Name of the component to remove
- Throws:
- Exception- if a component cannot be removed
 
- 
removeRealmRemove an existing Realm.- Parameters:
- name- MBean Name of the component to remove
- Throws:
- Exception- if a component cannot be removed
 
- 
removeServiceRemove an existing Service.- Parameters:
- name- MBean Name of the component to remove
- Throws:
- Exception- if a component cannot be removed
 
- 
removeValveRemove an existing Valve.- Parameters:
- name- MBean Name of the component to remove
- Throws:
- Exception- if a component cannot be removed
 
 
-