56380
|
1 |
/*
|
56475
|
2 |
* Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
|
56380
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
4 |
*
|
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
|
10 |
*
|
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
|
15 |
* accompanied this code).
|
|
16 |
*
|
|
17 |
* You should have received a copy of the GNU General Public License version
|
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
20 |
*
|
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
|
23 |
* questions.
|
|
24 |
*/
|
|
25 |
|
|
26 |
package jdk.incubator.sql2;
|
|
27 |
|
|
28 |
import java.util.LinkedList;
|
|
29 |
import java.util.List;
|
|
30 |
import java.util.function.Consumer;
|
56824
|
31 |
import java.util.function.LongConsumer;
|
56380
|
32 |
|
|
33 |
/**
|
56824
|
34 |
* Uses the builder pattern to get a {@link Session}. A {@link DataSource#getSession}
|
56380
|
35 |
* method is provided as a convenience.
|
56475
|
36 |
*
|
|
37 |
* Implementations must be thread safe.
|
56380
|
38 |
*/
|
|
39 |
public interface DataSource
|
|
40 |
extends AutoCloseable {
|
|
41 |
|
|
42 |
/**
|
|
43 |
* Instances of this type are used to build {@link DataSource}s. This type is
|
|
44 |
* immutable once configured. No property can be set more than once. No
|
|
45 |
* property can be set after {@link build} is called.
|
56797
|
46 |
*
|
|
47 |
* ISSUE: Probably need property(DataSourceProperty prop, Object value).
|
56380
|
48 |
*/
|
|
49 |
public interface Builder {
|
|
50 |
|
|
51 |
/**
|
56824
|
52 |
* Specify a property and its value for the built {@link DataSource}.
|
56380
|
53 |
*
|
56824
|
54 |
* @param p {@link DataSourceProperty} to set. Not {@code null}.
|
|
55 |
* @param v value for the property
|
56380
|
56 |
* @return this {@link Builder}
|
56824
|
57 |
* @throws IllegalArgumentException if {@code p.validate(v)} does not return
|
|
58 |
* true, if this method has already been called with the property
|
|
59 |
* {@code p}, or the implementation does not support the
|
|
60 |
* {@link DataSourceProperty}.
|
|
61 |
*/
|
|
62 |
public Builder property(DataSourceProperty p, Object v);
|
|
63 |
|
|
64 |
/**
|
|
65 |
* A convenience method for setting the {@link AdbaSessionProperty#URL}.
|
|
66 |
*
|
|
67 |
* @param url the value to be set for {@link AdbaSessionProperty#URL}
|
|
68 |
* @return this {@link Builder}
|
|
69 |
* @see sessionProperty
|
56380
|
70 |
*/
|
|
71 |
public default Builder url(String url) {
|
56824
|
72 |
return sessionProperty(AdbaSessionProperty.URL, url);
|
56380
|
73 |
}
|
|
74 |
|
|
75 |
/**
|
56824
|
76 |
* A convenience method for setting the {@link AdbaSessionProperty#USER}.
|
56380
|
77 |
*
|
56824
|
78 |
* @param name the value to be set for {@link AdbaSessionProperty#USER}
|
56380
|
79 |
* @return this {@link Builder}
|
56824
|
80 |
* @see sessionProperty
|
56380
|
81 |
*/
|
|
82 |
public default Builder username(String name) {
|
56824
|
83 |
return sessionProperty(AdbaSessionProperty.USER, name);
|
56380
|
84 |
}
|
|
85 |
|
|
86 |
/**
|
56824
|
87 |
* A convenience method for setting the {@link AdbaSessionProperty#PASSWORD}.
|
56380
|
88 |
*
|
56824
|
89 |
* @param password the value to be set for {@link AdbaSessionProperty#PASSWORD}
|
56380
|
90 |
* @return this {@link Builder}
|
56824
|
91 |
* @see sessionProperty
|
56380
|
92 |
*/
|
|
93 |
public default Builder password(String password) {
|
56824
|
94 |
return sessionProperty(AdbaSessionProperty.PASSWORD, password);
|
56380
|
95 |
}
|
|
96 |
|
|
97 |
/**
|
56824
|
98 |
* Specify the value of a {@link Session} property that will be set by default on
|
|
99 |
* all {@link Session}s produced by this {@link DataSource}. A different value can be set
|
|
100 |
* for a particular {@link Session} via {@link Session.Builder#property}.
|
56380
|
101 |
*
|
56824
|
102 |
* @param property the {@link SessionProperty} to be set. May not be {@code null}.
|
56380
|
103 |
* @param value the value to be set for {@code property}
|
|
104 |
* @return this {@link Builder}
|
|
105 |
* @throws IllegalArgumentException if {@code property.validate(value)} does not
|
|
106 |
* return {@code true}. If it throws an {@link Exception} that {@link Exception} is the cause. Or if
|
|
107 |
* this property has been specified previously to this method or
|
56824
|
108 |
* {@link sessionProperty} or {@link registerSessionProperty}.
|
56380
|
109 |
* @throws IllegalStateException if {@link build} has previously been called.
|
|
110 |
*/
|
56824
|
111 |
public Builder defaultSessionProperty(SessionProperty property, Object value);
|
56380
|
112 |
|
|
113 |
/**
|
56824
|
114 |
* Specify the value of a {@link Session} property that will be set on
|
|
115 |
* all {@link Session}s produced by the built {@link DataSource}.
|
56380
|
116 |
* Attempting to set a different value via
|
56824
|
117 |
* {@link Session.Builder#property} will throw
|
56380
|
118 |
* {@link IllegalArgumentException}.
|
|
119 |
*
|
56824
|
120 |
* @param property the {@link SessionProperty} to set. May not be
|
56380
|
121 |
* {@code null}.
|
|
122 |
* @param value the value to set as the default for {@code property}
|
|
123 |
* @return this {@link Builder}
|
|
124 |
* @throws IllegalArgumentException if {@code property.validate(value)} does
|
|
125 |
* not return {@code true}. If it throws an {@link Exception} that
|
|
126 |
* {@link Exception} is the cause. Or if this property has been specified
|
56824
|
127 |
* previously to this method or {@link defaultSessionProperty} or
|
|
128 |
* {@link registerSessionProperty}.
|
56380
|
129 |
* @throws IllegalStateException if {@link build} has previously been
|
|
130 |
* called.
|
|
131 |
*/
|
56824
|
132 |
public Builder sessionProperty(SessionProperty property, Object value);
|
56380
|
133 |
|
|
134 |
/**
|
|
135 |
* Make a user defined property known to the implementation. One reason to
|
|
136 |
* do this is so the default value of the property will be used. If the
|
|
137 |
* {@link DataSource} doesn't know about the property then it cannot know to
|
|
138 |
* set the default value. Convenience method.
|
|
139 |
*
|
56824
|
140 |
* @param property the {@link SessionProperty} to make known. May not be
|
56380
|
141 |
* {@code null}.
|
|
142 |
* @return this Builder
|
|
143 |
* @throws IllegalArgumentException if this property has been specified
|
56824
|
144 |
* previously to this method or {@link sessionProperty} or
|
|
145 |
* {@link defaultSessionProperty}.
|
56380
|
146 |
* @throws IllegalStateException if {@link build} has previously been
|
|
147 |
* called.
|
|
148 |
*/
|
56824
|
149 |
public default Builder registerSessionProperty(SessionProperty property) {
|
|
150 |
return defaultSessionProperty(property, property.defaultValue());
|
56380
|
151 |
}
|
|
152 |
|
|
153 |
/**
|
56797
|
154 |
* Provide a method that the built {@link DataSource} will call to control the
|
56824
|
155 |
* rate of {@link Session} creations. The built
|
56797
|
156 |
* {@link DataSource} will call {@code request} with a positive argument
|
56824
|
157 |
* when the {@link DataSource} is able to accept more calls to
|
|
158 |
* {@link DataSource#builder}. The difference between
|
56797
|
159 |
* the sum of all arguments passed to {@code request} and the number of
|
|
160 |
* calls to {@link DataSource#builder} is the
|
|
161 |
* <i>demand</i>. The demand must always be non-negative. If a call is made to
|
56824
|
162 |
* {@link DataSource#builder} that would make the demand negative, that call
|
56797
|
163 |
* throws {@link IllegalStateException}. If {@code requestHook} is not called,
|
|
164 |
* the demand is defined to be infinite.
|
|
165 |
*
|
|
166 |
* <p>
|
56824
|
167 |
* Since the user thread is never blocked, a user thread could in theory
|
|
168 |
* create, attach, use, and close {@link Session}s faster than the underlying
|
|
169 |
* implementation can process the submitted work. At some point work would
|
|
170 |
* start timing out or Java would run out of memory to store the queued
|
|
171 |
* {@link Operation}s. This is a poor way address the issue. This method
|
|
172 |
* allows user code to get feedback from the {@link DataSource} as to whether
|
|
173 |
* the {@link DataSource} can accept more work.
|
|
174 |
* </p>
|
56797
|
175 |
*
|
|
176 |
* @param request accepts calls to increase the demand. Not null.
|
|
177 |
* @return this {@link Builder}
|
|
178 |
* @throws IllegalStateException if this method has been called previously
|
|
179 |
*/
|
56824
|
180 |
public Builder requestHook(LongConsumer request);
|
56797
|
181 |
|
|
182 |
/**
|
56380
|
183 |
* Return a DataSource configured as specified.
|
|
184 |
*
|
|
185 |
* @return a configured {@link DataSource}. Not {@code null}.
|
|
186 |
* @throws IllegalArgumentException if unable to return a {@link DataSource} due to
|
|
187 |
* problems with the configuration such is missing or conflicting properties.
|
|
188 |
*/
|
|
189 |
public DataSource build();
|
|
190 |
}
|
|
191 |
|
|
192 |
/**
|
56824
|
193 |
* Returns a {@link Session} builder. By default that builder will return
|
|
194 |
* {@link Session}s with the {@code SessionProperty}s specified when creating this
|
|
195 |
* DataSource. Default and unspecified {@link SessionProperty}s can be set with
|
56380
|
196 |
* the returned builder.
|
|
197 |
*
|
56824
|
198 |
* @return a new {@link Session} builder. Not {@code null}.
|
56797
|
199 |
* @throws IllegalStateException if this {@link DataSource} is closed
|
56380
|
200 |
*/
|
56824
|
201 |
public Session.Builder builder();
|
56380
|
202 |
|
|
203 |
/**
|
56824
|
204 |
* Returns a {@link Session} that has a submitted attach {@link Operation}. Convenience
|
56380
|
205 |
* method for use with try with resources.
|
|
206 |
*
|
56824
|
207 |
* @return a {@link Session}
|
56797
|
208 |
* @throws IllegalStateException if this {@link DataSource} is closed
|
56380
|
209 |
*/
|
56824
|
210 |
public default Session getSession() {
|
|
211 |
return builder().build().attach();
|
56380
|
212 |
}
|
|
213 |
|
|
214 |
/**
|
56824
|
215 |
* Returns a {@link Session} that has a submitted attach {@link Operation} with an error
|
56380
|
216 |
* handler. Convenience method for use with try with resources. The error
|
56824
|
217 |
* handle handles errors in the attach {@link Operation}.
|
56380
|
218 |
*
|
56824
|
219 |
* @param handler for errors in the attach {@link Operation}
|
|
220 |
* @return a {@link Session}
|
56797
|
221 |
* @throws IllegalStateException if this {@link DataSource} is closed
|
56380
|
222 |
*/
|
56824
|
223 |
public default Session getSession(Consumer<Throwable> handler) {
|
|
224 |
return builder().build().attach(handler);
|
56380
|
225 |
}
|
|
226 |
|
|
227 |
/**
|
|
228 |
* Translates a SQL string from the format specified by the format argument
|
56824
|
229 |
* to a format that can be used to create {@link Operation}s for the {@link Session}s
|
56380
|
230 |
* provided by this {@link DataSource}.
|
|
231 |
*
|
|
232 |
* ISSUE: Just an idea
|
|
233 |
*
|
|
234 |
* @param format not {@code null}
|
|
235 |
* @param source SQL in the format specified by {@code format}. Not {@code null}.
|
|
236 |
* @return SQL in the format supported by this {@link DataSource}. Not {@code null}.
|
|
237 |
* @throws IllegalArgumentException if the {@code format} is not supported or
|
|
238 |
* if the {@link DataSource} cannot translate the SQL
|
56797
|
239 |
* @throws IllegalStateException if this {@link DataSource} is closed
|
56380
|
240 |
*/
|
|
241 |
public default String translateSql(String format, String source) throws SqlException {
|
|
242 |
throw new IllegalArgumentException("Unsupported format: \"" + format + "\"");
|
|
243 |
}
|
|
244 |
|
|
245 |
/**
|
|
246 |
* Return a list of the source formats accepted by the {@link translateSql} method.
|
|
247 |
*
|
|
248 |
* ISSUE: Just an idea
|
|
249 |
*
|
|
250 |
* @return an array of Strings each of which identifies a supported format
|
56797
|
251 |
* @throws IllegalStateException if this {@link DataSource} is closed
|
56380
|
252 |
*/
|
|
253 |
public default List<String> supportedTranslateSqlFormats() {
|
|
254 |
return new LinkedList<>();
|
|
255 |
}
|
|
256 |
|
|
257 |
@Override
|
|
258 |
public void close();
|
|
259 |
|
|
260 |
}
|