Author: dims
Date: Wed Jan 4 07:00:07 2006
New Revision: 365923
URL: http://svn.apache.org/viewcvs?rev=365923&view=rev
Log:
javadoc changes
Modified:
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisConfigBuilder.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisServiceBuilder.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentClassLoader.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentConstants.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentEngine.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DescriptionBuilder.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ModuleBuilder.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceBuilder.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceGroupBuilder.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListener.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListenerImpl.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveFileData.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveReader.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/WSInfoList.java
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisConfigBuilder.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisConfigBuilder.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisConfigBuilder.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisConfigBuilder.java
Wed Jan 4 07:00:07 2006
@@ -182,7 +182,7 @@
}
/**
- * To get the list og modules that is requird to be engage globally
+ * Gets the list of modules that is required to be engaged globally.
*
* @param moduleRefs <code>java.util.Iterator</code>
*/
@@ -197,7 +197,7 @@
}
/**
- * To process AxisObservers
+ * Processes AxisObservers.
*
* @param oservers
*/
@@ -282,7 +282,7 @@
}
/**
- * To process all the phase orders which are defined in axis2.xml
+ * Processes all the phase orders which are defined in axis2.xml.
*
* @param phaserders
*/
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisServiceBuilder.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisServiceBuilder.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisServiceBuilder.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/AxisServiceBuilder.java
Wed Jan 4 07:00:07 2006
@@ -76,7 +76,7 @@
import com.ibm.wsdl.util.xml.DOM2Writer;
/**
- * AxisServiceBuilder builds an AxisService using a WSDL document which is feed
+ * AxisServiceBuilder builds an AxisService using a WSDL document which is input
* as a javax.wsdl.Definition or as an InputStream. If there are multiple
* javax.wsdl.Service elements in the WSDL, the first is picked.
*/
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentClassLoader.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentClassLoader.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentClassLoader.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentClassLoader.java
Wed Jan 4 07:00:07 2006
@@ -39,9 +39,9 @@
private URL[] urls;
/**
- * DeploymentClassLoader is exetend form URLClassLoader , and the constructor
- * has not overide the super constroctor , but has done some stuff to find out
- * jar fils inside /lib director
+ * DeploymentClassLoader is extended from URLClassLoader. The constructor
+ * does not override the super constructor, but does additional steps like find out
+ * jar fils inside /lib directory.
*
* @param urls <code>URL</code>
* @param parent parent classloader <code>ClassLoader</code>
@@ -56,17 +56,18 @@
/**
* @param name <code>String</code> Name of the file to be loaded
- * @return <code>Class</code> return a class object if it found else
- * will return null or classNotfoun exeption
+ * @return Returns a <code>Class</code> object if it found else
+ * returns null or ClassNotFoundException.
* <p/>
- * The method has ovride in the following way
- * 1. called the super class and check to see wether the class is there
- * if the class is found then return that , else if super returns ClassNotfoundExeption
- * 2. Check wether the entry corresponding to the class name exsit in one of
jar files
- * in /lib director
- * 3. If it is there get the byte array out of that and creat a Class object
out of that
- * by calling "defineClass()" , if it sucssed then return that else
- * 4. Throw classNotfound exeption
+ * The method finds the class in the following way:
+ * <br>
+ * 1. Calls the super class to check to see whether the class is there.
+ * If the class is found then return that , else go to step 2 </br>
+ * <br>
+ * 2. Check wether the class name exist in one of jar files
+ * in /lib directory. If it is found, get the byte array and create a Class
+ * object from it by calling "defineClass()", else throws ClassNotFoundException.
+ * </br>
* @throws ClassNotFoundException
*/
protected Class findClass(final String name) throws ClassNotFoundException {
@@ -122,8 +123,8 @@
}
/**
- * This just search for jar files inside /lib dirctory and if there are any then those
- * will be added to the arraylit (only the name of the jar file)
+ * Searches for jar files in /lib directory. If they exist, they are
+ * will be added to the arraylist (only the name of the jar file).
*/
private void findLibJars() {
/**
@@ -156,12 +157,12 @@
}
/**
- * Read jar file (/lib) one by one , then for each file craete <code>ZipInputStream</code>
- * that and check to see wether there is any entry eith given name if it found then
- * Creat ByteArrayOutPutStream and get return that
+ * Reads jar file (/lib) one by one , then for each file creates <code>ZipInputStream</code>
+ * and checks to see wether there is any entry with the given name. If it found then
+ * creates ByteArrayOutPutStream and returns that.
*
* @param resourceName : Name of the resource that your are going to use
- * @return <code>byte[]</code>
+ * @return Returns <code>byte[]</code> .
*/
private byte[] getBytes(String resourceName) {
byte raw[];
@@ -206,14 +207,13 @@
}
/**
- * Read jar file (/lib) one by one , then for each file craete <code>ZipInputStream</code>
- * that and check to see wether there is any entry eith given name if it found then
- * Creat ByteArrayOutPutStream and get the class bytes to that .
- * after goning throgh each and evry jar file if there is no entry with given name
- * will throug a ClassNotFound execption
+ * Reads the jar file (/lib) one by one. For each file creates <code>ZipInputStream</code>
+ * and checks to see wether there is any entry with the name. If it is found then
+ * creates ByteArrayOutPutStream and gets the byte code for that. After going through
+ * each and every jar file if there is no entry with the name, throws a ClassNotFound
exception.
*
* @param filename <code>String</code> Name of the file to be loaded (Class
Name)
- * @return bytt[]
+ * @return Returns byte[].
* @throws java.io.IOException <code>Exception</code>
*/
private byte[] getClassByteCodes(String filename) throws Exception {
@@ -233,9 +233,9 @@
}
/*
- * This override locates resources similar to the way that getClassByteCodes() locates
classes.
- * We do not store the bytes from resources in memory, as
- * the size of resources is generally unpredictable
+ * Locates resources similar to the way that getClassByteCodes() locates classes.
+ * The bytes from resources are not stored in memory, as the size of resources is
+ * generally unpredictable.
*
* @param name
* @return inputstream
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentConstants.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentConstants.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentConstants.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentConstants.java
Wed Jan 4 07:00:07 2006
@@ -18,7 +18,7 @@
package org.apache.axis2.deployment;
/**
- * Constants used during service/module deployment
+ * Constants used during service/module deployment.
*/
public interface DeploymentConstants {
public static String META_INF = "META-INF";
@@ -83,7 +83,7 @@
String SUFFIX_JAR = ".jar";
String SUFFIX_WSDL = ".wsdl";
/**
- * Resource that contains the configuration
+ * Resource that contains the configuration.
*/
String AXIS2_CONFIGURATION_RESOURCE =
"org/apache/axis2/deployment/axis2.xml";
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentEngine.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentEngine.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentEngine.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DeploymentEngine.java
Wed Jan 4 07:00:07 2006
@@ -50,18 +50,18 @@
public String axis2repository = null;
/**
- * This will store all the web Services to deploy
+ * Stores all the web Services to deploy.
*/
private List wsToDeploy = new ArrayList();
/**
- * this will store all the web Services to undeploy
+ * Stores all the web Services to undeploy.
*/
private List wsToUnDeploy = new ArrayList();
private PhasesInfo phasesinfo = new PhasesInfo(); // to store phases list in axis2.xml
/**
- * To store the module specified in the server.xml at the document parsing time
+ * Stores the module specified in the server.xml at the document parsing time.
*/
private ArrayList modulelist = new ArrayList();
@@ -76,16 +76,15 @@
/**
- * Default constructor is need to deploy module and service programatically
+ * Default constructor is needed to deploy module and service programatically.
*/
public DeploymentEngine() {
}
/**
- * This the constructor which is used by Engine in order to start
- * Deployment module,
+ * This constructor is used by Engine to start the deployment module.
*
- * @param repositoryName is the path to which Repositary Listener should
+ * @param repositoryName is the path to which Repository Listener should
* listen to.
*/
public DeploymentEngine(String repositoryName) throws DeploymentException {
@@ -104,7 +103,7 @@
}
/**
- * while parsing the axis2.xml the module refferences have to be store some where , since
at that
+ * Adds module references to the list while parsing the axis2.xml file.
* time none of module availble (they load after parsing the document)
*
* @param moduleName <code>QName</code>
@@ -239,10 +238,10 @@
}
/**
- * This method can be used to build ModuleDescription for a given module archiev file
+ * Builds ModuleDescription for a given module archive file.
*
* @param modulearchive
- * @return
+ * @return Returns ModuleDescription.
* @throws DeploymentException
*/
public ModuleDescription buildModule(File modulearchive, AxisConfiguration config)
@@ -303,15 +302,15 @@
}
/**
- * This method is used to fill a axisservice object using services.xml , first it should
create
- * an axisservice object using WSDL and then fill that using given servic.xml and load
all the requed
- * class and build the chains , finally add the servicecontext to EngineContext and
axisservice into
- * EngineConfiguration
+ * Fills an axisservice object using services.xml. First creates
+ * an axisservice object using WSDL and then fills it using the given services.xml.
+ * Loads all the required class and builds the chains, finally adds the
+ * servicecontext to EngineContext and axisservice into EngineConfiguration.
*
* @param axisService
* @param serviceInputStream
* @param classLoader
- * @return
+ * @return Returns AxisService.
* @throws DeploymentException
*/
public AxisService buildService(AxisService axisService, InputStream serviceInputStream,
@@ -477,8 +476,7 @@
}
/**
- * This methode used to check the modules referd by server.xml
- * are exist , or they have deployed
+ * Checks if the modules, referred by server.xml, exist or that they are deployed.
*/
private void engageModules() throws AxisFault {
for (Iterator iterator = modulelist.iterator(); iterator.hasNext();) {
@@ -601,8 +599,7 @@
}
/**
- * this method use to start the Deployment engine
- * inorder to perform Hot deployment and so on..
+ * Starts the Deployment engine to perform Hot deployment and so on..
*/
private void startSearch(RepositoryListener listener) {
Scheduler scheduler = new Scheduler();
@@ -637,8 +634,8 @@
}
/**
- * This method is to check wether some one has change the system pre defined phases for
all the
- * flows if some one has done so will throw a DeploymentException
+ * Checks whether some one has changed the system pre-defined phases
+ * for all the flows. If they have been changed,throws a DeploymentException.
*
* @throws DeploymentException
*/
@@ -666,7 +663,7 @@
}
/**
- * tio get ER
+ * Gets AxisConfiguration.
*
* @return AxisConfiguration <code>AxisConfiguration</code>
*/
@@ -675,11 +672,11 @@
}
/**
- * This method is used to retrive service name form the arechive file name
- * if the archive file name is service1.aar , then axis service name would be service1
+ * Retrieves service name from the archive file name.
+ * If the archive file name is service1.aar , then axis service name would be service1
*
* @param fileName
- * @return String
+ * @return Returns String.
*/
private String getAxisServiceName(String fileName) {
char seperator = '.';
@@ -757,7 +754,7 @@
}
/**
- * To set hotDeployment and hot update
+ * Sets hotDeployment and hot update.
*/
private void setDeploymentFeatures() {
String value;
@@ -786,7 +783,7 @@
}
/**
- * Create directories for modules/services, copy configuration xml from class loader
if necessary
+ * Creates directories for modules/services, copies configuration xml from class loader
if necessary
*
* @param repositoryName
* @param xmlFile
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DescriptionBuilder.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DescriptionBuilder.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DescriptionBuilder.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/DescriptionBuilder.java
Wed Jan 4 07:00:07 2006
@@ -46,7 +46,7 @@
import java.util.Iterator;
/**
- * To do the common tasks for all *Builder class
+ * This class does the common tasks for all *Builder class.
*/
public class DescriptionBuilder implements DeploymentConstants {
@@ -64,10 +64,10 @@
}
/**
- * This will creat OMElemnt for a given descrition document (axis2.xml , services.xml
and
- * module.xml)
+ * Creates OMElement for a given description document (axis2.xml , services.xml and
+ * module.xml).
*
- * @return OMElement <code>OMElement</code>
+ * @return Returns <code>OMElement</code> .
* @throws javax.xml.stream.XMLStreamException
*
*/
@@ -84,8 +84,8 @@
}
/**
- * to load default message receivers , in this case first try to search in Axiservice
for the
- * given mepURL , if it not found will search in AixsConfiguration for the given mepURL
+ * Loads default message receivers. First searches in Axiservice for the
+ * given mepURL, if not found searches in AxisConfiguration with the given mepURL.
*
* @param mepURL : can be null
* @param service : This can be null <code>AxisService</code>
@@ -104,7 +104,7 @@
}
/**
- * To process default message recivers specify either in axis2.xml or services.xml
+ * Processes default message receivers specified either in axis2.xml or services.xml.
*
* @param messageReceivers
*/
@@ -152,10 +152,10 @@
}
/**
- * To process Flow elements in services.xml
+ * Processes flow elements in services.xml .
*
* @param flowelement <code>OMElement</code>
- * @return
+ * @return Returns Flow.
* @throws DeploymentException <code>DeploymentException</code>
*/
protected Flow processFlow(OMElement flowelement, ParameterInclude parent)
@@ -178,10 +178,10 @@
}
/**
- * To process Handler element
+ * Processes Handler element.
*
* @param handler_element <code>OMElement</code>
- * @return
+ * @return Returns HandlerDescription.
* @throws DeploymentException <code>DeploymentException</code>
*/
protected HandlerDescription processHandler(OMElement handler_element, ParameterInclude
parent)
@@ -282,13 +282,12 @@
}
/**
- * To get the Parameter object out from the OM
+ * Gets the Parameter object from the OM.
*
* @param parameters <code>Parameter</code>
* @param parameterInclude <code>ParameterInclude</code>
* @param parent <code>ParameterInclude</code>
- * return : will return parameters , wchih name is WSA-Mapping
, since we need to treat them
- * separately
+ * @return list of WSA action parameters
*/
protected ArrayList processParameters(Iterator parameters, ParameterInclude parameterInclude,
ParameterInclude parent)
@@ -403,11 +402,10 @@
/**
- * This method is used to retrive service name form the arechive file name
- * if the archive file name is service1.aar , then axis service name would be service1
+ * Gets the short file name. Short file name is the name before the dot.
*
* @param fileName
- * @return String
+ * @return Returns String.
*/
public static String getShortFileName(String fileName) {
char seperator = SEPARATOR_DOT;
@@ -424,10 +422,10 @@
}
/**
- * this method is to get the value of attribue
+ * Gets the value of an attribute.
* eg xsd:anyVal --> anyVal
*
- * @return String
+ * @return Returns String.
*/
protected String getValue(String in) {
char seperator = SEPARATOR_COLON;
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ModuleBuilder.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ModuleBuilder.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ModuleBuilder.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ModuleBuilder.java
Wed Jan 4 07:00:07 2006
@@ -34,8 +34,7 @@
import java.util.Iterator;
/**
- * This class is to convert OM->ServiceDescrption , where first create OM from services.xml
and
- * then populate service description by using OM
+ * Builds a module description from OM
*/
public class ModuleBuilder extends DescriptionBuilder {
private AxisConfiguration axisConfig;
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceBuilder.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceBuilder.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceBuilder.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceBuilder.java
Wed Jan 4 07:00:07 2006
@@ -37,8 +37,7 @@
import java.util.Iterator;
/**
- * This class is to convert OM->ServiceDescrption , where first create OM from services.xml
and
- * then populate service description by using OM
+ * Builds a service description from OM
*/
public class ServiceBuilder extends DescriptionBuilder {
private AxisConfiguration axisConfig;
@@ -57,7 +56,7 @@
}
/**
- * top most method that used to populate service from corresponding OM
+ * Populates service from corresponding OM.
*/
public AxisService populateService(OMElement service_element) throws DeploymentException
{
try {
@@ -202,7 +201,7 @@
}
/**
- * To get the list og modules that is requird to be engage globally
+ * Gets the list of modules that is required to be engaged globally.
*
* @param moduleRefs <code>java.util.Iterator</code>
* @throws DeploymentException <code>DeploymentException</code>
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceGroupBuilder.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceGroupBuilder.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceGroupBuilder.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/ServiceGroupBuilder.java
Wed Jan 4 07:00:07 2006
@@ -111,7 +111,7 @@
}
/**
- * To get the list of modules that is required to be engaged globally
+ * Gets the list of modules that is required to be engaged globally.
*
* @param moduleRefs <code>java.util.Iterator</code>
* @throws DeploymentException <code>DeploymentException</code>
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListener.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListener.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListener.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListener.java
Wed Jan 4 07:00:07 2006
@@ -19,28 +19,28 @@
/**
* RepositoryListener listens to a specific directory for updates.
- * eg: addition, removal or modification of files
+ * eg: addition, removal or modification of files.
*/
public interface RepositoryListener {
/**
- * this method is to check whether new module has been added
+ * Checks whether new module has been added.
*/
void checkModules();
/**
- * this method is to check whether new service has been added
+ * Checks whether new service has been added.
*/
void checkServices();
/**
- * this is to initialize the Deployment, this is invoked during Axis engine start up
- * at which point it should deploy all the services and modules, and initialize the WSInfoList
+ * Initializes the deployment. This is invoked during Axis engine start up
+ * at which point it deploys all the services and modules, and initializes the WSInfolist.
*/
void init();
/**
- * If new services or modules are added then this method will invoked
+ * Updates when new services or modules are added.
*/
void update();
}
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListenerImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListenerImpl.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListenerImpl.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/listener/RepositoryListenerImpl.java
Wed Jan 4 07:00:07 2006
@@ -42,8 +42,8 @@
/**
* This constructor takes two arguments, a folder name and a reference to Deployment
Engine
- * Fisrt it initilize the system, by loading all the modules in the /modules directory
- * and also creates a WSInfoList to store information about available modules and services
+ * First, it initializes the system, by loading all the modules in the /modules directory
+ * and then creates a WSInfoList to store information about available modules and services.
*
* @param folderName path to parent directory that the listener should listen to
* @param deploymentEngine reference to engine registry for updates
@@ -56,7 +56,7 @@
}
/**
- * Find a list of modules in this folder and add to wsInfoList
+ * Finds a list of modules in the folder and adds to wsInfoList.
*/
public void checkModules() {
String modulepath = folderName + MODULE_PATH;
@@ -81,7 +81,7 @@
}
/**
- * Find a list of services in this folder and add to wsInfoList
+ * Finds a list of services in the folder and adds to wsInfoList.
*/
public void checkServices() {
String modulepath = folderName + SERVICE_PATH;
@@ -91,10 +91,8 @@
}
/**
- * First it call to initalize method of WSInfoList to initilizat that
- * then it call to checkModules to load all the module.jar s
- * and then it call to update() method inorder to update the Deployment engine and
- * engine regsitry
+ * First initializes the WSInfoList, then calls checkModule to load all the modules
+ * and calls update() to update the Deployment engine and engine registry.
*/
public void init() {
wsInfoList.init();
@@ -103,8 +101,8 @@
}
/**
- * This method is to search a given folder for jar files
- * and added them to a list wich is in the WSInfolist class
+ * Searches a given folder for jar files and adds them to a list in the
+ * WSInfolist class.
*/
private void findServicesInDirectory(String folderName) {
File root = new File(folderName);
@@ -128,7 +126,7 @@
}
/**
- * this is the actual method that is invoked from the scheduler
+ * Method invoked from the scheduler to start the listener.
*/
public void startListener() {
checkServices();
@@ -136,7 +134,7 @@
}
/**
- * call to update method of WSInfoList object
+ * Updates WSInfoList object.
*/
public void update() {
wsInfoList.update();
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveFileData.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveFileData.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveFileData.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveFileData.java
Wed Jan 4 07:00:07 2006
@@ -28,8 +28,7 @@
import java.util.ArrayList;
/**
- * ArchiveFileData = Hot Deployment File Item, stores infromation about the module or service
- * item to be deployed
+ * ArchiveFileData stores information about the module or service item to be deployed.
*/
public class ArchiveFileData {
private File file = null;
@@ -91,10 +90,10 @@
}
/**
- * to check whthere a given file is a jar file
+ * Checks whether a given file is a jar or aar file.
*
* @param filename
- * @return boolean
+ * @return Returns boolean.
*/
public static boolean isServiceArchiveFile(String filename) {
return ((filename.endsWith(".jar")) | (filename.endsWith(".aar")));
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveReader.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveReader.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveReader.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/ArchiveReader.java
Wed Jan 4 07:00:07 2006
@@ -92,12 +92,13 @@
}
/**
- * This method first check whether the given module is there in the user home dirctory
if so return
- * that , else try to read the given module form classpath (from resources ) if found
first get the module.mar
- * file from the resourceStream and write that into user home/axis2home/nodule directory
- *
+ * Creates the module file archive file. Checks whether the module exists in home
+ * directory. If yes, returns that else reads the given module from classpath (from resources).
+ * If found, gets the module.mar file from the resource stream and writes into
+ * the userhome/axis2home/module directory.
+ *
* @param moduleName
- * @return
+ * @return Returns File.
* @throws DeploymentException
*/
public File creatModuleArchivefromResource(String moduleName, String axis2repository)
@@ -176,11 +177,16 @@
}
/**
- * This method will readServiceArchive the given jar or aar.
- * it take two arguments filename and refereance to DeployEngine
- *
+ * Extract Service XML files and builds the service groups
+ *
* @param filename
* @param engine
+ * @param axisServiceGroup
+ * @param extractService
+ * @param wsdls
+ * @param axisConfig
+ * @return
+ * @throws DeploymentException
*/
public ArrayList processServiceGroup(String filename, DeploymentEngine engine,
AxisServiceGroup axisServiceGroup,
@@ -238,10 +244,10 @@
}
/**
- * Craeting AxisService using
+ * Creats AxisService.
*
* @param in
- * @return
+ * @return Returns AxisService.
* @throws DeploymentException
*/
private AxisService processWSDLFile(InputStream in) throws DeploymentException {
@@ -254,7 +260,7 @@
}
/**
- * To create service objects out form wsdls file inside a service archive file
+ * Creates service objects from wsdl file inside a service archive file.
*
* @param file <code>ArchiveFileData</code>
* @param depengine <code>DeploymentEngine</code>
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/WSInfoList.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/WSInfoList.java?rev=365923&r1=365922&r2=365923&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/WSInfoList.java
(original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/repository/util/WSInfoList.java
Wed Jan 4 07:00:07 2006
@@ -39,7 +39,7 @@
public List currentJars = new ArrayList();
/**
- * Referance to DeploymentEngine to make update
+ * Reference to DeploymentEngine to make update
*/
private DeploymentEngine deployer;
@@ -48,16 +48,15 @@
}
/**
- * First it check whether the file is already available in the
- * system call isFileExist , if it is not deployed yet then it will add
- * that to jarList and to the deployment engine as new service or module
- * in adding new item to jarList it first create optimice and requird object to
- * keep those infor call WSInfo and that will be added to jarist and actual
- * jar file will be added to DeploymentEngine
+ * First checks whether the file is already available by the
+ * system call isFileExist. If it is not deployed yet then adds to the jarList
+ * and to the deployment engine as a new service or module.
+ * While adding new item to jarList, first creates the WSInfo object and
+ * then adds to the jarlist and actual jar file is added to DeploymentEngine.
* <p/>
- * If it is already exists then it check whether it has been updated
- * then change the last update date of the wsInfo and added two entries to DeploymentEngine
- * one for New Deployment and other for undeployment
+ * If the files already exists, then checks whether it has been updated
+ * then changes the last update date of the wsInfo and adds two entries to
+ * DeploymentEngine - one for New Deployment and other for undeployment.
*
* @param file actual jar files for either Module or service
* @param type indicate either Service or Module
@@ -117,11 +116,10 @@
}
/**
- * this is to check , undeploye WS
- * what this relly does is it caheck older jars files and
- * current jars if name of the old jar file does not exit in the currecntjar
+ * Checks undeployed Services. Checks old jars files and current jars.
+ * If name of the old jar file does not exist in the current jar
* list then it is assumed that the jar file has been removed
- * that is hot undeployment
+ * and that is hot undeployment.
*/
public void checkForUndeployedServices() {
if (!check) {
@@ -178,7 +176,7 @@
}
/**
- * This method is used to initialize the vector
+ * Clears the jarlist.
*/
public void init() {
jarList.clear();
@@ -200,8 +198,7 @@
}
/**
- * This method is to use to check the file exist and if so
- * it will return related wsinfo object to the file else return null;
+ * Gets the WSInfo object related to a file if it exists, null otherwise.
*
* @param filename
*/
@@ -220,7 +217,7 @@
}
/**
- * to check whether the file is already in the list
+ * Checks whether the file already exists in the list.
*
* @param filename
*/
@@ -229,8 +226,9 @@
}
/**
- * comapre the last update dates of both files and if those are differ
- * that will assume as the file is been modified
+ * Checks if a file has been modified by comparing the last update date of
+ * both files and WSInfo. If they are different, the file is assumed to have
+ * been modified.
*
* @param file
* @param wsInfo
|