1 /*
2 * Copyright (C) 2018, Thomas Wolf <thomas.wolf@paranor.ch>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.internal.transport.sshd.proxy;
44
45 import java.util.concurrent.Callable;
46
47 import org.apache.sshd.client.session.ClientProxyConnector;
48 import org.apache.sshd.common.io.IoSession;
49 import org.apache.sshd.common.util.Readable;
50
51 /**
52 * Some proxy connections are stateful and require the exchange of multiple
53 * request-reply messages. The default {@link ClientProxyConnector} has only
54 * support for sending a message; replies get routed through the Ssh session,
55 * and don't get back to this proxy connector. Augment the interface so that the
56 * session can know when to route messages received to the proxy connector, and
57 * when to start handling them itself.
58 */
59 public interface StatefulProxyConnector extends ClientProxyConnector {
60
61 /**
62 * A property key for a session property defining the timeout for setting up
63 * the proxy connection.
64 */
65 static final String TIMEOUT_PROPERTY = StatefulProxyConnector.class
66 .getName() + "-timeout"; //$NON-NLS-1$
67
68 /**
69 * Handle a received message.
70 *
71 * @param session
72 * to use for writing data
73 * @param buffer
74 * received data
75 * @throws Exception
76 * if data cannot be read, or the connection attempt fails
77 */
78 void messageReceived(IoSession session, Readable buffer) throws Exception;
79
80 /**
81 * Runs {@code command} once the proxy connection is established. May be
82 * called multiple times; commands are run sequentially. If the proxy
83 * connection is already established, {@code command} is executed directly
84 * synchronously.
85 *
86 * @param command
87 * operation to run
88 * @throws Exception
89 * if the operation is run synchronously and throws an exception
90 */
91 void runWhenDone(Callable<Void> command) throws Exception;
92 }