com.backblaze.b2.client.B2AccountAuthorizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of b2-sdk-core Show documentation

The core logic for B2 SDK for Java. Does not include any implementations of B2WebApiClient.

There is a newer version: 6.3.0

/*
 * Copyright 2017, Backblaze Inc. All Rights Reserved.
 * License https://www.backblaze.com/using_b2_code.html
 */
package com.backblaze.b2.client;

import com.backblaze.b2.client.exceptions.B2Exception;
import com.backblaze.b2.client.structures.B2AccountAuthorization;

/**
 * B2AccountAuthorizer provides a mechanism to get an accountId and
 * a corresponding B2AccountAuthorization.  The accountId is expected
 * to never change.  The B2AccountAuthorization is required to make
 * a new authorization every time it is called.
 */
public interface B2AccountAuthorizer {
    /**
     * @return the accountId whose authorization this returns.
     */
    String getAccountId();

    /**
     * This will be called to get a new B2AccountAuthorization instance.
     *
     * @param webifier in case it's useful.  :)
     * @return an account authorization for the account this represents.
     * @throws B2Exception if it throws a B2UnauthorizedException, it must
     *                     ensure that the requestCategory is set to
     *                     ACCOUNT_AUTHORIZATION, so retries work properly.
     */
    B2AccountAuthorization authorize(B2StorageClientWebifier webifier) throws B2Exception;
}