/*
 * Copyright 2003 Federal Chancellery Austria
 * MOA-SPSS has been developed in a cooperation between BRZ, the Federal
 * Chancellery Austria - ICT staff unit, and Graz University of Technology.
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 */

package at.gv.egovernment.moa.spss.server.config;

import java.math.BigInteger;

/**
 * A class containing information about an entry in a key group.
 *
 * @author Patrick Peck
 * @version $Id$
 */
public class KeyGroupEntry {
  /** The module ID of the key. */
  private final String moduleID;
  /** The issuer DN of the certificate identifying the key. */
  private final String issuerDN;
  /** The serial number of the certificate identifying the key. */
  private final BigInteger serialNumber;

  /**
   * Create a new <code>KeyGroupEntry</code>.
   *
   * @param moduleID        The key module ID to which this entry belongs to.
   * @param issuerAndSerial The issuer and serial number which uniquely identifies
   *                        a certificate within the key module.
   */
  public KeyGroupEntry(String moduleID, IssuerAndSerial issuerAndSerial) {
    this.moduleID = moduleID;
    this.issuerDN = issuerAndSerial.getIssuerDN();
    this.serialNumber = issuerAndSerial.getSerial();
  }

  /**
   * Create a new <code>KeyGroupEntry</code>.
   *
   * @param moduleID     The key module ID to which this entry belongs to.
   * @param issuerDN     The isser DN of the certificate within the key module.
   * @param serialNumber The serial number of the certificate within the key
   *                     module.
   */
  public KeyGroupEntry(
      String moduleID,
      String issuerDN,
      BigInteger serialNumber) {
    this.moduleID = moduleID;
    this.issuerDN = issuerDN;
    this.serialNumber = serialNumber;
  }

  /**
   * Return the key module ID to which this <code>KeyGroupEntry</code> belongs to.
   *
   * @return The key module ID.
   */
  public String getModuleID() {
    return moduleID;
  }

  /**
   * Return the issuer DN of this <code>KeyGroupEntry</code> for identifying the
   * certificate within the key module.
   *
   * @return The issuer DN of the certificate.
   */
  public String getIssuerDN() {
    return issuerDN;
  }

  /**
   * Return the serial number of this <code>KeyGroupEntry</code> for identifying
   * the certificate within the key module.
   *
   * @return The serial number of the certificate.
   */
  public BigInteger getSerialNumber() {
    return serialNumber;
  }

  /**
   * Compare this <code>KeyGroupEntry</code> to another.
   *
   * @param other The <code>KeyGroupEntry</code> to compare to.
   * @return <code>true</code>, if module ID, isser DN and serial number of
   *         <code>other</code> match the ones contained in this object, otherwise
   *         <code>false</code>.
   * @see java.lang.Object#equals(Object)
   */
  @Override
  public boolean equals(Object other) {
    if (other instanceof KeyGroupEntry) {
      final KeyGroupEntry entry = (KeyGroupEntry) other;
      return getModuleID().equals(entry.getModuleID())
          && getIssuerDN().equals(entry.getIssuerDN())
          && getSerialNumber().equals(entry.getSerialNumber());
    }
    return false;
  }

  /**
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode() {
    return getModuleID().hashCode()
        ^ getIssuerDN().hashCode()
        ^ getSerialNumber().hashCode();
  }
}