org.objectweb.jonas.webapp.jonasadmin
Class JonasAdminJmx

java.lang.Object
  extended by org.objectweb.jonas.webapp.jonasadmin.JonasAdminJmx

public class JonasAdminJmx
extends Object

Helper class supporting manipulation of MBeans (accessing MBeans).

Author:
Michel-Ange ANTON

Contributors: Adriana Danes


Constructor Summary
protected JonasAdminJmx()
          Protected constructor to prevent instantiation.
 
Method Summary
static String extractFilename(String p_Path)
          Extract the filename of complete path.
static String extractValueMbeanName(String pName, String pMBeanName)
          Extract the value of a key property from the MBean name.
static String findSecurityFactorySubType(String p_NameFactory, String domainName, String serverName)
          Return the SubType of a Security Factory in the current server.
static ObjectName getArchiveConfigObjectName(String domainName, String serverName)
           
static ArrayList getConnectionFactoriesList(org.apache.struts.util.MessageResources p_Resources, String domainName, String serverName)
          Return the default Connection Factories.
static ArrayList getDatasourceDependences(String pDatasourceName, String domainName, String serverName)
          Return the list of Datasource dependences for a given datasource name in the current server.
static ArrayList getDatasourceFilesDeployable(String domainName, String serverName)
          Return the list of Datasource properties files ready to deploy in the current server.
static ArrayList getDatasourceFilesDeployed(String domainName, String serverName)
          Return the list of deployed Datasources in the current server.
static ArrayList getEarFilesDeployable(String domainName, String serverName)
          Return the list of EAR filename ready to deploy in the current server.
static ArrayList getEarFilesDeployed(String domainName, String serverName)
          Return the list of deployed EAR filename in the current server.
static ArrayList[] getFamiliesMbeansLists(String serverName)
          Create a list for each family of Mbean.
static ObjectName getFirstMbean(ObjectName p_On, String serverName)
          Return the first ObjectName Mbean gotten by the query in the current MbeanServer.
static String getFirstMBeanName(ObjectName p_On, String serverName)
          Return the first Mbean name gotten by the query in the current MbeanServer.
static ArrayList getGroups(String domainName, String p_Resource, String serverName)
          Return the list of all groups in a resource.
static ObjectName getJ2eeServerObjectName(String serverName)
          Return the ObjectName corresponding to the J2EEServer managed object registered in the current MBeanServer.
static ObjectName getJ2eeServerObjectName(String p_DomainName, String serverName)
          Return the ObjectName corresponding to the J2EEServer managed object registered in the current MBeanServer and belonging to a domain.
static ArrayList getJarFilesDeployable(String domainName, String serverName)
          Return the list of JAR filename ready to deploy in the current server.
static ArrayList getJarFilesDeployed(String domainName, String serverName)
          Return the list of deployed JAR filename in the current server.
static List getListMbean(ObjectName p_On, String serverName)
          Return the list of ObjectName Mbean gotten by the query in the current MbeanServer.
static List getListMBeanName(ObjectName p_On, String serverName)
          Return the list of Mbean name gotten by the query in the current MbeanServer.
static ArrayList getLoggers(org.apache.struts.util.MessageResources p_Resources, WhereAreYou p_WhereAreYou, boolean p_Action)
          Return the list of all used loggers in this JOnAS server.
static ArrayList getMailFactoryDependences(String p_MailFactoryName, WhereAreYou p_WhereAreYou)
          Return the list of Mail factory dependences in the current server for a given factory name.
static ArrayList getMailFilesDeployable(String domainName, String serverName)
          Return the list of Mail factory files ready to deploy in the current server.
static ArrayList getMailFilesDeployed(WhereAreYou p_WhereAreYou)
          Return the list of deployed Mail factories in the current server.
static ArrayList getMbeansLists(String serverName)
          Create a list for each family of Mbean.
static ArrayList getMimeMailPartFactoriesDeployed(WhereAreYou p_WhereAreYou)
          Return the list of deployed MimePartDatasource Mail Factories in the current server.
static ArrayList getMimePartMailFilesDeployable(String domainName, String serverName)
          Return the list of MimePartDataSource Mail factory files ready to deploy in the current server.
