org.jboss.management.j2ee
Class WebModule

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      extended byorg.jboss.system.ServiceMBeanSupport (src) 
          extended byorg.jboss.management.j2ee.J2EEManagedObject (src) 
              extended byorg.jboss.management.j2ee.J2EEDeployedObject (src) 
                  extended byorg.jboss.management.j2ee.J2EEModule (src) 
                      extended byorg.jboss.management.j2ee.WebModule
All Implemented Interfaces:
MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src)

public class WebModule
extends J2EEModule (src)

The JBoss JSR-77.3.16 implementation of the WebModule model


Field Summary
 
Fields inherited from class org.jboss.management.j2ee.J2EEDeployedObject (src)
APPLICATION, CMP, EJB, JAWS, JBOSS, JBOSS_WEB, RAR, SAR, WEB
 
Fields inherited from class org.jboss.management.j2ee.J2EEManagedObject (src)
NAME, TYPE
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport (src)
server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.system.ServiceMBean (src)
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
WebModule(java.lang.String warName, ObjectName (src)  j2eeAppName, java.lang.String[] jvms, java.lang.String webDD, ObjectName (src)  webContainerName, java.lang.String jbossWebDD)
          Constructor taking the Name of this Object
 
Method Summary
 void addChild(ObjectName (src)  pChild)
           
static ObjectName (src) create(MBeanServer (src)  mbeanServer, java.lang.String earName, java.lang.String warName, java.net.URL pURL, ObjectName (src)  webContainerName)
          Creates the JSR-77 WebModule
static void destroy(MBeanServer (src)  mbeanServer, ObjectName (src)  jsr77Name)
          Destroy a JSR-77 WebModule
 java.lang.String getEventType(int index)
           
 java.lang.String[] getEventTypes()
           
 java.lang.String getjbossWebDeploymentDescriptor()
           
protected  java.util.Hashtable getParentKeys(ObjectName (src)  jsr77ParentName)
          This method can be overwritten by any subclass which must return <parent-j2eeType> indicating its parents.
 java.lang.String getservlet(int pIndex)
           
 java.lang.String[] getservlets()
          Return the associated servlet names as Strings.
 void postCreation()
           
 void preDestruction()
           
 void removeChild(ObjectName (src)  pChild)
           
 java.lang.String toString()
           
 
Methods inherited from class org.jboss.management.j2ee.J2EEModule (src)
getjavaVM, getjavaVMs
 
Methods inherited from class org.jboss.management.j2ee.J2EEDeployedObject (src)
getdeploymentDescriptor, getDeploymentDescriptor, getserver
 
Methods inherited from class org.jboss.management.j2ee.J2EEManagedObject (src)
getobjectName, getObjectName, getObjectName, getparent, getType, getType, iseventProvider, isstateManageable, isstatisticsProvider, newObjectName, postRegister, preDeregister, removeObject, removeObject, sendNotification, setparent
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport (src)
create, createService, destroy, destroyService, getLog, getName, getNextNotificationSequenceNumber, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, preRegister, start, startService, stop, stopService
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport (src)
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WebModule

public WebModule(java.lang.String warName,
                 ObjectName (src)  j2eeAppName,
                 java.lang.String[] jvms,
                 java.lang.String webDD,
                 ObjectName (src)  webContainerName,
                 java.lang.String jbossWebDD)
          throws MalformedObjectNameException (src) ,
                 InvalidParentException (src) 
Constructor taking the Name of this Object

Parameters:
warName - Name to be set which must not be null
j2eeAppName - the name of the parent JSR77 model component
jvms - the names of the deployment env JVM JSR77 model components
webDD - the web.xml descriptor text
webContainerName - the JBoss web container service name for the war
jbossWebDD - the jboss-web.xml descriptor text
Method Detail

create

public static ObjectName (src)  create(MBeanServer (src)  mbeanServer,
                                java.lang.String earName,
                                java.lang.String warName,
                                java.net.URL pURL,
                                ObjectName (src)  webContainerName)
Creates the JSR-77 WebModule

Parameters:
mbeanServer - MBeanServer the WebModule is created on
earName - Name of the Application but if null object then it is a standalone module (no EAR wrapper around)
warName - Name of the war
pURL - URL path to the local deployment of the module (where to find the DD file)
webContainerName - the JBoss web container mbean name

destroy

public static void destroy(MBeanServer (src)  mbeanServer,
                           ObjectName (src)  jsr77Name)
Destroy a JSR-77 WebModule

Parameters:
mbeanServer - The JMX MBeanServer the desired WebModule is registered on
jsr77Name - the JSR77 EJBModule component ObjectName

getservlets

public java.lang.String[] getservlets()
Return the associated servlet names as Strings.


getservlet

public java.lang.String getservlet(int pIndex)

getjbossWebDeploymentDescriptor

public java.lang.String getjbossWebDeploymentDescriptor()

addChild

public void addChild(ObjectName (src)  pChild)
Overrides:
addChild in class J2EEManagedObject (src)

removeChild

public void removeChild(ObjectName (src)  pChild)
Overrides:
removeChild in class J2EEManagedObject (src)

getEventTypes

public java.lang.String[] getEventTypes()

getEventType

public java.lang.String getEventType(int index)

postCreation

public void postCreation()
Overrides:
postCreation in class J2EEManagedObject (src)

preDestruction

public void preDestruction()
Overrides:
preDestruction in class J2EEManagedObject (src)

toString

public java.lang.String toString()
Overrides:
toString in class J2EEDeployedObject (src)

getParentKeys

protected java.util.Hashtable getParentKeys(ObjectName (src)  jsr77ParentName)
Description copied from class: J2EEManagedObject (src)
This method can be overwritten by any subclass which must return <parent-j2eeType> indicating its parents. By default it returns an empty hashtable instance.

Overrides:
getParentKeys in class J2EEManagedObject (src)
Parameters:
jsr77ParentName - the WebModule parent's JSR77 ObjectName
Returns:
A hashtable with the J2EE-Application and J2EE-Server as parent