org.eclipse.cft.server.core.internal.client.ClientRequest.java Source code

Introduction

Here is the source code for org.eclipse.cft.server.core.internal.client.ClientRequest.java

Source

/*******************************************************************************
 * Copyright (c) 2012, 2016 Pivotal Software, Inc. and others 
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution. 
 * 
 * The Eclipse Public License is available at 
 * 
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * and the Apache License v2.0 is available at 
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * You may elect to redistribute this code under either of these licenses.
 *  
 *  Contributors:
 *     Pivotal Software, Inc. - initial API and implementation
 ********************************************************************************/
package org.eclipse.cft.server.core.internal.client;

import org.cloudfoundry.client.lib.CloudFoundryOperations;
import org.eclipse.cft.server.core.internal.CloudErrorUtil;
import org.eclipse.cft.server.core.internal.CloudFoundryLoginHandler;
import org.eclipse.cft.server.core.internal.CloudFoundryPlugin;
import org.eclipse.cft.server.core.internal.CloudFoundryServer;
import org.eclipse.cft.server.core.internal.Messages;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.osgi.util.NLS;
import org.springframework.security.oauth2.common.OAuth2AccessToken;

/**
 * A Request performs a CF request via the cloudfoundry-client-lib API. It
 * performs various error handling and connection checks that are generally
 * common to most client requests, and therefore any client request should be
 * wrapped around a Request.
 * <p/>
 * By default, the set of client calls in the Request is made twice, the first
 * time it is executed immediate. If it fails due to connection error error, it
 * will attempt a second time.
 * <p/>
 * Subtypes can modify this behaviour and add conditions that will result in
 * further retries aside from connection errors.
 * 
 * 
 * @deprecated Only used for v1 client support. Use {@link CloudServerRequest} for wrapper client support
 */
public abstract class ClientRequest<T> extends BaseClientRequest<T> {

    public ClientRequest(String label) {
        super(label);
    }

    /**
     * Attempts to execute the client request by first checking proxy settings,
     * and if unauthorised/forbidden exceptions thrown the first time, will
     * attempt to log in. If that succeeds, it will attempt one more time.
     * Otherwise it will fail and not attempt the request any further.
     * @param client
     * @param cloudServer
     * @param subProgress
     * @return
     * @throws CoreException if attempt to execute failed, even after a second
     * attempt after a client login.
     */
    @Override
    protected T runAndWait(CloudFoundryOperations client, SubMonitor subProgress) throws CoreException {
        try {
            return super.runAndWait(client, subProgress);
        } catch (CoreException ce) {

            CloudFoundryServer server = null;
            if (this instanceof BehaviourRequest) {
                // Optionally, child requests may provide a cloud server for use by the login handler
                BehaviourRequest<?> br = (BehaviourRequest<T>) this;
                server = br.getCloudServer();
            }

            CloudFoundryLoginHandler handler = new CloudFoundryLoginHandler(client, server);

            CoreException accessError = null;
            String accessErrorMessage = null;

            if (handler.shouldAttemptClientLogin(ce)) {
                CloudFoundryPlugin
                        .logWarning(NLS.bind(Messages.ClientRequest_RETRY_REQUEST, getTokenAccessErrorLabel()));
                accessError = ce;

                int attempts = 3;
                OAuth2AccessToken token = handler.login(subProgress, attempts,
                        CloudOperationsConstants.LOGIN_INTERVAL);
                if (token == null) {
                    accessErrorMessage = Messages.ClientRequest_NO_TOKEN;
                } else if (token.isExpired()) {
                    accessErrorMessage = Messages.ClientRequest_TOKEN_EXPIRED;
                } else {
                    try {
                        return super.runAndWait(client, subProgress);
                    } catch (CoreException e) {
                        accessError = e;
                    }
                }
            }

            if (accessError != null) {
                Throwable cause = accessError.getCause() != null ? accessError.getCause() : accessError;
                if (accessErrorMessage == null) {
                    accessErrorMessage = accessError.getMessage();
                }
                accessErrorMessage = NLS.bind(Messages.ClientRequest_SECOND_ATTEMPT_FAILED,
                        getTokenAccessErrorLabel(), accessErrorMessage);

                throw CloudErrorUtil.toCoreException(accessErrorMessage, cause);
            }
            throw ce;
        }
    }

    /**
     * Return a label used to indicate the request type and other additional
     * information, like server name.
     */
    protected String getTokenAccessErrorLabel() {
        return getRequestLabel();
    }
}