org.mule.module.http.api.HttpAuthentication Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mule-module-http Show documentation

Provides components for exposing and consuming HTTP services

There is a newer version: 3.9.0

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.module.http.api;

import org.mule.api.MuleEvent;
import org.mule.api.MuleException;
import org.mule.module.http.internal.domain.request.HttpRequestBuilder;

/**
 * An object that authenticates an HTTP request.
 */
public interface HttpAuthentication
{

    /**
     * Adds authentication information to the request. This method will be executed before creating and sending the
     * request. Implementations will usually add some authentication header, but there is no restriction on this.
     *
     * @param muleEvent The event that is being processed.
     * @param builder The builder that is being used to create the HTTP request.
     */
    void authenticate(MuleEvent muleEvent, HttpRequestBuilder builder) throws MuleException;

    /**
     * Detects if there was an authentication failure in the response. After sending an HTTP request and creating an
     * event with the response, this method will be executed. If it returns false, the flow continues executing. If
     * it returns true, the requester will try to send the request again.
     *
     * @param firstAttemptResponseEvent The event with the response of the request.
     * @return True if the request should be sent again, false otherwise.
     */
    boolean shouldRetry(MuleEvent firstAttemptResponseEvent) throws MuleException;

}