summaryrefslogtreecommitdiffstats
path: root/luni/src/main/java/javax/net/ssl/SSLParameters.java
blob: 6694ef2854cde8e891d4585224b0785d2e8c939a (plain)
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
129
130
131
132
133
134
135
136
137
138
139
140
141
/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package javax.net.ssl;

/**
 * SSL handshake parameters that include protocols, cipher suites, and
 * client authentication requirements.
 * @since 1.6
 */
public class SSLParameters {

    private String[] cipherSuites;
    private String[] protocols;
    private boolean needClientAuth;
    private boolean wantClientAuth;

    /**
     * The default SSLParameters constructor. Cipher suites and
     * protocols are initialized to null and client authentication
     * options are initialized to false.
     */
    public SSLParameters() {}

    /**
     * A SSLParameters constructor that allows the values for the
     * initial cipher suites array to be provided. Other values
     * default as specified in {@link #SSLParameters()}.
     *
     * @param cipherSuites An array of cipherSuites that is cloned for
     * use within the SSLParameters, or null.
     */
    public SSLParameters(String[] cipherSuites) {
        setCipherSuites(cipherSuites);
    }

    /**
     * A SSLParameters constructor that allows the values for initial
     * cipher suites and protocols arrays to be provided. Other values
     * default as specified in {@link #SSLParameters()}.
     *
     * @param cipherSuites An array of cipher names that is cloned for
     * use within the SSLParameters, or null.
     * @param protocols An array of protocol names that is cloned for
     * use within the SSLParameters, or null.
     */
    public SSLParameters(String[] cipherSuites,
                         String[] protocols) {
        setCipherSuites(cipherSuites);
        setProtocols(protocols);
    }

    /**
     * Returns a copy of the cipher suites, or null if none have been
     * specified.
     */
    public String[] getCipherSuites() {
        if (cipherSuites == null) {
            return null;
        }
        return cipherSuites.clone();
    }

    /**
     * Sets the cipher suites to a copy of the input, or null
     */
    public void setCipherSuites(String[] cipherSuites) {
        this.cipherSuites = ((cipherSuites == null)
                             ? null
                             : cipherSuites.clone());
    }

    /**
     * Returns a copy of the protocols, or null if none have been
     * specified.
     */
    public String[] getProtocols() {
        if (protocols == null) {
            return null;
        }
        return protocols.clone();
    }

    /**
     * Sets the protocols to a copy of the input, or null
     */
    public void setProtocols(String[] protocols) {
        this.protocols = ((protocols == null)
                             ? null
                             : protocols.clone());
    }

    /**
     * Returns true if a server requires authentication from a client
     * during handshaking. If this returns true, {@link
     * #getWantClientAuth} will return false.
     */
    public boolean getNeedClientAuth () {
        return needClientAuth;
    }

    /**
     * Sets whether or not to a server needs client authentication.
     * After calling this, #getWantClientAuth() will return false.
     */
    public void setNeedClientAuth (boolean needClientAuth) {
        this.needClientAuth = needClientAuth;
        this.wantClientAuth = false;
    }

    /**
     * Returns true if a server optionally wants to authenticate a
     * client during handshaking. If this returns true, {@link
     * #getNeedClientAuth} will return false.
     */
    public boolean getWantClientAuth () {
        return wantClientAuth;
    }

    /**
     * Sets whether or not to a server wants client authentication.
     * After calling this, #getNeedClientAuth() will return false.
     */
    public void setWantClientAuth (boolean wantClientAuth) {
        this.wantClientAuth = wantClientAuth;
        this.needClientAuth = false;
    }
}