com.github.triceo.robozonky.app.investing.AbstractInvestmentMode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of robozonky-app Show documentation
There is a newer version: 4.0.0-beta-5
/*
 * Copyright 2017 Lukáš Petrovický
 *
 * 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 OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.github.triceo.robozonky.app.investing;

import java.util.Collection;
import java.util.Optional;
import java.util.concurrent.Semaphore;
import java.util.function.Consumer;
import java.util.function.Function;

import com.github.triceo.robozonky.api.remote.entities.Investment;
import com.github.triceo.robozonky.api.remote.entities.Loan;
import com.github.triceo.robozonky.api.strategies.LoanDescriptor;
import com.github.triceo.robozonky.app.authentication.ApiProvider;
import com.github.triceo.robozonky.app.authentication.AuthenticationHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

abstract class AbstractInvestmentMode implements InvestmentMode {

    protected final Logger LOGGER = LoggerFactory.getLogger(this.getClass());

    private final boolean isFaultTolerant;
    private final AuthenticationHandler authenticationHandler;
    private final ZonkyProxy.Builder proxyBuilder;

    protected AbstractInvestmentMode(final AuthenticationHandler authenticationHandler,
                                     final ZonkyProxy.Builder builder,
                                     final boolean isFaultTolerant) {
        this.authenticationHandler = authenticationHandler;
        this.proxyBuilder = builder;
        this.isFaultTolerant = isFaultTolerant;
    }

    @Override
    public boolean isFaultTolerant() {
        return isFaultTolerant;
    }

    @Override
    public boolean isDryRun() {
        return this.proxyBuilder.isDryRun();
    }

    protected ZonkyProxy.Builder getProxyBuilder() {
        return proxyBuilder;
    }

    protected AuthenticationHandler getAuthenticationHandler() {
        return authenticationHandler;
    }

    protected abstract Optional> execute(final ApiProvider apiProvider);

    @Override
    public Optional> get() {
        try (final ApiProvider api = new ApiProvider()) {
            LOGGER.trace("Executing.");
            return this.execute(api);
        } finally {
            LOGGER.trace("Finished.");
        }
    }

    /**
     * Start marketplace which will be putting loans into a given buffer.
     *
     * @param target The buffer to start putting loans into.
     */
    protected abstract void openMarketplace(Consumer> target);

    /**
     * Provide the investing algorithm.
     *
     * @param apiProvider API provider to use when constructing the investing mechanism.
     * @return Investments made by the algorithm.
     */
    protected abstract Function, Collection> getInvestor(ApiProvider apiProvider);

    /**
     * Execute the algorithm and give it a circuit breaker which, when turning true, tells the orchestration to
     * finish the operation and terminate.
     *
     * @param apiProvider The API provider to use when constructing the investing mechanism.
     * @param circuitBreaker Release in order to have this method stop and return.
     * @return Investments made while this method was running, or empty if failure.
     */
    protected Optional> execute(final ApiProvider apiProvider, final Semaphore circuitBreaker) {
        LOGGER.trace("Executing.");
        try {
            final ResultTracker buffer = new ResultTracker();
            final Consumer> investor = (loans) -> {
                final Collection descriptors = buffer.acceptLoansFromMarketplace(loans);
                final Collection result = getInvestor(apiProvider).apply(descriptors);
                buffer.acceptInvestmentsFromRobot(result);
            };
            openMarketplace(investor);
            LOGGER.trace("Will wait for user stop.");
            circuitBreaker.acquireUninterruptibly(Math.max(1, circuitBreaker.availablePermits()));
            LOGGER.trace("User stop received.");
            circuitBreaker.release();
            return Optional.of(buffer.getInvestmentsMade());
        } catch (final Exception ex) {
            LOGGER.error("Failed executing investments.", ex);
            return Optional.empty();
        }
    }

    @Override
    public void close() throws Exception {
        LOGGER.trace("Closing investing operations.");
    }
}