static ArrayList getMimePartMailFilesDeployed(WhereAreYou p_WhereAreYou)
          Return the list of deployed MimePartDataSource Mail factories in the current server.
static ArrayList getQueuesList(String domainName, String serverName)
          Return the Queue destinations list.
static ObjectName getRarConfigObjectName(String domainName, String serverName)
           
static ArrayList getRarFilesDeployable(String domainName, String serverName)
          Return the list of RAR filename ready to deploy in the current server.
static ArrayList getRarFilesDeployed(String domainName, String serverName)
          Return the list of deployed RAR filename in the current server.
static ArrayList getRoles(String domainName, String p_Resource, String serverName)
          Return the list of all roles in a resource.
static ArrayList getSecurityDatasourceFactories(String domainName, String serverName)
          Return the list of Security Datasource Factories in the current server.
static ArrayList getSecurityLdapFactories(String domainName, String serverName)
          Return the list of Security Ldap Factories in the current server.
static ArrayList getSecurityMemoryFactories(String domainName, String serverName)
          Return the list of Security Memory Factories in the current server.
static ArrayList getSessionMailFactoriesDeployed(WhereAreYou p_WhereAreYou)
          Return the list of deployed Session Mail Factories in the current server.
static ArrayList getSessionMailFilesDeployable(String domainName, String serverName)
          Return the list of Session Mail factory files ready to deploy in the current server.
static ArrayList getSessionMailFilesDeployed(WhereAreYou p_WhereAreYou)
          Return the list of deployed Session Mail factories in the current server.
static ArrayList getTopicsList(String domainName, String serverName)
          Return the Topic destinations list.
static ArrayList getUsers(String domainName, String p_Resource, String serverName)
          Return the list of all users in a resource.
static ArrayList getWarFilesDeployable(String domainName, String serverName)
          Return the list of WAR filename ready to deploy in the current server.
static ArrayList getWarFilesDeployed(String domainName, String serverName)
          Return the list of deployed WAR filename in the current server.
static boolean hasMBeanName(ObjectName p_On, String serverName)
          Verify if the Mbean gotten by the query in the current MbeanServer exists.
static ArrayList prepareContainersToDisplay(ArrayList p_Containers, String p_ContainerDir, String p_EarDir)
          Prepare a list of containers to diplay.
static String replace(String template, String placeholder, String value)
          Replace any occurrence of the specified placeholder in the specified template string with the specified replacement value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JonasAdminJmx

protected JonasAdminJmx()
Protected constructor to prevent instantiation.

Method Detail

replace

public static String replace(String template,
                             String placeholder,
                             String value)
Replace any occurrence of the specified placeholder in the specified template string with the specified replacement value.

Parameters:
template - Pattern string possibly containing the placeholder
placeholder - Placeholder expression to be replaced
value - Replacement value for the placeholder
Returns:
A complete string

getArchiveConfigObjectName

public static ObjectName getArchiveConfigObjectName(String domainName,
                                                    String serverName)

getRarConfigObjectName

public static ObjectName getRarConfigObjectName(String domainName,
                                                String serverName)

getJ2eeServerObjectName

public static ObjectName getJ2eeServerObjectName(String p_DomainName,
                                                 String serverName)
                                          throws ManagementException
Return the ObjectName corresponding to the J2EEServer managed object registered in the current MBeanServer and belonging to a domain. We should have one ObjectName corresponding to the current JOnAS server instance.

Parameters:
p_DomainName - The name of the management domain.
Returns:
an ObjectName which corresponds to a J2EEServer ObjectName pattern or null if no J2EEServer found for the given management domain (having j2eeType key property equal to J2EEServer)
Throws:
ManagementException - if could not connect to the MBean server

getJ2eeServerObjectName

public static ObjectName getJ2eeServerObjectName(String serverName)
Return the ObjectName corresponding to the J2EEServer managed object registered in the current MBeanServer. This method is used by EditTopAction to determine the list of JOnAS servers registered in the current registry (this code is particular to the current domain concept implementation). We should have one ObjectName corresponding to the current JOnAS server instance.

Returns:
an ObjectName which corresponds to a J2EEServer ObjectName pattern (having j2eeType key property equal to J2EEServer)

hasMBeanName

public static boolean hasMBeanName(ObjectName p_On,
                                   String serverName)
                            throws ManagementException
