Author: painter
Date: Tue Nov 6 18:08:29 2018
New Revision: 1845948
URL: http://svn.apache.org/viewvc?rev=1845948&view=rev
Log:
JavaDoc cleanup
Removed:
turbine/fulcrum/trunk/xmlrpc/maven.xml
turbine/fulcrum/trunk/xmlrpc/project.properties
turbine/fulcrum/trunk/xmlrpc/project.xml
Modified:
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/AbstractXmlRpcComponent.java
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcClientComponent.java
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcServerComponent.java
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcClientComponent.java
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcServerComponent.java
Modified:
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/AbstractXmlRpcComponent.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/AbstractXmlRpcComponent.java?rev=1845948&r1=1845947&r2=1845948&view=diff
==============================================================================
---
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/AbstractXmlRpcComponent.java
(original)
+++
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/AbstractXmlRpcComponent.java
Tue Nov 6 18:08:29 2018
@@ -31,8 +31,6 @@ import org.apache.xmlrpc.XmlRpc;
* Common code for the XML RPC components. This processes the
system-properties and parser entries
* from the config.
*
- * @todo Handle XmlRpc.setDebug(boolean)
- *
* @author <a href="mailto:[email protected]";>Jason van Zyl</a>
* @author <a href="mailto:[email protected]";>Quinton McCombs</a>
* @version $Id$
@@ -41,6 +39,9 @@ public abstract class AbstractXmlRpcComp
extends AbstractLogEnabled
implements Configurable, Initializable
{
+
+ // TODO Handle XmlRpc.setDebug(boolean)
+
/** SAX Parser class. */
protected String saxParserClass;
@@ -53,6 +54,9 @@ public abstract class AbstractXmlRpcComp
// Lifecycle Management
// ----------------------------------------------------------------------
+ /* (non-Javadoc)
+ * @see
org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)
+ */
public void configure(Configuration configuration)
throws ConfigurationException
{
Modified:
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcClientComponent.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcClientComponent.java?rev=1845948&r1=1845947&r2=1845948&view=diff
==============================================================================
---
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcClientComponent.java
(original)
+++
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcClientComponent.java
Tue Nov 6 18:08:29 2018
@@ -1,6 +1,5 @@
package org.apache.fulcrum.xmlrpc;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -20,7 +19,6 @@ package org.apache.fulcrum.xmlrpc;
* under the License.
*/
-
import org.apache.xmlrpc.XmlRpcClient;
import java.io.IOException;
@@ -32,41 +30,34 @@ import org.apache.xmlrpc.XmlRpcException
/**
* Default implementation of the client-side XML RPC component.
*
- * @avalon.component version="1.0" name="xmlrpc-client" lifestyle="singleton"
- * @avalon.service version="1.0"
type="org.apache.fulcrum.xmlrpc.XmlRpcClientComponent"
+ * avalon.component version="1.0" name="xmlrpc-client" lifestyle="singleton"
+ * avalon.service version="1.0"
type="org.apache.fulcrum.xmlrpc.XmlRpcClientComponent"
+ *
* @author <a href="mailto:[email protected]";>Jason van Zyl</a>
* @author <a href="mailto:[email protected]";>Quinton McCombs</a>
- * @version $Id$
+ * @version $Id: DefaultXmlRpcClientComponent.java 535465 2007-05-05 06:58:06Z
+ * tv $
*/
-public class DefaultXmlRpcClientComponent
- extends AbstractXmlRpcComponent
- implements XmlRpcClientComponent
-{
- /** Default Constructor. */
- public DefaultXmlRpcClientComponent()
- {
- // nothing to do
- }
-
- /**
- * Client's interface to XML-RPC.
- *
- * The return type is Object which you'll need to cast to
- * whatever you are expecting.
- *
- * @param url A URL.
- * @param methodName A String with the method name.
- * @param params A Vector with the parameters.
- * @return An Object.
- * @exception XmlRpcException
- * @exception IOException
- */
- public Object executeRpc(URL url,
- String methodName,
- Vector params)
- throws IOException, XmlRpcException
- {
- XmlRpcClient client = new XmlRpcClient ( url );
- return client.execute(methodName, params);
- }
+public class DefaultXmlRpcClientComponent extends AbstractXmlRpcComponent
implements XmlRpcClientComponent {
+ /** Default Constructor. */
+ public DefaultXmlRpcClientComponent() {
+ }
+
+ /**
+ * Client's interface to XML-RPC.
+ *
+ * The return type is Object which you'll need to cast to whatever you
are
+ * expecting.
+ *
+ * @param url A URL.
+ * @param methodName A String with the method name.
+ * @param params A Vector with the parameters.
+ * @return An Object.
+ * @throws XmlRpcException if unable to parse
+ * @throws IOException if resource not found
+ */
+ public Object executeRpc(URL url, String methodName, Vector params)
throws IOException, XmlRpcException {
+ XmlRpcClient client = new XmlRpcClient(url);
+ return client.execute(methodName, params);
+ }
}
Modified:
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcServerComponent.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcServerComponent.java?rev=1845948&r1=1845947&r2=1845948&view=diff
==============================================================================
---
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcServerComponent.java
(original)
+++
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/DefaultXmlRpcServerComponent.java
Tue Nov 6 18:08:29 2018
@@ -41,10 +41,8 @@ import java.net.Socket;
/**
* Default implementation of the server-side XML RPC component.
*
- * @todo Handle XmlRpc.setDebug(boolean)
- *
- * @avalon.component version="1.0" name="xmlrpc-server" lifestyle="singleton"
- * @avalon.service version="1.0"
type="org.apache.fulcrum.xmlrpc.XmlRpcServerComponent"
+ * avalon.component version="1.0" name="xmlrpc-server" lifestyle="singleton"
+ * avalon.service version="1.0"
type="org.apache.fulcrum.xmlrpc.XmlRpcServerComponent"
*
* @author <a href="mailto:[email protected]";>Jason van Zyl</a>
* @author <a href="mailto:[email protected]";>Quinton McCombs</a>
@@ -54,6 +52,9 @@ public class DefaultXmlRpcServerComponen
extends AbstractXmlRpcComponent
implements Startable, Disposable, Serviceable, ThreadSafe,
XmlRpcServerComponent
{
+
+ // TODO Handle XmlRpc.setDebug(boolean)
+
/** The service manager for this component. */
private ServiceManager manager;
@@ -88,6 +89,9 @@ public class DefaultXmlRpcServerComponen
// Lifecycle Management
// ----------------------------------------------------------------------
+ /* (non-Javadoc)
+ * @see
org.apache.fulcrum.xmlrpc.AbstractXmlRpcComponent#configure(org.apache.avalon.framework.configuration.Configuration)
+ */
public void configure(Configuration configuration)
throws ConfigurationException
{
@@ -123,18 +127,8 @@ public class DefaultXmlRpcServerComponen
deniedClients = configuration.getChildren("deniedClients");
}
- /**
+ /* (non-Javadoc)
* @see
org.apache.avalon.framework.service.Serviceable#service(org.apache.avalon.framework.service.ServiceManager)
- * @avalon.dependency key="handler.0"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.1"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.2"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.3"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.4"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.5"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.6"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.7"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.8"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
- * @avalon.dependency key="handler.9"
type="com.apache.xmlrpc.XmlRpcHandler" optional="true"
*/
public void service(ServiceManager manager)
throws ServiceException
@@ -146,6 +140,9 @@ public class DefaultXmlRpcServerComponen
// S T A R T A B L E
// ------------------------------------------------------------------------
+ /* (non-Javadoc)
+ * @see org.apache.avalon.framework.activity.Startable#start()
+ */
public void start()
throws Exception
{
@@ -155,6 +152,7 @@ public class DefaultXmlRpcServerComponen
/**
* This function initializes the XmlRpcService.
+ * @throws Exception generic exception
*/
public void initialize()
throws Exception
@@ -254,8 +252,8 @@ public class DefaultXmlRpcServerComponen
}
}
- /**
- * Shuts down this service, stopping running threads.
+ /* (non-Javadoc)
+ * @see org.apache.avalon.framework.activity.Startable#stop()
*/
public void stop()
throws Exception
@@ -283,8 +281,10 @@ public class DefaultXmlRpcServerComponen
// D I S P O S A B L E
// ------------------------------------------------------------------------
- /**
+ /*
* Unregisters all handlers and disposes of the server.
+ * (non-Javadoc)
+ * @see org.apache.avalon.framework.activity.Disposable#dispose()
*/
public void dispose()
{
@@ -309,8 +309,8 @@ public class DefaultXmlRpcServerComponen
* Register an Object as a default handler for the service.
*
* @param handler The handler to use.
- * @exception XmlRpcException
- * @exception IOException
+ * @throws XmlRpcException if unable to parse
+ * @throws IOException if resource not found
*/
public void registerHandler(Object handler)
throws XmlRpcException, IOException
@@ -341,7 +341,7 @@ public class DefaultXmlRpcServerComponen
*
* @param handlerName The name the handler is registered under.
* @param handlerClass The name of the class to use as a handler.
- * @exception Exception Couldn't instantiate handler.
+ * @throws Exception Couldn't instantiate handler.
*/
private void registerClassHandler(String handlerName, String handlerClass)
throws Exception
@@ -377,7 +377,7 @@ public class DefaultXmlRpcServerComponen
*
* @param handlerName The name to register this handle as.
* @param handlerRole The role of the component serving as the handler.
- * @exception Exception If the component could not be looked up.
+ * @throws Exception If the component could not be looked up.
*/
private void registerComponentHandler(String handlerName,
String handlerRole)
@@ -398,36 +398,32 @@ public class DefaultXmlRpcServerComponen
webserver.removeHandler(handlerName);
}
- /**
+ /*
* Switch client filtering on/off.
*
* @param state Whether to filter clients.
- *
- * @see #acceptClient(java.lang.String)
- * @see #denyClient(java.lang.String)
+ * @see
org.apache.fulcrum.xmlrpc.XmlRpcServerComponent#setParanoid(boolean)
*/
public void setParanoid(boolean state)
{
webserver.setParanoid(state);
}
- /**
+ /*
* Add an IP address to the list of accepted clients. The parameter can
* contain '*' as wildcard character, e.g. "192.168.*.*". You must
* call setParanoid(true) in order for this to have
* any effect.
*
* @param address The address to add to the list.
- *
- * @see #denyClient(java.lang.String)
- * @see #setParanoid(boolean)
+ * @see
org.apache.fulcrum.xmlrpc.XmlRpcServerComponent#acceptClient(java.lang.String)
*/
public void acceptClient(String address)
{
webserver.acceptClient(address);
}
- /**
+ /*
* Add an IP address to the list of denied clients. The parameter can
* contain '*' as wildcard character, e.g. "192.168.*.*". You must call
* setParanoid(true) in order for this to have any effect.
@@ -436,6 +432,7 @@ public class DefaultXmlRpcServerComponen
*
* @see #acceptClient(java.lang.String)
* @see #setParanoid(boolean)
+ * @see
org.apache.fulcrum.xmlrpc.XmlRpcServerComponent#denyClient(java.lang.String)
*/
public void denyClient(String address)
{
Modified:
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcClientComponent.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcClientComponent.java?rev=1845948&r1=1845947&r2=1845948&view=diff
==============================================================================
---
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcClientComponent.java
(original)
+++
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcClientComponent.java
Tue Nov 6 18:08:29 2018
@@ -30,7 +30,6 @@ import org.apache.xmlrpc.XmlRpcException
/**
* The interface a client-side XmlRpcService implements.
*
- * @avalon.service version="1.0"
* @author <a href="mailto:[email protected]";>Josh Lucas</a>
* @author <a href="mailto:[email protected]";>Magnús Ãór Torfason</a>
* @author <a href="mailto:[email protected]";>Rafal Krzewski</a>
@@ -50,8 +49,8 @@ public interface XmlRpcClientComponent
* @param methodName A String with the method name.
* @param params A Vector with the parameters.
* @return An Object.
- * @exception XmlRpcException
- * @exception IOException
+ * @throws XmlRpcException if an XmlRpcException occurs
+ * @throws IOException if resource is not found
*/
Object executeRpc(URL url,
String methodName,
Modified:
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcServerComponent.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcServerComponent.java?rev=1845948&r1=1845947&r2=1845948&view=diff
==============================================================================
---
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcServerComponent.java
(original)
+++
turbine/fulcrum/trunk/xmlrpc/src/java/org/apache/fulcrum/xmlrpc/XmlRpcServerComponent.java
Tue Nov 6 18:08:29 2018
@@ -28,7 +28,6 @@ import org.apache.xmlrpc.XmlRpcException
/**
* The interface a server-side XmlRpcService implements.
*
- * @avalon.service version="1.0"
* @author <a href="mailto:[email protected]";>Josh Lucas</a>
* @author <a href="mailto:[email protected]";>Magnús Ãór Torfason</a>
* @author <a href="mailto:[email protected]";>Rafal Krzewski</a>
@@ -47,8 +46,8 @@ public interface XmlRpcServerComponent
* @param handlerName The name under which we want
* to register the service
* @param handler The handler object
- * @exception XmlRpcException
- * @exception IOException
+ * @throws XmlRpcException if an XmlRpcException occurs
+ * @throws IOException if resource is not found
*/
void registerHandler(String handlerName, Object handler)
throws XmlRpcException, IOException;
@@ -58,8 +57,8 @@ public interface XmlRpcServerComponent
* the XmlRpc Server part.
*
* @param handler The handler object
- * @exception XmlRpcException
- * @exception IOException
+ * @throws XmlRpcException if an XmlRpcException occurs
+ * @throws IOException if resource is not found
*/
void registerHandler(Object handler)
throws XmlRpcException, IOException;
@@ -75,6 +74,7 @@ public interface XmlRpcServerComponent
* Switch client filtering on/off.
* @see #acceptClient(java.lang.String)
* @see #denyClient(java.lang.String)
+ * @param state filtering state
*/
void setParanoid(boolean state);
@@ -86,6 +86,7 @@ public interface XmlRpcServerComponent
*
* @see #denyClient(java.lang.String)
* @see #setParanoid(boolean)
+ * @param address The client address
*/
void acceptClient(String address);
@@ -96,6 +97,7 @@ public interface XmlRpcServerComponent
*
* @see #acceptClient(java.lang.String)
* @see #setParanoid(boolean)
+ * @param address the client to deny
*/
void denyClient(String address);
}
