All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • net.sourceforge.squirrel_sql.client.gui.db.SQLAlias Maven / Gradle / Ivy

    package net.sourceforge.squirrel_sql.client.gui.db;
/*
 * Copyright (C) 2001-2003 Colin Bell
 * [email protected]
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANT_Y; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
import java.beans.PropertyChangeListener;
import java.io.Serializable;

import net.sourceforge.squirrel_sql.fw.id.IIdentifier;
import net.sourceforge.squirrel_sql.fw.persist.ValidationException;
import net.sourceforge.squirrel_sql.fw.sql.ISQLAlias;
import net.sourceforge.squirrel_sql.fw.sql.SQLDriverProperty;
import net.sourceforge.squirrel_sql.fw.sql.SQLDriverPropertyCollection;
import net.sourceforge.squirrel_sql.fw.util.PropertyChangeReporter;
import net.sourceforge.squirrel_sql.fw.util.StringManager;
import net.sourceforge.squirrel_sql.fw.util.StringManagerFactory;
import net.sourceforge.squirrel_sql.fw.util.Utilities;

/**
 * This represents a Database alias which is a description of the means
 * required to connect to a JDBC complient database.
    
 * This class is a JavaBean.
 *
 * @author Colin Bell
 */
@SuppressWarnings("serial")
public class SQLAlias implements Cloneable, Serializable, ISQLAliasExt, Comparable
{
    /** Internationalized strings for this class. */
   private static final StringManager s_stringMgr =
      StringManagerFactory.getStringManager(SQLAlias.class);


   private interface IStrings
   {
      String ERR_BLANK_NAME = s_stringMgr.getString("SQLAlias.error.blankname");
      String ERR_BLANK_DRIVER = s_stringMgr.getString("SQLAlias.error.blankdriver");
      String ERR_BLANK_URL = s_stringMgr.getString("SQLAlias.error.blankurl");
   }

   private interface IPropNames extends ISQLAlias.IPropertyNames
   {
      // Empty block.
   }

   /** The IIdentifier that uniquely identifies this object. */
   private IIdentifier _id;

   /** The name of this alias. */
   private String _name;

   /**
    * The IIdentifier that identifies the ISQLDriver
    * that this ISQLAlias uses.
    */
   private IIdentifier _driverId;

   /** The URL required to access the database. */
   private String _url;

   /** Name of user for connection. */
   private String _userName;

   /** Password of user for connection. */
   private String _password;

   /** true if this alias should be logged on automatically. */
   private boolean _autoLogon;

   /** Should this alias be connected when the application is started up. */
   private boolean _connectAtStartup;

   /** If true then use drver properties. */
   private boolean _useDriverProperties = false;

   /** Collection of SQLDriverProperty objects for this alias. */
   private SQLDriverPropertyCollection _driverProps = new SQLDriverPropertyCollection();

   /** Object to handle property change events. */
   private transient PropertyChangeReporter _propChgReporter;

   private SQLAliasSchemaProperties _schemaProperties = new SQLAliasSchemaProperties();

   private SQLAliasColorProperties _colorProperties = new SQLAliasColorProperties();
   
   private SQLAliasConnectionProperties _connectionProperties = new SQLAliasConnectionProperties();
   
   /**
    * Default ctor.
    */
   public SQLAlias()
   {
   }

   /**
    * Ctor specifying the identifier.
    *
    * @param	id	Uniquely identifies this object.
    */
   public SQLAlias(IIdentifier id)
   {
      _id = id;
      _name = "";
      _driverId = null;
      _url = "";
      _userName = "";
      _password = "";
   }

