org.jboss.console.plugins.helpers
Class AbstractPluginWrapper

java.lang.Object
  extended byorg.jboss.console.plugins.helpers.AbstractPluginWrapper
All Implemented Interfaces:
ConsolePlugin (src) , PluginWrapper (src) , java.io.Serializable
Direct Known Subclasses:
AOPLister (src) , BasePluginWrapper (src) , EJBModuleLister (src) , J2EEAppLister (src) , JMSLister (src) , JSR77Lister (src) , MBeansLister (src) , MonitorLister (src) , UCLLister (src) , WebModuleLister (src)

public abstract class AbstractPluginWrapper
extends java.lang.Object
implements PluginWrapper (src) , ConsolePlugin (src)

See Also:
, Serialized Form

Nested Class Summary
static interface AbstractPluginWrapper.InternalResourceChecker (src)
           
 class AbstractPluginWrapper.RootTreeChecker (src)
           
 class AbstractPluginWrapper.SingleMBeanChecker (src)
           
 class AbstractPluginWrapper.StandardMBeanChecker (src)
           
 class AbstractPluginWrapper.SubFolderChecker (src)
           
 
Field Summary
protected  AbstractPluginWrapper.InternalResourceChecker (src) checker
           
static java.lang.String FOLDER_NAME_PARAM
           
protected  java.lang.String folderName
           
static java.lang.String IS_ROOT_NODE_PARAM
           
protected  Logger (src) log
           
static java.lang.String MBEAN_CLASS_PARAM
           
protected  java.lang.String mbeanClass
           
protected  MBeanServer (src) mbeanServer
           
static java.lang.String OBJECT_NAME_PARAM
           
protected  java.lang.String objectName
           
protected  java.lang.String pluginName
           
protected  java.lang.String pluginVersion
           
protected  PluginManager (src) pm
           
protected  java.lang.String rootContextName
           
static java.lang.String SCRIPT_NAME_PARAM
           
static java.lang.String WRAPPER_CLASS_PARAM
           
 
Fields inherited from interface org.jboss.console.manager.interfaces.ConsolePlugin (src)
PLUGIN_PROFILES, WEB_PROFILE
 
Constructor Summary
AbstractPluginWrapper()
           
 
Method Summary
protected  TreeNodeMenuEntry (src) [] createMenus(java.lang.String[] content)
           
protected  SimpleResourceTreeNode (src) createResourceNode(java.lang.String name, java.lang.String description, java.lang.String iconUrl, java.lang.String defaultUrl, TreeNodeMenuEntry (src) [] menuEntries, TreeNode (src) [] subNodes, ResourceTreeNode (src) [] subResNodes, ManageableResource (src)  resource)
           
protected  SimpleResourceTreeNode (src) createResourceNode(java.lang.String name, java.lang.String description, java.lang.String iconUrl, java.lang.String defaultUrl, TreeNodeMenuEntry (src) [] menuEntries, TreeNode (src) [] subNodes, ResourceTreeNode (src) [] subResNodes, java.lang.String jmxObjectName, java.lang.String jmxClassName)
           
protected  SimpleTreeNode (src) createTreeNode(java.lang.String name, java.lang.String description, java.lang.String iconUrl, java.lang.String defaultUrl, TreeNodeMenuEntry (src) [] menuEntries, TreeNode (src) [] subNodes, ResourceTreeNode (src) [] subResNodes)
           
 void destroy()
           
protected  java.lang.String encode(java.lang.String source)
           
protected  void findJBossMBeanServer()
           
protected  void findPluginManager()
           
protected  java.lang.String fixUrl(java.lang.String source)
           
 java.lang.String getIdentifier()
           
protected  MBeanServer (src) getMBeanServer()
           
protected  ObjectInstance (src) [] getMBeansForClass(java.lang.String scope, java.lang.String className)
           
protected  ObjectInstance (src) [] getMBeansForQuery(java.lang.String scope, QueryExp (src)  query)
           
protected  java.lang.String getPluginIdentifier()
           
protected  java.lang.String getPluginVersion()
           
 TreeNode (src) getSubTreeForResource(PluginManager (src)  master, java.lang.String profile, ManageableResource (src)  resource)
           
 java.lang.String[] getSupportedProfiles()
          Define in which console framework this plugin can be plugged (web, eclipse, etc.)
protected abstract  TreeNode (src) getTreeForResource(java.lang.String profile, ManageableResource (src)  resource)
           
 java.lang.String getVersion()
           
 void init(ServletConfig servletConfig)
           
protected  boolean isResourceToBeManaged(ManageableResource (src)  resource)
           
 void readConfigurationParameters(ServletConfig config)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OBJECT_NAME_PARAM

public static final java.lang.String OBJECT_NAME_PARAM
See Also:
Constant Field Values (src)

FOLDER_NAME_PARAM

public static final java.lang.String FOLDER_NAME_PARAM
See Also:
Constant Field Values (src)

