java.com.ionic.sdk.agent.cipher.file.cover.FileCryptoCoverPageServicesInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ionic-sdk Show documentation

The Ionic Java SDK provides an easy-to-use interface to the Ionic Platform.

There is a newer version: 2.9.0

package com.ionic.sdk.agent.cipher.file.cover;

import com.ionic.sdk.agent.cipher.file.data.FileType;
import com.ionic.sdk.error.IonicException;

/**
 * Cover Page Service provider interface class used by the various cipher implementations.
 * 
 * This interface allows for a consumer to override the default cover page provider with their own implementation.
 */
public abstract class FileCryptoCoverPageServicesInterface {

    /**
     * Get the requested cover page.
     * 

     * This function is called by the file ciphers to retrieve a cover page when creating your own
     * implementation of FileCryptoCoverPageServicesInterface.
     *
     * @param fileType the {@link FileType} requested
     * @return the bytes of the cover page
     * @throws IonicException on failure to fetch cover page of the requested type
     */
    public abstract byte[] getCoverPage(FileType fileType) throws IonicException;

    /**
     * Get the requested access denied page.
     * 
     * This function is called by the file ciphers to retrieve an access denied page when creating your own
     * implementation of FileCryptoCoverPageServicesInterface.
     *
     * @param fileType the {@link FileType} requested
     * @return the bytes of the access denied page
     * @throws IonicException on failure to fetch access denied page of the requested type
     */
    public abstract byte[] getAccessDeniedPage(FileType fileType) throws IonicException;
}