Site.java

package com.intrbiz.bergamot.model;

import java.io.Serializable;
import java.util.EnumSet;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.UUID;

import com.intrbiz.bergamot.data.BergamotDB;
import com.intrbiz.bergamot.model.adapter.ParametersAdapter;
import com.intrbiz.bergamot.model.message.SiteMO;
import com.intrbiz.bergamot.model.util.Parameter;
import com.intrbiz.bergamot.model.util.Parameterised;
import com.intrbiz.data.db.compiler.meta.SQLColumn;
import com.intrbiz.data.db.compiler.meta.SQLPrimaryKey;
import com.intrbiz.data.db.compiler.meta.SQLTable;
import com.intrbiz.data.db.compiler.meta.SQLUnique;
import com.intrbiz.data.db.compiler.meta.SQLVersion;

/**
 * A monitoring 'site'
 */
@SQLTable(schema = BergamotDB.class, name = "site", since = @SQLVersion({ 1, 0, 0 }))
public final class Site extends BergamotObject<SiteMO> implements Serializable, Parameterised
{
    private static final long serialVersionUID = 1L;

    @SQLColumn(index = 1, name = "id", since = @SQLVersion({ 1, 0, 0 }))
    @SQLPrimaryKey()
    protected UUID id;

    @SQLColumn(index = 2, name = "name", notNull = true, since = @SQLVersion({ 1, 0, 0 }))
    @SQLUnique()
    protected String name;

    @SQLColumn(index = 3, name = "summary", notNull = true, since = @SQLVersion({ 1, 0, 0 }))
    protected String summary;

    @SQLColumn(index = 4, name = "description", since = @SQLVersion({ 1, 0, 0 }))
    protected String description;

    @SQLColumn(index = 5, name = "aliases", type = "TEXT[]", since = @SQLVersion({ 1, 0, 0 }))
    protected List<String> aliases = new LinkedList<String>();

    @SQLColumn(index = 6, name = "pool_count", notNull = true, since = @SQLVersion({ 1, 0, 0 }))
    protected int poolCount = 4;
    
    /**
     * Arbitrary parameters of an object
     */
    @SQLColumn(index = 7, name = "parameters", type = "JSON", adapter = ParametersAdapter.class, since = @SQLVersion({ 2, 0, 0 }))
    private LinkedHashMap<String, Parameter> parameters = new LinkedHashMap<String, Parameter>();
    
    @SQLColumn(index = 8, name = "disabled", since = @SQLVersion({ 3, 45, 0 }))
    private boolean disabled = false;

    public Site()
    {
        super();
    }

    public Site(UUID id, String name, String summary)
    {
        super();
        this.id = id;
        this.name = name;
        this.summary = summary;
    }

    public UUID getId()
    {
        return id;
    }

    public void setId(UUID id)
    {
        this.id = id;
    }

    public String getName()
    {
        return name;
    }

    public void setName(String name)
    {
        this.name = name;
    }

    public String getSummary()
    {
        return summary;
    }

    public void setSummary(String summary)
    {
        this.summary = summary;
    }

    public String getDescription()
    {
        return description;
    }

    public void setDescription(String description)
    {
        this.description = description;
    }

    public List<String> getAliases()
    {
        return aliases;
    }

    public void setAliases(List<String> aliases)
    {
        this.aliases = aliases;
    }

    /**
     * Get the number of processing pools for this site
     * @return
     */
    public int getPoolCount()
    {
        return poolCount;
    }

    public void setPoolCount(int poolCount)
    {
        this.poolCount = poolCount;
    }
    
    @Override
    public LinkedHashMap<String, Parameter> getParameters()
    {
        return parameters;
    }

    @Override
    public void setParameters(LinkedHashMap<String, Parameter> parameters)
    {
        if (parameters == null) parameters = new LinkedHashMap<String, Parameter>();
        this.parameters = parameters;
    }

    public boolean isDisabled()
    {
        return disabled;
    }

    public void setDisabled(boolean disabled)
    {
        this.disabled = disabled;
    }

    @Override
    public SiteMO toMO(Contact contact, EnumSet<MOFlag> options)
    {
        SiteMO mo = new SiteMO();
        mo.setId(this.getId());
        mo.setName(this.getName());
        mo.setSummary(this.getSummary());
        mo.setDescription(this.getDescription());
        mo.setAliases(this.getAliases());
        return mo;
    }

    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((id == null) ? 0 : id.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj)
    {
        if (this == obj) return true;
        if (obj == null) return false;
        if (getClass() != obj.getClass()) return false;
        Site other = (Site) obj;
        if (id == null)
        {
            if (other.id != null) return false;
        }
        else if (!id.equals(other.id)) return false;
        return true;
    }

    /**
     * Generate a random object id for an object contained by this site
     * 
     * @return
     */
    public UUID randomObjectId()
    {
        return randomId(this.getId());
    }

    /**
     * Get the processing pool for a given objectId
     */
    public int computeProcessingPool(UUID objectId)
    {
        return ((int) (objectId.getLeastSignificantBits() & 0xFFL)) % this.getPoolCount();
    }
    
    /**
     * Check if the given object id correctly has this sites id mask
     * @param objectId - the object id to validate
     * @return true if the given object id is valid for this site
     */
    public boolean isValidObjectId(UUID objectId)
    {
        return this.id.equals(getSiteId(objectId));
    }
    
    public String getU2FAppId()
    {
        return "https://" + this.getName();
    }

    public String toString()
    {
        return "Site { id => " + this.id + ", name => " + this.name + " }";
    }

    /**
     * Generate a new random site id, site ids only use the upper 48 bits.
     * 
     * @return the site id
     */
    public static UUID randomSiteId()
    {
        return getSiteId(UUID.randomUUID());
    }

    /**
     * Generate a random object id within the given site
     * 
     * @param siteId
     * @return
     */
    public static UUID randomId(UUID siteId)
    {
        return setSiteId(siteId, UUID.randomUUID());
    }

    /**
     * Get the site id for the given object id
     * 
     * @param objectId
     * @return
     */
    public static UUID getSiteId(UUID objectId)
    {
        return new UUID((objectId.getMostSignificantBits() & 0xFFFFFFFF_FFFF0000L) | 0x0000000000004000L, 0x80000000_00000000L);
    }

    /**
     * Set the site id into the given object id
     * 
     * @param siteId
     * @param objectId
     * @return
     */
    public static UUID setSiteId(UUID siteId, UUID objectId)
    {
        return new UUID((siteId.getMostSignificantBits() & 0xFFFFFFFF_FFFF0000L) | (objectId.getMostSignificantBits() & 0x00000000_0000FFFFL), objectId.getLeastSignificantBits());
    }
}