Verify if the Mbean gotten by the query in the current MbeanServer exists.

Parameters:
p_On - Query Mbean name to search
Returns:
true if MBean exists
Throws:
ManagementException

getFirstMBeanName

public static String getFirstMBeanName(ObjectName p_On,
                                       String serverName)
                                throws ManagementException
Return the first Mbean name gotten by the query in the current MbeanServer.

Parameters:
p_On - Query Mbean name to search
Returns:
The first MBean name or null if not found
Throws:
ManagementException

getListMBeanName

public static List getListMBeanName(ObjectName p_On,
                                    String serverName)
Return the list of Mbean name gotten by the query in the current MbeanServer.

Parameters:
p_On - Query Mbean name to search
Returns:
A list of string Mbean name

getFirstMbean

public static ObjectName getFirstMbean(ObjectName p_On,
                                       String serverName)
                                throws ManagementException
Return the first ObjectName Mbean gotten by the query in the current MbeanServer.

Parameters:
p_On - Query Mbean name to search
Returns:
The first ObjectName or null if not found
Throws:
ManagementException

getListMbean

public static List getListMbean(ObjectName p_On,
                                String serverName)
                         throws ManagementException
Return the list of ObjectName Mbean gotten by the query in the current MbeanServer.

Parameters:
p_On - Query Mbeans to search
Returns:
The list of ObjectName
Throws:
ManagementException

extractValueMbeanName

public static String extractValueMbeanName(String pName,
                                           String pMBeanName)
Extract the value of a key property from the MBean name. This method is usefull when we have the String form and not the ObjectName (avoid creating an ObjectName instance).

Parameters:
pName - Name of the key property
pMBeanName - Stringified ObjectName
Returns:
The value or null if not found

extractFilename

public static String extractFilename(String p_Path)
Extract the filename of complete path.

Parameters:
p_Path - Complete path (directory and filename)
Returns:
The filename or null

getJarFilesDeployable

public static ArrayList getJarFilesDeployable(String domainName,
                                              String serverName)
                                       throws ManagementException
Return the list of JAR filename ready to deploy in the current server.

Returns:
The list of JAR filename.
Throws:
ManagementException

getJarFilesDeployed

public static ArrayList getJarFilesDeployed(String domainName,
                                            String serverName)
                                     throws ManagementException
Return the list of deployed JAR filename in the current server.

Returns:
The list of JAR filename.
Throws:
ManagementException

getEarFilesDeployable

public static ArrayList getEarFilesDeployable(String domainName,
                                              String serverName)
                                       throws ManagementException
Return the list of EAR filename ready to deploy in the current server.

Returns:
The list of EAR filename.
Throws:
ManagementException

getWarFilesDeployable

public static ArrayList getWarFilesDeployable(String domainName,
                                              String serverName)
                                       throws ManagementException
Return the list of WAR filename ready to deploy in the current server.

Returns:
The list of WAR filename.
Throws:
ManagementException

getRarFilesDeployable

public static ArrayList getRarFilesDeployable(String domainName,
                                              String serverName)
                                       throws ManagementException
Return the list of RAR filename ready to deploy in the current server.

Returns:
The list of RAR filename.
Throws:
ManagementException

getWarFilesDeployed

public static ArrayList getWarFilesDeployed(String domainName,
                                            String serverName)
                                     throws ManagementException
Return the list of deployed WAR filename in the current server.

Returns:
The list of WAR filename.
Throws:
ManagementException

getEarFilesDeployed

public static ArrayList getEarFilesDeployed(String domainName,
                                            String serverName)
                                     throws ManagementException
Return the list of deployed EAR filename in the current server.

Returns:
The list of EAR filename.
Throws:
ManagementException

getRarFilesDeployed

public static ArrayList getRarFilesDeployed(String domainName,
                                            String serverName)
                                     throws ManagementException
Return the list of deployed RAR filename in the current server.

Returns:
The list of RAR filename.
Throws:
ManagementException

prepareContainersToDisplay

public static ArrayList prepareContainersToDisplay(ArrayList p_Containers,
                                                   String p_ContainerDir,
                                                   String p_EarDir)
Prepare a list of containers to diplay. Deleting prefix root container directory, sorting the list.

