/*************************************************************************
 *                                                                       *
 *  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.statusrepo;

import java.util.Map;
import javax.ejb.Local;
import javax.ejb.Remote;
import org.signserver.statusrepo.common.NoSuchPropertyException;
import org.signserver.statusrepo.common.StatusEntry;

/**
 * Interface towards the status repository session bean.
 * 
 * @author Markus Kilås
 * @version $Id: IStatusRepositorySession.java 2139 2012-02-19 19:26:06Z netmackan $
 */
public interface IStatusRepositorySession {

    String LOG_OPERATION = "STATUSREPO_OPERATION";
    String LOG_PROPERTY = "STATUSREPO_PROPERTY";
    String LOG_VALUE = "STATUSREPO_VALUE";
    String LOG_EXPIRATION = "STATUSREPO_EXPIRATION";

    /**
     * Get a property.
     *
     * @param key Key to get the value for
     * @return The value if existing and not expired, otherwise null
     */
    StatusEntry getValidEntry(String key) throws NoSuchPropertyException;

    /**
     * Set a property without expiration, the value will live until the
     * application is restarted.
     *
     * @param key The key to set the value for
     * @param value The value to set
     */
    void update(String key, String value) throws NoSuchPropertyException;

     /**
     * Set a property with a given expiration timestamp.
     *
     * After the expiration the get method will return null.
     *
     * @param key The key to set the value for
     * @param value The value to set
     */
    void update(String key, String value, long expiration) throws NoSuchPropertyException;


    /**
     * @return An unmodifiable map of all properties
     */
    Map<String, StatusEntry> getAllEntries();

    /**
     * Remote interface.
     */
    @Remote
    interface IRemote extends IStatusRepositorySession {

        String JNDI_NAME = "signserver/StatusRepositorySessionBean/remote";
    }

    /**
     * Local interface.
     */
    @Local
    interface ILocal extends IStatusRepositorySession {

        String JNDI_NAME = "signserver/StatusRepositorySessionBean/local";
    }
}