Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: e974dec4ea9a388c8be5abd17ec4dedb932a3c82 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/***************************************************************************
 * Copyright (c) 2004 - 2008 Eike Stepper, Germany.
 * 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.acceptor;

import org.eclipse.net4j.connector.ConnectorLocation;
import org.eclipse.net4j.connector.IConnector;
import org.eclipse.net4j.util.container.IContainer;
import org.eclipse.net4j.util.container.IElementProcessor;
import org.eclipse.net4j.util.factory.IFactory;
import org.eclipse.net4j.util.factory.IFactoryKey;
import org.eclipse.net4j.util.registry.IRegistry;

import org.eclipse.internal.net4j.acceptor.Acceptor;

import java.util.List;

/**
 * Accepts incoming connection requests from {@link ConnectorLocation#CLIENT client} {@link IConnector connectors} and
 * creates the appropriate {@link ConnectorLocation#SERVER server} connectors.
 * <p>
 * Since the process of accepting connection requests is heavily dependent on the implementation of the respective
 * connectors the only public API is introspection and notification.
 * <p>
 * This interface is <b>not</b> intended to be implemented by clients. Service providers <b>must</b> extend the
 * abstract {@link Acceptor} class.
 * <p>
 * <dt><b>Class Diagram:</b></dt>
 * <dd> <img src="doc-files/Acceptors.png" title="Diagram Acceptors" border="0" usemap="#Acceptors.png"/></dd>
 * <p>
 * <MAP NAME="Acceptors.png"> <AREA SHAPE="RECT" COORDS="10,8,99,58" HREF="IAcceptor.html"> <AREA SHAPE="RECT"
 * COORDS="289,8,378,58" HREF="IConnector.html"> </MAP>
 * <p>
 * <dt><b>Sequence Diagram:</b></dt>
 * <dd> <img src="doc-files/ConnectionProcess.jpg" title="Connection Process" border="0"
 * usemap="#ConnectionProcess.jpg"/></dd>
 * <p>
 * <MAP NAME="ConnectionProcess.jpg"> <AREA SHAPE="RECT" COORDS="146,136,265,165" HREF="IConnector.html"> <AREA
 * SHAPE="RECT" COORDS="485,75,564,105" HREF="IAcceptor.html"> <AREA SHAPE="RECT" COORDS="296,325,414,355"
 * HREF="IConnector.html"> <AREA SHAPE="RECT" COORDS="64,426,444,506" HREF="ConnectorState.html#CONNECTING"> <AREA
 * SHAPE="RECT" COORDS="64,516,444,596" HREF="ConnectorState.html#NEGOTIATING"> </MAP>
 * 
 * @author Eike Stepper
 */
public interface IAcceptor extends IContainer<IConnector>
{
  /**
   * Returns the factory registry used by this acceptor to prepare newly accepted connectors.
   */
  public IRegistry<IFactoryKey, IFactory> getProtocolFactoryRegistry();

  /**
   * Returns the post processors used by this acceptor to prepare newly accepted connectors.
   */
  public List<IElementProcessor> getProtocolPostProcessors();

  /**
   * Returns an array of the connectors that have been accepted by this acceptor and not been closed since.
   */
  public IConnector[] getAcceptedConnectors();
}

Back to the top