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  	 * <p>Constructor for S3Config.</p>
62  	 *
63  	 * @param region
64  	 *            AWS region
65  	 * @param bucket
66  	 *            S3 storage bucket
67  	 * @param storageClass
68  	 *            S3 storage class
69  	 * @param accessKey
70  	 *            access key for authenticating to AWS
71  	 * @param secretKey
72  	 *            secret key for authenticating to AWS
73  	 * @param expirationSeconds
74  	 *            period in seconds after which requests signed for this bucket
75  	 *            will expire
76  	 * @param disableSslVerify
77  	 *            if {@code true} disable Amazon server certificate and hostname
78  	 *            verification
79  	 */
80  	public S3Config(String region, String bucket, String storageClass,
81  			String accessKey, String secretKey, int expirationSeconds,
82  			boolean disableSslVerify) {
83  		this.region = region;
84  		this.bucket = bucket;
85  		this.storageClass = storageClass;
86  		this.accessKey = accessKey;
87  		this.secretKey = secretKey;
88  		this.expirationSeconds = expirationSeconds;
89  		this.disableSslVerify = disableSslVerify;
90  	}
91  
92  	/**
93  	 * Get the <code>region</code>.
94  	 *
95  	 * @return Get name of AWS region this bucket resides in
96  	 */
97  	public String getRegion() {
98  		return region;
99  	}
100 
101 	/**
102 	 * Get the <code>bucket</code>.
103 	 *
104 	 * @return Get S3 storage bucket name
105 	 */
106 	public String getBucket() {
107 		return bucket;
108 	}
109 
110 	/**
111 	 * Get the <code>storageClass</code>.
112 	 *
113 	 * @return S3 storage class to use for objects stored in this bucket
114 	 */
115 	public String getStorageClass() {
116 		return storageClass;
117 	}
118 
119 	/**
120 	 * Get the <code>accessKey</code>.
121 	 *
122 	 * @return access key for authenticating to AWS
123 	 */
124 	public String getAccessKey() {
125 		return accessKey;
126 	}
127 
128 	/**
129 	 * Get the <code>secretKey</code>.
130 	 *
131 	 * @return secret key for authenticating to AWS
132 	 */
133 	public String getSecretKey() {
134 		return secretKey;
135 	}
136 
137 	/**
138 	 * Get the <code>expirationSeconds</code>.
139 	 *
140 	 * @return period in seconds after which requests signed for this bucket
141 	 *         will expire
142 	 */
143 	public int getExpirationSeconds() {
144 		return expirationSeconds;
145 	}
146 
147 	/**
148 	 * @return {@code true} if Amazon server certificate and hostname
149 	 *         verification is disabled
150 	 */
151 	boolean isDisableSslVerify() {
152 		return disableSslVerify;
153 	}
154 
155 }