/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/ds/resource/legal-notices/cddl.txt
 * or http://www.opensource.org/licenses/cddl1.php.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/ds/resource/legal-notices/cddl.txt.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2010-2016 UnboundID Corp.
 */
package com.unboundid.directory.sdk.broker.types;

import com.unboundid.util.Mutable;
import com.unboundid.util.NotExtensible;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;

import java.util.Collections;
import java.util.Date;
import java.util.Iterator;
import java.util.Set;

/**
 * This class provides a data structure for working with OAuth2 access tokens.
 */
@NotExtensible()
@Mutable()
@ThreadSafety(level= ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class AccessToken extends Token
{
  // The user ID associated with this token.
  private final String userId;

  // The set of scope IDs for which the application has requested or authorized.
  private final Set<String> scopeIds;

  // The refresh token associated with this access token.
  private volatile RefreshToken refreshToken;

  /**
   * Construct a new access token instance.
   *
   * @param userId The user ID of the resource owner this access token is
   *                 associated with or the application ID if resource owner
   *                 authentication was not performed.
   * @param applicationId The application ID with which this token is
   *                      associated. Must not be null.
   * @param generateTimestamp The time that this token was generated. Must not
   *                          be null.
   * @param maxValiditySeconds The maximum length of time in seconds that this
   *                           token will be considered valid. Must not be null
   *                           and must not be negative.
   * @param scopeIds The set of scopes for which the client has been authorized.
   *                 Must not be null.
   */
  public AccessToken(final String userId, final String applicationId,
                     final Date generateTimestamp,
                     final long maxValiditySeconds, final Set<String> scopeIds)
  {
    super(applicationId, scopeIds, generateTimestamp, maxValiditySeconds);
    this.userId = userId;
    this.scopeIds = Collections.unmodifiableSet(scopeIds);
  }

  /**
   * Retrieves the user ID of the resource owner this access token is
   * associated with. Some grant types don't require resource owner involvement
   * (ie. client_credentials), the userId may be equal to the application ID in
   * such cases.
   *
   * @return The user ID of the resource owner this access token is associated
   *         with or equal to the application ID if resource owner
   *         authentication was not performed.
   */
  public String getUserId()
  {
    return userId;
  }

  /**
   * Retrieves the refresh token associated with this access token.
   *
   * @return The refresh token associated with this access token or {@code null}
   *         if there is no associated refresh token.
   */
  public RefreshToken getRefreshToken()
  {
    return refreshToken;
  }

  /**
   * Sets the refresh token associated with this access token.
   *
   * @param refreshToken The refresh token associated with this access token.
   */
  public void setRefreshToken(final RefreshToken refreshToken)
  {
    Validator.ensureNotNull(refreshToken);
    this.refreshToken = refreshToken;
  }

  /**
   * Retrieves a hash code for this access token.
   *
   * @return  A hash code for this access token.
   */
  @Override
  public int hashCode()
  {
    final int prime = 31;
    int result = super.hashCode();
    result = prime * result + (userId != null ? userId.hashCode() : 0);
    result = prime * result + (scopeIds != null ? scopeIds.hashCode() : 0);
    return result;
  }

  /**
   * Indicates whether the provided object is equal to this access token.
   *
   * @param  o  The object for which to make the determination.
   *
   * @return  {@code true} if the provided object is equal to this authorization
   *          code, or {@code false} if not.
   */
  @Override
  public boolean equals(final Object o)
  {
    if (this == o)
    {
      return true;
    }
    if (o == null || getClass() != o.getClass())
    {
      return false;
    }

    AccessToken that = (AccessToken) o;

    if (scopeIds != null ?
        !scopeIds.equals(that.scopeIds) :
        that.scopeIds != null)
    {
      return false;
    }
    if (userId != null ?
        !userId.equals(that.userId) :
        that.userId != null)
    {
      return false;
    }
    if (refreshToken != null ?
        !refreshToken.equals(that.refreshToken) :
        that.refreshToken != null)
    {
      return false;
    }

    return super.equals(o);
  }

  /**
   * Appends a string representation of this access token to the provided
   * buffer.
   *
   * @param  buffer  The buffer to which the string representation should be
   *                 appended.
   */
  protected void toString(final StringBuilder buffer)
  {
    buffer.append("AccessToken(userId='");
    buffer.append(userId);
    buffer.append("', appID=");
    buffer.append(getApplicationId());
    buffer.append(", generateTimestamp=");
    buffer.append(getGenerateTimestamp());
    buffer.append("', maxValiditySeconds=");
    buffer.append(getMaxValiditySeconds());
    buffer.append(", value=");
    buffer.append(getValue());

    if (! scopeIds.isEmpty())
    {
      buffer.append(", scopes={");

      final Iterator<String> iterator = scopeIds.iterator();
      while (iterator.hasNext())
      {
        buffer.append(iterator.next());
        if (iterator.hasNext())
        {
          buffer.append(", ");
        }
      }

      buffer.append('}');
    }

    buffer.append("')");
  }
}