/*************************************************************************
 *                                                                       *
 *  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.protocol.validationservice.ws;

import org.signserver.common.IllegalRequestException;
import org.signserver.common.SignServerException;

/**
 * WebService interface for the Validation Service
 *
 * @author Philip Vendil
 * @version $Id: IValidationWS.java 1865 2011-09-27 13:22:17Z anatom $
 */
public interface IValidationWS {

    /**
     * WebService method used to check the revocation status of a certificate. It performs
     * calls to underlying validation services depending on CA issued the certificate.
     * 
     * The call also checks verification and validity of the certificate.
     * 
     * @param serviceName id or name of the validation service to validate the certificate
     * @param base64Cert the certificate to check in base64 encoding. 
     * @param certPurposes the intended purposes that the client want to use the certificate for a ',' separated string (optional). 
     * @return A response containing the status of the certificate.
     * @throws IllegalRequestException if the request contains illegal data.
     * @throws OperationFailedException if operation couldn't be performed due to application error or communication problems
     * with underlying systems.
     */
    ValidationResponse isValid(String serviceName, String base64Cert, String certPurposes)
            throws IllegalRequestException, SignServerException;

    /**
     * Method used to check the status of the current node of the service. The method checks
     * the availability of this and all underlying systems.
     * 
     * @param serviceName id or name of the validation service to check
     * 
     * @return a status message of the status of the system, returns the string "ALLOK" if the system
     * is running without any problems, otherwise will the message describing the error be returned.
     * 
     * @throws IllegalRequestException if the caller isn't authorized to perform this call.
     */
    String getStatus(String serviceName) throws IllegalRequestException;
}