SCM-Manager/scm-webapp/src/main/java/sonia/scm/security/SecureKey.java

/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
    
package sonia.scm.security;

//~--- non-JDK imports --------------------------------------------------------

import com.google.common.base.Objects;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

//~--- JDK imports ------------------------------------------------------------

/**
 * Secure key can be used for singing messages and tokens.
 *
 * @author Sebastian Sdorra
 * @since 2.0.0
 */
@XmlRootElement(name = "secure-key")
@XmlAccessorType(XmlAccessType.FIELD)
public final class SecureKey
{

  /**
   * Constructs a new secure key.
   * This constructor should only be used by jaxb.
   *
   */
  SecureKey() {}

  /**
   * Constructs a new secure key.
   *
   *
   * @param bytes bytes of key
   * @param creationDate creation date
   */
  public SecureKey(byte[] bytes, long creationDate)
  {
    this.bytes = bytes;
    this.creationDate = creationDate;
  }

  //~--- methods --------------------------------------------------------------

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean equals(Object obj)
  {
    if (obj == null)
    {
      return false;
    }

    if (getClass() != obj.getClass())
    {
      return false;
    }

    final SecureKey other = (SecureKey) obj;

    return Objects.equal(bytes, other.bytes)
      && Objects.equal(creationDate, other.creationDate);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public int hashCode()
  {
    return Objects.hashCode(bytes, creationDate);
  }

  //~--- get methods ----------------------------------------------------------

  /**
   * Returns the bytes of the key.
   *
   *
   * @return bytes of key
   */
  public byte[] getBytes()
  {
    return bytes;
  }

  /**
   * Returns the creation date of the key.
   *
   *
   * @return key creation date
   */
  public long getCreationDate()
  {
    return creationDate;
  }

  //~--- fields ---------------------------------------------------------------

  /** bytes of key */
  private byte[] bytes;

  /** creation date */
  private long creationDate;
}