org.ovirt.engine.core.bll

Class LoginBaseCommand<T extends LoginUserParameters>

java.lang.Object

org.ovirt.engine.core.dal.dbbroker.auditloghandling.TimeoutBase

org.ovirt.engine.core.dal.dbbroker.auditloghandling.AuditLogableBase

org.ovirt.engine.core.bll.CommandBase<T>

org.ovirt.engine.core.bll.LoginBaseCommand<T>

All Implemented Interfaces:

Serializable, RollbackHandler, TransactionMethod<Object>

Direct Known Subclasses:

LoginUserCommand

public abstract class LoginBaseCommand<T extends LoginUserParameters>
extends CommandBase<T>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AdUser	_adUser

Fields inherited from class org.ovirt.engine.core.bll.CommandBase

BYTES_IN_GB, log

Constructor Summary

Constructors

Constructor and Description
LoginBaseCommand(T parameters)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract UserAuthenticationResult	AuthenticateUser(RefObject<Boolean> isLocalBackend, RefObject<Boolean> isAdmin)
protected boolean	canDoAction()
protected VdcReturnValueBase	CreateReturnValue() Factory to determine the type of the ReturnValue field
protected void	executeCommand()
AuditLogType	getAuditLogTypeValue()
String	getDomain()
Map<Guid,VdcObjectType>	getPermissionCheckSubjects() Permissions are attached to object so every command must declare its object target type and its GUID
String	getUserPassword()
protected void	HandleUserSession(AdUser adUser) Handles the user session.
protected boolean	IsUserAutorizedToRunAction() Check if current user is authorized to run current action.
protected boolean	isUserCanBeAuthenticated()
protected boolean	persistUserSession()

Methods inherited from class org.ovirt.engine.core.bll.CommandBase

acquireLock, addCanDoActionMessage, addCanDoActionMessage, addValidationGroup, CanDoActionOnly, compensate, ConcreteCreateTask, CreateTask, EndAction, endActionInTransactionScope, EndSuccessfully, EndWithFailure, ExecuteAction, freeLock, getActionReturnValue, getActionState, getActionType, getBusinessEntitySnapshotDAO, getCommandShouldBeLogged, getCompensationContext, getDescription, getNow, getObjectLockingId, getParameters, getParametersForTask, getReturnValue, getSucceeded, GetTagsAttachedToObject, getTaskIdList, getTransactionScopeOption, getTransactionTimeout, getValidationGroups, IsBackwardsCompatible, isInternalExecution, RevertTasks, Rollback, runInTransaction, runVdsCommand, setActionMessageParameters, setActionReturnValue, setCommandShouldBeLogged, setCompensationContext, setDescription, setInternalExecution, setSucceeded, UpdateTasksWithActionParameters, validateInputs

Methods inherited from class org.ovirt.engine.core.dal.dbbroker.auditloghandling.AuditLogableBase

AddCustomValue, AppendCustomValue, DefaultLog, getCurrentUser, GetCustomValue, getCustomValues, getKey, getSnapshotName, getStorageDomain, getStorageDomainDAO, getStorageDomainId, getStorageDomainName, getStoragePool, getStoragePoolDAO, getStoragePoolId, getStoragePoolName, getUserId, getUserName, getVds, getVdsDAO, getVdsGroup, getVdsGroupDAO, getVdsGroupId, getVdsGroupName, getVdsId, getVdsIdRef, getVdsName, getVm, getVmDAO, getVmId, getVmIdRef, getVmName, getVmStaticDAO, getVmStatisticsDAO, getVmTemplate, getVmTemplateDAO, getVmTemplateId, getVmTemplateIdRef, getVmTemplateName, log, setCurrentUser, setSnapshotName, setStorageDomain, setStorageDomainId, setStoragePool, setStoragePoolId, setUserId, setUserName, setVds, setVdsGroup, setVdsGroupId, setVdsId, setVdsIdRef, setVdsName, setVm, setVmId, setVmName, setVmTemplate, setVmTemplateId, setVmTemplateName

Methods inherited from class org.ovirt.engine.core.dal.dbbroker.auditloghandling.TimeoutBase

getEndTime, getLegal, getTimeoutObjectId, getUseTimout, setEndTime, setTimeoutObjectId, setUseTimout

Methods inherited from class java.lang.Object

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

Field Detail

_adUser

protected AdUser _adUser

Constructor Detail

LoginBaseCommand

public LoginBaseCommand(T parameters)

Method Detail

CreateReturnValue

protected VdcReturnValueBase CreateReturnValue()

Description copied from class: CommandBase

Factory to determine the type of the ReturnValue field

Overrides:

CreateReturnValue in class CommandBase<T extends LoginUserParameters>

Returns:

HandleUserSession

protected void HandleUserSession(AdUser adUser)

Handles the user session.

Parameters:

adUser - The ad user.

getUserPassword

public String getUserPassword()

getDomain

public String getDomain()

getAuditLogTypeValue

public AuditLogType getAuditLogTypeValue()

Overrides:

getAuditLogTypeValue in class AuditLogableBase

AuthenticateUser

protected abstract UserAuthenticationResult AuthenticateUser(RefObject<Boolean> isLocalBackend,
                                        RefObject<Boolean> isAdmin)

executeCommand

protected void executeCommand()

Specified by:

executeCommand in class CommandBase<T extends LoginUserParameters>

canDoAction

protected boolean canDoAction()

Overrides:

canDoAction in class CommandBase<T extends LoginUserParameters>

persistUserSession

protected boolean persistUserSession()

isUserCanBeAuthenticated

protected boolean isUserCanBeAuthenticated()

IsUserAutorizedToRunAction

protected boolean IsUserAutorizedToRunAction()

Description copied from class: CommandBase

Check if current user is authorized to run current action. skip check if MLA is off or command is internal

Overrides:

IsUserAutorizedToRunAction in class CommandBase<T extends LoginUserParameters>

Returns:

getPermissionCheckSubjects

public Map<Guid,VdcObjectType> getPermissionCheckSubjects()

Description copied from class: CommandBase

Permissions are attached to object so every command must declare its object target type and its GUID

Specified by:

getPermissionCheckSubjects in class CommandBase<T extends LoginUserParameters>

Returns:

Map of Guids to Object types