org.hawkular.inventory.api.model

Class Tenant

java.lang.Object

org.hawkular.inventory.api.model.AbstractElement<B,U>

org.hawkular.inventory.api.model.Entity<Tenant.Blueprint,Tenant.Update>

org.hawkular.inventory.api.model.Tenant

public final class Tenant
extends Entity<Tenant.Blueprint,Tenant.Update>

A tenant is a top level entity that owns everything else. Multiple tenants are not supposed to share anything between each other.

Note that the tenant does not have a dedicated blueprint type (i.e. data required to create a new tenant in some context), because the only data needed to create a new tenant is its ID, which can easily be modelled by a String.

Since:

1.0

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tenant.Blueprint
static class	Tenant.Update

Nested classes/interfaces inherited from class org.hawkular.inventory.api.model.AbstractElement

AbstractElement.Updater<U extends AbstractElement.Update,E extends AbstractElement<?,U>>

Field Summary

Fields inherited from class org.hawkular.inventory.api.model.AbstractElement

ID_PROPERTY, properties

Constructor Summary

Constructors

Constructor and Description
Tenant(CanonicalPath path)
Tenant(CanonicalPath path, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(ElementVisitor<R,P> visitor, P parameter) Accepts the provided visitor.
AbstractElement.Updater<Tenant.Update,Tenant>	update()

Methods inherited from class org.hawkular.inventory.api.model.Entity

appendToString, toString

Methods inherited from class org.hawkular.inventory.api.model.AbstractElement

equals, getId, getPath, getProperties, hashCode, valueOrDefault

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Tenant

public Tenant(CanonicalPath path)

Tenant

public Tenant(CanonicalPath path,
              Map<String,Object> properties)

Method Detail

update

public AbstractElement.Updater<Tenant.Update,Tenant> update()

Specified by:

update in class AbstractElement<Tenant.Blueprint,Tenant.Update>

Returns:

a new updater object to modify this entity and produce a new one.

accept

public <R,P> R accept(ElementVisitor<R,P> visitor,
                      P parameter)

Description copied from class: AbstractElement

Accepts the provided visitor.

Specified by:

accept in class AbstractElement<Tenant.Blueprint,Tenant.Update>

Type Parameters:

R - the return type

P - the type of the parameter

Parameters:

visitor - the visitor to visit this entity

parameter - the parameter to pass on to the visitor

Returns:

the return value provided by the visitor