org.apache.servicemix.http.BasicAuthCredentials Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of servicemix-http Show documentation
There is a newer version: 2013.01
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.servicemix.http;

import javax.jbi.messaging.MessageExchange;
import javax.jbi.messaging.MessagingException;
import javax.jbi.messaging.NormalizedMessage;

import org.apache.commons.httpclient.Credentials;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.apache.commons.httpclient.auth.AuthScope;
import org.apache.servicemix.expression.Expression;

/**
 * @author roehl.sioson
 * @org.apache.xbean.XBean element="basicAuthCredentials"
 * description="This class contains parameters needed to send basic authentication credentials"
 */
public class BasicAuthCredentials {

    protected Expression username;
    protected Expression password;

    public BasicAuthCredentials() {
    }

    /**
     * @return Returns the username.
     */
    public Expression getUsername() {
        return username;
    }

    /**
     * @param ssl The username to set.
     */
    public void setUsername(Expression username) {
        this.username = username;
    }

    /**
     * @return Returns the password.
     */
    public Expression getPassword() {
        return password;
    }

    /**
     * @param ssl The password to set.
     */
    public void setPassword(Expression password) {
        this.password = password;
    }


    /**
     * Applies this authentication to the given method.
     *
     * @param client the client on which to set the authentication information
     * @param exchange the message exchange to be used for evaluating the expression
     * @param message the normalized message to be used for evaluating the expression
     * @throws MessagingException if the correct value for username/password cannot be determined when using an expression
     */
    public void applyCredentials(HttpClient client, MessageExchange exchange, NormalizedMessage message) throws MessagingException {
        AuthScope scope = new AuthScope(AuthScope.ANY_HOST, AuthScope.ANY_PORT);
        Credentials credentials = 
            new UsernamePasswordCredentials((String) this.username.evaluate(exchange, message), 
                    (String) this.password.evaluate(exchange, message));
        client.getState().setCredentials(scope, credentials);
    }

    /**
     * Applies this authentication to the given method.
     *
     * @param client the client on which to set the authentication information
     * @param exchange the message exchange to be used for evaluating the expression
     * @param message the normalized message to be used for evaluating the expression
     * @throws MessagingException if the correct value for user name/password cannot be determined when using an expression
     */
    public void applyProxyCredentials(HttpClient client, MessageExchange exchange, NormalizedMessage message) throws MessagingException {
        AuthScope scope = new AuthScope(AuthScope.ANY_HOST, AuthScope.ANY_PORT);
        Credentials credentials = 
            new UsernamePasswordCredentials((String) this.username.evaluate(exchange, message), 
                    (String) this.password.evaluate(exchange, message));
        client.getState().setProxyCredentials(scope, credentials);
    }

}