Ibahagi sa

Offline Publishing

Offline publishing allows a client, after making an initial connection to the rights management service, to generate publishing licenses for newly protected content without making a service call. This is useful for applications that either need to function in an offline mode, or want to avoid making service calls.

Requirements

The offline publishing feature has the following requirements:

  • A supported version of MIP SDK.
  • A user licensed for Microsoft Purview Information Protection. Licensing requirements
  • Internet connectivity for the application to initialize and cache data offline.

Not Supported

The following items aren't supported as part of the offline publishing feature:

  • Active Directory Rights Management Services (AD RMS) is not supported.
  • Double Key Encryption (DKE): The DKE feature must make a service call to fetch the public key at publishing.

Using Offline Publishing with the Protection SDK

Offline publishing requires three steps to enable the application to publish without calling the service:

  1. Enable the offline publishing setting on the profile settings (for the applicable SDK).
  2. Set the template refresh rate. This API sets the validity period for the cached templates.
  3. Call the template retrieval APIs to populate the cache (GetTemplatesAsync() or GetTemplates()).

Using Offline Publishing with the File SDK

The File SDK uses offline publishing by default and requires no additional setup or configuration.

Caching Behavior

An application won't contact the service to get templates until the refresh period has expired or until GetTemplatesAsync() or GetTemplates() are called. If the application is offline and the cache has expired, publishing will fail. The refresh interval should strike a balance between offline usage for end users and ensuring that templates are fresh. For most applications, 24 hours, or less, is ideal.

Examples

The following code snippets are taken from these sample applications:

After completing the following steps, creating a publishing license will occur without making a service call if the templates cache hasn't expired.

C++ Example

Configure ProtectionProfileSettings (C++)

// Initialize ProtectionProfileSettings using MipContext
ProtectionProfile::Settings profileSettings(mMipContext,
    mip::CacheStorageType::OnDiskEncrypted,
    ::make_shared<sample::consent::ConsentDelegateImpl>(),
    std::make_shared<ProtectionProfileObserverImpl>()
);

// Enable Offline Publishing
profileSettings.SetOfflinePublishing(true);

Set the template refresh period (C++)

// Set the template refresh interval
engineSettings.SetTemplateRefreshArgs(std::chrono::hours(24));

Fetch templates to initialize the cache (C++)

auto loadPromise = std::make_shared<std::promise<vector<shared_ptr<mip::TemplateDescriptor>>>>();
std::future<vector<shared_ptr<mip::TemplateDescriptor>>> loadFuture = loadPromise->get_future();
mEngine->GetTemplatesAsync(engineObserver, loadPromise);
auto templates = loadFuture.get();

.NET Example

Configure ProtectionProfileSettings (.NET)

// Initialize ProtectionProfileSettings
var profileSettings = new ProtectionProfileSettings(mipContext, 
                CacheStorageType.OnDisk, 
                new ConsentDelegateImplementation());

// Enable Offline Publishing
profileSettings.OfflinePublishing = true;

Set template refresh period (.NET)

// Initialize ProtectionEngineSettings
var engineSettings = new ProtectionEngineSettings(identity.Email, authDelegate, "", "")
{
    Identity = identity
};

// Set the template refresh interval
engineSettings.TemplateRefreshRate = new TimeSpan(24, 0, 0);

var engine = profile.AddEngine(engineSettings);

Fetch templates to initialize the cache (.NET)

List<TemplateDescriptor> templates = engine.GetTemplates();

Java Example

Configure ProtectionProfileSettings (Java)

ProtectionProfileSettings profileSettings = new ProtectionProfileSettings();
profileSettings.setMipContext(mipContext);
profileSettings.setCacheStorageType(CacheStorageType.ON_DISK);
profileSettings.setConsentDelegate(new ConsentDelegateImplementation());

// Enable Offline Publishing
profileSettings.setOfflinePublishing(true);

Set the template refresh period (Java)

ProtectionEngineSettings engineSettings = new ProtectionEngineSettings(identity.getEmail(), authDelegate, "", "");
engineSettings.setIdentity(identity);

// Set the template refresh interval in hours
engineSettings.setTemplateRefreshRate(Duration.ofHours(24));

Fetch templates to initialize the cache (Java)

List<TemplateDescriptor> templates = engine.getTemplates();
  • Last updated on