MBEAN_CLASS_PARAM

public static final java.lang.String MBEAN_CLASS_PARAM
See Also:
Constant Field Values (src)

WRAPPER_CLASS_PARAM

public static final java.lang.String WRAPPER_CLASS_PARAM
See Also:
Constant Field Values (src)

SCRIPT_NAME_PARAM

public static final java.lang.String SCRIPT_NAME_PARAM
See Also:
Constant Field Values (src)

IS_ROOT_NODE_PARAM

public static final java.lang.String IS_ROOT_NODE_PARAM
See Also:
Constant Field Values (src)

mbeanServer

protected MBeanServer (src)  mbeanServer

pm

protected PluginManager (src)  pm

pluginName

protected java.lang.String pluginName

pluginVersion

protected java.lang.String pluginVersion

objectName

protected java.lang.String objectName

mbeanClass

protected java.lang.String mbeanClass

folderName

protected java.lang.String folderName

rootContextName

protected java.lang.String rootContextName

log

protected Logger (src)  log

checker

protected AbstractPluginWrapper.InternalResourceChecker (src)  checker
Constructor Detail

AbstractPluginWrapper

public AbstractPluginWrapper()
Method Detail

init

public void init(ServletConfig servletConfig)
          throws java.lang.Exception
Specified by:
init in interface PluginWrapper (src)
Throws:
java.lang.Exception

destroy

public void destroy()
Specified by:
destroy in interface PluginWrapper (src)

readConfigurationParameters

public void readConfigurationParameters(ServletConfig config)

getIdentifier

public java.lang.String getIdentifier()
Specified by:
getIdentifier in interface ConsolePlugin (src)

getVersion

public java.lang.String getVersion()
Specified by:
getVersion in interface ConsolePlugin (src)

getSupportedProfiles

public java.lang.String[] getSupportedProfiles()
Description copied from interface: ConsolePlugin (src)
Define in which console framework this plugin can be plugged (web, eclipse, etc.)

Specified by:
getSupportedProfiles in interface ConsolePlugin (src)

getSubTreeForResource

public TreeNode (src)  getSubTreeForResource(PluginManager (src)  master,
                                      java.lang.String profile,
                                      ManageableResource (src)  resource)
Specified by:
getSubTreeForResource in interface ConsolePlugin (src)

isResourceToBeManaged

protected boolean isResourceToBeManaged(ManageableResource (src)  resource)

getTreeForResource

protected abstract TreeNode (src)  getTreeForResource(java.lang.String profile,
                                               ManageableResource (src)  resource)

getPluginIdentifier

protected java.lang.String getPluginIdentifier()

getPluginVersion

protected java.lang.String getPluginVersion()

findJBossMBeanServer

protected void findJBossMBeanServer()

findPluginManager

protected void findPluginManager()

getMBeanServer

protected MBeanServer (src)  getMBeanServer()

fixUrl

protected java.lang.String fixUrl(java.lang.String source)

getMBeansForClass

protected ObjectInstance (src) [] getMBeansForClass(java.lang.String scope,
                                             java.lang.String className)

getMBeansForQuery

protected ObjectInstance (src) [] getMBeansForQuery(java.lang.String scope,
                                             QueryExp (src)  query)

createTreeNode

protected SimpleTreeNode (src)  createTreeNode(java.lang.String name,
                                        java.lang.String description,
                                        java.lang.String iconUrl,
                                        java.lang.String defaultUrl,
                                        TreeNodeMenuEntry (src) [] menuEntries,
                                        TreeNode (src) [] subNodes,
                                        ResourceTreeNode (src) [] subResNodes)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

createResourceNode

protected SimpleResourceTreeNode (src)  createResourceNode(java.lang.String name,
                                                    java.lang.String description,
                                                    java.lang.String iconUrl,
                                                    java.lang.String defaultUrl,
                                                    TreeNodeMenuEntry (src) [] menuEntries,
                                                    TreeNode (src) [] subNodes,
                                                    ResourceTreeNode (src) [] subResNodes,
                                                    java.lang.String jmxObjectName,
                                                    java.lang.String jmxClassName)
                                             throws java.lang.Exception
Throws:
java.lang.Exception

createResourceNode

protected SimpleResourceTreeNode (src)  createResourceNode(java.lang.String name,
                                                    java.lang.String description,
                                                    java.lang.String iconUrl,
                                                    java.lang.String defaultUrl,
                                                    TreeNodeMenuEntry (src) [] menuEntries,
                                                    TreeNode (src) [] subNodes,
                                                    ResourceTreeNode (src) [] subResNodes,
                                                    ManageableResource (src)  resource)
                                             throws java.lang.Exception
Throws:
java.lang.Exception

createMenus

protected TreeNodeMenuEntry (src) [] createMenus(java.lang.String[] content)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

encode

protected java.lang.String encode(java.lang.String source)