/*************************************************************************
 *                                                                       *
 *  SignServer: The OpenSource Automated Signing Server                  *
 *                                                                       *
 *  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.signserver.server;

import java.util.Date;
import java.util.Properties;

/**
 * Interface defining an accurate time source, could be the local computer
 * clock or a connection to a time device.
 *
 * Its main function is getGenTime returning a java.util.Date
 *
 * @author philip
 * @version $Id: ITimeSource.java 2345 2012-05-06 09:03:57Z netmackan $
 */
public interface ITimeSource {

    /**
     * Method called after creation of instance.
     * @param props the signers properties
     */
    void init(Properties props);

    /**
     * Main method that should retrieve the current time from the device.
     * @return an accurate current time or null if it is not available.
     */
    Date getGenTime();
}