com.guardtime.ksi.pdu.AggregatorConfiguration 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-2016 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.pdu;

import com.guardtime.ksi.hashing.HashAlgorithm;

import java.util.List;

/**
 * Interface for aggregator configuration.
 */
public interface AggregatorConfiguration {

    /**
     * Return the maximum level value that the client's aggregation tree are allowed to have.
     */
    Long getMaximumLevel();

    /**
     * Return the  hash function that the client is recommended to use in its aggregation trees.
     */
    HashAlgorithm getAggregationAlgorithm();

    /**
     * Return the recommended duration of client's aggregation round, in milliseconds.
     */
    Long getAggregationPeriod();

    /**
     * Returns the maximum number of requests the client is allowed to send within one aggregation period of the
     * recommended duration.
     */
    Long getMaximumRequests();

    /**
     * Returns a list of parent server URI-s
     */
    List getParents();

}