com.guardtime.ksi.service.KSIExtendingService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ksi-service-client Show documentation

Common module for all KSI service clients

There is a newer version: 4.19.220

/*
 * Copyright 2013-2017 Guardtime, Inc.
 *
 * This file is part of the Guardtime client SDK.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES, CONDITIONS, OR OTHER LICENSES OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 * "Guardtime" and "KSI" are trademarks or registered trademarks of
 * Guardtime, Inc., and no license to trademarks is granted; Guardtime
 * reserves and retains all trademark rights.
 */
package com.guardtime.ksi.service;

import com.guardtime.ksi.exceptions.KSIException;
import com.guardtime.ksi.pdu.ExtenderConfiguration;
import com.guardtime.ksi.pdu.ExtensionResponse;
import com.guardtime.ksi.pdu.ExtensionResponseFuture;

import java.io.Closeable;
import java.util.Date;
import java.util.List;

/**
 * Provides KSI services to communicate with extender(s).
 */
public interface KSIExtendingService extends Closeable {

    /**
     * Used to extend existing signatures.
     *
     * @param aggregationTime - aggregation time of the existing signature.
     * @param publicationTime - publication time to which the existing signature is to be extended.
     * @return instance of {@link ExtensionResponseFuture} containing calendar chains needed to extend the signature.
     */
    Future extend(Date aggregationTime, Date publicationTime) throws KSIException;

    /**
     * If the implementation combines multiple clients then this method can be used to get those subservices. If the implementation
     * is a client that directly connects to a single gateway then it will return an empty list.
     */
    List getSubExtendingServices();

    /**
     * Registers a new {@link ConfigurationListener } for the client. Each time client's configuration is
     * update is handled, this listener is called.
     */
    void registerExtenderConfigurationListener(ConfigurationListener listener);

    /**
     * Makes the client ask for configuration update. On completion of the update config registered {@link ConfigurationListener}s
     * are called
     *
     * @return Future of the {@link ExtenderConfiguration}
     */
    Future getExtendingConfiguration();

}