← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/monodevelop/oneiric

« back to all changes in this revision

Viewing changes to contrib/NGit/NGit.Transport/SshSessionFactory.cs

  • Committer: Bazaar Package Importer
  • Author(s): Jo Shields
  • Date: 2011-06-27 17:03:13 UTC
  • mto: (1.8.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 54.
  • Revision ID: james.westby@ubuntu.com-20110627170313-6cvz3s19x6e9hqe9
Import upstream version 2.5.92+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/NGit/NGit.Transport/SshSessionFactory.cs
 
1
/*
 
2
This code is derived from jgit (http://eclipse.org/jgit).
 
3
Copyright owners are documented in jgit'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
 
 
44
using NGit.Transport;
 
45
using NGit.Util;
 
46
using Sharpen;
 
47
 
 
48
namespace NGit.Transport
 
49
{
 
50
        /// <summary>Creates and destroys SSH connections to a remote system.</summary>
 
51
        /// <remarks>
 
52
        /// Creates and destroys SSH connections to a remote system.
 
53
        /// <p>
 
54
        /// Different implementations of the session factory may be used to control
 
55
        /// communicating with the end-user as well as reading their personal SSH
 
56
        /// configuration settings, such as known hosts and private keys.
 
57
        /// <p>
 
58
        /// A
 
59
        /// <see cref="RemoteSession">RemoteSession</see>
 
60
        /// must be returned to the factory that created it.
 
61
        /// Callers are encouraged to retain the SshSessionFactory for the duration of
 
62
        /// the period they are using the Session.
 
63
        /// </remarks>
 
64
        public abstract class SshSessionFactory
 
65
        {
 
66
                private static SshSessionFactory INSTANCE = new DefaultSshSessionFactory();
 
67
 
 
68
                /// <summary>Get the currently configured JVM-wide factory.</summary>
 
69
                /// <remarks>
 
70
                /// Get the currently configured JVM-wide factory.
 
71
                /// <p>
 
72
                /// A factory is always available. By default the factory will read from the
 
73
                /// user's <code>$HOME/.ssh</code> and assume OpenSSH compatibility.
 
74
                /// </remarks>
 
75
                /// <returns>factory the current factory for this JVM.</returns>
 
76
                public static SshSessionFactory GetInstance()
 
77
                {
 
78
                        return INSTANCE;
 
79
                }
 
80
 
 
81
                /// <summary>Change the JVM-wide factory to a different implementation.</summary>
 
82
                /// <remarks>Change the JVM-wide factory to a different implementation.</remarks>
 
83
                /// <param name="newFactory">
 
84
                /// factory for future sessions to be created through. If null the
 
85
                /// default factory will be restored.s
 
86
                /// </param>
 
87
                public static void SetInstance(SshSessionFactory newFactory)
 
88
                {
 
89
                        if (newFactory != null)
 
90
                        {
 
91
                                INSTANCE = newFactory;
 
92
                        }
 
93
                        else
 
94
                        {
 
95
                                INSTANCE = new DefaultSshSessionFactory();
 
96
                        }
 
97
                }
 
98
 
 
99
                /// <summary>Open (or reuse) a session to a host.</summary>
 
100
                /// <remarks>
 
101
                /// Open (or reuse) a session to a host.
 
102
                /// <p>
 
103
                /// A reasonable UserInfo that can interact with the end-user (if necessary)
 
104
                /// is installed on the returned session by this method.
 
105
                /// <p>
 
106
                /// The caller must connect the session by invoking <code>connect()</code>
 
107
                /// if it has not already been connected.
 
108
                /// </remarks>
 
109
                /// <param name="uri">URI information about the remote host</param>
 
110
                /// <param name="credentialsProvider">provider to support authentication, may be null.
 
111
                ///     </param>
 
112
                /// <param name="fs">
 
113
                /// the file system abstraction which will be necessary to
 
114
                /// perform certain file system operations.
 
115
                /// </param>
 
116
                /// <param name="tms">Timeout value, in milliseconds.</param>
 
117
                /// <returns>a session that can contact the remote host.</returns>
 
118
                /// <exception cref="NGit.Errors.TransportException">the session could not be created.
 
119
                ///     </exception>
 
120
                public abstract RemoteSession GetSession(URIish uri, CredentialsProvider credentialsProvider
 
121
                        , FS fs, int tms);
 
122
 
 
123
                /// <summary>Close (or recycle) a session to a host.</summary>
 
124
                /// <remarks>Close (or recycle) a session to a host.</remarks>
 
125
                /// <param name="session">
 
126
                /// a session previously obtained from this factory's
 
127
                /// <see cref="GetSession(URIish, CredentialsProvider, NGit.Util.FS, int)">GetSession(URIish, CredentialsProvider, NGit.Util.FS, int)
 
128
                ///     </see>
 
129
                /// method.
 
130
                /// </param>
 
131
                public virtual void ReleaseSession(RemoteSession session)
 
132
                {
 
133
                        session.Disconnect();
 
134
                }
 
135
        }
 
136
}