Skip to content

Commit cdd4ee1

Browse files
zephyr2222zephyr2222
authored
Merge pull request #115 from yuyang733/feature-add_symlink_support
feat: add the symlink support
2 parents ec2e763 + b143372 commit cdd4ee1

File tree

11 files changed

+451
-2
lines changed

11 files changed

+451
-2
lines changed

‎src/main/java/com/qcloud/cos/COS.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,28 @@ public COSObject getObject(GetObjectRequest getObjectRequest)
375375
public ObjectMetadata getObject(GetObjectRequest getObjectRequest, File destinationFile)
376376
throws CosClientException, CosServiceException;
377377

378+
/**
379+
* <p>
380+
* Create a Symlink for the specified object.
381+
* The <code>PutSymlinkRequest</code> contains all the details of the request, including the bucket created to,
382+
* the symLink name referred to the target object, the target object key.
383+
* <p/>
384+
* @param putSymlinkRequest the request object containing all the parameter to create a symlink.
385+
* @return the result creating symlink.
386+
*/
387+
public PutSymlinkResult putSymlink(PutSymlinkRequest putSymlinkRequest);
388+
389+
/**
390+
* <p>
391+
* Get the object the symbolic link actually points to.
392+
* The <code>GetSymlinkRequest</code> contains all the details of the request, including the bucket created to,
393+
* the symbolic link queried.
394+
* </p>
395+
* @param getSymlinkRequest the request object containing all the parameter to get a symlink.
396+
* @return the target the symbolic link referred to.
397+
*/
398+
public GetSymlinkResult getSymlink(GetSymlinkRequest getSymlinkRequest);
399+
378400
/**
379401
* @param bucketName Name of bucket that presumably contains object
380402
* @param objectName Name of object that has to be checked

‎src/main/java/com/qcloud/cos/COSClient.java‎

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1176,6 +1176,54 @@ public COSObject getCOSObjectStream() {
11761176
return cosObject.getObjectMetadata();
11771177
}
11781178

1179+
@Override
1180+
public PutSymlinkResult putSymlink(PutSymlinkRequest putSymlinkRequest) {
1181+
rejectNull(putSymlinkRequest, "The request must not be null.");
1182+
rejectNull(putSymlinkRequest.getBucketName(),
1183+
"The bucket name parameter must be specified when create symlink.");
1184+
rejectNull(putSymlinkRequest.getSymlink(), "The symlink name must be specified when create symlink");
1185+
rejectNull(putSymlinkRequest.getTarget(), "The target object must be specified when create symlink");
1186+
1187+
CosHttpRequest<CosServiceRequest> request = createRequest(putSymlinkRequest.getBucketName(),
1188+
putSymlinkRequest.getSymlink(), putSymlinkRequest, HttpMethodName.PUT);
1189+
request.addParameter("symlink", null);
1190+
addParameterIfNotNull(request,"versionId", putSymlinkRequest.getVersionId());
1191+
1192+
request.addHeader(Headers.SYMLINK_TARGET, putSymlinkRequest.getTarget());
1193+
1194+
// Set acl
1195+
// canned acl
1196+
addHeaderIfNotNull(request, Headers.COS_CANNED_ACL,
1197+
putSymlinkRequest.getCannedAccessControlList() != null ?
1198+
putSymlinkRequest.getCannedAccessControlList().toString() : null);
1199+
1200+
// custom acl
1201+
if (putSymlinkRequest.getAccessControlList() != null) {
1202+
byte[] aclAsXml = new AclXmlFactory().convertToXmlByteArray(putSymlinkRequest.getAccessControlList());
1203+
request.addHeader(Headers.CONTENT_TYPE, "application/xml");
1204+
request.addHeader(Headers.CONTENT_LENGTH, String.valueOf(aclAsXml.length));
1205+
request.setContent(new ByteArrayInputStream(aclAsXml));
1206+
}
1207+
1208+
return invoke(request, new PutSymlinkResultHandler());
1209+
}
1210+
1211+
@Override
1212+
public GetSymlinkResult getSymlink(GetSymlinkRequest getSymlinkRequest) {
1213+
rejectNull(getSymlinkRequest, "The request must not be null.");
1214+
rejectNull(getSymlinkRequest.getBucketName(),
1215+
"The bucket name parameter must be specified when getting symlink.");
1216+
rejectNull(getSymlinkRequest.getSymlink(), "The requested symbolic link must be specified.");
1217+
1218+
CosHttpRequest<CosServiceRequest> request = createRequest(getSymlinkRequest.getBucketName(),
1219+
getSymlinkRequest.getSymlink(), getSymlinkRequest, HttpMethodName.GET);
1220+
request.addParameter("symlink", null);
1221+
addParameterIfNotNull(request,"versionId", getSymlinkRequest.getVersionId());
1222+
1223+
return invoke(request, new GetSymlinkResultHandler());
1224+
}
1225+
1226+
11791227
@Override
11801228
public boolean doesObjectExist(String bucketName, String objectName)
11811229
throws CosClientException, CosServiceException {
@@ -1687,8 +1735,6 @@ public void abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploa
16871735

16881736
}
16891737

1690-
1691-
16921738
@Override
16931739
public CompleteMultipartUploadResult completeMultipartUpload(
16941740
CompleteMultipartUploadRequest completeMultipartUploadRequest)

‎src/main/java/com/qcloud/cos/Headers.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,4 +327,6 @@ public interface Headers {
327327
public static final String ENCRYPTION_UNENCRYPTED_CONTENT_MD5 = "client-side-encryption-unencrypted-content-md5";
328328
public static final String ENCRYPTION_DATA_SIZE = "client-side-encryption-data-size";
329329
public static final String ENCRYPTION_PART_SIZE = "client-side-encryption-part-size";
330+
331+
public static final String SYMLINK_TARGET= "x-cos-symlink-target";
330332
}

‎src/main/java/com/qcloud/cos/demo/CreateSymlinkDemo.java‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
package com.qcloud.cos.demo;
2+
3+
import com.qcloud.cos.COSClient;
4+
import com.qcloud.cos.ClientConfig;
5+
import com.qcloud.cos.auth.BasicCOSCredentials;
6+
import com.qcloud.cos.auth.COSCredentials;
7+
import com.qcloud.cos.model.PutSymlinkRequest;
8+
import com.qcloud.cos.model.PutSymlinkResult;
9+
import com.qcloud.cos.region.Region;
10+
11+
public class CreateSymlinkDemo {
12+
13+
private static final String secretId = "";
14+
private static final String secretKey = "";
15+
private static final String bucket = "";
16+
private static final String region = "";
17+
18+
public static void createSymlink(String symlink, String target) {
19+
COSCredentials cosCredentials = new BasicCOSCredentials(secretId, secretKey);
20+
ClientConfig clientConfig = new ClientConfig(new Region(region));
21+
22+
COSClient cosClient = new COSClient(cosCredentials, clientConfig);
23+
24+
PutSymlinkRequest putSymlinkRequest = new PutSymlinkRequest(bucket, symlink, target);
25+
26+
try {
27+
PutSymlinkResult putSymlinkResult = cosClient.putSymlink(putSymlinkRequest);
28+
System.out.println("ETag: " + putSymlinkResult.getETag());
29+
} finally {
30+
cosClient.shutdown();
31+
}
32+
33+
}
34+
35+
public static void main(String[] args) {
36+
createSymlink("test-symlink", "word_count.txt");
37+
}
38+
}

‎src/main/java/com/qcloud/cos/demo/GetSymlinkDemo.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
package com.qcloud.cos.demo;
2+
3+
import com.qcloud.cos.COSClient;
4+
import com.qcloud.cos.ClientConfig;
5+
import com.qcloud.cos.auth.BasicCOSCredentials;
6+
import com.qcloud.cos.auth.COSCredentials;
7+
import com.qcloud.cos.model.GetSymlinkRequest;
8+
import com.qcloud.cos.model.GetSymlinkResult;
9+
import com.qcloud.cos.region.Region;
10+
11+
public class GetSymlinkDemo {
12+
private static final String secretId = "";
13+
private static final String secretKey = "";
14+
private static final String bucket = "";
15+
private static final String region = "";
16+
17+
public static String getSymlink(String symlink) {
18+
COSCredentials cosCredentials = new BasicCOSCredentials(secretId, secretKey);
19+
ClientConfig clientConfig = new ClientConfig(new Region(region));
20+
COSClient cosClient = new COSClient(cosCredentials, clientConfig);
21+
22+
GetSymlinkResult getSymlinkResult = cosClient.getSymlink(
23+
new GetSymlinkRequest(bucket, symlink, null));
24+
25+
return getSymlinkResult.getTarget();
26+
}
27+
28+
public static void main(String[] args) {
29+
System.out.println(getSymlink("test-symlink"));
30+
}
31+
}

‎src/main/java/com/qcloud/cos/model/GetSymlinkRequest.java‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
package com.qcloud.cos.model;
2+
3+
import com.qcloud.cos.internal.CosServiceRequest;
4+
5+
import java.io.Serializable;
6+
7+
public class GetSymlinkRequest extends CosServiceRequest implements Serializable {
8+
private static final long serialVersionUID = -1413983172326934188L;
9+
10+
private String bucketName;
11+
private String symlink;
12+
private String versionId;
13+
14+
public GetSymlinkRequest() {
15+
}
16+
17+
public GetSymlinkRequest(String bucketName, String symlink, String versionId) {
18+
this.bucketName = bucketName;
19+
this.symlink = symlink;
20+
this.versionId = versionId;
21+
}
22+
23+
public GetSymlinkRequest withBucketName(String bucketName) {
24+
this.bucketName = bucketName;
25+
return this;
26+
}
27+
28+
public GetSymlinkRequest withSymlink(String symlink) {
29+
this.symlink = symlink;
30+
return this;
31+
}
32+
33+
public GetSymlinkRequest withVersionId(String versionId) {
34+
this.versionId = versionId;
35+
return this;
36+
}
37+
38+
public String getBucketName() {
39+
return bucketName;
40+
}
41+
42+
public void setBucketName(String bucketName) {
43+
this.bucketName = bucketName;
44+
}
45+
46+
public String getSymlink() {
47+
return symlink;
48+
}
49+
50+
public void setSymlink(String symlink) {
51+
this.symlink = symlink;
52+
}
53+
54+
public String getVersionId() {
55+
return versionId;
56+
}
57+
58+
public void setVersionId(String versionId) {
59+
this.versionId = versionId;
60+
}
61+
}

‎src/main/java/com/qcloud/cos/model/GetSymlinkResult.java‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
package com.qcloud.cos.model;
2+
3+
import java.io.Serializable;
4+
5+
public class GetSymlinkResult implements Serializable {
6+
private static final long serialVersionUID = 3524820691299905321L;
7+
8+
private String requestId;
9+
private String ETag;
10+
private String target;
11+
12+
public String getRequestId() {
13+
return requestId;
14+
}
15+
16+
public void setRequestId(String requestId) {
17+
this.requestId = requestId;
18+
}
19+
20+
public String getETag() {
21+
return ETag;
22+
}
23+
24+
public void setETag(String ETag) {
25+
this.ETag = ETag;
26+
}
27+
28+
public String getTarget() {
29+
return target;
30+
}
31+
32+
public void setTarget(String target) {
33+
this.target = target;
34+
}
35+
}

‎src/main/java/com/qcloud/cos/model/GetSymlinkResultHandler.java‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
package com.qcloud.cos.model;
2+
3+
import com.qcloud.cos.Headers;
4+
import com.qcloud.cos.http.CosHttpResponse;
5+
import com.qcloud.cos.internal.AbstractCosResponseHandler;
6+
import com.qcloud.cos.internal.CosServiceResponse;
7+
8+
import java.util.Map;
9+
10+
public class GetSymlinkResultHandler extends AbstractCosResponseHandler<GetSymlinkResult> {
11+
@Override
12+
public CosServiceResponse<GetSymlinkResult> handle(CosHttpResponse response) throws Exception {
13+
GetSymlinkResult getSymlinkResult = new GetSymlinkResult();
14+
final CosServiceResponse<GetSymlinkResult> cosServiceResponse = new CosServiceResponse<>();
15+
for (Map.Entry<String, String> header : response.getHeaders().entrySet()) {
16+
String key = header.getKey();
17+
String value = header.getValue();
18+
19+
if (Headers.REQUEST_ID.compareToIgnoreCase(key) == 0) {
20+
getSymlinkResult.setRequestId(value);
21+
continue;
22+
}
23+
24+
if (Headers.ETAG.compareToIgnoreCase(key) == 0) {
25+
getSymlinkResult.setETag(value);
26+
continue;
27+
}
28+
29+
if (Headers.SYMLINK_TARGET.compareToIgnoreCase(key) == 0) {
30+
getSymlinkResult.setTarget(value);
31+
}
32+
}
33+
34+
cosServiceResponse.setResult(getSymlinkResult);
35+
return cosServiceResponse;
36+
}
37+
}

0 commit comments

Comments
 (0)