1+ /**
2+ * Copyright (c) 2011-2013 Optimax Software Ltd.
3+ * All rights reserved.
4+ *
5+ * Redistribution and use in source and binary forms, with or without
6+ * modification, are permitted provided that the following conditions are met:
7+ *
8+ * * Redistributions of source code must retain the above copyright notice,
9+ * this list of conditions and the following disclaimer.
10+ * * Redistributions in binary form must reproduce the above copyright notice,
11+ * this list of conditions and the following disclaimer in the documentation
12+ * and/or other materials provided with the distribution.
13+ * * Neither the name of Optimax Software, ElasticInbox, nor the names
14+ * of its contributors may be used to endorse or promote products derived
15+ * from this software without specific prior written permission.
16+ *
17+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
21+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
24+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27+ */
28+
29+ package com .elasticinbox .core .blob ;
30+
31+ import static com .elasticinbox .core .blob .store .BlobStoreConstants .*;
32+
33+ import java .net .URI ;
34+ import java .net .URISyntaxException ;
35+
36+ import me .prettyprint .cassandra .utils .Assert ;
37+
38+ import org .jclouds .http .Uris ;
39+ import org .jclouds .http .Uris .UriBuilder ;
40+ import org .jclouds .http .utils .Queries ;
41+
42+ import com .google .common .collect .Multimap ;
43+
44+ /**
45+ * This class provides Blob URI builder and parser tools.
46+ * <p>
47+ * Blobs URI contains following parts:
48+ * <ul>
49+ * <li>Schema - always "blob"</li>
50+ * <li>Host - blob storage profile name</li>
51+ * <li>Path - path where blob stored</li>
52+ * <li>Query parameters - various blob attributes such as compression algorithm,
53+ * encryption key, block count, etc.</li>
54+ * </ul>
55+ * <p>
56+ * Examples:
57+ * <p>
58+ * <code>blob://db/f1ca99e0-99a0-11e2-95f0-040cced3bd7a?c=dfl&b=1</code>
59+ * <p>
60+ * <code>blob://aws3-bucket/f1ca99e0-99a0-11e2-95f0-040cced3bd7a:myemail?c=dfl&e=ekey2</code>
61+ *
62+ * @author Rustam Aliyev
63+ */
64+ public class BlobURI
65+ {
66+ private String profile ;
67+ private String name ;
68+ private String compression ;
69+ private String encryptionKey ;
70+ private Integer blockCount ;
71+
72+ /**
73+ * Blob storage profile name.
74+ * @return
75+ */
76+ public String getProfile () {
77+ return profile ;
78+ }
79+
80+ /**
81+ * Blob name
82+ *
83+ * @return
84+ */
85+ public String getName () {
86+ return BlobUtils .relativize (name );
87+ }
88+
89+ /**
90+ * Compression type (e.g. {@code "dfl"} for Deflate)
91+ *
92+ * @return
93+ */
94+ public String getCompression () {
95+ return compression ;
96+ }
97+
98+ /**
99+ * Encryption key name
100+ *
101+ * @return
102+ */
103+ public String getEncryptionKey () {
104+ return encryptionKey ;
105+ }
106+
107+ /**
108+ * Total count of blocks
109+ * @return
110+ */
111+ public Integer getBlockCount () {
112+ return blockCount ;
113+ }
114+
115+ /**
116+ * Blob storage profile name.
117+ * <p>
118+ * This parameter will be stored as a host of a URI.
119+ *
120+ * @param profile
121+ * @return
122+ */
123+ public BlobURI setProfile (String profile ) {
124+ this .profile = profile ;
125+ return this ;
126+ }
127+
128+ /**
129+ * Blob name
130+ * <p>
131+ * This parameter will be stored as a path of a URI.
132+ *
133+ * @param path
134+ * @return
135+ */
136+ public BlobURI setName (String path )
137+ {
138+ // URI requires absolute path, add leading "/" if not already set
139+ this .name = (path .charAt (0 ) == '/' ) ? path : "/" + path ;
140+ return this ;
141+ }
142+
143+ /**
144+ * Compression type (e.g. {@code "dfl"} for Deflate)
145+ * <p>
146+ * This parameter will be stored in the query part of a URI.
147+ *
148+ * @param compressionType
149+ * @return
150+ */
151+ public BlobURI setCompression (String compressionType ) {
152+ this .compression = compressionType ;
153+ return this ;
154+ }
155+
156+ /**
157+ * Encryption key name which can was used for blob encryption.
158+ * <p>
159+ * This parameter will be stored in the query part of a URI.
160+ *
161+ * @param encryptionKey
162+ * @return
163+ */
164+ public BlobURI setEncryptionKey (String encryptionKey ) {
165+ this .encryptionKey = encryptionKey ;
166+ return this ;
167+ }
168+
169+ /**
170+ * Total number of blocks blob was split into.
171+ * <p>
172+ * This parameter will be stored in the query part of a URI.
173+ *
174+ * @param blockCount
175+ * @return
176+ */
177+ public BlobURI setBlockCount (Integer blockCount ) {
178+ this .blockCount = blockCount ;
179+ return this ;
180+ }
181+
182+ /**
183+ * Parse URI and populate fields
184+ *
185+ * @return
186+ */
187+ public BlobURI fromURI (URI uri )
188+ {
189+ Assert .notNull (uri , "URI cannot be null" );
190+ Assert .isTrue (uri .getScheme ().equals (URI_SCHEME ), "Invalid URI scheme specified for blob: " + uri .getScheme ());
191+ Assert .notNull (uri .getHost (), "Invalid storage profile specified, unable to parse URI" + uri .toString ());
192+ Assert .notNull (uri .getPath (), "Invalid blob name provided, unable to parse URI: " + uri .toString ());
193+
194+ this .profile = uri .getHost ();
195+ this .name = uri .getPath ();
196+
197+ Multimap <String , String > queryParams = Queries .queryParser ().apply (uri .getQuery ());
198+
199+ if (queryParams .containsKey (URI_PARAM_ENCRYPTION_KEY )) {
200+ this .encryptionKey = queryParams .get (URI_PARAM_ENCRYPTION_KEY ).toArray (new String [0 ])[0 ];
201+ }
202+
203+ if (queryParams .containsKey (URI_PARAM_COMPRESSION )) {
204+ this .compression = queryParams .get (URI_PARAM_COMPRESSION ).toArray (new String [0 ])[0 ];
205+ }
206+
207+ if (queryParams .containsKey (URI_PARAM_BLOCK_COUNT )) {
208+ this .blockCount = Integer .parseInt (queryParams .get (URI_PARAM_BLOCK_COUNT ).toArray (new String [0 ])[0 ]);
209+ }
210+
211+ return this ;
212+ }
213+
214+ /**
215+ * Build blob {@link URI} from given parameters
216+ * <p>
217+ * Examples:
218+ * <p>
219+ * <code>blob://db/f1ca99e0-99a0-11e2-95f0-040cced3bd7a?c=dfl&b=1</code>
220+ * <p>
221+ * <code>blob://aws3-bucket/f1ca99e0-99a0-11e2-95f0-040cced3bd7a:myemail?c=dfl&e=ekey2</code>
222+ */
223+ public URI buildURI ()
224+ {
225+ Assert .notNull (this .profile , "Blob storage profile must be specified" );
226+ Assert .notNull (this .name , "Blob name must be provided" );
227+
228+ URI baseuri ;
229+
230+ try {
231+ baseuri = new URI (URI_SCHEME , this .profile , this .name , null );
232+ } catch (URISyntaxException e ) {
233+ throw new IllegalArgumentException ("Invalid blob profile or path: " , e );
234+ }
235+
236+ UriBuilder ub = Uris .uriBuilder (baseuri );
237+
238+ if (this .compression != null ) {
239+ ub .addQuery (URI_PARAM_COMPRESSION , this .compression );
240+ }
241+
242+ if (this .encryptionKey != null ) {
243+ ub .addQuery (URI_PARAM_ENCRYPTION_KEY , this .encryptionKey );
244+ }
245+
246+ if (this .blockCount != null ) {
247+ ub .addQuery (URI_PARAM_BLOCK_COUNT , Integer .toString (this .blockCount ));
248+ }
249+
250+ return ub .build ();
251+ }
252+ }
0 commit comments