File	Doc	Category	Size	Date	Package
IMountService.java	API Doc	Android 5.1 API	69447	Thu Mar 12 22:22:10 GMT 2015	android.os.storage

IMountService

Fields Summary
static final int	ENCRYPTION_STATE_NONE The volume is not encrypted.
static final int	ENCRYPTION_STATE_OK The volume has been encrypted succesfully.
static final int	ENCRYPTION_STATE_ERROR_UNKNOWN The volume is in a bad state.
static final int	ENCRYPTION_STATE_ERROR_INCOMPLETE Encryption is incomplete
static final int	ENCRYPTION_STATE_ERROR_INCONSISTENT Encryption is incomplete and irrecoverable
static final int	ENCRYPTION_STATE_ERROR_CORRUPT Underlying data is corrupt

Constructors Summary

Methods Summary
public int	changeEncryptionPassword(int type, java.lang.String password) Changes the encryption password.
public void	clearPassword() Securely clear password from vold
public int	createSecureContainer(java.lang.String id, int sizeMb, java.lang.String fstype, java.lang.String key, int ownerUid, boolean external)
public int	decryptStorage(java.lang.String password) Decrypts any encrypted volumes.
public int	destroySecureContainer(java.lang.String id, boolean force)
public int	encryptStorage(int type, java.lang.String password) Encrypts storage.
public int	finalizeSecureContainer(java.lang.String id)
public void	finishMediaUpdate() Call into MountService by PackageManager to notify that its done processing the media status update request.
public int	fixPermissionsSecureContainer(java.lang.String id, int gid, java.lang.String filename)
public int	formatVolume(java.lang.String mountPoint) Format external storage given a mount point. Returns an int consistent with MountServiceResultCode
public int	getEncryptionState() Determines the encryption state of the volume. return a numerical value. See {@code ENCRYPTION_STATE_*} for possible values.
public java.lang.String	getField(java.lang.String field) Gets a field from the crypto header. param field field to get return contents of field
public java.lang.String	getMountedObbPath(java.lang.String rawPath) Gets the path to the mounted Opaque Binary Blob (OBB).
public java.lang.String	getPassword() Get password from vold return password or empty string
public int	getPasswordType() Determines the type of the encryption password return PasswordType
public java.lang.String	getSecureContainerFilesystemPath(java.lang.String cid) Gets the path on the filesystem for the ASEC container itself. param cid ASEC container ID return path to filesystem or {@code null} if it's not found throws RemoteException
public java.lang.String[]	getSecureContainerList() Gets an Array of currently known secure container IDs
public java.lang.String	getSecureContainerPath(java.lang.String id)
public int[]	getStorageUsers(java.lang.String path) Returns an array of pids with open files on the specified path.
public StorageVolume[]	getVolumeList() Returns list of all mountable volumes.
public java.lang.String	getVolumeState(java.lang.String mountPoint) Gets the state of a volume via its mountpoint.
public boolean	isExternalStorageEmulated() Returns whether or not the external storage is emulated.
public boolean	isObbMounted(java.lang.String rawPath) Checks whether the specified Opaque Binary Blob (OBB) is mounted somewhere.
public boolean	isSecureContainerMounted(java.lang.String id)
public boolean	isUsbMassStorageConnected() Returns true if a USB mass storage host is connected
public boolean	isUsbMassStorageEnabled() Returns true if a USB mass storage host is enabled (media is shared)
public long	lastMaintenance() Report the time of the last maintenance operation such as fstrim. return Timestamp of the last maintenance operation, in the System.currentTimeMillis() time base throws RemoteException
public int	mkdirs(java.lang.String callingPkg, java.lang.String path) Ensure that all directories along given path exist, creating parent directories as needed. Validates that given path is absolute and that it contains no relative "." or ".." paths or symlinks. Also ensures that path belongs to a volume managed by vold, and that path is either external storage data or OBB directory belonging to calling app.
public void	mountObb(java.lang.String rawPath, java.lang.String canonicalPath, java.lang.String key, IObbActionListener token, int nonce) Mounts an Opaque Binary Blob (OBB) with the specified decryption key and only allows the calling process's UID access to the contents. MountService will call back to the supplied IObbActionListener to inform it of the terminal state of the call.
public int	mountSecureContainer(java.lang.String id, java.lang.String key, int ownerUid, boolean readOnly)
public int	mountVolume(java.lang.String mountPoint) Mount external storage at given mount point. Returns an int consistent with MountServiceResultCode
public void	registerListener(IMountServiceListener listener) Registers an IMountServiceListener for receiving async notifications.
public int	renameSecureContainer(java.lang.String oldId, java.lang.String newId)
public int	resizeSecureContainer(java.lang.String id, int sizeMb, java.lang.String key)
public void	runMaintenance() Kick off an immediate maintenance operation throws RemoteException
public void	setField(java.lang.String field, java.lang.String contents) Set a field in the crypto header. param field field to set param contents contents to set in field
public void	setUsbMassStorageEnabled(boolean enable) Enables / disables USB mass storage. The caller should check actual status of enabling/disabling USB mass storage via StorageEventListener.
public void	shutdown(IMountShutdownObserver observer) Shuts down the MountService and gracefully unmounts all external media. Invokes call back once the shutdown is complete.
public void	unmountObb(java.lang.String rawPath, boolean force, IObbActionListener token, int nonce) Unmounts an Opaque Binary Blob (OBB). When the force flag is specified, any program using it will be forcibly killed to unmount the image. MountService will call back to the supplied IObbActionListener to inform it of the terminal state of the call.
public int	unmountSecureContainer(java.lang.String id, boolean force)
public void	unmountVolume(java.lang.String mountPoint, boolean force, boolean removeEncryption) Safely unmount external storage at given mount point. The unmount is an asynchronous operation. Applications should register StorageEventListener for storage related status changes. param mountPoint the mount point param force whether or not to forcefully unmount it (e.g. even if programs are using this data currently) param removeEncryption whether or not encryption mapping should be removed from the volume. This value implies {@code force}.
public void	unregisterListener(IMountServiceListener listener) Unregisters an IMountServiceListener
public int	verifyEncryptionPassword(java.lang.String password) Verify the encryption password against the stored volume. This method may only be called by the system process.