+ In this category you'll find a number of articles about physical transport connections: + diff --git a/plugins/org.eclipse.emf.cdo.doc/html/online/summary.html b/plugins/org.eclipse.emf.cdo.doc/html/online/summary.html new file mode 100644 index 0000000000..773c265080 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/html/online/summary.html @@ -0,0 +1,3 @@ +
- * This tutorial outlines the steps needed to create a Net4j {@link IConnector} and connect it to an {@link IAcceptor}. - *
- * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eu nibh in erat dapibus accumsan. Aenean cursus - * lacinia dictum. Mauris non sem sapien. Vivamus sem ante, posuere a rhoncus ac, varius in nisi. Sed pulvinar urna ac - * est iaculis mattis. Ut eget massa felis, nec volutpat purus. In id aliquet mi. Duis euismod sapien sollicitudin nisi - * vestibulum nec vulputate urna euismod. Proin pulvinar ornare nunc, ac auctor elit placerat eget. Integer eu erat ac - * risus ultricies mattis vel nec nunc. Proin venenatis tellus sit amet dui congue nec vehicula urna sollicitudin. Donec - * porta, risus eu auctor semper, ante lectus lobortis sem, a luctus diam dui eu sapien. Sed at metus et dolor tincidunt - * convallis id a est. Donec quam nisl, scelerisque a feugiat id, mattis vel urna. Suspendisse facilisis, libero ac - * ultricies dictum, mi sem feugiat purus, ac aliquam metus purus sed leo. Sed a viverra metus. - * - * @author Eike Stepper - */ -public class CreatingTransportConnections -{ - /** - * Select a Transport Type - *
- * Currently supported transport types are: - *
- * Ut eget massa felis, nec volutpat purus. In id aliquet mi. Duis euismod sapien sollicitudin nisi vestibulum nec - * vulputate urna euismod. Proin pulvinar ornare nunc, ac auctor elit placerat eget. Integer eu erat ac risus - * ultricies mattis vel nec nunc. - *
- * {@link Snippets#snippet1() ContainerSetup.java} - *
- * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eu nibh in erat dapibus accumsan. Aenean cursus - * lacinia dictum. Mauris non sem sapien. Vivamus sem ante, posuere a rhoncus ac, varius in nisi. Sed pulvinar urna ac - * est iaculis mattis. Ut eget massa felis, nec volutpat purus. In id aliquet mi. Duis euismod sapien sollicitudin - * nisi vestibulum nec vulputate urna euismod. Proin pulvinar ornare nunc, ac auctor elit placerat eget. Integer eu - * erat ac risus ultricies mattis vel nec nunc. Proin venenatis tellus sit amet dui congue nec vehicula urna - * sollicitudin. Donec porta, risus eu auctor semper, ante lectus lobortis sem, a luctus diam dui eu sapien. Sed at - * metus et dolor tincidunt convallis id a est. Donec quam nisl, scelerisque a feugiat id, mattis vel urna. - * Suspendisse facilisis, libero ac ultricies dictum, mi sem feugiat purus, ac aliquam metus purus sed leo. Sed a - * viverra metus. - */ - public class SetupWiringContainer - { - } - - /** - * Add Configuration Parameters - */ - public class AddConfigurationParameters - { - /** - * Set the Buffer Capacity - *
- * {@link JMSConnector} - */ - public class SetBufferCapacity - { - } - - /** - * Set the Connection Timeout - *
- * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eu nibh in erat dapibus accumsan. Aenean cursus
- * lacinia dictum. Mauris non sem sapien. Vivamus sem ante, posuere a rhoncus ac, varius in nisi. Sed pulvinar urna
- * ac est iaculis mattis. Ut eget massa felis, nec volutpat purus. In id aliquet mi. Duis euismod sapien
- * sollicitudin nisi vestibulum nec vulputate urna euismod. Proin pulvinar ornare nunc, ac auctor elit placerat
- * eget. Integer eu erat ac risus ultricies mattis vel nec nunc. Proin venenatis tellus sit amet dui congue nec
- * vehicula urna sollicitudin. Donec porta, risus eu auctor semper, ante lectus lobortis sem, a luctus diam dui eu
- * sapien. Sed at metus et dolor tincidunt convallis id a est. Donec quam nisl, scelerisque a feugiat id, mattis vel
- * urna. Suspendisse facilisis, libero ac ultricies dictum, mi sem feugiat purus, ac aliquam metus purus sed leo.
- * Sed a viverra metus.
- */
- public class SetConnectionTimeout
- {
- }
- }
-}
-
-// ----------------------------------------------------------------------------- //
-
-/**
- * @snippet
- */
-class Snippets
-{
- /**
- * @callout Create a separate {@link IManagedContainer}.
- * @callout Create a factory of type "jms" in the productGroup "org.eclipse.net4j.connectors".
- * @callout Create a JMS connector.
- * @callout The new container can not be used when inactive.
- */
- public void snippet1()
- {
- // Create a dedicated container instance
- IManagedContainer container = /* callout */new ManagedContainer();
-
- // Register your custom factories
- container.registerFactory( /* callout */new Factory("org.eclipse.net4j.connectors", "jms")
- {
- public IConnector create(String description) throws ProductCreationException
- {
- return /* callout */new JMSConnector(description);
- }
- });
-
- // Use utility classes to register additional factories
- Net4jUtil.prepareContainer(container);
- TCPUtil.prepareContainer(container);
-
- // Do not forget to activate the container before you use it
- /* callout */container.activate();
- }
-
- /**
- * @callout The channel must not be null.
- */
- public class JMSConnector extends Connector
- {
- public JMSConnector(String description)
- {
- }
-
- public void multiplexChannel(InternalChannel /* callout */channel)
- {
- }
-
- // snip
- @Override
- protected INegotiationContext createNegotiationContext()
- {
- return null;
- }
-
- @Override
- protected void registerChannelWithPeer(short channelID, long timeout, IProtocol protocol)
- throws ChannelException
- {
- }
- // snap
- }
-}
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/connectors/package-info.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/connectors/package-info.java
deleted file mode 100644
index ac8fb9e42e..0000000000
--- a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/connectors/package-info.java
+++ /dev/null
@@ -1,16 +0,0 @@
-/*
- * Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- * Contributors:
- * Eike Stepper - initial API and implementation
- */
-
-/**
- * Connectors
- */
-package org.eclipse.emf.cdo.doc.connectors;
-
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/online/package-info.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/online/package-info.java
index 589134cc71..202cda2f78 100644
--- a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/online/package-info.java
+++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/online/package-info.java
@@ -10,7 +10,7 @@
*/
/**
- * Online
+ * Online Docs
*
* @number 555
*/
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/connectors/CreatingTransportConnections.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/connectors/CreatingTransportConnections.java
new file mode 100644
index 0000000000..f475526988
--- /dev/null
+++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/connectors/CreatingTransportConnections.java
@@ -0,0 +1,191 @@
+/*
+ * Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Eike Stepper - initial API and implementation
+ */
+package org.eclipse.emf.cdo.doc.programmers.connectors;
+
+import org.eclipse.emf.cdo.doc.programmers.connectors.CreatingTransportConnections.AddConfigurationParameters.SetBufferCapacity;
+import org.eclipse.emf.cdo.doc.programmers.connectors.Snippets.JMSConnector;
+import org.eclipse.emf.cdo.doc.programmers.sessions.ConnectingToRepositories.SetConnectionTimeout;
+
+import org.eclipse.net4j.Net4jUtil;
+import org.eclipse.net4j.acceptor.IAcceptor;
+import org.eclipse.net4j.channel.ChannelException;
+import org.eclipse.net4j.connector.IConnector;
+import org.eclipse.net4j.http.server.IHTTPAcceptor;
+import org.eclipse.net4j.jvm.IJVMAcceptor;
+import org.eclipse.net4j.protocol.IProtocol;
+import org.eclipse.net4j.tcp.ITCPAcceptor;
+import org.eclipse.net4j.tcp.TCPUtil;
+import org.eclipse.net4j.util.container.IManagedContainer;
+import org.eclipse.net4j.util.container.ManagedContainer;
+import org.eclipse.net4j.util.factory.Factory;
+import org.eclipse.net4j.util.factory.ProductCreationException;
+import org.eclipse.net4j.util.security.INegotiationContext;
+
+import org.eclipse.spi.net4j.Connector;
+import org.eclipse.spi.net4j.InternalChannel;
+
+import java.nio.channels.SocketChannel;
+
+/**
+ * Creating Transport Connections
+ *
+ * This tutorial outlines the steps needed to create a Net4j {@link IConnector} and connect it to an {@link IAcceptor}. + *
+ * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eu nibh in erat dapibus accumsan. Aenean cursus + * lacinia dictum. Mauris non sem sapien. Vivamus sem ante, posuere a rhoncus ac, varius in nisi. Sed pulvinar urna ac + * est iaculis mattis. Ut eget massa felis, nec volutpat purus. In id aliquet mi. Duis euismod sapien sollicitudin nisi + * vestibulum nec vulputate urna euismod. Proin pulvinar ornare nunc, ac auctor elit placerat eget. Integer eu erat ac + * risus ultricies mattis vel nec nunc. Proin venenatis tellus sit amet dui congue nec vehicula urna sollicitudin. Donec + * porta, risus eu auctor semper, ante lectus lobortis sem, a luctus diam dui eu sapien. Sed at metus et dolor tincidunt + * convallis id a est. Donec quam nisl, scelerisque a feugiat id, mattis vel urna. Suspendisse facilisis, libero ac + * ultricies dictum, mi sem feugiat purus, ac aliquam metus purus sed leo. Sed a viverra metus. + * + * @author Eike Stepper + */ +public class CreatingTransportConnections +{ + /** + * Select a Transport Type + *
+ * Currently supported transport types are: + *
+ * Ut eget massa felis, nec volutpat purus. In id aliquet mi. Duis euismod sapien sollicitudin nisi vestibulum nec + * vulputate urna euismod. Proin pulvinar ornare nunc, ac auctor elit placerat eget. Integer eu erat ac risus + * ultricies mattis vel nec nunc. + *
+ * {@link Snippets#snippet1() ContainerSetup.java} + *
+ * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eu nibh in erat dapibus accumsan. Aenean cursus + * lacinia dictum. Mauris non sem sapien. Vivamus sem ante, posuere a rhoncus ac, varius in nisi. Sed pulvinar urna ac + * est iaculis mattis. Ut eget massa felis, nec volutpat purus. In id aliquet mi. Duis euismod sapien sollicitudin + * nisi vestibulum nec vulputate urna euismod. Proin pulvinar ornare nunc, ac auctor elit placerat eget. Integer eu + * erat ac risus ultricies mattis vel nec nunc. Proin venenatis tellus sit amet dui congue nec vehicula urna + * sollicitudin. Donec porta, risus eu auctor semper, ante lectus lobortis sem, a luctus diam dui eu sapien. Sed at + * metus et dolor tincidunt convallis id a est. Donec quam nisl, scelerisque a feugiat id, mattis vel urna. + * Suspendisse facilisis, libero ac ultricies dictum, mi sem feugiat purus, ac aliquam metus purus sed leo. Sed a + * viverra metus. + */ + public class SetupWiringContainer + { + } + + /** + * Add Configuration Parameters + */ + public class AddConfigurationParameters + { + /** + * Set the Buffer Capacity + *
+ * {@link JMSConnector} + */ + public class SetBufferCapacity + { + } + + /** + * Set the Connection Timeout + *
+ * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eu nibh in erat dapibus accumsan. Aenean cursus
+ * lacinia dictum. Mauris non sem sapien. Vivamus sem ante, posuere a rhoncus ac, varius in nisi. Sed pulvinar urna
+ * ac est iaculis mattis. Ut eget massa felis, nec volutpat purus. In id aliquet mi. Duis euismod sapien
+ * sollicitudin nisi vestibulum nec vulputate urna euismod. Proin pulvinar ornare nunc, ac auctor elit placerat
+ * eget. Integer eu erat ac risus ultricies mattis vel nec nunc. Proin venenatis tellus sit amet dui congue nec
+ * vehicula urna sollicitudin. Donec porta, risus eu auctor semper, ante lectus lobortis sem, a luctus diam dui eu
+ * sapien. Sed at metus et dolor tincidunt convallis id a est. Donec quam nisl, scelerisque a feugiat id, mattis vel
+ * urna. Suspendisse facilisis, libero ac ultricies dictum, mi sem feugiat purus, ac aliquam metus purus sed leo.
+ * Sed a viverra metus.
+ */
+ public class SetConnectionTimeout
+ {
+ }
+ }
+}
+
+// ----------------------------------------------------------------------------- //
+
+/**
+ * @snippet
+ */
+class Snippets
+{
+ /**
+ * @callout Create a separate {@link IManagedContainer}.
+ * @callout Create a factory of type "jms" in the productGroup "org.eclipse.net4j.connectors".
+ * @callout Create a JMS connector.
+ * @callout The new container can not be used when inactive.
+ */
+ public void snippet1()
+ {
+ // Create a dedicated container instance
+ IManagedContainer container = /* callout */new ManagedContainer();
+
+ // Register your custom factories
+ container.registerFactory( /* callout */new Factory("org.eclipse.net4j.connectors", "jms")
+ {
+ public IConnector create(String description) throws ProductCreationException
+ {
+ return /* callout */new JMSConnector(description);
+ }
+ });
+
+ // Use utility classes to register additional factories
+ Net4jUtil.prepareContainer(container);
+ TCPUtil.prepareContainer(container);
+
+ // Do not forget to activate the container before you use it
+ /* callout */container.activate();
+ }
+
+ /**
+ * @callout The channel must not be null.
+ */
+ public class JMSConnector extends Connector
+ {
+ public JMSConnector(String description)
+ {
+ }
+
+ public void multiplexChannel(InternalChannel /* callout */channel)
+ {
+ }
+
+ // snip
+ @Override
+ protected INegotiationContext createNegotiationContext()
+ {
+ return null;
+ }
+
+ @Override
+ protected void registerChannelWithPeer(short channelID, long timeout, IProtocol protocol)
+ throws ChannelException
+ {
+ }
+ // snap
+ }
+}
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/connectors/package-info.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/connectors/package-info.java
new file mode 100644
index 0000000000..7f8770afdf
--- /dev/null
+++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/connectors/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Eike Stepper - initial API and implementation
+ */
+
+/**
+ * Connectors
+ *
+ * In this category you'll find a number of articles about physical transport connections: {@toc}
+ *
+ * @number 1
+ */
+package org.eclipse.emf.cdo.doc.programmers.connectors;
+
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/package-info.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/package-info.java
new file mode 100644
index 0000000000..67b92e8bea
--- /dev/null
+++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/package-info.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Eike Stepper - initial API and implementation
+ */
+
+/**
+ * Programmer's Guide
+ *
+ * @number 1
+ */
+package org.eclipse.emf.cdo.doc.programmers;
+
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/sessions/ConnectingToRepositories.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/sessions/ConnectingToRepositories.java
new file mode 100644
index 0000000000..a277a6dee4
--- /dev/null
+++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/sessions/ConnectingToRepositories.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Eike Stepper - initial API and implementation
+ */
+package org.eclipse.emf.cdo.doc.programmers.sessions;
+
+/**
+ * Connecting To Repositories
+ */
+public class ConnectingToRepositories
+{
+ /**
+ * Set Buffer Capacity
+ */
+ public class SetBufferCapacity
+ {
+ }
+
+ /**
+ * Set Connection Timeout
+ */
+ public class SetConnectionTimeout
+ {
+ }
+}
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/sessions/package-info.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/sessions/package-info.java
new file mode 100644
index 0000000000..a94b063643
--- /dev/null
+++ b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/programmers/sessions/package-info.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Eike Stepper - initial API and implementation
+ */
+
+/**
+ * Sessions
+ *
+ * @number 2
+ */
+package org.eclipse.emf.cdo.doc.programmers.sessions;
+
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/sessions/ConnectingToRepositories.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/sessions/ConnectingToRepositories.java
deleted file mode 100644
index 33d47ce10a..0000000000
--- a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/sessions/ConnectingToRepositories.java
+++ /dev/null
@@ -1,31 +0,0 @@
-/*
- * Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- * Contributors:
- * Eike Stepper - initial API and implementation
- */
-package org.eclipse.emf.cdo.doc.sessions;
-
-/**
- * Connecting To Repositories
- */
-public class ConnectingToRepositories
-{
- /**
- * Set Buffer Capacity
- */
- public class SetBufferCapacity
- {
- }
-
- /**
- * Set Connection Timeout
- */
- public class SetConnectionTimeout
- {
- }
-}
diff --git a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/sessions/package-info.java b/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/sessions/package-info.java
deleted file mode 100644
index 597b7e244e..0000000000
--- a/plugins/org.eclipse.emf.cdo.doc/src/org/eclipse/emf/cdo/doc/sessions/package-info.java
+++ /dev/null
@@ -1,16 +0,0 @@
-/*
- * Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- * Contributors:
- * Eike Stepper - initial API and implementation
- */
-
-/**
- * Sessions
- */
-package org.eclipse.emf.cdo.doc.sessions;
-
diff --git a/plugins/org.eclipse.emf.cdo.doc/toc.xml b/plugins/org.eclipse.emf.cdo.doc/toc.xml
index da31e92378..d71de8d81c 100644
--- a/plugins/org.eclipse.emf.cdo.doc/toc.xml
+++ b/plugins/org.eclipse.emf.cdo.doc/toc.xml
@@ -2,18 +2,20 @@
-
@@ -62,4 +68,42 @@ public class CategoryImpl extends BodyImpl implements Category
{
return (PackageDoc)super.getDoc();
}
+
+ @Override
+ public void generate() throws IOException
+ {
+ File targetFolder = getOutputFile();
+ File sourceFolder = getDoc().position().file().getParentFile();
+ for (File file : sourceFolder.listFiles())
+ {
+ if (file.isFile())
+ {
+ String name = file.getName();
+ if (!name.endsWith(".java") && !name.equals("package-info.java"))
+ {
+ File targetFile = new File(targetFolder, name);
+ ArticleUtil.copyFile(file, targetFile);
+ }
+ }
+ }
+
+ super.generate();
+ generate(getTocTarget());
+ }
+
+ @Override
+ public void generate(HtmlWriter out) throws IOException
+ {
+ String title = getTitle();
+ out.writeHeading(1, title);
+
+ EList