git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[JGIT PATCH/RFC] Removed possibility to change stderr for ssh sessions

From
CPConstantine Plotnikov <constantine.plotnikov@gmail.com>
Date
Apr 21, 2009, 18:49 UTC
Message-ID
<85647ef50904211149lc4a4902h554c973017d87adb@mail.gmail.com>

The current implementation allowed to change stderr for the ssh sessions. However this functionality is broken. It is used only by GitSshTransport and that class expects a very specific behavior from this class. For example toString() method should return the entire content of the stream. So only implementation from SshConfigSessionFactory would have worked anyway. Returning System.err (as was suggested by javadoc) comment would have broken existing functionality. This patch makes this functionality explicitly private.

If this functionality is to be reopened, this additional behavior should be documented and there should be additional lifecycle control, since the user streams will be interested to know when stream will be no more used in order to release resoources.

Signed-off-by: Constantine Plotnikov <constantine.plotnikov@gmail.com>
---
 .../jgit/transport/SshConfigSessionFactory.java    |   34 -----------------
 .../spearce/jgit/transport/SshSessionFactory.java  |    8 +++--
 .../spearce/jgit/transport/TransportGitSsh.java    |   38 +++++++++++++++++++-
 3 files changed, 42 insertions(+), 38 deletions(-)
diff --git a/org.spearce.jgit/src/org/spearce/jgit/transport/SshConfigSessionFactory.java
b/org.spearce.jgit/src/org/spearce/jgit/transport/SshConfigSessionFactory.java
index 4d29829..a87e149 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/transport/SshConfigSessionFactory.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/transport/SshConfigSessionFactory.java
@@ -43,7 +43,6 @@
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.io.OutputStream;
 import java.util.HashMap;
 import java.util.Map;

@@ -225,37 +224,4 @@ private static void loadIdentity(final JSch sch,
final File priv) {
 			}
 		}
 	}
-
-	@Override
-	public OutputStream getErrorStream() {
-		return new OutputStream() {
-			private StringBuilder all = new StringBuilder();
-
-			private StringBuilder sb = new StringBuilder();
-
-			public String toString() {
-				String r = all.toString();
-				while (r.endsWith("\n"))
-					r = r.substring(0, r.length() - 1);
-				return r;
-			}
-
-			@Override
-			public void write(final int b) throws IOException {
-				if (b == '\r') {
-					System.err.print('\r');
-					return;
-				}
-
-				sb.append((char) b);
-
-				if (b == '\n') {
-					final String line = sb.toString();
-					System.err.print(line);
-					all.append(line);
-					sb = new StringBuilder();
-				}
-			}
-		};
-	}
 }
diff --git a/org.spearce.jgit/src/org/spearce/jgit/transport/SshSessionFactory.java
b/org.spearce.jgit/src/org/spearce/jgit/transport/SshSessionFactory.java
index f03e80c..bd24d2f 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/transport/SshSessionFactory.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/transport/SshSessionFactory.java
@@ -125,10 +125,12 @@ public void releaseSession(final Session session) {
 	}

 	/**
-	 * Find or create an OutputStream for Ssh to use. For a command line client
-	 * this is probably System.err.
+	 * The method does not have to be implemented and will be removed in
future versions.
 	 *
 	 * @return an OutputStream to receive the SSH error stream.
 	 */
-	public abstract OutputStream getErrorStream();
+	@Deprecated
+	public OutputStream getErrorStream() {
+		throw new UnsupportedOperationException("This method should not be called.");
+	}
 }
diff --git a/org.spearce.jgit/src/org/spearce/jgit/transport/TransportGitSsh.java
b/org.spearce.jgit/src/org/spearce/jgit/transport/TransportGitSsh.java
index a24878a..bfe0259 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/transport/TransportGitSsh.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/transport/TransportGitSsh.java
@@ -137,7 +137,7 @@ ChannelExec exec(final String exe) throws
TransportException {
 			cmd.append(' ');
 			sqAlways(cmd, path);
 			channel.setCommand(cmd.toString());
-			errStream = SshSessionFactory.getInstance().getErrorStream();
+			errStream = createErrorStream();
 			channel.setErrStream(errStream, true);
 			channel.connect();
 			return channel;
@@ -146,6 +146,42 @@ ChannelExec exec(final String exe) throws
TransportException {
 		}
 	}

+	/**
+	 * @return the error stream for the channel, the stream is used to
detect specific
+	 *   error reasons for exceptions.
+	 */
+	private static OutputStream createErrorStream() {
+		return new OutputStream() {
+			private StringBuilder all = new StringBuilder();
+
+			private StringBuilder sb = new StringBuilder();
+
+			public String toString() {
+				String r = all.toString();
+				while (r.endsWith("\n"))
+					r = r.substring(0, r.length() - 1);
+				return r;
+			}
+
+			@Override
+			public void write(final int b) throws IOException {
+				if (b == '\r') {
+					System.err.print('\r');
+					return;
+				}
+
+				sb.append((char) b);
+
+				if (b == '\n') {
+					final String line = sb.toString();
+					System.err.print(line);
+					all.append(line);
+					sb = new StringBuilder();
+				}
+			}
+		};
+	}
+
 	NoRemoteRepositoryException cleanNotFound(NoRemoteRepositoryException nf) {
 		String why = errStream.toString();
 		if (why == null || why.length() == 0)
-- 
1.6.0.2.1172.ga5ed0
Next: Shawn O. Pearce
Message 1 of 4 in “Removed possibility to change stderr for ssh sessions”
  1. Removed possibility to change stderr for ssh sessionsConstantine Plotnikov, Apr 21, 2009
  2. Shawn O. PearceApr 22, 2009
  3. Constantine PlotnikovApr 22, 2009
  4. Shawn O. PearceApr 22, 2009

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.