JiraWebSessionCallback.java Source code

Introduction

Here is the source code for JiraWebSessionCallback.java

Source

/*******************************************************************************
 * Copyright (c) 2004, 2008 Brock Janiczak and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Brock Janiczak - initial API and implementation
 *     Tasktop Technologies - improvements
 *******************************************************************************/

import java.io.IOException;

import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HostConfiguration;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpMethod;
import org.apache.commons.httpclient.HttpMethodBase;
import org.apache.commons.httpclient.HttpStatus;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.mylyn.commons.net.Policy;
import org.eclipse.mylyn.commons.net.WebUtil;

import com.atlassian.connector.eclipse.internal.jira.core.model.JiraIssue;
import com.atlassian.connector.eclipse.internal.jira.core.service.JiraClient;
import com.atlassian.connector.eclipse.internal.jira.core.service.JiraException;
import com.atlassian.connector.eclipse.internal.jira.core.service.JiraRedirectException;

/**
 * @author Steffen Pingel
 */
public abstract class JiraWebSessionCallback {

    private HostConfiguration hostConfiguration;

    private HttpClient httpClient;

    private String baseUrl;

    private boolean followRedirects;

    public void configure(HttpClient httpClient, HostConfiguration hostConfiguration, String baseUrl,
            boolean followRedirects) {
        this.httpClient = httpClient;
        this.hostConfiguration = hostConfiguration;
        this.baseUrl = baseUrl;
        this.followRedirects = followRedirects;
    }

    public int execute(HttpMethod method) throws JiraException {
        return execute(method, Policy.monitorFor(null));
    }

    public int execute(HttpMethod method, IProgressMonitor monitor) throws JiraException {
        try {
            return WebUtil.execute(httpClient, hostConfiguration, method, monitor);
        } catch (IOException e) {
            throw new JiraException(e);
        }
    }

    public abstract void run(JiraClient client, String baseUrl, IProgressMonitor monitor)
            throws JiraException, IOException;

    protected boolean expectRedirect(HttpMethodBase method, JiraIssue issue) throws JiraException {
        return expectRedirect(method, "/browse/" + issue.getKey()); //$NON-NLS-1$
    }

    protected boolean expectRedirect(HttpMethodBase method, String page) throws JiraException {
        return expectRedirect(method, page, true);
    }

    protected boolean expectRedirect(HttpMethodBase method, String page, boolean fullMatch) throws JiraException {
        if (method.getStatusCode() != HttpStatus.SC_MOVED_TEMPORARILY) {
            return false;
        }

        Header locationHeader = method.getResponseHeader("location"); //$NON-NLS-1$
        if (locationHeader == null) {
            throw new JiraRedirectException();
        }
        String url = locationHeader.getValue();
        if (fullMatch) {
            // only if followRedirects is enabled the baseUrl is guaranteed to match the redirect url, otherwise the repository might be sending back a different url 
            if ((followRedirects && !url.startsWith(baseUrl + page)) || (!followRedirects && !url.endsWith(page))) {
                throw new JiraRedirectException(url);
            }
        } else {
            // the client does not know exactly where the repository will redirect to
            if (!url.contains(page)) {
                throw new JiraRedirectException(url);
            }
        }
        return true;
    }

}