[381472] Design a repository administration API

https://bugs.eclipse.org/bugs/show_bug.cgi?id=381472

1 files changed, 257 insertions, 251 deletions

diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/internal/tcp/ControlChannel.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/internal/tcp/ControlChannel.java
index d5fdf575ec..18ac3648ea 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/internal/tcp/ControlChannel.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/internal/tcp/ControlChannel.java
@@ -1,251 +1,257 @@
-/*

- * Copyright (c) 2004 - 2012 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.net4j.internal.tcp;

-

-import org.eclipse.net4j.buffer.IBuffer;

-import org.eclipse.net4j.connector.ConnectorException;

-import org.eclipse.net4j.internal.tcp.bundle.OM;

-import org.eclipse.net4j.internal.tcp.messages.Messages;

-import org.eclipse.net4j.protocol.IProtocol;

-import org.eclipse.net4j.util.ImplementationError;

-import org.eclipse.net4j.util.concurrent.ConcurrencyUtil;

-import org.eclipse.net4j.util.concurrent.ISynchronizer;

-import org.eclipse.net4j.util.concurrent.SynchronizingCorrelator;

-import org.eclipse.net4j.util.concurrent.TimeoutRuntimeException;

-import org.eclipse.net4j.util.om.trace.ContextTracer;

-import org.eclipse.net4j.util.security.INegotiationContext;

-import org.eclipse.net4j.util.security.INegotiationContext.Receiver;

-

-import org.eclipse.internal.net4j.buffer.BufferUtil;

-

-import org.eclipse.spi.net4j.Channel;

-import org.eclipse.spi.net4j.InternalChannel;

-import org.eclipse.spi.net4j.InternalChannelMultiplexer;

-

-import java.nio.ByteBuffer;

-import java.text.MessageFormat;

-

-/**

- * @author Eike Stepper

- */

-public class ControlChannel extends Channel

