/*************************************************************************
 *                                                                       *
 *  CESeCore: CE Security Core                                           *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General Public           *
 *  License as published by the Free Software Foundation; either         *
 *  version 2.1 of the License, or any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/

package org.cesecore.roles.member;

import java.io.Serializable;

import javax.persistence.Entity;
import javax.persistence.PostLoad;
import javax.persistence.PrePersist;
import javax.persistence.PreUpdate;
import javax.persistence.Table;
import javax.persistence.Transient;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.CompareToBuilder;
import org.cesecore.dbprotection.ProtectedData;
import org.cesecore.dbprotection.ProtectionStringBuilder;

/**
 * Entity bean for Role members. Does not correspond to a physical entity, but rather to an individual credential linked to an entity. The same 
 * individuals may share the same credential (such as belonging to the same organization, or sharing an account, while one individual may have access
 * to several credentials (such as a user using several different certificates for identification depending on location). 
 * 
 *  Each member is linked to a Role, though not intrinsically so via foreign keys 
 * 
 * @version $Id: RoleMemberData.java 25634 2017-04-03 12:02:08Z jeklund $
 */
@Entity
@Table(name = "RoleMemberData")
public class RoleMemberData extends ProtectedData implements Serializable, Comparable<RoleMemberData> {

    private static final long serialVersionUID = 1L;
   
    private int primaryKey;

    private String tokenType;
    private int tokenIssuerId;
    private int tokenMatchKey;
    private int tokenMatchOperator;
    private String tokenMatchValueColumn;
    private int roleId;
    private String descriptionColumn;
    
    private int rowVersion = 0;
    private String rowProtection;

    public RoleMemberData() {
    }

    /** Construct the object from RoleMember value object */
    public RoleMemberData(final RoleMember roleMember) {
        setPrimaryKey(roleMember.getId());
        updateValuesFromValueObject(roleMember);
    }

    /**
     * Slightly more verbose constructor used for upgrades.
     * 
     * @param primaryKey the primary key for this object. It's required to check the database for any objects with the same key, otherwise that 
     *  object will be overridden
     * @param tokenType a string which defined the implementation of AcceessMatchValue used by this member
     * @param tokenIssuerId the issuer of token if relevant or 0 (RoleMember.NO_ISSUER) otherwise
     * @param tokenMatchKey the integer value determining how to interpret the tokenMatchValue, defined in a class that inherits the interface AcceessMatchValue
     * @param tokenMatchOperator how to perform the match. 0 (AccessMatchType.UNUSED.getNumericValue())to let the determine this from tokenSubType.
     * @param tokenMatchValue the actual value with which to match
     * @param roleId the ID of the role to which this member belongs. May be null.
     * @param description a human readable description of this role member. Null will be treated as an empty String.
     */
    public RoleMemberData(final int primaryKey, final String tokenType, final int tokenIssuerId, final int tokenMatchKey, final int tokenMatchOperator,
            final String tokenMatchValue, final int roleId, String description) {
        this.primaryKey = primaryKey;
        this.tokenType = tokenType;
        this.tokenIssuerId = tokenIssuerId;
        this.tokenMatchKey = tokenMatchKey;
        this.tokenMatchOperator = tokenMatchOperator;
        this.tokenMatchValueColumn = tokenMatchValue;
        this.roleId = roleId;
        this.setDescription(description);
    }

    /** @return the primary key of this entity bean, a pseudo-random integer */
    public int getPrimaryKey() {
        return primaryKey;
    }

    public void setPrimaryKey(int primaryKey) {
        this.primaryKey = primaryKey;
    }

    /** @return the authentication token type that this member identifies to (such as X509CertificateAuthenticationToken) */
    public String getTokenType() {
        return tokenType;
    }
    
    public void setTokenType(final String tokenType) {
        this.tokenType = tokenType;
    }

    /** @return issuer identifier of this token or 0 (RoleMember.NO_ISSUER) if this is not relevant for this token type */
    public int getTokenIssuerId() {
        return tokenIssuerId;
    }

    public void setTokenIssuerId(int tokenIssuerId) {
        this.tokenIssuerId = tokenIssuerId;
    }

    /** @return the match value type with to match, i.e. CN, serial number, or username */
    public int getTokenMatchKey() {
        return tokenMatchKey;
    }

    public void setTokenMatchKey(final int tokenMatchKey) {
        this.tokenMatchKey = tokenMatchKey;
    }
        
    /** @return what kind of operator to apply to the match value */
    public int getTokenMatchOperator() {
        return tokenMatchOperator;
    }

    public void setTokenMatchOperator(final int tokenMatchOperator) {
        this.tokenMatchOperator = tokenMatchOperator;
    }

