~ubuntu-branches/debian/sid/php-cassandra/sid

« back to all changes in this revision

Viewing changes to cassandra-1.3.0/doc/Cassandra/SSLOptions/Builder.php

  • Committer: Package Import Robot
  • Author(s): Ondřej Surý
  • Date: 2017-04-18 17:16:30 UTC
  • Revision ID: package-import@ubuntu.com-20170418171630-fw8udixss0879s32
Tags: upstream-1.3.0
Import upstream version 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?php
 
2
 
 
3
/**
 
4
 * Copyright 2017 DataStax, Inc.
 
5
 *
 
6
 * Licensed under the Apache License, Version 2.0 (the "License");
 
7
 * you may not use this file except in compliance with the License.
 
8
 * You may obtain a copy of the License at
 
9
 *
 
10
 * http://www.apache.org/licenses/LICENSE-2.0
 
11
 *
 
12
 * Unless required by applicable law or agreed to in writing, software
 
13
 * distributed under the License is distributed on an "AS IS" BASIS,
 
14
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 
15
 * See the License for the specific language governing permissions and
 
16
 * limitations under the License.
 
17
 */
 
18
 
 
19
namespace Cassandra\SSLOptions;
 
20
 
 
21
/**
 
22
 * SSLOptions builder allows fluent configuration of ssl options.
 
23
 *
 
24
 * @see \Cassandra::ssl()
 
25
 * @see \Cluster\Builder::withSSL()
 
26
 */
 
27
final class Builder {
 
28
 
 
29
    /**
 
30
     * Builds SSL options.
 
31
     *
 
32
     * @return \SSLOptions ssl options configured accordingly.
 
33
     */
 
34
    public function build() { }
 
35
 
 
36
    /**
 
37
     * Adds a trusted certificate. This is used to verify node's identity.
 
38
     *
 
39
     * @param string $path ,... one or more paths to files containing a PEM formatted certificate.
 
40
     *
 
41
     * @throws \Exception\InvalidArgumentException
 
42
     *
 
43
     * @return Builder self
 
44
     */
 
45
    public function withTrustedCerts($path) { }
 
46
 
 
47
    /**
 
48
     * Disable certificate verification.
 
49
     *
 
50
     * @param int $flags
 
51
     *
 
52
     * @throws \Exception\InvalidArgumentException
 
53
     *
 
54
     * @return Builder self
 
55
     */
 
56
    public function withVerifyFlags($flags) { }
 
57
 
 
58
    /**
 
59
     * Set client-side certificate chain.
 
60
     *
 
61
     * This is used to authenticate the client on the server-side. This should contain the entire Certificate
 
62
     * chain starting with the certificate itself.
 
63
     *
 
64
     * @param string $path path to a file containing a PEM formatted certificate.
 
65
     *
 
66
     * @throws \Exception\InvalidArgumentException
 
67
     *
 
68
     * @return Builder self
 
69
     */
 
70
    public function withClientCert($path) { }
 
71
 
 
72
    /**
 
73
     * Set client-side private key. This is used to authenticate the client on
 
74
     * the server-side.
 
75
     *
 
76
     * @param string $path Path to the private key file
 
77
     * @param string|null $passphrase Passphrase for the private key, if any
 
78
     *
 
79
     * @throws \Exception\InvalidArgumentException
 
80
     *
 
81
     * @return Builder self
 
82
     */
 
83
    public function withPrivateKey($path, $passphrase) { }
 
84
 
 
85
}