org.ovirt.engine.core.bll

Class UserCommandBase<T extends AdElementParametersBase>

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.UserCommandBase<T>

All Implemented Interfaces:

Serializable, RollbackHandler, TransactionMethod<Object>

Direct Known Subclasses:

RemoveUserCommand, VmToUserCommand

@CustomLogFields(value=@CustomLogField(value="AdUserName"))
public abstract class UserCommandBase<T extends AdElementParametersBase>
extends CommandBase<T>

See Also:

Serialized Form

Field Summary

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

BYTES_IN_GB, log

Constructor Summary

Constructors

Modifier	Constructor and Description
	UserCommandBase()
protected	UserCommandBase(Guid commandId) Constructor for command creation when compensation is applied on startup
	UserCommandBase(T parameters)

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	CanAttachVmTo(Guid vmId, ArrayList<String> message)
protected Guid	getAdUserId()
String	getAdUserName()
protected String	getDescription()
Map<Guid,VdcObjectType>	getPermissionCheckSubjects() Permissions are attached to object so every command must declare its object target type and its GUID
static DbUser	initUser(VdcUser vdcUser, String sessionId)
static DbUser	persistAuthenticatedUser(AdUser adUser) Check if the authenticated user exist in the DB.
static void	ProcessAdElementDefaultRole(Guid adElementId, String userName) Process on changing VdcRole to user/group.

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

acquireLock, addCanDoActionMessage, addCanDoActionMessage, addValidationGroup, canDoAction, CanDoActionOnly, compensate, ConcreteCreateTask, CreateReturnValue, CreateTask, EndAction, endActionInTransactionScope, EndSuccessfully, EndWithFailure, ExecuteAction, executeCommand, freeLock, getActionReturnValue, getActionState, getActionType, getBusinessEntitySnapshotDAO, getCommandShouldBeLogged, getCompensationContext, getNow, getObjectLockingId, getParameters, getParametersForTask, getReturnValue, getSucceeded, GetTagsAttachedToObject, getTaskIdList, getTransactionScopeOption, getTransactionTimeout, getValidationGroups, IsBackwardsCompatible, isInternalExecution, IsUserAutorizedToRunAction, 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, getAuditLogTypeValue, 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

Constructor Detail

UserCommandBase

public UserCommandBase()

UserCommandBase

protected UserCommandBase(Guid commandId)

Constructor for command creation when compensation is applied on startup

Parameters:

commandId -

UserCommandBase

public UserCommandBase(T parameters)

Method Detail

getDescription

protected String getDescription()

Overrides:

getDescription in class CommandBase<T extends AdElementParametersBase>

getAdUserName

public String getAdUserName()

getAdUserId

protected Guid getAdUserId()

initUser

public static DbUser initUser(VdcUser vdcUser,
              String sessionId)

persistAuthenticatedUser

public static DbUser persistAuthenticatedUser(AdUser adUser)

Check if the authenticated user exist in the DB. Add it if its missing.

Parameters:

adUser -

Returns:

newly create

ProcessAdElementDefaultRole

public static void ProcessAdElementDefaultRole(Guid adElementId,
                               String userName)

Process on changing VdcRole to user/group. First remove on current permissions since them not relevant anymore. Second if new user/group role are User or PowerUser - add to it default permission with specific role.

CanAttachVmTo

public static boolean CanAttachVmTo(Guid vmId,
                    ArrayList<String> message)

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 AdElementParametersBase>

Returns:

Map of Guids to Object types