/*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2015-2016 ForgeRock AS.
*/
package org.forgerock.openam.core.rest.devices.services;

import org.forgerock.openam.core.rest.devices.DeviceSerialisation;

/**
 * Provides all necessary configuration information at a realm-wide level to device-based
 * authentication modules underneath it.
 */
public interface DeviceService {

    /**
     * Retrieve this realm's attribute name, under which the JSON configuration is stored.
     *
     * @return Plaintext attribute name.
     */
    String getConfigStorageAttributeName();

    /**
     * Returns the strategy used for storing devices as profile attributes.
     *
     * @return the device profile storage strategy.
     */
    DeviceSerialisation getDeviceSerialisationStrategy();

}
