svn commit: r775309 - /webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/transport/TransportListener.java

[ve...@apache.org]

Author: veithen
Date: Fri May 15 20:19:39 2009
New Revision: 775309

URL: http://svn.apache.org/viewvc?rev=775309&view=rev
Log:
Added some Javadoc.

Modified:
    webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/transport/TransportListener.java

Modified: webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/transport/TransportListener.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/transport/TransportListener.java?rev=775309&r1=775308&r2=775309&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/transport/TransportListener.java (original)
+++ webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/transport/TransportListener.java Fri May 15 20:19:39 2009
@@ -51,6 +51,19 @@
      */
     EndpointReference getEPRForService(String serviceName, String ip) throws AxisFault;
 
+    /**
+     * Get the endpoint references for a given service. These are the addresses that a client
+     * can use to send requests to the given service through this transport.
+     * 
+     * @param serviceName TODO: this is actually not simply the service name!
+     * @param ip The host name or IP address of the local host. The implementation should use
+     *           this information instead of {@link java.net.InetAddress#getLocalHost()}.
+     *           The value of this parameter may be <code>null</code>, in which case the
+     *           implementation should use {@link org.apache.axis2.util.Utils#getIpAddress(
+     *           org.apache.axis2.engine.AxisConfiguration)}.
+     * @return an array of endpoint references for the given service
+     * @throws AxisFault
+     */
     EndpointReference[] getEPRsForService(String serviceName, String ip) throws AxisFault;
 
     /**