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.auth;
44
45 import java.net.InetSocketAddress;
46
47 /**
48 * Abstract base class for {@link AuthenticationHandler}s encapsulating basic
49 * common things.
50 *
51 * @param <ParameterType>
52 * defining the parameter type for the authentication
53 * @param <TokenType>
54 * defining the token type for the authentication
55 */
56 public abstract class AbstractAuthenticationHandler<ParameterType, TokenType>
57 implements AuthenticationHandler<ParameterType, TokenType> {
58
59 /** The {@link InetSocketAddress} or the proxy to connect to. */
60 protected InetSocketAddress proxy;
61
62 /** The last set parameters. */
63 protected ParameterType params;
64
65 /** A flag telling whether this authentication is done. */
66 protected boolean done;
67
68 /**
69 * Creates a new {@link AbstractAuthenticationHandler} to authenticate with
70 * the given {@code proxy}.
71 *
72 * @param proxy
73 * the {@link InetSocketAddress} of the proxy to connect to
74 */
75 public AbstractAuthenticationHandler(InetSocketAddress proxy) {
76 this.proxy = proxy;
77 }
78
79 @Override
80 public final void setParams(ParameterType input) {
81 params = input;
82 }
83
84 @Override
85 public final boolean isDone() {
86 return done;
87 }
88
89 }