001/*
002 * This library is part of OpenCms -
003 * The Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.db.storage.s3;
029
030import java.time.Instant;
031import java.util.Objects;
032
033/**
034 * Metadata returned by an S3 object listing.<p>
035 */
036public final class CmsS3ObjectMetadata {
037
038    /** The object key. */
039    private final String m_key;
040
041    /** The object last-modified timestamp. */
042    private final Instant m_lastModified;
043
044    /** The object length. */
045    private final long m_length;
046
047    /** The opaque object revision, usually the ETag. */
048    private final String m_revision;
049
050    /**
051     * Creates object metadata.<p>
052     *
053     * @param key the object key
054     * @param length the object length
055     * @param lastModified the last-modified timestamp, or {@code null}
056     * @param revision the opaque revision, or {@code null}
057     */
058    public CmsS3ObjectMetadata(String key, long length, Instant lastModified, String revision) {
059
060        m_key = Objects.requireNonNull(key, "key");
061        if (length < 0) {
062            throw new IllegalArgumentException("The S3 object length must not be negative.");
063        }
064        m_length = length;
065        m_lastModified = lastModified;
066        m_revision = revision;
067    }
068
069    /** Returns the object key. */
070    public String getKey() {
071
072        return m_key;
073    }
074
075    /** Returns the last-modified timestamp, or {@code null}. */
076    public Instant getLastModified() {
077
078        return m_lastModified;
079    }
080
081    /** Returns the object length. */
082    public long getLength() {
083
084        return m_length;
085    }
086
087    /** Returns the opaque object revision, or {@code null}. */
088    public String getRevision() {
089
090        return m_revision;
091    }
092
093}