org.apache.brooklyn.policy.jclouds.os

Class CreateUserPolicy

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.policy.AbstractPolicy

org.apache.brooklyn.policy.jclouds.os.CreateUserPolicy

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Policy, SensorEventListener<Location>, BrooklynObjectInternal

public class CreateUserPolicy
extends AbstractPolicy
implements SensorEventListener<Location>

When attached to an entity, this will monitor for when an SshMachineLocation is added to that entity (e.g. when a VM has been provisioned for it). The policy will then (asynchronously) add a new user to the VM, with a randomly generated password. The ssh details will be set as a sensor on the entity. If this is used, it is strongly encouraged to tell users to change the password on first login. A preferred mechanism would be for an external key-management tool to generate ssh key-pairs for the user, and for the public key to be passed to Brooklyn. However, there is not a customer requirement for that yet, so focusing on the password-approach.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

AbstractEntityAdjunct.AdjunctTagSupport, AbstractEntityAdjunct.BasicSubscriptionSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<java.lang.Boolean>	GRANT_SUDO
static ConfigKey<java.lang.Boolean>	RESET_LOGIN_USER
static AttributeSensor<java.lang.String>	VM_USER_CREDENTIALS
static ConfigKey<java.lang.String>	VM_USERNAME

Fields inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

HIGHLIGHT_NAME_LAST_ACTION, HIGHLIGHT_NAME_LAST_CONFIRMATION, HIGHLIGHT_NAME_LAST_VIOLATION, HIGHLIGHT_NAME_TRIGGERS

Fields inherited from interface org.apache.brooklyn.api.sensor.SensorEventListener

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateUserPolicy()

Method Summary

Modifier and Type	Method and Description
void	onEvent(SensorEvent<Location> event) The SensorEvent handler method.
void	setEntity(EntityLocal entity)

Methods inherited from class org.apache.brooklyn.core.policy.AbstractPolicy

destroy, getPolicyType, getRebindSupport, isRunning, isSuspended, relations, resume, suspend, toString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

config, configure, getAdjunctType, getConfig, getDisplayName, getEntity, getExecutionContext, getHighlights, getManagementContext, getUniqueTag, isDestroyed, setDisplayName, setHighlights, subscriptions, tags

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, init, rebind, setCatalogItemId, setCatalogItemIdAndSearchPath, setManagementContext, stackCatalogItemId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.policy.Policy

getId

Methods inherited from interface org.apache.brooklyn.api.objs.EntityAdjunct

getHighlights, getUniqueTag, isDestroyed

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, getDisplayName, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Field Detail

VM_USERNAME

public static final ConfigKey<java.lang.String> VM_USERNAME

GRANT_SUDO

public static final ConfigKey<java.lang.Boolean> GRANT_SUDO

VM_USER_CREDENTIALS

public static final AttributeSensor<java.lang.String> VM_USER_CREDENTIALS

RESET_LOGIN_USER

public static final ConfigKey<java.lang.Boolean> RESET_LOGIN_USER

Constructor Detail

CreateUserPolicy

public CreateUserPolicy()

Method Detail

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractEntityAdjunct

onEvent

public void onEvent(SensorEvent<Location> event)

Description copied from interface: SensorEventListener

The SensorEvent handler method.

Specified by:

onEvent in interface SensorEventListener<Location>