View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  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,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.transport.minio;
20  
21  import java.io.InputStream;
22  import java.net.URI;
23  import java.net.URISyntaxException;
24  import java.nio.file.Files;
25  import java.nio.file.Path;
26  import java.nio.file.StandardCopyOption;
27  import java.util.Collections;
28  import java.util.HashMap;
29  import java.util.Map;
30  
31  import io.minio.GetObjectArgs;
32  import io.minio.MinioClient;
33  import io.minio.StatObjectArgs;
34  import io.minio.UploadObjectArgs;
35  import io.minio.credentials.Provider;
36  import io.minio.credentials.StaticProvider;
37  import io.minio.errors.ErrorResponseException;
38  import org.eclipse.aether.ConfigurationProperties;
39  import org.eclipse.aether.RepositorySystemSession;
40  import org.eclipse.aether.repository.AuthenticationContext;
41  import org.eclipse.aether.repository.RemoteRepository;
42  import org.eclipse.aether.spi.connector.transport.AbstractTransporter;
43  import org.eclipse.aether.spi.connector.transport.GetTask;
44  import org.eclipse.aether.spi.connector.transport.PeekTask;
45  import org.eclipse.aether.spi.connector.transport.PutTask;
46  import org.eclipse.aether.spi.connector.transport.Transporter;
47  import org.eclipse.aether.transfer.NoTransporterException;
48  import org.eclipse.aether.util.ConfigUtils;
49  import org.eclipse.aether.util.FileUtils;
50  
51  /**
52   * A transporter for S3 backed by MinIO Java.
53   *
54   * @since 2.0.2
55   */
56  final class MinioTransporter extends AbstractTransporter implements Transporter {
57      private final URI baseUri;
58  
59      private final Map<String, String> headers;
60  
61      private final MinioClient client;
62  
63      private final ObjectNameMapper objectNameMapper;
64  
65      MinioTransporter(
66              RepositorySystemSession session,
67              RemoteRepository repository,
68              ObjectNameMapperFactory objectNameMapperFactory)
69              throws NoTransporterException {
70          try {
71              URI uri = new URI(repository.getUrl()).parseServerAuthority();
72              if (uri.isOpaque()) {
73                  throw new URISyntaxException(repository.getUrl(), "URL must not be opaque");
74              }
75              if (uri.getRawFragment() != null || uri.getRawQuery() != null) {
76                  throw new URISyntaxException(repository.getUrl(), "URL must not have fragment or query");
77              }
78              String path = uri.getPath();
79              if (path == null) {
80                  path = "/";
81              }
82              if (!path.startsWith("/")) {
83                  path = "/" + path;
84              }
85              if (!path.endsWith("/")) {
86                  path = path + "/";
87              }
88              this.baseUri = URI.create(uri.getScheme() + "://" + uri.getRawAuthority() + path);
89          } catch (URISyntaxException e) {
90              throw new NoTransporterException(repository, e.getMessage(), e);
91          }
92  
93          HashMap<String, String> headers = new HashMap<>();
94          @SuppressWarnings("unchecked")
95          Map<Object, Object> configuredHeaders = (Map<Object, Object>) ConfigUtils.getMap(
96                  session,
97                  Collections.emptyMap(),
98                  ConfigurationProperties.HTTP_HEADERS + "." + repository.getId(),
99                  ConfigurationProperties.HTTP_HEADERS);
100         if (configuredHeaders != null) {
101             configuredHeaders.forEach((k, v) -> headers.put(String.valueOf(k), v != null ? String.valueOf(v) : null));
102         }
103         this.headers = headers;
104 
105         String username = null;
106         String password = null;
107         try (AuthenticationContext repoAuthContext = AuthenticationContext.forRepository(session, repository)) {
108             if (repoAuthContext != null) {
109                 username = repoAuthContext.get(AuthenticationContext.USERNAME);
110                 password = repoAuthContext.get(AuthenticationContext.PASSWORD);
111             }
112         }
113         if (username == null || password == null) {
114             throw new IllegalStateException(
115                     "Minio transport: No accessKey and/or secretKey provided for repository " + repository.getId());
116         }
117 
118         Provider credentialsProvider = new StaticProvider(username, password, null);
119         this.client = MinioClient.builder()
120                 .endpoint(repository.getUrl())
121                 .credentialsProvider(credentialsProvider)
122                 .build();
123         this.objectNameMapper = objectNameMapperFactory.create(session, repository, client, headers);
124     }
125 
126     @Override
127     public int classify(Throwable error) {
128         if (error instanceof ErrorResponseException) {
129             String errorCode = ((ErrorResponseException) error).errorResponse().code();
130             if ("NoSuchKey".equals(errorCode) || "NoSuchBucket".equals(errorCode)) {
131                 return ERROR_NOT_FOUND;
132             }
133         }
134         return ERROR_OTHER;
135     }
136 
137     @Override
138     protected void implPeek(PeekTask task) throws Exception {
139         ObjectName objectName =
140                 objectNameMapper.name(baseUri.relativize(task.getLocation()).getPath());
141         StatObjectArgs.Builder builder = StatObjectArgs.builder()
142                 .bucket(objectName.getBucket())
143                 .object(objectName.getName())
144                 .extraHeaders(headers);
145         client.statObject(builder.build());
146     }
147 
148     @Override
149     protected void implGet(GetTask task) throws Exception {
150         ObjectName objectName =
151                 objectNameMapper.name(baseUri.relativize(task.getLocation()).getPath());
152         try (InputStream stream = client.getObject(GetObjectArgs.builder()
153                 .bucket(objectName.getBucket())
154                 .object(objectName.getName())
155                 .extraHeaders(headers)
156                 .build())) {
157             final Path dataFile = task.getDataPath();
158             if (dataFile == null) {
159                 utilGet(task, stream, true, -1, false);
160             } else {
161                 try (FileUtils.CollocatedTempFile tempFile = FileUtils.newTempFile(dataFile)) {
162                     task.setDataPath(tempFile.getPath(), false);
163                     utilGet(task, stream, true, -1, false);
164                     tempFile.move();
165                 } finally {
166                     task.setDataPath(dataFile);
167                 }
168             }
169         }
170     }
171 
172     @Override
173     protected void implPut(PutTask task) throws Exception {
174         ObjectName objectName =
175                 objectNameMapper.name(baseUri.relativize(task.getLocation()).getPath());
176         task.getListener().transportStarted(0, task.getDataLength());
177         final Path dataFile = task.getDataPath();
178         if (dataFile == null) {
179             try (FileUtils.TempFile tempFile = FileUtils.newTempFile()) {
180                 Files.copy(task.newInputStream(), tempFile.getPath(), StandardCopyOption.REPLACE_EXISTING);
181                 client.uploadObject(UploadObjectArgs.builder()
182                         .bucket(objectName.getBucket())
183                         .object(objectName.getName())
184                         .filename(tempFile.getPath().toString())
185                         .build());
186             }
187         } else {
188             client.uploadObject(UploadObjectArgs.builder()
189                     .bucket(objectName.getBucket())
190                     .object(objectName.getName())
191                     .filename(dataFile.toString())
192                     .build());
193         }
194     }
195 
196     @Override
197     protected void implClose() {
198         try {
199             client.close();
200         } catch (Exception e) {
201             throw new RuntimeException(e);
202         }
203     }
204 }