org.eclipse.datatools.connectivity
Class PropertiesPersistenceHook

java.lang.Object
  extended by org.eclipse.datatools.connectivity.PropertiesPersistenceHook
All Implemented Interfaces:
IPropertiesPersistenceHook

public class PropertiesPersistenceHook
extends java.lang.Object
implements IPropertiesPersistenceHook


Constructor Summary
PropertiesPersistenceHook()
           
 
Method Summary
 boolean arePropertiesComplete(java.util.Properties props)
          Allows the framework to determine whether or not a connection dialog needs to be displayed prior to opening a connection to the server (e.g.
 java.lang.String getConnectionPropertiesPageID()
          Returns the ID of the property page used to collect the information required to make the property set complete.
 java.util.Properties getPersitentProperties(java.util.Properties props)
          Returns the property set that should be persisted by the framework.
 java.util.Properties populateTransientProperties(java.util.Properties props)
          Returns a property set which includes any transient or derived properties that must be set prior to usage.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertiesPersistenceHook

public PropertiesPersistenceHook()
Method Detail

getPersitentProperties

public java.util.Properties getPersitentProperties(java.util.Properties props)
Description copied from interface: IPropertiesPersistenceHook
Returns the property set that should be persisted by the framework. This allows extensions to prevent certain properties from being persisted by the framework (e.g. authentication information, derived properties, etc.). This method is invoked by the framework just prior to the properties being persisted.

Specified by:
getPersitentProperties in interface IPropertiesPersistenceHook
Parameters:
props - the properties currently associated with a connection profile
Returns:
the properties to be persisted by the framework

populateTransientProperties

public java.util.Properties populateTransientProperties(java.util.Properties props)
Description copied from interface: IPropertiesPersistenceHook
Returns a property set which includes any transient or derived properties that must be set prior to usage. This allows the provider to alter the property set when it is being loaded (e.g. for migration purposes, etc.). This method is invoked by the framework after the properties have been loaded, but prior to them being associated with the connection profile.

Specified by:
populateTransientProperties in interface IPropertiesPersistenceHook
Parameters:
props - the properties loaded from the workspace
Returns:
the modified property set

arePropertiesComplete

public boolean arePropertiesComplete(java.util.Properties props)
Description copied from interface: IPropertiesPersistenceHook
Allows the framework to determine whether or not a connection dialog needs to be displayed prior to opening a connection to the server (e.g. authentication information is missing). This call is not intended to verify that the information will allow for a successful connection, just that the information is complete enough to make an attempt.

Specified by:
arePropertiesComplete in interface IPropertiesPersistenceHook
Parameters:
props - the property set to inspect
Returns:
true if the property set is complete; false if additional information must be specified.

getConnectionPropertiesPageID

public java.lang.String getConnectionPropertiesPageID()
Description copied from interface: IPropertiesPersistenceHook
Returns the ID of the property page used to collect the information required to make the property set complete.

Specified by:
getConnectionPropertiesPageID in interface IPropertiesPersistenceHook
Returns:
the ID of the property page used to collect the missing required properties


Copyright © 2006 -- 2008 Actuate, IBM Corporation, Sybase, Inc. and others. All rights reserved.