com.itextpdf.commons.bouncycastle.tsp.ITimeStampResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-android Show documentation
There is a newer version: 9.0.0
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2023 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.commons.bouncycastle.tsp;

import com.itextpdf.commons.bouncycastle.asn1.cmp.IPKIFailureInfo;

import java.io.IOException;

/**
 * This interface represents the wrapper for TimeStampResponse that provides the ability
 * to switch between bouncy-castle and bouncy-castle FIPS implementations.
 */
public interface ITimeStampResponse {
    /**
     * Calls actual {@code validate} method for the wrapped TimeStampResponse object.
     *
     * @param request TimeStampRequest wrapper
     *
     * @throws AbstractTSPException TSPException wrapper.
     */
    void validate(ITimeStampRequest request) throws AbstractTSPException;

    /**
     * Calls actual {@code getFailInfo} method for the wrapped TimeStampResponse object.
     *
     * @return {@link IPKIFailureInfo} the wrapper for the received PKIFailureInfo object.
     */
    IPKIFailureInfo getFailInfo();

    /**
     * Calls actual {@code getTimeStampToken} method for the wrapped TimeStampResponse object.
     *
     * @return {@link ITimeStampToken} the wrapper for the received TimeStampToken object.
     */
    ITimeStampToken getTimeStampToken();

    /**
     * Calls actual {@code getStatusString} method for the wrapped TimeStampResponse object.
     *
     * @return status string.
     */
    String getStatusString();

    /**
     * Calls actual {@code getEncoded} method for the wrapped TimeStampResponse object.
     *
     * @return the default encoding for the wrapped object.
     *
     * @throws IOException on encoding error.
     */
    byte[] getEncoded() throws IOException;
}