01: /*
02: * ====================================================================
03: * Copyright (c) 2004-2008 TMate Software Ltd. All rights reserved.
04: *
05: * This software is licensed as described in the file COPYING, which
06: * you should have received as part of this distribution. The terms
07: * are also available at http://svnkit.com/license.html
08: * If newer versions of this license are posted there, you may use a
09: * newer version instead, at your option.
10: * ====================================================================
11: */
12: package org.tmatesoft.svn.core.auth;
13:
14: import org.tmatesoft.svn.core.SVNErrorMessage;
15:
16: /**
17: * The <b>ISVNProxyManager</b> interface is used to manage http server
18: * options.
19: *
20: * <p>
21: * A default implementation of the <b>ISVNProxyManager</b> interface (that comes along
22: * with a default implementation of <b>ISVNAuthenticationManager</b> - <b>org.tmatesoft.svn.core.internal.wc.DefaultSVNAuthenticationManager</b>)
23: * uses servers options from the standard <i>servers</i> file (it can be found in the
24: * Subversion runtime configuration area - read {@link org.tmatesoft.svn.core.wc.ISVNOptions more}).
25: *
26: * <p>
27: * HTTP proxy options handled by <b>ISVNProxyManager</b> are similar to
28: * the native SVN options - read more on <b>servers</b> options in the
29: * <a href="http://svnbook.red-bean.com/nightly/en/svn.advanced.html#svn.advanced.confarea.opts.servers">Subversion online book</a>.
30: *
31: * @version 1.1.1
32: * @author TMate Software Ltd.
33: * @see ISVNAuthenticationManager
34: */
35: public interface ISVNProxyManager {
36:
37: /**
38: * Returns the proxy host for HTTP connection.
39: *
40: * @return the hostname of the proxy server through which
41: * HTTP-based requests must pass
42: *
43: */
44: public String getProxyHost();
45:
46: /**
47: * Returns the port number on the proxy host to use.
48: *
49: * @return a port number
50: */
51: public int getProxyPort();
52:
53: /**
54: * Returns the username to supply to the proxy machine.
55: *
56: * @return a username
57: */
58: public String getProxyUserName();
59:
60: /**
61: * Returns the password to supply to the proxy machine.
62: *
63: * @return a password
64: */
65: public String getProxyPassword();
66:
67: /**
68: * Accepts this proxy settings if successfully connected
69: * to the proxy server, or not if failed to connect.
70: *
71: * @param accepted <span class="javakeyword">true</span> if
72: * the proxy is successfully reached, otherwise
73: * <span class="javakeyword">false</span>
74: * @param errorMessage the reason of the failure to connect to
75: * the proxy server
76: */
77: public void acknowledgeProxyContext(boolean accepted,
78: SVNErrorMessage errorMessage);
79: }
|