/*************************************************************************
* Copyright 2009-2012 Eucalyptus Systems, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*
* Please contact Eucalyptus Systems, Inc., 6755 Hollister Ave., Goleta
* CA 93117, USA or visit http://www.eucalyptus.com/licenses/ if you need
* additional information or have any questions.
*
* This file may incorporate work covered under the following copyright
* and permission notice:
*
* Software License Agreement (BSD License)
*
* Copyright (c) 2008, Regents of the University of California
* All rights reserved.
*
* Redistribution and use of this software in source and binary forms,
* with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE. USERS OF THIS SOFTWARE ACKNOWLEDGE
* THE POSSIBLE PRESENCE OF OTHER OPEN SOURCE LICENSED MATERIAL,
* COPYRIGHTED MATERIAL OR PATENTED MATERIAL IN THIS SOFTWARE,
* AND IF ANY SUCH MATERIAL IS DISCOVERED THE PARTY DISCOVERING
* IT MAY INFORM DR. RICH WOLSKI AT THE UNIVERSITY OF CALIFORNIA,
* SANTA BARBARA WHO WILL THEN ASCERTAIN THE MOST APPROPRIATE REMEDY,
* WHICH IN THE REGENTS' DISCRETION MAY INCLUDE, WITHOUT LIMITATION,
* REPLACEMENT OF THE CODE SO IDENTIFIED, LICENSING OF THE CODE SO
* IDENTIFIED, OR WITHDRAWAL OF THE CODE CAPABILITY TO THE EXTENT
* NEEDED TO COMPLY WITH ANY SUCH LICENSES OR RIGHTS.
************************************************************************/
package com.eucalyptus.walrus.entities;
import static com.eucalyptus.upgrade.Upgrades.Version.*;
import java.util.concurrent.Callable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.PersistenceContext;
import javax.persistence.PreUpdate;
import javax.persistence.Table;
import org.apache.log4j.Logger;
import com.eucalyptus.configurable.ConfigurableClass;
import com.eucalyptus.configurable.ConfigurableField;
import com.eucalyptus.entities.AbstractPersistent;
import com.eucalyptus.entities.Transactions;
import com.eucalyptus.upgrade.Upgrades;
import com.eucalyptus.upgrade.Upgrades.PreUpgrade;
import com.eucalyptus.walrus.WalrusBackend;
import com.eucalyptus.walrus.util.WalrusProperties;
import groovy.sql.Sql;
@Entity
@PersistenceContext(name = "eucalyptus_walrus")
@Table(name = "walrus_info")
@ConfigurableClass(root = "walrusbackend", description = "WalrusBackend backend configuration.", deferred = true)
public class WalrusInfo extends AbstractPersistent {
@Column(name = "walrus_name", unique = true)
private String name;
@ConfigurableField(description = "Path to buckets storage", displayName = "Buckets Path")
@Column(name = "storage_dir")
private String storageDir;
@Column(name = "storage_max_buckets_per_user")
private Integer storageMaxBucketsPerAccount;
@Column(name = "storage_max_bucket_size_mb")
private Integer storageMaxBucketSizeInMB;
@Column(name = "storage_snapshot_size_gb")
private Integer storageMaxTotalSnapshotSizeInGb;
@Column(name = "storage_walrus_bucket_names_require_compliance")
private Boolean bucketNamesRequireDnsCompliance;
private static final Logger LOG = Logger.getLogger(WalrusInfo.class);
public WalrusInfo() {}
public WalrusInfo(final String name, final String storageDir, final Integer storageMaxBucketsPerAccount, final Integer storageMaxBucketSizeInMB,
final Integer storageMaxTotalSnapshotSizeInGb, final Boolean bucketNamesRequireDnsCompliance) {
this.name = name;
this.storageDir = storageDir;
this.storageMaxBucketsPerAccount = storageMaxBucketsPerAccount;
this.storageMaxBucketSizeInMB = storageMaxBucketSizeInMB;
this.storageMaxTotalSnapshotSizeInGb = storageMaxTotalSnapshotSizeInGb;
this.bucketNamesRequireDnsCompliance = bucketNamesRequireDnsCompliance;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getStorageDir() {
return storageDir;
}
public void setStorageDir(final String storageDir) {
this.storageDir = storageDir;
}
public Integer getStorageMaxBucketsPerAccount() {
return storageMaxBucketsPerAccount;
}
public void setStorageMaxBucketsPerAccount(final Integer storageMaxBucketsPerAccount) {
this.storageMaxBucketsPerAccount = storageMaxBucketsPerAccount;
}
public Integer getStorageMaxBucketSizeInMB() {
return storageMaxBucketSizeInMB;
}
public void setStorageMaxBucketSizeInMB(final Integer storageMaxBucketSizeInMB) {
this.storageMaxBucketSizeInMB = storageMaxBucketSizeInMB;
}
public Integer getStorageMaxTotalSnapshotSizeInGb() {
return storageMaxTotalSnapshotSizeInGb;
}
public void setStorageMaxTotalSnapshotSizeInGb(Integer storageMaxTotalSnapshotSizeInGb) {
this.storageMaxTotalSnapshotSizeInGb = storageMaxTotalSnapshotSizeInGb;
}
public Boolean getBucketNamesRequireDnsCompliance() {
return bucketNamesRequireDnsCompliance;
}
public void setBucketNamesRequireDnsCompliance(Boolean bucketNamesRequireDnsCompliance) {
this.bucketNamesRequireDnsCompliance = bucketNamesRequireDnsCompliance;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((name == null) ? 0 : name.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
WalrusInfo other = (WalrusInfo) obj;
if (name == null) {
if (other.name != null)
return false;
} else if (!name.equals(other.name))
return false;
return true;
}
@PreUpdate
public void preUpdateChecks() {
if (this.getBucketNamesRequireDnsCompliance() == null) {
this.setBucketNamesRequireDnsCompliance(WalrusProperties.BUCKET_NAMES_REQUIRE_DNS_COMPLIANCE);
}
}
private static WalrusInfo generateDefault() {
return new WalrusInfo(WalrusProperties.NAME, WalrusProperties.bucketRootDirectory, WalrusProperties.MAX_BUCKETS_PER_ACCOUNT,
(int) (WalrusProperties.MAX_BUCKET_SIZE / WalrusProperties.M), WalrusProperties.MAX_TOTAL_SNAPSHOT_SIZE,
WalrusProperties.BUCKET_NAMES_REQUIRE_DNS_COMPLIANCE);
}
public static WalrusInfo getWalrusInfo() {
WalrusInfo walrusInfo = null;
try {
walrusInfo = Transactions.find(new WalrusInfo());
} catch (Exception e) {
LOG.warn("Walrus configuration not found. Loading defaults.");
try {
walrusInfo = Transactions.saveDirect(generateDefault());
} catch (Exception e1) {
try {
walrusInfo = Transactions.find(new WalrusInfo());
} catch (Exception e2) {
LOG.warn("Failed to persist and retrieve WalrusInfo entity");
}
}
}
if (walrusInfo == null) {
walrusInfo = generateDefault();
}
return walrusInfo;
}
@PreUpgrade( value = WalrusBackend.class, since = v5_0_0 )
public static class WalrusInfoPreUpgrade500 implements Callable<Boolean> {
@Override
public Boolean call( ) throws Exception {
Sql sql = null;
try {
sql = Upgrades.DatabaseFilters.NEWVERSION.getConnection( "eucalyptus_walrus" );
sql.execute( "alter table walrus_info drop column if exists storage_walrus_total_capacity" );
return true;
} catch ( Exception ex ) {
LOG.error( "Error deleting column storage_walrus_total_capacity for walrus_info", ex );
return false;
} finally {
if ( sql != null ) {
sql.close( );
}
}
}
}
}