/*

* MinIO Java SDK for Amazon S3 Compatible Cloud Storage, (C) 2015-2021 MinIO, Inc.

*

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

* http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/

package io.minio.messages;

import io.minio.Time;

import io.minio.Utils;

import java.time.ZonedDateTime;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Objects;

import javax.annotation.Nonnull;

import org.simpleframework.xml.Element;

import org.simpleframework.xml.ElementList;

import org.simpleframework.xml.Root;

import org.simpleframework.xml.convert.Convert;

import org.simpleframework.xml.convert.Converter;

import org.simpleframework.xml.stream.InputNode;

import org.simpleframework.xml.stream.OutputNode;

/**

* Object information in {@link ListBucketResultV1}, {@link ListBucketResultV2} and {@link

* ListVersionsResult}.

*/

public abstract class Item {

@Element(name = "ETag", required = false)

private String etag; // except DeleteMarker

@Element(name = "Key")

private String objectName;

@Element(name = "LastModified")

private Time.S3Time lastModified;

@Element(name = "Owner", required = false)

private Owner owner;

@Element(name = "Size", required = false)

private long size; // except DeleteMarker

@Element(name = "StorageClass", required = false)

private String storageClass; // except DeleteMarker, not in case of MinIO server.

@Element(name = "IsLatest", required = false)

private boolean isLatest; // except ListObjects V1

@Element(name = "VersionId", required = false)

private String versionId; // except ListObjects V1

@Element(name = "UserMetadata", required = false)

private UserMetadata userMetadata;

@Element(name = "UserTags", required = false)

private String userTags;

@ElementList(name = "ChecksumAlgorithm", inline = true, required = false)

private List<String> checksumAlgorithm;

@Element(name = "ChecksumType", required = false)

private String checksumType;

@Element(name = "RestoreStatus", required = false)

private RestoreStatus restoreStatus;

private boolean isDir = false;

private String encodingType = null;

public Item() {}

/** Constructs a new Item for prefix i.e. directory. */

public Item(String prefix) {

this.objectName = prefix;

this.isDir = true;

}

public void setEncodingType(String encodingType) {

this.encodingType = encodingType;

}

/** Returns object name. */

public String objectName() {

return Utils.urlDecode(objectName, encodingType);

}

/** Returns last modified time of the object. */

public ZonedDateTime lastModified() {

return lastModified == null ? null : lastModified.toZonedDateTime();

}

/** Returns ETag of the object. */

public String etag() {

return etag;

}

/** Returns object size. */

public long size() {

return size;

}

/** Returns storage class of the object. */

public String storageClass() {

return storageClass;

}

/** Returns owner object of given the object. */

public Owner owner() {

return owner;

}

/** Returns user metadata. This is MinIO specific extension to ListObjectsV2. */

public Map<String, String> userMetadata() {

return (userMetadata == null) ? null : userMetadata.get();

}

public String userTags() {

return userTags;

}

/** Returns whether this version ID is latest. */

public boolean isLatest() {

return isLatest;

}

/** Returns version ID. */

public String versionId() {

return versionId;

}

/** Returns whether this item is a directory or not. */

public boolean isDir() {

return isDir;

}

/** Returns whether this item is a delete marker or not. */

public boolean isDeleteMarker() {

return this instanceof ListVersionsResult.DeleteMarker;

}

public List<String> checksumAlgorithm() {

return Utils.unmodifiableList(checksumAlgorithm);

}

public String checksumType() {

return checksumType;

}

public RestoreStatus restoreStatus() {

return restoreStatus;

}

@Override

public String toString() {

return String.format(

"etag=%s, objectName=%s, lastModified=%s, owner=%s, size=%s, storageClass=%s, isLatest=%s, "

+ "versionId=%s, userMetadata=%s, userTags=%s, checksumAlgorithm=%s, checksumType=%s, "

+ "restoreStatus=%s, isDir=%s, encodingType=%s",

Utils.stringify(etag),

Utils.stringify(objectName),

Utils.stringify(lastModified),

Utils.stringify(owner),

Utils.stringify(size),

Utils.stringify(storageClass),

Utils.stringify(isLatest),

Utils.stringify(versionId),

Utils.stringify(userMetadata),

Utils.stringify(userTags),

Utils.stringify(checksumAlgorithm),

Utils.stringify(checksumType),

Utils.stringify(restoreStatus),

Utils.stringify(isDir),

Utils.stringify(encodingType));

}

/** Restore status of object information. */

@Root(name = "RestoreStatus", strict = false)

public static class RestoreStatus {

@Element(name = "IsRestoreInProgress", required = false)

private Boolean isRestoreInProgress;

@Element(name = "RestoreExpiryDate", required = false)

private Time.S3Time restoreExpiryDate;

public RestoreStatus(

@Element(name = "IsRestoreInProgress", required = false) Boolean isRestoreInProgress,

@Element(name = "RestoreExpiryDate", required = false) Time.S3Time restoreExpiryDate) {

this.isRestoreInProgress = isRestoreInProgress;

this.restoreExpiryDate = restoreExpiryDate;

}

public Boolean isRestoreInProgress() {

return isRestoreInProgress;

}

public ZonedDateTime restoreExpiryDate() {

return restoreExpiryDate == null ? null : restoreExpiryDate.toZonedDateTime();

}

@Override

public String toString() {

return String.format(

"RestoreStatus{isRestoreInProgress=%s, restoreExpiryDate=%s}",

Utils.stringify(isRestoreInProgress), Utils.stringify(restoreExpiryDate));

}

}

/** User metadata of object information. */

@Root(name = "UserMetadata")

@Convert(UserMetadata.UserMetadataConverter.class)

public static class UserMetadata {

Map<String, String> map;

public UserMetadata() {}

public UserMetadata(@Nonnull Map<String, String> map) {

this.map =

Utils.unmodifiableMap(Objects.requireNonNull(map, "User metadata must not be null"));

}

public Map<String, String> get() {

return map;

}

@Override

public String toString() {

return String.format("UserMetadata{%s}", Utils.stringify(map));

}

/** XML converter user metadata of object information. */

public static class UserMetadataConverter implements Converter<UserMetadata> {

@Override

public UserMetadata read(InputNode node) throws Exception {

Map<String, String> map = new HashMap<>();

while (true) {

InputNode childNode = node.getNext();

if (childNode == null) break;

map.put(childNode.getName(), childNode.getValue());

}

if (map.size() > 0) {

return new UserMetadata(map);

}

return null;

}

@Override

public void write(OutputNode node, UserMetadata metadata) throws Exception {

for (Map.Entry<String, String> entry : metadata.get().entrySet()) {

OutputNode childNode = node.getChild(entry.getKey());

childNode.setValue(entry.getValue());

}

node.commit();

}

}

}

}