-{

-  public static final short CONTROL_CHANNEL_INDEX = InternalChannelMultiplexer.RESERVED_CHANNEL;

-

-  public static final byte OPCODE_NEGOTIATION = 1;

-

-  public static final byte OPCODE_REGISTRATION = 2;

-

-  public static final byte OPCODE_REGISTRATION_ACK = 3;

-

-  public static final byte OPCODE_DEREGISTRATION = 4;

-

-  public static final byte SUCCESS = 1;

-

-  public static final byte FAILURE = 0;

-

-  private static final ContextTracer TRACER = new ContextTracer(OM.DEBUG, ControlChannel.class);

-

-  private SynchronizingCorrelator<Short, Boolean> acknowledgements = new SynchronizingCorrelator<Short, Boolean>();

-

-  public ControlChannel(TCPConnector connector)

-  {

-    setID(CONTROL_CHANNEL_INDEX);

-    setMultiplexer(connector);

-    setReceiveExecutor(connector.getConfig().getReceiveExecutor());

-    setUserID(connector.getUserID());

-  }

-

-  public TCPConnector getConnector()

-  {

-    return (TCPConnector)getMultiplexer();

-  }

-

-  public boolean registerChannel(short channelID, long timeout, IProtocol<?> protocol)

-  {

-    if (TRACER.isEnabled())

-    {

-      TRACER.format("Registering channel {0} with protocol {1}", channelID, protocol); //$NON-NLS-1$

-    }

-

-    assertValidChannelID(channelID);

-    ISynchronizer<Boolean> acknowledgement = acknowledgements.correlate(channelID);

-

-    IBuffer buffer = provideBuffer();

-    ByteBuffer byteBuffer = buffer.startPutting(CONTROL_CHANNEL_INDEX);

-    byteBuffer.put(OPCODE_REGISTRATION);

-    byteBuffer.putShort(channelID);

-    BufferUtil.putUTF8(byteBuffer, protocol == null ? null : protocol.getType());

-    handleBuffer(buffer);

-

-    Boolean acknowledged = acknowledgement.get(timeout);

-    if (acknowledged == null)

-    {

-      throw new TimeoutRuntimeException(MessageFormat.format(Messages.getString("ControlChannel_0"), timeout)); //$NON-NLS-1$

-    }

-

-    return acknowledged;

-  }

-

-  public void deregisterChannel(short channelID)

-  {

-    if (TRACER.isEnabled())

-    {

-      TRACER.format("Deregistering channel {0}", channelID); //$NON-NLS-1$

-    }

-

-    assertValidChannelID(channelID);

-    IBuffer buffer = provideBuffer();

-    ByteBuffer byteBuffer = buffer.startPutting(CONTROL_CHANNEL_INDEX);

-    byteBuffer.put(OPCODE_DEREGISTRATION);

-    byteBuffer.putShort(channelID);

-    handleBuffer(buffer);

-  }

-

-  @Override

-  public void handleBufferFromMultiplexer(IBuffer buffer)

-  {

-    try

-    {

-      ByteBuffer byteBuffer = buffer.getByteBuffer();

-      byte opcode = byteBuffer.get();

-      switch (opcode)

-      {

-      case OPCODE_NEGOTIATION:

-      {

-        assertNegotiating();

-        INegotiationContext negotiationContext = getConnector().getNegotiationContext();

-        while (negotiationContext == null)

-        {

-          ConcurrencyUtil.sleep(20);

-          negotiationContext = getConnector().getNegotiationContext();

-        }

-

-        Receiver receiver = negotiationContext.getReceiver();

-        receiver.receiveBuffer(negotiationContext, byteBuffer);

-        break;

-      }

-

-      case OPCODE_REGISTRATION:

-      {

-        assertConnected();

-        short channelID = byteBuffer.getShort();

-        assertValidChannelID(channelID);

-        boolean success = true;

-

-        try

-        {

-          byte[] handlerFactoryUTF8 = BufferUtil.getByteArray(byteBuffer);

-          String protocolID = BufferUtil.fromUTF8(handlerFactoryUTF8);

-          InternalChannel channel = getConnector().inverseOpenChannel(channelID, protocolID);

-          if (channel == null)

-          {

-            throw new ConnectorException(Messages.getString("ControlChannel_4")); //$NON-NLS-1$

-          }

-        }

-        catch (Exception ex)

-        {

-          OM.LOG.error(ex);

-          success = false;

-        }

-

-        sendStatus(OPCODE_REGISTRATION_ACK, channelID, success);

-        break;

-      }

-

-      case OPCODE_DEREGISTRATION:

-      {

-        assertConnected();

-        short channelID = byteBuffer.getShort();

-        if (channelID == CONTROL_CHANNEL_INDEX)

-        {

-          throw new ImplementationError();

-        }

-

-        try

-        {

-          getConnector().inverseCloseChannel(channelID);

-        }

-        catch (Exception ex)

-        {

-          OM.LOG.error(ex);

-        }

-

-        break;

-      }

-

-      case OPCODE_REGISTRATION_ACK:

-      {

-        assertConnected();

-        short channelID = byteBuffer.getShort();

-        boolean success = byteBuffer.get() == SUCCESS;

-        acknowledgements.put(channelID, success);

-        break;

-      }

-

-      default:

-        OM.LOG.error("Invalid opcode: " + opcode); //$NON-NLS-1$

-        getConnector().deactivate();

-      }

-    }

-    finally

-    {

-      buffer.release();

-    }

-  }

-

-  @Override

-  public String toString()

-  {

-    return MessageFormat.format("Channel[Control, {0}]", getLocation()); //$NON-NLS-1$

-  }

-

-  @Override

-  protected void unregisterFromMultiplexer()

-  {

-    // Do nothing

-  }

-

-  private void sendStatus(byte opcode, short channelID, boolean status)

-  {

-    IBuffer buffer = provideBuffer();

-    ByteBuffer byteBuffer = buffer.startPutting(CONTROL_CHANNEL_INDEX);

-    byteBuffer.put(opcode);

-    byteBuffer.putShort(channelID);

-    byteBuffer.put(status ? SUCCESS : FAILURE);

-    handleBuffer(buffer);

-  }

-

-  private void assertNegotiating()

-  {

-    if (!getConnector().isNegotiating())

-    {

-      getConnector().deactivate();

-      throw new IllegalStateException("Connector is not negotiating"); //$NON-NLS-1$

-    }

-  }

-

-  private void assertConnected()

-  {

-    if (!getConnector().isConnected())

-    {

-      throw new IllegalStateException("Connector is not connected"); //$NON-NLS-1$

-    }

-  }

-

-  private void assertValidChannelID(short channelID)

-  {

-    if (channelID == CONTROL_CHANNEL_INDEX)

-    {

-      throw new IllegalArgumentException("Bad channelID"); //$NON-NLS-1$

-    }

-  }

-}

