Package org.jdrupes.vmoperator.manager.events

Class GetDisplaySecret

java.lang.Object

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

org.jgrapes.core.Event<String>

org.jdrupes.vmoperator.manager.events.GetDisplaySecret

All Implemented Interfaces:

Future<String>, Associator, Eligible

public class GetDisplaySecret
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
GetDisplaySecret(VmDefinition vmDef, String user)	Instantiates a new request for the display secret.

Method Summary

Modifier and Type	Method	Description
String	secret()	Return the secret.
boolean	secretAvailable()	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

GetDisplaySecret

public GetDisplaySecret(VmDefinition vmDef,
 String user)

Instantiates a new request for the display secret.

After handling the event, a result of null means that no secret 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

secretAvailable

public boolean secretAvailable()

Returns true if a password is available.

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

Returns:

true, if successful

secret

public String secret()

Return the secret.

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

Returns:

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