/*
    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed 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 de.smartics.properties.impl.config.domain.key.rtaware;
  
  import org.apache.commons.lang.StringUtils;
  
  import de.smartics.properties.api.config.domain.key.ApplicationId;
  import de.smartics.properties.api.config.domain.key.EnvironmentId;
  import de.smartics.properties.impl.config.domain.key.envapp.AbstractConfigurationKey;
  import de.smartics.util.lang.Arg;
  
  /**
   * The configuration key identifies a configuration with environment and
   * application information. With this key all configuration values can be
   * accessed by their local configuration keys.
   */
  public final class TenantUserConfigurationKey extends
      AbstractConfigurationKey<TenantUserConfigurationKey>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The identifier of the tenant the configuration is for.
     *
     * @serial
     */
    private final TenantId tenantId;
  
    /**
     * The identifier of the user the configuration is for.
     *
     * @serial
     */
    private final UserId userId;
  
    /**
     * The pre-calculated hash code of this instance.
     *
     * @serial
     */
    private final int hashCodeValue;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor for any tenant and any user..
     *
     * @param environmentId the identifier of the environment the application is
     *          deployed in.
     * @param applicationId the identifier of the application whose configuration
     *          is requested.
     * @throws NullPointerException if {@code environmentId} or
     *           {@code applicationId} is <code>null</code>.
     */
    public TenantUserConfigurationKey(final EnvironmentId environmentId,
        final ApplicationId applicationId) throws NullPointerException
    {
      this(environmentId, applicationId, TenantId.ANY_TENANT, UserId.ANY_USER);
    }
  
    /**
     * Default constructor.
     *
     * @param environmentId the identifier of the environment the application is
     *          deployed in.
     * @param applicationId the identifier of the application whose configuration
     *          is requested.
     * @param tenantId the identifier of the tenant the configuration is for.
     * @param userId the identifier of the user the configuration is for.
     * @throws NullPointerException if {@code environmentId},
     *           {@code applicationId}, {@code tenantId}, or {@code userId} is
     *           <code>null</code>.
    */
   public TenantUserConfigurationKey(final EnvironmentId environmentId,
       final ApplicationId applicationId, final TenantId tenantId,
       final UserId userId) throws NullPointerException
   {
     super(environmentId, applicationId);
     this.tenantId = Arg.checkNotNull("tenantId", tenantId);
     this.userId = Arg.checkNotNull("userId", userId);
     this.hashCodeValue = calcHashCode();
   }
 
   /**
    * Copy constructor.
    *
    * @param key the key to copy.
    * @param appId the appId to set into the copy.
    * @throws NullPointerException if {@code key} or {@code appId} is
    *           <code>null</code>.
    */
   public TenantUserConfigurationKey(final TenantUserConfigurationKey key,
       final ApplicationId appId) throws NullPointerException
   {
     this(key.getEnvironmentId(), appId, key.tenantId, key.userId);
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   private int calcHashCode()
   {
     int result = super.hashCodeValue;
     result = 37 * result + tenantId.hashCode();
     result = 37 * result + userId.hashCode();
 
     return result;
   }
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the identifier of the tenant the configuration is for.
    *
    * @return the identifier of the tenant the configuration is for.
    */
   public TenantId getTenantId()
   {
     return tenantId;
   }
 
   /**
    * Returns the identifier of the user the configuration is for.
    *
    * @return the identifier of the user the configuration is for.
    */
   public UserId getUserId()
   {
     return userId;
   }
 
   // --- business -------------------------------------------------------------
 
   @Override
   public boolean hasActiveDynamicParts()
   {
     return !(TenantId.ANY_TENANT.equals(this.tenantId) && UserId.ANY_USER
         .equals(this.userId));
   }
 
   // --- object basics --------------------------------------------------------
 
   /**
    * Returns the hash code of the object.
    *
    * @return the hash code.
    */
   @Override
   public int hashCode()
   {
     return hashCodeValue;
   }
 
   /**
    * Returns <code>true</code> if the given object is semantically equal to the
    * given object, <code>false</code> otherwise.
    *
    * @param object the instance to compare to.
    * @return <code>true</code> if the given object is semantically equal to the
    *         given object, <code>false</code> otherwise.
    */
   @Override
   public boolean equals(final Object object)
   {
     if (this == object)
     {
       return true;
     }
     else if (!super.equals(object))
     {
       return false;
     }
 
     final TenantUserConfigurationKey other =
         (TenantUserConfigurationKey) object;
 
     return (tenantId.equals(other.tenantId) && userId.equals(other.userId));
   }
 
   @Override
   public int compareTo(final TenantUserConfigurationKey o)
   {
     int result = super.compareTo(o);
     if (result == 0)
     {
       result = tenantId.compareTo(o.tenantId);
     }
     if (result == 0)
     {
       result = userId.compareTo(o.userId);
     }
     return result;
   }
 
   @Override
   public String toString()
   {
     final StringBuilder buffer = new StringBuilder();
 
     final String userIdString = userId.toString();
     if (StringUtils.isNotBlank(userIdString))
     {
       buffer.append(userIdString);
     }
     buffer.append('/');
 
     final String tenantIdString = tenantId.toString();
     if (StringUtils.isNotBlank(tenantIdString))
     {
       buffer.append(tenantIdString);
     }
     buffer.append('/');
 
     buffer.append(super.toString());
 
     if (buffer.length() == 0)
     {
       buffer.append("<no named key>");
     }
     return buffer.toString();
   }
 }