+/*
+ * Copyright (c) 2004 - 2012 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.net4j.internal.tcp;
+
+import org.eclipse.net4j.buffer.IBuffer;
+import org.eclipse.net4j.connector.ConnectorException;
+import org.eclipse.net4j.internal.tcp.bundle.OM;
+import org.eclipse.net4j.internal.tcp.messages.Messages;
+import org.eclipse.net4j.protocol.IProtocol;
+import org.eclipse.net4j.util.ImplementationError;
+import org.eclipse.net4j.util.concurrent.ConcurrencyUtil;
+import org.eclipse.net4j.util.concurrent.ISynchronizer;
+import org.eclipse.net4j.util.concurrent.SynchronizingCorrelator;
+import org.eclipse.net4j.util.concurrent.TimeoutRuntimeException;
+import org.eclipse.net4j.util.om.trace.ContextTracer;
+import org.eclipse.net4j.util.security.INegotiationContext;
+import org.eclipse.net4j.util.security.INegotiationContext.Receiver;
+
+import org.eclipse.internal.net4j.buffer.BufferUtil;
+
+import org.eclipse.spi.net4j.Channel;
+import org.eclipse.spi.net4j.InternalChannel;
+import org.eclipse.spi.net4j.InternalChannelMultiplexer;
+
+import java.nio.ByteBuffer;
+import java.text.MessageFormat;
+
+/**
+ * @author Eike Stepper
+ */
+public class ControlChannel extends Channel
+{
+  public static final short CONTROL_CHANNEL_INDEX = InternalChannelMultiplexer.RESERVED_CHANNEL;
+
+  public static final byte OPCODE_NEGOTIATION = 1;
+
+  public static final byte OPCODE_REGISTRATION = 2;
+
+  public static final byte OPCODE_REGISTRATION_ACK = 3;
+
+  public static final byte OPCODE_DEREGISTRATION = 4;
+
+  public static final byte SUCCESS = 1;
+
+  public static final byte FAILURE = 0;
+
+  private static final ContextTracer TRACER = new ContextTracer(OM.DEBUG, ControlChannel.class);
+
+  private SynchronizingCorrelator<Short, Boolean> acknowledgements = new SynchronizingCorrelator<Short, Boolean>();
+
+  public ControlChannel(TCPConnector connector)
+  {
+    setID(CONTROL_CHANNEL_INDEX);
+    setMultiplexer(connector);
+    setReceiveExecutor(connector.getConfig().getReceiveExecutor());
+    setUserID(connector.getUserID());
+  }
+
+  public TCPConnector getConnector()
+  {
+    return (TCPConnector)getMultiplexer();
+  }
+
+  public boolean registerChannel(short channelID, long timeout, IProtocol<?> protocol)
+  {
+    if (TRACER.isEnabled())
+    {
+      TRACER.format("Registering channel {0} with protocol {1}", channelID, protocol); //$NON-NLS-1$
+    }
+
+    assertValidChannelID(channelID);
+    ISynchronizer<Boolean> acknowledgement = acknowledgements.correlate(channelID);
+
+    IBuffer buffer = provideBuffer();
+    ByteBuffer byteBuffer = buffer.startPutting(CONTROL_CHANNEL_INDEX);
+    byteBuffer.put(OPCODE_REGISTRATION);
+    byteBuffer.putShort(channelID);
+    BufferUtil.putUTF8(byteBuffer, protocol == null ? null : protocol.getType());
+    handleBuffer(buffer);
+
+    Boolean acknowledged = acknowledgement.get(timeout);
+    if (acknowledged == null)
+    {
+      throw new TimeoutRuntimeException(MessageFormat.format(Messages.getString("ControlChannel_0"), timeout)); //$NON-NLS-1$
+    }
+
+    return acknowledged;
+  }
+
+  public void deregisterChannel(short channelID)
+  {
+    if (TRACER.isEnabled())
+    {
+      TRACER.format("Deregistering channel {0}", channelID); //$NON-NLS-1$
+    }
+
+    assertValidChannelID(channelID);
+    IBuffer buffer = provideBuffer();
+    ByteBuffer byteBuffer = buffer.startPutting(CONTROL_CHANNEL_INDEX);
+    byteBuffer.put(OPCODE_DEREGISTRATION);
+    byteBuffer.putShort(channelID);
+    handleBuffer(buffer);
+  }
+
+  @Override
+  public void handleBufferFromMultiplexer(IBuffer buffer)
+  {
+    try
+    {
+      ByteBuffer byteBuffer = buffer.getByteBuffer();
+      byte opcode = byteBuffer.get();
+      switch (opcode)
+      {
+      case OPCODE_NEGOTIATION:
+      {
+        assertNegotiating();
+        INegotiationContext negotiationContext = getConnector().getNegotiationContext();
+        while (negotiationContext == null)
+        {
+          ConcurrencyUtil.sleep(20);
+          negotiationContext = getConnector().getNegotiationContext();
+        }
+
+        Receiver receiver = negotiationContext.getReceiver();
+        receiver.receiveBuffer(negotiationContext, byteBuffer);
+        break;
+      }
+
+      case OPCODE_REGISTRATION:
+      {
+        assertConnected();
+        short channelID = byteBuffer.getShort();
+        assertValidChannelID(channelID);
+        boolean success = true;
+
+        try
+        {
+          byte[] handlerFactoryUTF8 = BufferUtil.getByteArray(byteBuffer);
+          String protocolID = BufferUtil.fromUTF8(handlerFactoryUTF8);
+          InternalChannel channel = getConnector().inverseOpenChannel(channelID, protocolID);
+          if (channel == null)
+          {
+            throw new ConnectorException(Messages.getString("ControlChannel_4")); //$NON-NLS-1$
+          }
+        }
+        catch (Exception ex)
+        {
+          success = false;
+          if (TRACER.isEnabled())
+          {
+            TRACER.trace("Problem during channel registration", ex); //$NON-NLS-1$
+          }
+        }
+
+        sendStatus(OPCODE_REGISTRATION_ACK, channelID, success);
+        break;
+      }
+
+      case OPCODE_DEREGISTRATION:
+      {
+        assertConnected();
+        short channelID = byteBuffer.getShort();
+        if (channelID == CONTROL_CHANNEL_INDEX)
+        {
+          throw new ImplementationError();
+        }
+
+        try
+        {
+          getConnector().inverseCloseChannel(channelID);
+        }
+        catch (Exception ex)
+        {
+          if (TRACER.isEnabled())
+          {
+            TRACER.trace("Problem during channel deregistration", ex); //$NON-NLS-1$
+          }
+        }
+
+        break;
+      }
+
+      case OPCODE_REGISTRATION_ACK:
+      {
+        assertConnected();
+        short channelID = byteBuffer.getShort();
+        boolean success = byteBuffer.get() == SUCCESS;
+        acknowledgements.put(channelID, success);
+        break;
+      }
+
+      default:
+        OM.LOG.error("Invalid opcode: " + opcode); //$NON-NLS-1$
+        getConnector().deactivate();
+      }
+    }
+    finally
+    {
+      buffer.release();
+    }
+  }
+
+  @Override
+  public String toString()
+  {
+    return MessageFormat.format("Channel[Control, {0}]", getLocation()); //$NON-NLS-1$
+  }
+
+  @Override
+  protected void unregisterFromMultiplexer()
+  {
+    // Do nothing
+  }
+
+  private void sendStatus(byte opcode, short channelID, boolean status)
+  {
+    IBuffer buffer = provideBuffer();
+    ByteBuffer byteBuffer = buffer.startPutting(CONTROL_CHANNEL_INDEX);
+    byteBuffer.put(opcode);
+    byteBuffer.putShort(channelID);
+    byteBuffer.put(status ? SUCCESS : FAILURE);
+    handleBuffer(buffer);
+  }
+
+  private void assertNegotiating()
+  {
+    if (!getConnector().isNegotiating())
+    {
+      getConnector().deactivate();
+      throw new IllegalStateException("Connector is not negotiating"); //$NON-NLS-1$
+    }
+  }
+
+  private void assertConnected()
+  {
+    if (!getConnector().isConnected())
+    {
+      throw new IllegalStateException("Connector is not connected"); //$NON-NLS-1$
+    }
+  }
+
+  private void assertValidChannelID(short channelID)
+  {
+    if (channelID == CONTROL_CHANNEL_INDEX)
+    {
+      throw new IllegalArgumentException("Bad channelID"); //$NON-NLS-1$
+    }
+  }
+}