-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ClientConnectionInfo.java
128 lines (116 loc) · 4.01 KB
/
ClientConnectionInfo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.impl.query.clientconnection;
/**
* This is implemented as an abstract class in order to support different formatting for {@link #asConnectionDetails()},
* when this method is no longer needed, and we move to a standardized format across all types of connections, we can
* turn this class into a simpler value type that just holds the fields that are actually used.
*/
public abstract class ClientConnectionInfo
{
/**
* Used by {@link #asConnectionDetails()} only. When the {@code connectionDetails} string is no longer needed,
* this can go away, since the username is provided though other means to the places that need it.
*/
@Deprecated
public ClientConnectionInfo withUsername( String username )
{
return new ConnectionInfoWithUsername( this, username );
}
/**
* This method provides the custom format for each type of connection.
* <p>
* Preferably we would not need to have a custom format for each type of connection, but this is provided for
* backwards compatibility reasons.
*
* @return a custom log-line format describing this type of connection.
*/
@Deprecated
public abstract String asConnectionDetails();
/**
* This method is overridden in the subclasses where this information is available.
*
* @return the scheme used for connecting to the server, or {@code null} if no scheme is available.
*/
public String protocol()
{
return null;
}
/**
* This method is overridden in the subclasses where this information is available.
*
* @return the address of the client. or {@code null} if the address is not available.
*/
public String clientAddress()
{
return null;
}
/**
* This method is overridden in the subclasses where this information is available.
*
* @return the URI of this server that the client connected to, or {@code null} if the URI is not available.
*/
public String requestURI()
{
return null;
}
public static final ClientConnectionInfo EMBEDDED_CONNECTION = new ClientConnectionInfo()
{
@Override
public String asConnectionDetails()
{
return "embedded-session\t";
}
};
/**
* Should be removed along with {@link #withUsername(String)} and {@link #asConnectionDetails()}.
*/
@Deprecated
private static class ConnectionInfoWithUsername extends ClientConnectionInfo
{
private final ClientConnectionInfo source;
private final String username;
private ConnectionInfoWithUsername( ClientConnectionInfo source, String username )
{
this.source = source;
this.username = username;
}
@Override
public String asConnectionDetails()
{
return source.asConnectionDetails() + '\t' + username;
}
@Override
public String protocol()
{
return source.protocol();
}
@Override
public String clientAddress()
{
return source.clientAddress();
}
@Override
public String requestURI()
{
return source.requestURI();
}
}
}