Package org.gnome.gio

Class MountOperation

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.MountOperation

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

MountOperation

@Generated("io.github.jwharm.JavaGI")
public class MountOperation
extends GObject

GMountOperation provides a mechanism for interacting with the user. It can be used for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations. It can also be used to ask the user questions or show a list of applications preventing unmount or eject operations from completing.

Note that GMountOperation is used for more than just Mount objects – for example it is also used in Drive.start(java.util.Set<org.gnome.gio.DriveStartFlags>, org.gnome.gio.MountOperation, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) and Drive.stop(java.util.Set<org.gnome.gio.MountUnmountFlags>, org.gnome.gio.MountOperation, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Users should instantiate a subclass of this that implements all the various callbacks to show the required dialogs, such as GtkMountOperation. If no user interaction is desired (for example when automounting filesystems at login time), usually NULL can be passed, see each method taking a GMountOperation for details.

Throughout the API, the term ‘TCRYPT’ is used to mean ‘compatible with TrueCrypt and VeraCrypt’. TrueCrypt is a discontinued system for encrypting file containers, partitions or whole disks, typically used with Windows. VeraCrypt is a maintained fork of TrueCrypt with various improvements and auditing fixes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MountOperation.AbortedCallback	Functional interface declaration of the AbortedCallback callback.
static interface	MountOperation.AskPasswordCallback	Functional interface declaration of the AskPasswordCallback callback.
static interface	MountOperation.AskQuestionCallback	Functional interface declaration of the AskQuestionCallback callback.
static class	MountOperation.Builder<B extends MountOperation.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	MountOperation.MountOperationClass
static interface	MountOperation.ReplyCallback	Functional interface declaration of the ReplyCallback callback.
static interface	MountOperation.ShowProcessesCallback	Functional interface declaration of the ShowProcessesCallback callback.
static interface	MountOperation.ShowUnmountProgressCallback	Functional interface declaration of the ShowUnmountProgressCallback callback.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
MountOperation()	Creates a new MountOperation.
MountOperation(MemorySegment address)	Create a MountOperation proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected void	aborted()
protected void	askPassword(String message, String defaultUser, String defaultDomain, Set<AskPasswordFlags> flags)
protected void	askQuestion(String message, @Nullable String @Nullable [] choices)	Virtual implementation of GMountOperation::ask-question.
protected MountOperation	asParent()	Returns this instance as if it were its parent type.
static MountOperation.Builder<? extends MountOperation.Builder>	builder()	A MountOperation.Builder object constructs a MountOperation with the specified properties.
void	emitAborted()	Emits the "aborted" signal.
void	emitAskPassword(String message, String defaultUser, String defaultDomain, Set<AskPasswordFlags> flags)	Emits the "ask-password" signal.
void	emitAskQuestion(String message, @Nullable String @Nullable [] choices)	Emits the "ask-question" signal.
void	emitReply(MountOperationResult result)	Emits the "reply" signal.
void	emitShowProcesses(String message, @Nullable Pid @Nullable [] processes, @Nullable String @Nullable [] choices)	Emits the "show-processes" signal.
void	emitShowUnmountProgress(String message, long timeLeft, long bytesLeft)	Emits the "show-unmount-progress" signal.
boolean	getAnonymous()	Check to see whether the mount operation is being used for an anonymous user.
int	getChoice()	Gets a choice from the mount operation.
@Nullable String	getDomain()	Gets the domain of the mount operation.
boolean	getIsTcryptHiddenVolume()	Check to see whether the mount operation is being used for a TCRYPT hidden volume.
boolean	getIsTcryptSystemVolume()	Check to see whether the mount operation is being used for a TCRYPT system volume.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@Nullable String	getPassword()	Gets a password from the mount operation.
PasswordSave	getPasswordSave()	Gets the state of saving passwords for the mount operation.
int	getPim()	Gets a PIM from the mount operation.
static @Nullable Type	getType()	Get the GType of the MountOperation class
@Nullable String	getUsername()	Get the user name from the mount operation.
SignalConnection<MountOperation.AbortedCallback>	onAborted(MountOperation.AbortedCallback handler)	Emitted by the backend when e.g.
SignalConnection<MountOperation.AskPasswordCallback>	onAskPassword(MountOperation.AskPasswordCallback handler)	Emitted when a mount operation asks the user for a password.
SignalConnection<MountOperation.AskQuestionCallback>	onAskQuestion(MountOperation.AskQuestionCallback handler)	Emitted when asking the user a question and gives a list of choices for the user to choose from.
SignalConnection<MountOperation.ReplyCallback>	onReply(MountOperation.ReplyCallback handler)	Emitted when the user has replied to the mount operation.
SignalConnection<MountOperation.ShowProcessesCallback>	onShowProcesses(MountOperation.ShowProcessesCallback handler)	Emitted when one or more processes are blocking an operation e.g.
SignalConnection<MountOperation.ShowUnmountProgressCallback>	onShowUnmountProgress(MountOperation.ShowUnmountProgressCallback handler)	Emitted when an unmount operation has been busy for more than some time (typically 1.5 seconds).
void	reply(MountOperationResult result)	Emits the GMountOperation::reply signal.
void	setAnonymous(boolean anonymous)	Sets the mount operation to use an anonymous user if anonymous is true.
void	setChoice(int choice)	Sets a default choice for the mount operation.
void	setDomain(@Nullable String domain)	Sets the mount operation's domain.
void	setIsTcryptHiddenVolume(boolean hiddenVolume)	Sets the mount operation to use a hidden volume if hiddenVolume is true.
void	setIsTcryptSystemVolume(boolean systemVolume)	Sets the mount operation to use a system volume if systemVolume is true.
void	setPassword(@Nullable String password)	Sets the mount operation's password to password.
void	setPasswordSave(PasswordSave save)	Sets the state of saving passwords for the mount operation.
void	setPim(int pim)	Sets the mount operation's PIM to pim.
void	setUsername(@Nullable String username)	Sets the user name within this MountOperation to username.
protected void	showProcesses(String message, @Nullable Pid @Nullable [] processes, @Nullable String @Nullable [] choices)	Virtual implementation of GMountOperation::show-processes.
protected void	showUnmountProgress(String message, long timeLeft, long bytesLeft)

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MountOperation

public MountOperation(MemorySegment address)

Create a MountOperation proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

MountOperation

public MountOperation()

Creates a new MountOperation.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the MountOperation class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected MountOperation asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getAnonymous

public boolean getAnonymous()

Check to see whether the mount operation is being used for an anonymous user.

Returns:

true if mount operation is anonymous.

getChoice

public int getChoice()

Gets a choice from the mount operation.

Returns:

an integer containing an index of the user's choice from the choice's list, or 0.

getDomain

public @Nullable String getDomain()

Gets the domain of the mount operation.

Returns:

a string set to the domain.

getIsTcryptHiddenVolume

public boolean getIsTcryptHiddenVolume()

Check to see whether the mount operation is being used for a TCRYPT hidden volume.

Returns:

true if mount operation is for hidden volume.

Since:

2.58

getIsTcryptSystemVolume

public boolean getIsTcryptSystemVolume()

Check to see whether the mount operation is being used for a TCRYPT system volume.

Returns:

true if mount operation is for system volume.

Since:

2.58

getPassword

public @Nullable String getPassword()

Gets a password from the mount operation.

Returns:

a string containing the password within op.

getPasswordSave

public PasswordSave getPasswordSave()

Gets the state of saving passwords for the mount operation.

Returns:

a GPasswordSave flag.

getPim

public int getPim()

Gets a PIM from the mount operation.

Returns:

The VeraCrypt PIM within op.

Since:

2.58

getUsername

public @Nullable String getUsername()

Get the user name from the mount operation.

Returns:

a string containing the user name.

reply

public void reply(MountOperationResult result)

Emits the GMountOperation::reply signal.

Parameters:

result - a GMountOperationResult

setAnonymous

public void setAnonymous(boolean anonymous)

Sets the mount operation to use an anonymous user if anonymous is true.

Parameters:

anonymous - boolean value.

setChoice

public void setChoice(int choice)

Sets a default choice for the mount operation.

Parameters:

choice - an integer.

setDomain

public void setDomain(@Nullable String domain)

Sets the mount operation's domain.

Parameters:

domain - the domain to set.

setIsTcryptHiddenVolume

public void setIsTcryptHiddenVolume(boolean hiddenVolume)

Sets the mount operation to use a hidden volume if hiddenVolume is true.

Parameters:

hiddenVolume - boolean value.

Since:

2.58

setIsTcryptSystemVolume

public void setIsTcryptSystemVolume(boolean systemVolume)

Sets the mount operation to use a system volume if systemVolume is true.

Parameters:

systemVolume - boolean value.

Since:

2.58

setPassword

public void setPassword(@Nullable String password)

Sets the mount operation's password to password.

Parameters:

password - password to set.

setPasswordSave

public void setPasswordSave(PasswordSave save)

Sets the state of saving passwords for the mount operation.

Parameters:

save - a set of GPasswordSave flags.

setPim

public void setPim(int pim)

Sets the mount operation's PIM to pim.

Parameters:

pim - an unsigned integer.

Since:

2.58

setUsername

public void setUsername(@Nullable String username)

Sets the user name within this MountOperation to username.

Parameters:

username - input username.

aborted

protected void aborted()

askPassword

protected void askPassword(String message,
 String defaultUser,
 String defaultDomain,
 Set<AskPasswordFlags> flags)

askQuestion

protected void askQuestion(String message,
 @Nullable String @Nullable [] choices)

Virtual implementation of GMountOperation::ask-question.

Parameters:

message - string containing a message to display to the user

choices - an array of strings for each possible choice

showProcesses

protected void showProcesses(String message,
 @Nullable Pid @Nullable [] processes,
 @Nullable String @Nullable [] choices)

Virtual implementation of GMountOperation::show-processes.

Parameters:

message - string containing a message to display to the user

processes - an array of GPid for processes blocking the operation

choices - an array of strings for each possible choice

Since:

2.22

showUnmountProgress

protected void showUnmountProgress(String message,
 long timeLeft,
 long bytesLeft)

onAborted

public SignalConnection<MountOperation.AbortedCallback> onAborted(MountOperation.AbortedCallback handler)

Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress.

Implementations of GMountOperation should handle this signal by dismissing open password dialogs.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.20

See Also:

• MountOperation.AbortedCallback.run()

emitAborted

public void emitAborted()

Emits the "aborted" signal. See onAborted(org.gnome.gio.MountOperation.AbortedCallback).

onAskPassword

public SignalConnection<MountOperation.AskPasswordCallback> onAskPassword(MountOperation.AskPasswordCallback handler)

Emitted when a mount operation asks the user for a password.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• MountOperation.AskPasswordCallback.run(java.lang.String, java.lang.String, java.lang.String, java.util.Set<org.gnome.gio.AskPasswordFlags>)

emitAskPassword

public void emitAskPassword(String message,
 String defaultUser,
 String defaultDomain,
 Set<AskPasswordFlags> flags)

Emits the "ask-password" signal. See onAskPassword(org.gnome.gio.MountOperation.AskPasswordCallback).

onAskQuestion

public SignalConnection<MountOperation.AskQuestionCallback> onAskQuestion(MountOperation.AskQuestionCallback handler)

Emitted when asking the user a question and gives a list of choices for the user to choose from.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• MountOperation.AskQuestionCallback.run(java.lang.String, java.lang.String[])

emitAskQuestion

public void emitAskQuestion(String message,
 @Nullable String @Nullable [] choices)

Emits the "ask-question" signal. See onAskQuestion(org.gnome.gio.MountOperation.AskQuestionCallback).

onReply

public SignalConnection<MountOperation.ReplyCallback> onReply(MountOperation.ReplyCallback handler)

Emitted when the user has replied to the mount operation.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• MountOperation.ReplyCallback.run(org.gnome.gio.MountOperationResult)

emitReply

public void emitReply(MountOperationResult result)

Emits the "reply" signal. See onReply(org.gnome.gio.MountOperation.ReplyCallback).

onShowProcesses

public SignalConnection<MountOperation.ShowProcessesCallback> onShowProcesses(MountOperation.ShowProcessesCallback handler)

Emitted when one or more processes are blocking an operation e.g. unmounting/ejecting a GMount or stopping a GDrive.

Note that this signal may be emitted several times to update the list of blocking processes as processes close files. The application should only respond with g_mount_operation_reply() to the latest signal (setting GMountOperation:choice to the choice the user made).

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.22

See Also:

• MountOperation.ShowProcessesCallback.run(java.lang.String, org.gnome.glib.Pid[], java.lang.String[])

emitShowProcesses

public void emitShowProcesses(String message,
 @Nullable Pid @Nullable [] processes,
 @Nullable String @Nullable [] choices)

Emits the "show-processes" signal. See onShowProcesses(org.gnome.gio.MountOperation.ShowProcessesCallback).

onShowUnmountProgress

public SignalConnection<MountOperation.ShowUnmountProgressCallback> onShowUnmountProgress(MountOperation.ShowUnmountProgressCallback handler)

Emitted when an unmount operation has been busy for more than some time (typically 1.5 seconds).

When unmounting or ejecting a volume, the kernel might need to flush pending data in its buffers to the volume stable storage, and this operation can take a considerable amount of time. This signal may be emitted several times as long as the unmount operation is outstanding, and then one last time when the operation is completed, with bytesLeft set to zero.

Implementations of GMountOperation should handle this signal by showing an UI notification, and then dismiss it, or show another notification of completion, when bytesLeft reaches zero.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.34

See Also:

• MountOperation.ShowUnmountProgressCallback.run(java.lang.String, long, long)

emitShowUnmountProgress

public void emitShowUnmountProgress(String message,
 long timeLeft,
 long bytesLeft)

Emits the "show-unmount-progress" signal. See onShowUnmountProgress(org.gnome.gio.MountOperation.ShowUnmountProgressCallback).

builder

public static MountOperation.Builder<? extends MountOperation.Builder> builder()

A MountOperation.Builder object constructs a MountOperation with the specified properties. Use the various set...() methods to set properties, and finish construction with MountOperation.Builder.build().

Returns:

the builder object