   /**
    * Assign data from the passed ISQLAlias to this one.
    *
    * This Alias becomes a clone of rhs.
    *
    * @param	rhs	 ISQLAlias to copy data from.
    *
    * @param b
    * @exception	ValidationException
    *				Thrown if an error occurs assigning data from
    *				rhs.
    */
   public synchronized void assignFrom(SQLAlias rhs, boolean withIdentifier)
      throws ValidationException
   {
      if(withIdentifier)
      {
         setIdentifier(rhs.getIdentifier());
      }
      
      setName(rhs.getName());
      setDriverIdentifier(rhs.getDriverIdentifier());
      setUrl(rhs.getUrl());
      setUserName(rhs.getUserName());
      setPassword(rhs.getPassword());
      setAutoLogon(rhs.isAutoLogon());
      setUseDriverProperties(rhs.getUseDriverProperties());
      setDriverProperties(rhs.getDriverPropertiesClone());
      _schemaProperties = 
          (SQLAliasSchemaProperties) Utilities.cloneObject(rhs._schemaProperties, 
                                                           getClass().getClassLoader());
      _colorProperties = 
      	(SQLAliasColorProperties) Utilities.cloneObject(rhs._colorProperties, getClass().getClassLoader());
      
      _connectionProperties = new SQLAliasConnectionProperties();
      SQLAliasConnectionProperties rhsConnProps = rhs.getConnectionProperties();
		_connectionProperties.setEnableConnectionKeepAlive(rhsConnProps.isEnableConnectionKeepAlive());
		_connectionProperties.setKeepAliveSleepTimeSeconds(rhsConnProps.getKeepAliveSleepTimeSeconds());
		_connectionProperties.setKeepAliveSqlStatement(rhsConnProps.getKeepAliveSqlStatement());
   }

   /**
    * Returns true if this objects is equal to the passed one. Two
    * ISQLAlias objects are considered equal if they have the same
    * identifier.
    */
   public boolean equals(Object rhs)
   {
      boolean rc = false;
      if (rhs != null && rhs.getClass().equals(getClass()))
      {
         rc = ((ISQLAlias)rhs).getIdentifier().equals(getIdentifier());
      }
      return rc;
   }

   /**
    * Returns a hash code value for this object.
    */
   public synchronized int hashCode()
   {
      return getIdentifier().hashCode();
   }

   /**
    * Returns the name of this ISQLAlias.
    */
   public String toString()
   {
      return getName();
   }

   /**
    * Compare this SQLAlias to another object. If the passed object
    * is a SQLAlias, then the getName() functions of the two
    * SQLAlias objects are used to compare them. Otherwise, it throws a
    * ClassCastException (as SQLAlias objects are comparable only to
    * other SQLAlias objects).
    */
   public int compareTo(Object rhs)
   {
      return _name.compareTo(((ISQLAlias)rhs).getName());
   }

   public void addPropertyChangeListener(PropertyChangeListener listener)
   {
      getPropertyChangeReporter().addPropertyChangeListener(listener);
   }

   public void removePropertyChangeListener(PropertyChangeListener listener)
   {
      getPropertyChangeReporter().removePropertyChangeListener(listener);
   }

   /**
    * Returns true if this object is valid.
    
    * Implementation for IPersistable.
    */
   public synchronized boolean isValid()
   {
      return _name != null
                 && _name.length() > 0 
                 && _driverId != null
                 && _url != null
                 && _url.length() > 0;
   }

   public IIdentifier getIdentifier()
   {
      return _id;
   }

   public String getName()
   {
      return _name;
   }

   public IIdentifier getDriverIdentifier()
   {
      return _driverId;
   }

   public String getUrl()
   {
      return _url;
   }

   public String getUserName()
   {
      return _userName;
   }

   /**
    * Retrieve the saved password.
    *
    * @return		The saved password.
    */
   public String getPassword()
   {
      return _password;
   }

   /**
    * Set the password for this alias.
    *
    * @param	password	The new password.
    */
   public void setPassword(String password)
   {
      String data = getString(password);
      if (_password != data)
      {
         final String oldValue = _password;
         _password = data;
         getPropertyChangeReporter().firePropertyChange(IPropNames.PASSWORD,
                                    oldValue, _password);
      }
   }

   /**
    * Should this alias be logged on automatically.
    *
    * @return	true is this alias should be logged on automatically
    * 			else false.
    */
   public boolean isAutoLogon()
   {
      return _autoLogon;
   }

   /**
    * Set whether this alias should be logged on automatically.
    *
    * @param	value	true if alias should be autologged on
    * 					else falsetrue if this alias should be connected when the
    *			application is started up.
    */
   public boolean isConnectAtStartup()
   {
      return _connectAtStartup;
   }

   /**
    * Set whether alias should be connected when the application is started up.
    *
    * @param	value	true if alias should be connected when the
    *					application is started up.
    */
   public void setConnectAtStartup(boolean value)
   {
      if (_connectAtStartup != value)
      {
         _connectAtStartup = value;
         getPropertyChangeReporter().firePropertyChange(IPropNames.CONNECT_AT_STARTUP,
                                    !_connectAtStartup, _connectAtStartup);
      }
   }

   /**
    * Returns whether this alias uses driver properties.
    */
   public boolean getUseDriverProperties()
   {
      return _useDriverProperties;
   }

