extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ObjectModel.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.guacamole.auth.jdbc.base;

import java.util.Collection;

/**
 * Object representation of a Guacamole object, such as a user or connection,
 * as represented in the database.
 */
public abstract class ObjectModel {

    /**
     * The ID of this object in the database, if any.
     */
    private Integer objectID;

    /**
     * The unique identifier which identifies this object.
     */
    private String identifier;

    /**
     * Map of all arbitrary attributes associated with this object but not
     * directly mapped to a particular column.
     */
    private ArbitraryAttributeMap arbitraryAttributes =
            new ArbitraryAttributeMap();

    /**
     * Creates a new, empty object.
     */
    public ObjectModel() {
    }

    /**
     * Returns the identifier that uniquely identifies this object.
     *
     * @return
     *     The identifier that uniquely identifies this object.
     */
    public String getIdentifier() {
        return identifier;
    }

    /**
     * Sets the identifier that uniquely identifies this object.
     *
     * @param identifier
     *     The identifier that uniquely identifies this object.
     */
    public void setIdentifier(String identifier) {
        this.identifier = identifier;
    }

    /**
     * Returns the ID of this object in the database, if it exists.
     *
     * @return
     *     The ID of this object in the database, or null if this object was
     *     not retrieved from the database.
     */
    public Integer getObjectID() {
        return objectID;
    }

    /**
     * Sets the ID of this object to the given value.
     *
     * @param objectID
     *     The ID to assign to this object.
     */
    public void setObjectID(Integer objectID) {
        this.objectID = objectID;
    }

    /**
     * Returns a map of attribute name/value pairs for all attributes associated
     * with this model which do not have explicit mappings to actual model
     * properties. All other attributes (those which are explicitly supported
     * by the model) should instead be mapped to properties with corresponding
     * and properly-typed columns.
     *
     * @return
     *     A map of attribute name/value pairs for all attributes associated
     *     with this model which do not otherwise have explicit mappings to
     *     properties.
     */
    public ArbitraryAttributeMap getArbitraryAttributeMap() {
        return arbitraryAttributes;
    }

    /**
     * Returns whether at least one arbitrary attribute name/value pair has
     * been associated with this object.
     *
     * @return
     *     true if this object has at least one arbitrary attribute set, false
     *     otherwise.
     */
    public boolean hasArbitraryAttributes() {
        return !arbitraryAttributes.isEmpty();
    }

    /**
     * Returns a Collection view of the equivalent attribute model objects
     * which make up the map of arbitrary attribute name/value pairs returned
     * by getArbitraryAttributeMap(). Additions and removals on the returned
     * Collection directly affect the attribute map.
     *
     * @return
     *      A Collection view of the map returned by
     *      getArbitraryAttributeMap().
     */
    public Collection<ArbitraryAttributeModel> getArbitraryAttributes() {
        return arbitraryAttributes.toModelCollection();
    }

    /**
     * Replaces all arbitrary attributes associated with this object with the
     * attribute name/value pairs within the given collection of model objects.
     *
     * @param arbitraryAttributes
     *     The Collection of model objects containing the attribute name/value
     *     pairs which should replace all currently-stored arbitrary attributes,
     *     if any.
     */
    public void setArbitraryAttributes(Collection<ArbitraryAttributeModel> arbitraryAttributes) {
        this.arbitraryAttributes = ArbitraryAttributeMap.fromModelCollection(arbitraryAttributes);
    }

}