View Javadoc
1   /*
2    * Copyright (C) 2015, Matthias Sohn <matthias.sohn@sap.com>
3    * Copyright (C) 2015, Sasa Zivkov <sasa.zivkov@sap.com>
4    * and other copyright owners as documented in the project's IP log.
5    *
6    * This program and the accompanying materials are made available
7    * under the terms of the Eclipse Distribution License v1.0 which
8    * accompanies this distribution, is reproduced below, and is
9    * available at http://www.eclipse.org/org/documents/edl-v10.php
10   *
11   * All rights reserved.
12   *
13   * Redistribution and use in source and binary forms, with or
14   * without modification, are permitted provided that the following
15   * conditions are met:
16   *
17   * - Redistributions of source code must retain the above copyright
18   *   notice, this list of conditions and the following disclaimer.
19   *
20   * - Redistributions in binary form must reproduce the above
21   *   copyright notice, this list of conditions and the following
22   *   disclaimer in the documentation and/or other materials provided
23   *   with the distribution.
24   *
25   * - Neither the name of the Eclipse Foundation, Inc. nor the
26   *   names of its contributors may be used to endorse or promote
27   *   products derived from this software without specific prior
28   *   written permission.
29   *
30   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43   */
44  package org.eclipse.jgit.lfs.server.s3;
45  
46  /**
47   * Configuration for an Amazon AWS S3 bucket
48   *
49   * @since 4.3
50   */
51  public class S3Config {
52  	private final String region;
53  	private final String bucket;
54  	private final String storageClass;
55  	private final String accessKey;
56  	private final String secretKey;
57  	private final int expirationSeconds;
58  	private final boolean disableSslVerify;
59  
60  	/**
61  	 * @param region
62  	 *            AWS region
63  	 * @param bucket
64  	 *            S3 storage bucket
65  	 * @param storageClass
66  	 *            S3 storage class
67  	 * @param accessKey
68  	 *            access key for authenticating to AWS
69  	 * @param secretKey
70  	 *            secret key for authenticating to AWS
71  	 * @param expirationSeconds
72  	 *            period in seconds after which requests signed for this bucket
73  	 *            will expire
74  	 * @param disableSslVerify
75  	 *            if {@code true} disable Amazon server certificate and hostname
76  	 *            verification
77  	 */
78  	public S3Config(String region, String bucket, String storageClass,
79  			String accessKey, String secretKey, int expirationSeconds,
80  			boolean disableSslVerify) {
81  		this.region = region;
82  		this.bucket = bucket;
83  		this.storageClass = storageClass;
84  		this.accessKey = accessKey;
85  		this.secretKey = secretKey;
86  		this.expirationSeconds = expirationSeconds;
87  		this.disableSslVerify = disableSslVerify;
88  	}
89  
90  	/**
91  	 * @return Get name of AWS region this bucket resides in
92  	 */
93  	public String getRegion() {
94  		return region;
95  	}
96  
97  	/**
98  	 * @return Get S3 storage bucket name
99  	 */
100 	public String getBucket() {
101 		return bucket;
102 	}
103 
104 	/**
105 	 * @return S3 storage class to use for objects stored in this bucket
106 	 */
107 	public String getStorageClass() {
108 		return storageClass;
109 	}
110 
111 	/**
112 	 * @return access key for authenticating to AWS
113 	 */
114 	public String getAccessKey() {
115 		return accessKey;
116 	}
117 
118 	/**
119 	 * @return secret key for authenticating to AWS
120 	 */
121 	public String getSecretKey() {
122 		return secretKey;
123 	}
124 
125 	/**
126 	 * @return period in seconds after which requests signed for this bucket
127 	 *         will expire
128 	 */
129 	public int getExpirationSeconds() {
130 		return expirationSeconds;
131 	}
132 
133 	/**
134 	 * @return {@code true} if Amazon server certificate and hostname
135 	 *         verification is disabled
136 	 */
137 	boolean isDisableSslVerify() {
138 		return disableSslVerify;
139 	}
140 
141 }