com.ionic.sdk.addon.dpapi.device.profile.persistor

Class DeviceProfilePersistorWindows

java.lang.Object

com.ionic.sdk.device.profile.persistor.DeviceProfilePersistorBase

com.ionic.sdk.addon.dpapi.device.profile.persistor.DeviceProfilePersistorWindows

All Implemented Interfaces:

com.ionic.sdk.device.profile.persistor.ProfilePersistor

public final class DeviceProfilePersistorWindows
extends com.ionic.sdk.device.profile.persistor.DeviceProfilePersistorBase

DeviceProfilePersistorWindows brokers access to a persisted Ionic Secure Enrollment Profile, protected using the Windows Data Protection API.

Constructor Summary

Constructors

Constructor and Description
DeviceProfilePersistorWindows() Default constructor for DeviceProfilePersistorDPAPI.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormatVersionOverride()
java.util.List<com.ionic.sdk.device.profile.DeviceProfile>	loadAllProfiles(java.lang.String[] activeProfile) Deserialize Secure Enrollment Profile data from the filesystem.
void	saveAllProfiles(java.util.List<com.ionic.sdk.device.profile.DeviceProfile> profiles, java.lang.String activeProfile) Serialize Secure Enrollment Profile data to the filesystem.
void	setFormatVersionOverride(java.lang.String formatVersionOverride) Set the persistor format version preference.

Methods inherited from class com.ionic.sdk.device.profile.persistor.DeviceProfilePersistorBase

getFilePath, setFilePath

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceProfilePersistorWindows

public DeviceProfilePersistorWindows()
                              throws com.ionic.sdk.error.IonicException

Default constructor for DeviceProfilePersistorDPAPI.

Throws:

com.ionic.sdk.error.IonicException - on instantiation in the context of a non-Windows operating system

Method Detail

getFormatVersionOverride

public java.lang.String getFormatVersionOverride()

Returns:

the persistor format version preference specified by the user

setFormatVersionOverride

public void setFormatVersionOverride(java.lang.String formatVersionOverride)

Set the persistor format version preference. This allows specification of a serialization format different than the default v1.0 format.

Parameters:

formatVersionOverride - the persistor format version preference

loadAllProfiles

public java.util.List<com.ionic.sdk.device.profile.DeviceProfile> loadAllProfiles(java.lang.String[] activeProfile)
                                                                           throws com.ionic.sdk.error.IonicException

Deserialize Secure Enrollment Profile data from the filesystem.

Attempt first to load using the v1.1 DPAPI persistor. If this fails, fallback to the v1.0 persistor.

Specified by:

loadAllProfiles in interface com.ionic.sdk.device.profile.persistor.ProfilePersistor

Overrides:

loadAllProfiles in class com.ionic.sdk.device.profile.persistor.DeviceProfilePersistorBase

Parameters:

activeProfile - an out parameter that will provide the persisted active profile

Returns:

the list of persisted device profiles

Throws:

com.ionic.sdk.error.IonicException - if v1.1 json header is not present, expect ISAGENT_ERROR decrypt or json parsing can throw a sdk exception, expect ISAGENT_PARSEFAILED, ISAGENT_MISSINGVALUE, ISAGENT_RESOURCE_NOT_FOUND, or ISCRYPTO_ERROR

saveAllProfiles

public void saveAllProfiles(java.util.List<com.ionic.sdk.device.profile.DeviceProfile> profiles,
                            java.lang.String activeProfile)
                     throws com.ionic.sdk.error.IonicException

Serialize Secure Enrollment Profile data to the filesystem.

Unless otherwise specified (via setFormatVersionOverride(String)), v1.0 of the Windows persistor is used by default.

To specify v1.1, use setFormatVersionOverride with parameter DeviceProfilePersistorWindowsV11.HEADER_VALUE_VERSION.

Version 1.1 provides for a json type header that describes the file content. The subsequent byte stream is handled by the base implementation, DeviceProfilePersistorBase.

Specified by:

saveAllProfiles in interface com.ionic.sdk.device.profile.persistor.ProfilePersistor

Overrides:

saveAllProfiles in class com.ionic.sdk.device.profile.persistor.DeviceProfilePersistorBase

Parameters:

profiles - change the list of available profiles to this input parameter.

activeProfile - change the active device profile to this input parameter.

Throws:

com.ionic.sdk.error.IonicException - write to disk can throw a ISAGENT_OPENFILE exception saveAllProfilesToJson can throw an ISCRYPTO_ERROR on encrypt.