Parameters:
p_Containers - The list of containers
p_ContainerDir - The root container directory
p_EarDir - The root ear directory or null
Returns:
The list of containers ready to display

getMailFilesDeployable

public static ArrayList getMailFilesDeployable(String domainName,
                                               String serverName)
                                        throws ManagementException
Return the list of Mail factory files ready to deploy in the current server.

Returns:
The list of Mail factory properties filenames.
Throws:
ManagementException

getMimePartMailFilesDeployable

public static ArrayList getMimePartMailFilesDeployable(String domainName,
                                                       String serverName)
                                                throws ManagementException
Return the list of MimePartDataSource Mail factory files ready to deploy in the current server.

Returns:
The list of MimePartDataSource Mail factory properties filenames.
Throws:
ManagementException

getSessionMailFilesDeployable

public static ArrayList getSessionMailFilesDeployable(String domainName,
                                                      String serverName)
                                               throws ManagementException
Return the list of Session Mail factory files ready to deploy in the current server.

Returns:
The list of Session Mail factory properties filenames.
Throws:
ManagementException

getMimePartMailFilesDeployed

public static ArrayList getMimePartMailFilesDeployed(WhereAreYou p_WhereAreYou)
                                              throws ManagementException
Return the list of deployed MimePartDataSource Mail factories in the current server.

Parameters:
p_WhereAreYou - The container WhereAreYou
Returns:
The list of MimePartDataSource Mail factory filename.
Throws:
ManagementException

getSessionMailFilesDeployed

public static ArrayList getSessionMailFilesDeployed(WhereAreYou p_WhereAreYou)
                                             throws ManagementException
Return the list of deployed Session Mail factories in the current server.

Parameters:
p_WhereAreYou - The container WhereAreYou
Returns:
The list of Session Mail factory filename.
Throws:
ManagementException

getMailFilesDeployed

public static ArrayList getMailFilesDeployed(WhereAreYou p_WhereAreYou)
                                      throws ManagementException
Return the list of deployed Mail factories in the current server.

Parameters:
p_WhereAreYou - The container WhereAreYou
Returns:
The list of Mail factory filename.
Throws:
ManagementException

getDatasourceFilesDeployable

public static ArrayList getDatasourceFilesDeployable(String domainName,
                                                     String serverName)
                                              throws ManagementException
Return the list of Datasource properties files ready to deploy in the current server.

Returns:
The list of Datasource properties filenames.
Throws:
ManagementException - Could not get managzement info from the MBeanServer

getDatasourceFilesDeployed

public static ArrayList getDatasourceFilesDeployed(String domainName,
                                                   String serverName)
                                            throws ManagementException
Return the list of deployed Datasources in the current server.

Parameters:
domainName - Current domain name
serverName - Current server name
Returns:
The list of Datasource filename.
Throws:
ManagementException - Could not get managzement info from the MBeanServer

getDatasourceDependences

public static ArrayList getDatasourceDependences(String pDatasourceName,
                                                 String domainName,
                                                 String serverName)
                                          throws ManagementException
Return the list of Datasource dependences for a given datasource name in the current server.

Parameters:
pDatasourceName - The name of the datasource
domainName - Current domain name
serverName - Current server name
Returns:
The list of Datasource dependence (a list of names corresponding to EJBs using this datasource).
Throws:
ManagementException - Could not get managzement info from the MBeanServer
MalformedObjectNameException

getMailFactoryDependences

public static ArrayList getMailFactoryDependences(String p_MailFactoryName,
                                                  WhereAreYou p_WhereAreYou)
                                           throws ManagementException
Return the list of Mail factory dependences in the current server for a given factory name.

Parameters:
p_MailFactoryName - The name of the mail factory
p_WhereAreYou - The container WhereAreYou
Returns:
The list of Mail factory dependences (a list of names corresponding to EJBs using this mail factory).
Throws:
ManagementException

getSessionMailFactoriesDeployed

public static ArrayList getSessionMailFactoriesDeployed(WhereAreYou p_WhereAreYou)
                                                 throws ManagementException
Return the list of deployed Session Mail Factories in the current server.

Parameters:
p_WhereAreYou - The container WhereAreYou
Returns:
The list
Throws:
ManagementException

getMimeMailPartFactoriesDeployed

