Package org.jdrupes.vmoperator.manager.events

Class PrepareConsole

java.lang.Object

org.jgrapes.core.internal.EventBase<String>

org.jgrapes.core.Event<String>

org.jdrupes.vmoperator.manager.events.PrepareConsole

All Implemented Interfaces:

Future<String>, Associator, Eligible

public class PrepareConsole
extends Event<String>

Gets the current display secret and optionally updates it.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
PrepareConsole(VmDefinition vmDef, String user)	Instantiates a new request for the display secret.
PrepareConsole(VmDefinition vmDef, String user, boolean loginUser)	Instantiates a new request for the display secret.

Method Summary

Modifier and Type	Method	Description
boolean	loginUser()	Checks if the user should be logged in before allowing access.
String	password()	Return the password.
boolean	passwordAvailable()	Returns true if a password is available.
String	user()	Return the id of the user who has requested the password.
VmDefinition	vmDefinition()	Gets the vm definition.

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handled, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo, toString

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

PrepareConsole

public PrepareConsole(VmDefinition vmDef,
 String user,
 boolean loginUser)

Instantiates a new request for the display secret.

After handling the event, a result of null means that no password is needed. No result means that the console is not accessible.

Parameters:

vmDef - the vm name

user - the requesting user

loginUser - login the user

PrepareConsole

public PrepareConsole(VmDefinition vmDef,
 String user)

Instantiates a new request for the display secret.

After handling the event, a result of null means that no password is needed. No result means that the console is not accessible.

Parameters:

vmDef - the vm name

user - the requesting user

Method Details

vmDefinition

public VmDefinition vmDefinition()

Gets the vm definition.

Returns:

the vm definition

user

public String user()

Return the id of the user who has requested the password.

Returns:

the string

loginUser

public boolean loginUser()

Checks if the user should be logged in before allowing access.

Returns:

the loginUser

passwordAvailable

public boolean passwordAvailable()

Returns true if a password is available.

May only be called when the event is completed. Note that the password returned by password() may be null, indicating that no password is needed.

Returns:

true, if successful

password

public String password()

Return the password.

May only be called when the event has been completed with a valid result (see passwordAvailable()).

Returns:

the password. A value of null means that no password is required.