    //@Column(name="tokenMatchValue")
    @Deprecated
    /** @deprecated (Only for database mapping) {@link #getTokenMatchValue()} */
    public String getTokenMatchValueColumn() {
        return tokenMatchValueColumn;
    }
    @Deprecated
    /** @deprecated (Only for database mapping) {@link #setTokenMatchValue(String)} */
    public void setTokenMatchValueColumn(final String tokenMatchValueColumn) {
        this.tokenMatchValueColumn = tokenMatchValueColumn;
    }

    @Transient
    /** @return the actual value with which we match (never returns null) */
    public String getTokenMatchValue() {
        return StringUtils.defaultIfEmpty(getTokenMatchValueColumn(), "");
    }
    
    @Transient
    public void setTokenMatchValue(final String tokenMatchValue) {
        this.setTokenMatchValueColumn(StringUtils.defaultIfEmpty(tokenMatchValue, null));
    }

    /** @return the role to which this member belongs or 0 if it is not assigned to a role. */
    public int getRoleId() {
        return roleId;
    }
    
    public void setRoleId(final int roleId) {
        this.roleId = roleId;
    }

    //@Column(name="description")
    @Deprecated
    /** @deprecated (Only for database mapping) {@link #getDescription()} */
    public String getDescriptionColumn() {
        return descriptionColumn;
    }
    @Deprecated
    /** @deprecated (Only for database mapping) {@link #setDescription(String)} */
    public void setDescriptionColumn(final String descriptionColumn) {
        this.descriptionColumn = descriptionColumn;
    }

    @Transient
    /** @return a human readable description of the role member */
    public String getDescription() {
        return StringUtils.defaultIfEmpty(getDescriptionColumn(), "");
    }

    @Transient
    public void setDescription(final String description) {
        this.setDescriptionColumn(StringUtils.defaultIfEmpty(description, null));
    }
    
    public int getRowVersion() {
        return rowVersion;
    }

    public void setRowVersion(final int rowVersion) {
        this.rowVersion = rowVersion;
    }

    /** @return the row integrity protection String */
    public String getRowProtection() {
        return getZzzRowProtection();
    }
    public void setRowProtection(final String rowProtection) {
        this.setZzzRowProtection(rowProtection);
    }

    /** 
     * Horrible work-around due to the fact that Oracle needs to have (LONG and) CLOB values last in order to avoid ORA-24816.
     * 
     * Since Hibernate sorts columns by the property names, naming this Z-something will apparently ensure that this column is used last.
     * @deprecated Use {@link #getRowProtection()} instead
     */
    @Deprecated
    public String getZzzRowProtection() {
        return rowProtection;
    }
    /** @deprecated Use {@link #setRowProtection(String)} instead */
    @Deprecated
    public void setZzzRowProtection(final String zzzRowProtection) {
        this.rowProtection = zzzRowProtection;
    }

    // Start Database integrity protection methods
    @Transient
    @Override
    protected String getProtectString(final int version) {
        final ProtectionStringBuilder build = new ProtectionStringBuilder();
        // What is important to protect here is the data that we define
        // rowVersion is automatically updated by JPA, so it's not important, it is only used for optimistic locking
        build.append(getPrimaryKey()).append(getTokenType()).append(getTokenIssuerId()).append(getTokenMatchKey()).append(getTokenMatchOperator()).
            append(getTokenMatchValue()).append(getRoleId()).append(getDescription());
        return build.toString();
    }

    @Transient
    @Override
    protected int getProtectVersion() {
        return 1;
    }

    @PrePersist
    @PreUpdate
    @Override
    protected void protectData() {
        super.protectData();
    }

    @PostLoad
    @Override
    protected void verifyData() {
        super.verifyData();
    }

    @Override
    @Transient
    protected String getRowId() {
        return String.valueOf(getPrimaryKey());
    }

    //
    // End Database integrity protection methods
    //

    @Override
    public int compareTo(RoleMemberData o) {
        return new CompareToBuilder().append(this.tokenType, o.tokenType).append(this.tokenIssuerId, o.tokenIssuerId).append(this.tokenMatchKey, o.tokenMatchKey)
                .append(this.tokenMatchOperator, o.tokenMatchOperator).append(this.tokenMatchValueColumn, o.tokenMatchValueColumn).toComparison();
    }
    
    @Transient
    public RoleMember asValueObject() {
        return new RoleMember(primaryKey, tokenType, tokenIssuerId, tokenMatchKey, tokenMatchOperator, getTokenMatchValue(), roleId, getDescription());
    }
    
    /** Sets all fields except the ID */
    @Transient
    public void updateValuesFromValueObject(final RoleMember roleMember) {
        setTokenType(roleMember.getTokenType());
        setTokenIssuerId(roleMember.getTokenIssuerId());
        setTokenMatchKey(roleMember.getTokenMatchKey());
        setTokenMatchOperator(roleMember.getTokenMatchOperator());
        setTokenMatchValue(roleMember.getTokenMatchValue());
        setRoleId(roleMember.getRoleId());
        setDescription(roleMember.getDescription());
    }
}