Update of /var/cvs/src/org/mmbase/framework
In directory james.mmbase.org:/tmp/cvs-serv29822/src/org/mmbase/framework
Modified Files:
Block.java ComponentRepository.java ConnectionRenderer.java
DeniedRenderer.java ErrorRenderer.java Framework.java
FrameworkFilter.java Setting.java VirtualComponent.java
package.html
Log Message:
javadoc
See also: http://cvs.mmbase.org/viewcvs/src/org/mmbase/framework
Index: Block.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Block.java,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -b -r1.39 -r1.40
--- Block.java 12 Apr 2008 12:58:20 -0000 1.39
+++ Block.java 25 Apr 2008 14:31:38 -0000 1.40
@@ -16,12 +16,28 @@
import org.mmbase.util.logging.Logging;
/**
- * A Block is a representation of a page within a component. It has 2
renderers,
+ * A Block is a representation of a page within a component. It has two
renderers,
* 'head' and 'body', and a processor.
*
+ * Blocks can be configured in a [EMAIL PROTECTED] Component}. A typical
block, this one is the
+ * 'applications' block (the former 'Applications' admin page) which is one of
the
+ * core components, looks like this:
+ *
+ * <p>
+ * <block name="applications" classification="mmbase.admin"
mimetype="text/html"><br />
+ * <title xml:lang="en">Applications</title><br />
+ * <title xml:lang="nl">Applicaties</title><br />
+ * <description xml:lang="en">Shows an overview of all MMBase apps1
applications</description><br />
+ * <body jsp="applications.jspx"><br />
+ * <param name="application" type="String" /><br />
+ * </body><br />
+ * </block>
+ * </p>
+ *
+ *
* @author Johannes Verelst
* @author Michiel Meeuwissen
- * @version $Id: Block.java,v 1.39 2008/04/12 12:58:20 michiel Exp $
+ * @version $Id: Block.java,v 1.40 2008/04/25 14:31:38 andre Exp $
* @since MMBase-1.9
*/
public class Block {
Index: ComponentRepository.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/ComponentRepository.java,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -b -r1.35 -r1.36
--- ComponentRepository.java 12 Apr 2008 13:23:27 -0000 1.35
+++ ComponentRepository.java 25 Apr 2008 14:31:39 -0000 1.36
@@ -21,10 +21,11 @@
import org.mmbase.util.logging.Logging;
/**
- * This (singleton) class maintains all compoments which are registered in the
current MMBase.
+ * This (singleton) class maintains all [EMAIL PROTECTED] Component}s which
are registered in the current MMBase.
+ * Components can be configured by placing their configuration in
'config/components/'.
*
* @author Michiel Meeuwissen
- * @version $Id: ComponentRepository.java,v 1.35 2008/04/12 13:23:27 michiel
Exp $
+ * @version $Id: ComponentRepository.java,v 1.36 2008/04/25 14:31:39 andre Exp
$
* @since MMBase-1.9
*/
public class ComponentRepository {
Index: ConnectionRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/ConnectionRenderer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- ConnectionRenderer.java 23 Feb 2008 12:44:03 -0000 1.4
+++ ConnectionRenderer.java 25 Apr 2008 14:31:39 -0000 1.5
@@ -24,10 +24,28 @@
import org.mmbase.util.logging.Logging;
/**
- * A Renderer implementation based on an external connection.
+ * A [EMAIL PROTECTED] Renderer} implementation based on an external
connection.
+ * An example of a [EMAIL PROTECTED] ConnectionRenderer} is the following one:
+ *
+ * <p>
+ * <block name="mmbase_news"<br />
+ * classification="mmbase.about:100"<br />
+ * mimetype="text/html"><br />
+ * <title xml:lang="nl">Nieuws</title><br />
+ * <title xml:lang="en">News</title><br />
+ * <description xml:lang="en">Shows latest news from the mmbase
site</description><br />
+ * <body><br />
+ * <class name="org.mmbase.framework.ConnectionRenderer"><br />
+ * <param name="url">http://www.mmbase.org/rss</param><br
/>
+ * <param name="xslt">xslt/rss.xslt</param><br />
+ * </class><br />
+ * </body><br />
+ * </block>
+ * </p>
+ *
*
* @author Michiel Meeuwissen
- * @version $Id: ConnectionRenderer.java,v 1.4 2008/02/23 12:44:03 michiel Exp
$
+ * @version $Id: ConnectionRenderer.java,v 1.5 2008/04/25 14:31:39 andre Exp $
* @since MMBase-1.9
*/
public class ConnectionRenderer extends AbstractRenderer {
Index: DeniedRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/DeniedRenderer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- DeniedRenderer.java 25 Apr 2008 13:42:47 -0000 1.5
+++ DeniedRenderer.java 25 Apr 2008 14:31:39 -0000 1.6
@@ -21,11 +21,14 @@
import org.mmbase.util.logging.Logging;
/**
- * Renderer which can be used in stead, if rendering of a certain block proved
to be not allowed for
- * the current user.
+ * [EMAIL PROTECTED] Renderer} to be used in case of access denied (status
401).
+ * If rendering of a certain block proved to be not allowed for the current
user.
+ * Requests get dispatched to a block 'core/401.jspx' with a more or less
+ * userfriendly message.
*
* @author Michiel Meeuwissen
- * @version $Id: DeniedRenderer.java,v 1.5 2008/04/25 13:42:47 andre Exp $
+ * @author André van Toly
+ * @version $Id: DeniedRenderer.java,v 1.6 2008/04/25 14:31:39 andre Exp $
* @since MMBase-1.9
*/
Index: ErrorRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/ErrorRenderer.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -b -r1.11 -r1.12
--- ErrorRenderer.java 23 Feb 2008 12:44:03 -0000 1.11
+++ ErrorRenderer.java 25 Apr 2008 14:31:39 -0000 1.12
@@ -22,14 +22,13 @@
import org.mmbase.util.logging.Logging;
/**
- * If rendering of a block fails, for some reason, then this renderer can be
used in stead, to
- * present the error.
+ * If rendering of a [EMAIL PROTECTED] Block} fails for some reason this
renderer should be used to present the error.
*
* @todo Its workings are similar to /mmbase/errorpages/500.jsp, and we should
consider that these two
* share code.
*
* @author Michiel Meeuwissen
- * @version $Id: ErrorRenderer.java,v 1.11 2008/02/23 12:44:03 michiel Exp $
+ * @version $Id: ErrorRenderer.java,v 1.12 2008/04/25 14:31:39 andre Exp $
* @since MMBase-1.9
*/
Index: Framework.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Framework.java,v
retrieving revision 1.51
retrieving revision 1.52
diff -u -b -r1.51 -r1.52
--- Framework.java 18 Apr 2008 13:47:13 -0000 1.51
+++ Framework.java 25 Apr 2008 14:31:39 -0000 1.52
@@ -19,15 +19,16 @@
import org.mmbase.util.logging.Logging;
/**
- * A framework displays and processes components.
- *
- * The Framework as UrlConverter must never return <code>null</code>, IOW, it
should
- * <em>always</em> know how to do this.
- *
+ * The MMBase Framework displays and processes components.
+ * [EMAIL PROTECTED] Component}s consist of [EMAIL PROTECTED] Block}s which
typically are pieces of JSP.
+ * The framework uses an urlfilter [EMAIL PROTECTED] FrameworkFilter} that can
be configured
+ * in 'config/framework.xml'.
*
* @author Johannes Verelst
* @author Pierre van Rooden
- * @version $Id: Framework.java,v 1.51 2008/04/18 13:47:13 michiel Exp $
+ * @author Michiel Meeuwissen
+ * @author André van Toly
+ * @version $Id: Framework.java,v 1.52 2008/04/25 14:31:39 andre Exp $
* @since MMBase-1.9
*/
public abstract class Framework {
Index: FrameworkFilter.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/FrameworkFilter.java,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -b -r1.24 -r1.25
--- FrameworkFilter.java 18 Apr 2008 13:47:13 -0000 1.24
+++ FrameworkFilter.java 25 Apr 2008 14:31:39 -0000 1.25
@@ -30,12 +30,13 @@
* corresponding page (technical URL) within the website. When the recieved
URL is not
* recognized by the framework as an 'userfriendly' one, it just gets
forwarded in its original
* form. The filtering and conversion to an URL pointing to an existing JSP
template is done by
- * an UrlConverter, of which the framework extends.
+ * an [EMAIL PROTECTED] basic/UrlConverter}.
+ *
* Regular expressions that define URL's to be excluded from filtering should
be listed in the
* 'excludes' parameter in web.xml.
*
* @author André van Toly
- * @version $Id: FrameworkFilter.java,v 1.24 2008/04/18 13:47:13 michiel Exp $
+ * @version $Id: FrameworkFilter.java,v 1.25 2008/04/25 14:31:39 andre Exp $
*/
public class FrameworkFilter implements Filter, MMBaseStarter {
Index: Setting.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Setting.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- Setting.java 28 Jan 2008 16:28:22 -0000 1.6
+++ Setting.java 25 Apr 2008 14:31:39 -0000 1.7
@@ -18,15 +18,14 @@
import org.mmbase.util.logging.Logging;
/**
- * Representation of component related settings. These settings can be defined
in the component
- * XML.
+ * Representation of [EMAIL PROTECTED] Component} related settings.
+ * These settings can be defined in their proper Component XML.
*
* @todo The <em>values</em> of the settings can still only be set in memory
and in the component
* xml. There must be some way to persistify them. There should also be a
editor in the admin pages.
*
- *
* @author Michiel Meeuwissen
- * @version $Id: Setting.java,v 1.6 2008/01/28 16:28:22 michiel Exp $
+ * @version $Id: Setting.java,v 1.7 2008/04/25 14:31:39 andre Exp $
* @since MMBase-1.9
*/
public class Setting<C> {
Index: VirtualComponent.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/VirtualComponent.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- VirtualComponent.java 20 Feb 2008 17:44:07 -0000 1.4
+++ VirtualComponent.java 25 Apr 2008 14:31:39 -0000 1.5
@@ -11,10 +11,10 @@
import org.mmbase.util.logging.*;
/**
- * A Virtual component is a component which is only mentioned as a dependency
of another component.
+ * A Virtual Component is a component which is only mentioned as a dependency
of another component.
*
* @author Michiel Meeuwissen
- * @version $Id: VirtualComponent.java,v 1.4 2008/02/20 17:44:07 michiel Exp $
+ * @version $Id: VirtualComponent.java,v 1.5 2008/04/25 14:31:39 andre Exp $
* @since MMBase-1.9
*/
public class VirtualComponent {
Index: package.html
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/package.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- package.html 30 Jul 2007 16:36:05 -0000 1.2
+++ package.html 25 Apr 2008 14:31:39 -0000 1.3
@@ -13,7 +13,8 @@
<ul>
<li><em>Framework</em></li>
<li>
- <em>State</em>. The render state. The framework is responsible for
calling State.getState(request). See BasicFramework.
+ <em>State</em>. The render state. The framework is responsible for
calling
+ State.getState(request). See BasicFramework.
</li>
<li>
The <em>ComponentRepository</em>. There is one instance of this in
every MMBase, and all
@@ -25,7 +26,7 @@
implement it's own url-conversion functionalilty)
</li>
</ul>
- <!-- version of package description $Id: package.html,v 1.2 2007/07/30
16:36:05 michiel Exp $
+ <!-- version of package description $Id: package.html,v 1.3 2008/04/25
14:31:39 andre Exp $
-->
@since MMBase-1.9
</body>
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
