mobile/android/thirdparty/ch/boye/httpclientandroidlib/auth/params/AuthParams.java

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 * Licensed to the Apache Software Foundation (ASF) under one
michael@0 4 * or more contributor license agreements. See the NOTICE file
michael@0 5 * distributed with this work for additional information
michael@0 6 * regarding copyright ownership. The ASF licenses this file
michael@0 7 * to you under the Apache License, Version 2.0 (the
michael@0 8 * "License"); you may not use this file except in compliance
michael@0 9 * with the License. You may obtain a copy of the License at
michael@0 10 *
michael@0 11 * http://www.apache.org/licenses/LICENSE-2.0
michael@0 12 *
michael@0 13 * Unless required by applicable law or agreed to in writing,
michael@0 14 * software distributed under the License is distributed on an
michael@0 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0 16 * KIND, either express or implied. See the License for the
michael@0 17 * specific language governing permissions and limitations
michael@0 18 * under the License.
michael@0 19 * ====================================================================
michael@0 20 *
michael@0 21 * This software consists of voluntary contributions made by many
michael@0 22 * individuals on behalf of the Apache Software Foundation. For more
michael@0 23 * information on the Apache Software Foundation, please see
michael@0 24 * <http://www.apache.org/>.
michael@0 25 *
michael@0 26 */
michael@0 27
michael@0 28 package ch.boye.httpclientandroidlib.auth.params;
michael@0 29
michael@0 30 import ch.boye.httpclientandroidlib.annotation.Immutable;
michael@0 31
michael@0 32 import ch.boye.httpclientandroidlib.params.HttpParams;
michael@0 33 import ch.boye.httpclientandroidlib.protocol.HTTP;
michael@0 34
michael@0 35 /**
michael@0 36 * An adaptor for manipulating HTTP authentication parameters
michael@0 37 * in {@link HttpParams}.
michael@0 38 *
michael@0 39 * @since 4.0
michael@0 40 *
michael@0 41 * @see AuthPNames
michael@0 42 */
michael@0 43 @Immutable
michael@0 44 public final class AuthParams {
michael@0 45
michael@0 46 private AuthParams() {
michael@0 47 super();
michael@0 48 }
michael@0 49
michael@0 50 /**
michael@0 51 * Obtains the charset for encoding
michael@0 52 * {@link ch.boye.httpclientandroidlib.auth.Credentials}.If not configured,
michael@0 53 * {@link HTTP#DEFAULT_PROTOCOL_CHARSET}is used instead.
michael@0 54 *
michael@0 55 * @return The charset
michael@0 56 */
michael@0 57 public static String getCredentialCharset(final HttpParams params) {
michael@0 58 if (params == null) {
michael@0 59 throw new IllegalArgumentException("HTTP parameters may not be null");
michael@0 60 }
michael@0 61 String charset = (String) params.getParameter
michael@0 62 (AuthPNames.CREDENTIAL_CHARSET);
michael@0 63 if (charset == null) {
michael@0 64 charset = HTTP.DEFAULT_PROTOCOL_CHARSET;
michael@0 65 }
michael@0 66 return charset;
michael@0 67 }
michael@0 68
michael@0 69
michael@0 70 /**
michael@0 71 * Sets the charset to be used when encoding
michael@0 72 * {@link ch.boye.httpclientandroidlib.auth.Credentials}.
michael@0 73 *
michael@0 74 * @param charset The charset
michael@0 75 */
michael@0 76 public static void setCredentialCharset(final HttpParams params, final String charset) {
michael@0 77 if (params == null) {
michael@0 78 throw new IllegalArgumentException("HTTP parameters may not be null");
michael@0 79 }
michael@0 80 params.setParameter(AuthPNames.CREDENTIAL_CHARSET, charset);
michael@0 81 }
michael@0 82
michael@0 83 }

mercurial