/*************************************************************************
* Copyright 2009-2014 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 edu.ucsb.eucalyptus.cloud.entities;
import java.util.NoSuchElementException;
import java.util.UUID;
import java.util.concurrent.TimeUnit;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.PersistenceContext;
import javax.persistence.Table;
import org.apache.http.conn.util.InetAddressUtils;
import org.apache.log4j.Logger;
import com.eucalyptus.configurable.ConfigurableClass;
import com.eucalyptus.configurable.ConfigurableField;
import com.eucalyptus.configurable.ConfigurableProperty;
import com.eucalyptus.configurable.ConfigurablePropertyException;
import com.eucalyptus.configurable.PropertyChangeListener;
import com.eucalyptus.entities.AbstractPersistent;
import com.eucalyptus.entities.Entities;
import com.eucalyptus.entities.TransactionResource;
import com.eucalyptus.util.DNSProperties;
import com.google.common.base.Supplier;
import com.google.common.base.Suppliers;
import com.google.common.net.InternetDomainName;
@Entity
@PersistenceContext( name = "eucalyptus_general" )
@Table( name = "system_info" )
@ConfigurableClass( root = "system.dns", description = "Basic system configuration." )
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
public class SystemConfiguration extends AbstractPersistent {
private static Logger LOG = Logger.getLogger( SystemConfiguration.class );
public static class SystemConfigurationNameServerChangeListener implements PropertyChangeListener {
@Override
public void fireChange( ConfigurableProperty t, Object newValue ) throws ConfigurablePropertyException {
try {
if ( newValue instanceof String ) {
String value = ((String) newValue);
// Only validate if not empty.. Empty is also valid
if ( !value.equals("") ) {
// Were we provided a coma-delimited list or a single entry
if ( value.contains(",") ) {
// Validate every hosts.
for ( final String entry : value.split(",") ) {
if ( !InetAddressUtils.isIPv4Address( entry ) ) {
throw new ConfigurablePropertyException("Malformed domain name server list");
}
}
} else {
if ( !InetAddressUtils.isIPv4Address( value ) ) {
throw new ConfigurablePropertyException("Malformed domain name server list");
}
}
}
}
} catch ( final Exception e ) {
throw new ConfigurablePropertyException("Malformed domain name server list");
}
}
}
public static final class DomainNamePropertyChangeListener implements PropertyChangeListener {
@Override
public void fireChange( final ConfigurableProperty t, final Object newValue ) throws ConfigurablePropertyException {
if ( newValue == null || !InternetDomainName.isValid( String.valueOf( newValue ) ) ) {
throw new ConfigurablePropertyException( "Invalid name ("+newValue+")" );
}
}
}
private static final Supplier<SystemConfiguration> systemConfigurationSupplier = Suppliers.memoizeWithExpiration(
SystemConfigurationSupplier.INSTANCE,
5,
TimeUnit.SECONDS
);
@ConfigurableField( description = "Unique ID of this cloud installation.", readonly = false )
@Column( name = "system_registration_id" )
private String registrationId;
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
@ConfigurableField( description = "Domain name to use for DNS.",
changeListener = DomainNamePropertyChangeListener.class,
initial = DNSProperties.LOCALHOST_DOMAIN )
@Column( name = "dns_domain" )
private String dnsDomain;
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
@ConfigurableField( description = "Nameserver hostname.", initial = DNSProperties.LOCALHOST_NS )
@Column( name = "nameserver" )
private String nameserver;
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
@ConfigurableField( description = "Nameserver ip address.",
changeListener = SystemConfigurationNameServerChangeListener.class,
initial = DNSProperties.LOCALHOST_IP )
@Column( name = "ns_address" )
private String nameserverAddress;
public SystemConfiguration( ) {
}
public SystemConfiguration( final String dnsDomain, final String nameserver, final String nameserverAddress ) {
this.dnsDomain = dnsDomain;
this.nameserver = nameserver;
this.nameserverAddress = nameserverAddress;
}
public String getRegistrationId( ) {
return registrationId;
}
public void setRegistrationId( final String registrationId ) {
this.registrationId = registrationId;
}
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
public String getDnsDomain( ) {
return dnsDomain;
}
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
public void setDnsDomain( String dnsDomain ) {
this.dnsDomain = dnsDomain;
}
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
public String getNameserver( ) {
return nameserver;
}
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
public void setNameserver( String nameserver ) {
this.nameserver = nameserver;
}
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
public String getNameserverAddress( ) {
return nameserverAddress;
}
@Deprecated //GRZE: this class will FINALLY be superceded by new DNS support in 3.4: DO NOT USE IT!
public void setNameserverAddress( String nameserverAddress ) {
this.nameserverAddress = nameserverAddress;
}
@Override
public int hashCode( ) {
final int prime = 31;
int result = 1;
result = prime * result + ( ( registrationId == null ) ? 0 : registrationId.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;
SystemConfiguration other = ( SystemConfiguration ) obj;
if ( registrationId == null ) {
if ( other.registrationId != null ) return false;
} else if ( !registrationId.equals( other.registrationId ) ) return false;
return true;
}
public static SystemConfiguration getSystemConfiguration() {
return systemConfigurationSupplier.get( );
}
private enum SystemConfigurationSupplier implements Supplier<SystemConfiguration> {
INSTANCE;
@Override
public SystemConfiguration get() {
try {
try ( final TransactionResource db = Entities.transactionFor( SystemConfiguration.class ) ) {
SystemConfiguration conf = Entities.uniqueResult( new SystemConfiguration());
SystemConfiguration.validateSystemConfiguration( conf );
db.commit( );
return conf;
} catch ( NoSuchElementException e ) {
try ( final TransactionResource db = Entities.transactionFor( SystemConfiguration.class ) ) {
LOG.warn("Failed to get system configuration. Loading defaults.");
SystemConfiguration conf = SystemConfiguration.validateSystemConfiguration(null);
Entities.persist( conf );
db.commit( );
return conf;
}
}
} catch (Exception t) {
LOG.error("Unable to get system configuration.", t);
return validateSystemConfiguration(null);
}
}
}
private static SystemConfiguration validateSystemConfiguration(SystemConfiguration s) {
SystemConfiguration sysConf = s != null ? s : new SystemConfiguration();
if( sysConf.getRegistrationId() == null ) {
sysConf.setRegistrationId( UUID.randomUUID().toString() );
}
if(sysConf.getDnsDomain() == null) {
sysConf.setDnsDomain(DNSProperties.DOMAIN);
}
if(sysConf.getNameserver() == null) {
sysConf.setNameserver(DNSProperties.NS_HOST);
}
if(sysConf.getNameserverAddress() == null) {
sysConf.setNameserverAddress(DNSProperties.NS_IP);
}
return sysConf;
}
}