   public void setIdentifier(IIdentifier id)
   {
      _id = id;
   }

   public void setName(String name) throws ValidationException
   {
      String data = getString(name);
      if (data.length() == 0)
      {
         throw new ValidationException(IStrings.ERR_BLANK_NAME);
      }
      if (_name != data)
      {
         final String oldValue = _name;
         _name = data;
         getPropertyChangeReporter().firePropertyChange(IPropNames.NAME,
                                    oldValue, _name);
      }
   }

   public void setDriverIdentifier(IIdentifier data)
      throws ValidationException
   {
      if (data == null)
      {
         throw new ValidationException(IStrings.ERR_BLANK_DRIVER);
      }
      if (_driverId != data)
      {
         final IIdentifier oldValue = _driverId;
         _driverId = data;
         getPropertyChangeReporter().firePropertyChange(IPropNames.DRIVER,
                                    oldValue, _driverId);
      }
   }

   public void setUrl(String url) throws ValidationException
   {
      String data = getString(url);
      if (data.length() == 0)
      {
         throw new ValidationException(IStrings.ERR_BLANK_URL);
      }
      if (_url != data)
      {
         final String oldValue = _url;
         _url = data;
         getPropertyChangeReporter().firePropertyChange(IPropNames.URL,
                                       oldValue, _url);
      }
   }

   public void setUserName(String userName)
   {
      String data = getString(userName);
      if (_userName != data)
      {
         final String oldValue = _userName;
         _userName = data;
         getPropertyChangeReporter().firePropertyChange(IPropNames.USER_NAME,
                                    oldValue, _userName);
      }
   }

   public void setUseDriverProperties(boolean value)
   {
      if (_useDriverProperties != value)
      {
         final boolean oldValue = _useDriverProperties;
         _useDriverProperties = value;
         getPropertyChangeReporter().firePropertyChange(IPropNames.USE_DRIVER_PROPERTIES,
                                    oldValue, _useDriverProperties);
      }
   }

   /**
    * Retrieve a copy of the SQL driver properties.
    *
    * @return	the SQL driver properties.
    */
   public synchronized SQLDriverPropertyCollection getDriverPropertiesClone()
   {
      final int count = _driverProps.size();
      SQLDriverProperty[] newar = new SQLDriverProperty[count];
      for (int i = 0; i < count; ++i)
      {
         newar[i] = (SQLDriverProperty)_driverProps.getDriverProperty(i).clone();
      }
      SQLDriverPropertyCollection coll = new SQLDriverPropertyCollection();
      coll.setDriverProperties(newar);
      return coll;
   }

   public synchronized void setDriverProperties(SQLDriverPropertyCollection value)
   {
      _driverProps.clear();
      if (value != null)
      {
         synchronized (value)
         {
            final int count = value.size();
            SQLDriverProperty[] newar = new SQLDriverProperty[count];
            for (int i = 0; i < count; ++i)
            {
               newar[i] = (SQLDriverProperty)value.getDriverProperty(i).clone();

            }
            _driverProps.setDriverProperties(newar);
         }
      }
   }

   private synchronized PropertyChangeReporter getPropertyChangeReporter()
   {
      if (_propChgReporter == null)
      {
         _propChgReporter = new PropertyChangeReporter(this);
      }
      return _propChgReporter;
   }

   private String getString(String data)
   {
      return data != null ? data.trim() : "";
   }


   public SQLAliasSchemaProperties getSchemaProperties()
   {
      return _schemaProperties;      
   }

   /**
    * @see net.sourceforge.squirrel_sql.client.gui.db.ISQLAliasExt#setSchemaProperties(net.sourceforge.squirrel_sql.client.gui.db.SQLAliasSchemaProperties)
    */
   public void setSchemaProperties(SQLAliasSchemaProperties schemaProperties)
   {
      _schemaProperties = schemaProperties;
   }

	@Override
	public SQLAliasColorProperties getColorProperties()
	{
		return _colorProperties;
	}

	@Override
	public void setColorProperties(SQLAliasColorProperties colorProperties)
	{
		_colorProperties = colorProperties;
	}

	@Override
	public SQLAliasConnectionProperties getConnectionProperties()
	{
		return _connectionProperties;
	}

	@Override
	public void setConnectionProperties(SQLAliasConnectionProperties connectionProperties)
	{
		_connectionProperties = connectionProperties;
	}

}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy