/**********************************************************************
Copyright (c) 2011 Andy Jefferson and others. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Contributors:
   ...
**********************************************************************/
package org.datanucleus.store;

/**
 * Interface implemented by any StoreManager that wants to provide a hook to encrypt field data
 * prior to persistence.
 */
public interface EncryptionAwareStoreManager
{
    /**
     * Method to set the encryption provider for persistent data.
     * When a provider is set on the StoreManager, any persist (insert/update) or retrieval will be intercepted.
     * This should be called before the StoreManager is used for persistence/retrieval.
     * @param provider The provider to use.
     */
    void setEncryptionProvider(PersistenceEncryptionProvider provider);
}