public static ArrayList getMimeMailPartFactoriesDeployed(WhereAreYou p_WhereAreYou)
                                                  throws ManagementException
Return the list of deployed MimePartDatasource Mail Factories in the current server.

Parameters:
p_WhereAreYou - The container WhereAreYou
Returns:
The list
Throws:
ManagementException

getSecurityMemoryFactories

public static ArrayList getSecurityMemoryFactories(String domainName,
                                                   String serverName)
                                            throws MalformedObjectNameException
Return the list of Security Memory Factories in the current server.

Returns:
The list of Security Memory Factories
Throws:
MalformedObjectNameException

getSecurityDatasourceFactories

public static ArrayList getSecurityDatasourceFactories(String domainName,
                                                       String serverName)
                                                throws MalformedObjectNameException
Return the list of Security Datasource Factories in the current server.

Returns:
The list of Security Datasource Factories
Throws:
MalformedObjectNameException

getSecurityLdapFactories

public static ArrayList getSecurityLdapFactories(String domainName,
                                                 String serverName)
                                          throws MalformedObjectNameException
Return the list of Security Ldap Factories in the current server.

Returns:
The list of Security Ldap Factories
Throws:
MalformedObjectNameException

findSecurityFactorySubType

public static String findSecurityFactorySubType(String p_NameFactory,
                                                String domainName,
                                                String serverName)
                                         throws MalformedObjectNameException
Return the SubType of a Security Factory in the current server.

Parameters:
p_NameFactory - The factory name to find
Returns:
The SubType or null if not found
Throws:
ManagementException
MalformedObjectNameException

getUsers

public static ArrayList getUsers(String domainName,
                                 String p_Resource,
                                 String serverName)
                          throws ManagementException,
                                 MalformedObjectNameException
Return the list of all users in a resource.

Parameters:
domainName - the domain name
p_Resource - The resource
Returns:
The list of users
Throws:
ManagementException
MalformedObjectNameException

getRoles

public static ArrayList getRoles(String domainName,
                                 String p_Resource,
                                 String serverName)
                          throws ManagementException,
                                 MalformedObjectNameException
Return the list of all roles in a resource.

Parameters:
domainName - the domain name
p_Resource - The resource
Returns:
The list of roles
Throws:
ManagementException
MalformedObjectNameException

getGroups

public static ArrayList getGroups(String domainName,
                                  String p_Resource,
                                  String serverName)
                           throws ManagementException,
                                  MalformedObjectNameException
Return the list of all groups in a resource.

Parameters:
domainName - the domain name
p_Resource - The resource
Returns:
The list of groups
Throws:
ManagementException
MalformedObjectNameException

getQueuesList

public static ArrayList getQueuesList(String domainName,
                                      String serverName)
Return the Queue destinations list.

Returns:
The list

getTopicsList

public static ArrayList getTopicsList(String domainName,
                                      String serverName)
Return the Topic destinations list.

Returns:
The list

getConnectionFactoriesList

public static ArrayList getConnectionFactoriesList(org.apache.struts.util.MessageResources p_Resources,
                                                   String domainName,
                                                   String serverName)
Return the default Connection Factories.

Parameters:
p_Resources - The messages
Returns:
The list

getLoggers

public static ArrayList getLoggers(org.apache.struts.util.MessageResources p_Resources,
                                   WhereAreYou p_WhereAreYou,
                                   boolean p_Action)
                            throws MalformedObjectNameException
Return the list of all used loggers in this JOnAS server.

Parameters:
p_Resources - The used message resource
p_WhereAreYou - The used WhereAreYou instance
p_Action - True to get the action (to use directly in jsp) or False to get the same action but in forward (write in the file struts-config.xml)
Returns:
The list of loggers
Throws:
ManagementException
MalformedObjectNameException

getMbeansLists

public static ArrayList getMbeansLists(String serverName)
                                throws ManagementException
Create a list for each family of Mbean.

Returns:
An array of lists
Throws:
ManagementException

getFamiliesMbeansLists

public static ArrayList[] getFamiliesMbeansLists(String serverName)
                                          throws ManagementException
Create a list for each family of Mbean.

Returns:
An array of lists
Throws:
ManagementException


Copyright © 2007 OW2 Consortium. All Rights Reserved.