56380
|
1 |
/*
|
|
2 |
* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
|
|
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 |
/**
|
|
29 |
* An attribute of a {@link Connection} that can be configured to influence its
|
|
30 |
* behavior. Implementors of this interface define the properties of
|
|
31 |
* {@link Connection}s. The {@link Connection.Builder#property} method is used to set the values
|
|
32 |
* of {@link Connection} properties.
|
|
33 |
*
|
|
34 |
*/
|
|
35 |
public interface ConnectionProperty {
|
|
36 |
|
|
37 |
/**
|
|
38 |
* Return the name of this {@link ConnectionProperty}.
|
|
39 |
*
|
|
40 |
* @return the name of this {@link ConnectionProperty}
|
|
41 |
*/
|
|
42 |
public String name();
|
|
43 |
|
|
44 |
/**
|
|
45 |
* Return the type of the value of this {@link ConnectionProperty}. Any value
|
|
46 |
* set for this property must be assignable to this type.
|
|
47 |
*
|
|
48 |
* @return the type of the values of this {@link ConnectionProperty}
|
|
49 |
*/
|
|
50 |
public Class<?> range();
|
|
51 |
|
|
52 |
/**
|
|
53 |
* Determine whether a value is valid for this {@link ConnectionProperty}. Returns
|
|
54 |
* {@code true} if {@code value} is valid and {@code false} otherwise.
|
|
55 |
*
|
|
56 |
* @param value a value for this {@link ConnectionProperty}
|
|
57 |
* @return {@code true} iff {@code value} is valid for this {@link ConnectionProperty}
|
|
58 |
*/
|
|
59 |
public default boolean validate(Object value) {
|
|
60 |
return (value == null && this.range() == Void.class) || this.range().isInstance(value);
|
|
61 |
}
|
|
62 |
|
|
63 |
/**
|
|
64 |
* Return the value for this property to use if no other value is set. For
|
|
65 |
* this to have any meaning for a user defined property the property must be
|
|
66 |
* registered with the {@link DataSource} by calling
|
|
67 |
* {@link DataSource.Builder#registerConnectionProperty}.
|
|
68 |
*
|
|
69 |
* @return the default value or {@code null} if there is no default value
|
|
70 |
*/
|
|
71 |
public Object defaultValue();
|
|
72 |
|
|
73 |
/**
|
|
74 |
* Returns true if this {@link ConnectionProperty} is contains sensitive information
|
|
75 |
* such as a password or encryption key.
|
|
76 |
*
|
|
77 |
* @return true iff this is sensitive
|
|
78 |
*/
|
|
79 |
public boolean isSensitive();
|
|
80 |
|
|
81 |
/**
|
|
82 |
* Returns an {@link Operation} that will configure the {@link Connection} to have the
|
|
83 |
* specified property value.May return {@code null} if no {@link Operation} needed. The
|
|
84 |
returned {@link Operation} is a member of group but is not submitted.
|
|
85 |
*
|
|
86 |
* Called by {@link Connection.Builder#build()} to configure a {@link Connection} as specified
|
|
87 |
* in the {@link Connection.Builder#property} method. ConnectionProperties known to the implementation
|
|
88 |
* may return {@code null} and rely on the implementation to do the right thing.
|
|
89 |
*
|
|
90 |
* @param <S>
|
|
91 |
* @param group an {@link OperationGroup} which will be the container of the returned
|
|
92 |
* {@link Operation}, if any
|
|
93 |
* @param value the value to which the property is to be set. May be null if
|
|
94 |
* {@link range()} is {@link Void}.
|
|
95 |
* @return an {@link Operation} or null
|
|
96 |
* @throws IllegalStateException if it is not possible to configure the
|
|
97 |
* {@link Connection} as specified.
|
|
98 |
* @throws IllegalArgumentException if {@code this.validate(value)} returns {@code false}
|
|
99 |
*/
|
|
100 |
public default <S> Operation<? extends S> configureOperation(OperationGroup<S, ?> group, Object value) {
|
|
101 |
if (validate(value)) {
|
|
102 |
return null;
|
|
103 |
}
|
|
104 |
else {
|
|
105 |
throw new IllegalArgumentException(value.toString() + " is invalid");
|
|
106 |
}
|
|
107 |
}
|
|
108 |
|
|
109 |
}
|