org.objectweb.jonas.web
Interface AbsJWebContainerServiceImplMBean

All Known Implementing Classes:
AbsJWebContainerServiceImpl, Jetty6Service, Tomcat6Service

public interface AbsJWebContainerServiceImplMBean

This interface provides a description for the web container management.

Author:
Ludovic Bert, Florent Benoit, Michel-Ange Anton (Contributor)

Method Summary
 List getAutoloadDirectories()
          Return the list of "autoload" directories for web applications.
 Integer getCurrentNumberOfWars()
           
 List getDeployableWars()
          Return the list of installed web applications ready to deploy.
 List getDeployedWars()
          Return the list of all loaded web applications.
 List getInstalledWars()
          Return the list of installed web applications.
 String getServerName()
          Gets the name of the server which is the web container
 String getServerVersion()
          Gets the version of the server which is the web container
 Set getWarNames()
          This method is added temporarily.
 String getWarsDirectory()
          Return the WebApps directory.
 boolean isWarLoaded(String fileName)
          Test if the specified filename is already deployed or not
 void registerWar(String fileName)
          Register a WAR, this method is used for the JMX Management.
 void unRegisterWar(String fileName)
          Unregister a WAR, this method is used for the JMX Management.
 

Method Detail

registerWar

void registerWar(String fileName)
                 throws RemoteException,
                        JWebContainerServiceException
Register a WAR, this method is used for the JMX Management.

Parameters:
fileName - the name of the war to deploy.
Throws:
RemoteException - if rmi call failed.
JWebContainerServiceException - if the registration of the WAR failed.

unRegisterWar

void unRegisterWar(String fileName)
                   throws RemoteException,
                          JWebContainerServiceException
Unregister a WAR, this method is used for the JMX Management.

Parameters:
fileName - the name of the war to undeploy.
Throws:
RemoteException - if rmi call failed.
JWebContainerServiceException - if the unregistration of the WAR failed.

getInstalledWars

List getInstalledWars()
                      throws Exception
Return the list of installed web applications. The WAR files or the directories with expanded web application are searched in JONAS_BASE/webapps and all webapps directories 'autoload'.

Returns:
The list of WAR files or the directories with expanded web application found
Throws:
Exception - if the list can't be retrieved

getCurrentNumberOfWars

Integer getCurrentNumberOfWars()
Returns:
current number of wars deployed in the JOnAS server

getWarNames

Set getWarNames()
This method is added temporarily. It will disapear when Wars will have their associated MBeans (when Wars will become manageable)

Returns:
the names of the wars currently deployed in the JOnAS server

isWarLoaded

boolean isWarLoaded(String fileName)
Test if the specified filename is already deployed or not

Parameters:
fileName - the name of the war file.
Returns:
true if the war is deployed, else false.

getDeployedWars

List getDeployedWars()
Return the list of all loaded web applications.

Returns:
The list of deployed web applications

getDeployableWars

List getDeployableWars()
                       throws Exception
Return the list of installed web applications ready to deploy.

Returns:
The list of deployable web applications
Throws:
Exception - if the deployable wars can't be returned

getWarsDirectory

String getWarsDirectory()
Return the WebApps directory.

Returns:
The WebApps directory

getServerName

String getServerName()
Gets the name of the server which is the web container

Returns:
the name of the server which is the web container

getServerVersion

String getServerVersion()
Gets the version of the server which is the web container

Returns:
the version of the server which is the web container

getAutoloadDirectories

List getAutoloadDirectories()
Return the list of "autoload" directories for web applications.

Returns:
The list of all "autoload" directories


Copyright © 2007 OW2 Consortium. All Rights Reserved.