Author: michiel
Date: 2009-09-10 14:41:50 +0200 (Thu, 10 Sep 2009)
New Revision: 38560
Modified:
speeltuin/mihxil/webservice/mmbase/src/main/java/org/mmbase/webservice/WebService.java
speeltuin/mihxil/webservice/mmbase/src/main/java/org/mmbase/webservice/WebServiceRepository.java
Log:
javadoc
Modified:
speeltuin/mihxil/webservice/mmbase/src/main/java/org/mmbase/webservice/WebService.java
===================================================================
---
speeltuin/mihxil/webservice/mmbase/src/main/java/org/mmbase/webservice/WebService.java
2009-09-10 12:33:51 UTC (rev 38559)
+++
speeltuin/mihxil/webservice/mmbase/src/main/java/org/mmbase/webservice/WebService.java
2009-09-10 12:41:50 UTC (rev 38560)
@@ -18,6 +18,7 @@
import org.mmbase.util.functions.*;
/**
+ * An instance of this interface describes one webservice. also See {...@link
AbstractWebService} .
*
* @author Michiel Meeuwissen
* @version $Id$
@@ -32,6 +33,7 @@
/**
* The associated action, which defines who may execute this web service.
Public web services may simply return {...@link #PUBLIC}.
+ * You may simply implemente the 'default action checker', but we can also
leave it to the security implementation. (AFAIK no security has complete
support for that yet).
*/
Action getAction();
@@ -39,12 +41,14 @@
/**
* This is the core of web-service. Based on some (optional) parameters
(an empty object must be
- * created by {...@link #createParameters} and then filled), it must
create XML, by writing tha to
+ * created by {...@link #createParameters} and then filled), it must
create XML, by writing that to
* the given XMLStreamWriter.
*/
void serve(XMLStreamWriter writer, Parameters params) throws
WebServiceException, XMLStreamException;
-
+ /**
+ * Creates an empty parameter object to fill and than pass to {...@link
#serve}
+ */
Parameters createParameters();
Parameter[] getParameterDefinition();
@@ -52,6 +56,9 @@
LocalizedString getDescription();
+ /**
+ * In the 'REST' formalism a certain web service can be associated with
one or more of these 'type' of executing them. They correspond to the basic
HTTP methods.
+ */
static enum Type {
GET,
POST,
Modified:
speeltuin/mihxil/webservice/mmbase/src/main/java/org/mmbase/webservice/WebServiceRepository.java
===================================================================
---
speeltuin/mihxil/webservice/mmbase/src/main/java/org/mmbase/webservice/WebServiceRepository.java
2009-09-10 12:33:51 UTC (rev 38559)
+++
speeltuin/mihxil/webservice/mmbase/src/main/java/org/mmbase/webservice/WebServiceRepository.java
2009-09-10 12:41:50 UTC (rev 38560)
@@ -21,6 +21,7 @@
import org.mmbase.util.functions.*;
/**
+ * The WebServiceRepository singleton is responsible for which WebService are
available. WebServices may be executed by {...@link WebServiceServlet}.
*
* @author Michiel Meeuwissen
* @version $Id$
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
