1 /* 2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/auth/params/AuthParams.java $ 3 * $Revision: 618365 $ 4 * $Date: 2008-02-04 10:20:08 -0800 (Mon, 04 Feb 2008) $ 5 * 6 * ==================================================================== 7 * Licensed to the Apache Software Foundation (ASF) under one 8 * or more contributor license agreements. See the NOTICE file 9 * distributed with this work for additional information 10 * regarding copyright ownership. The ASF licenses this file 11 * to you under the Apache License, Version 2.0 (the 12 * "License"); you may not use this file except in compliance 13 * with the License. You may obtain a copy of the License at 14 * 15 * http://www.apache.org/licenses/LICENSE-2.0 16 * 17 * Unless required by applicable law or agreed to in writing, 18 * software distributed under the License is distributed on an 19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20 * KIND, either express or implied. See the License for the 21 * specific language governing permissions and limitations 22 * under the License. 23 * ==================================================================== 24 * 25 * This software consists of voluntary contributions made by many 26 * individuals on behalf of the Apache Software Foundation. For more 27 * information on the Apache Software Foundation, please see 28 * <http://www.apache.org/>. 29 * 30 */ 31 32 package org.apache.http.auth.params; 33 34 import org.apache.http.params.HttpParams; 35 import org.apache.http.protocol.HTTP; 36 37 /** 38 * This class implements an adaptor around the {@link HttpParams} interface 39 * to simplify manipulation of the HTTP authentication specific parameters. 40 * 41 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 42 * 43 * @version $Revision: 618365 $ 44 * 45 * @since 4.0 46 * 47 * @see AuthPNames 48 */ 49 public final class AuthParams { 50 AuthParams()51 private AuthParams() { 52 super(); 53 } 54 55 /** 56 * Obtains the charset for encoding 57 * {@link org.apache.http.auth.Credentials}. 58 * If not configured, 59 * {@link HTTP#DEFAULT_PROTOCOL_CHARSET HTTP.DEFAULT_PROTOCOL_CHARSET} 60 * is used instead. 61 * 62 * @return The charset 63 * 64 * @see AuthPNames#CREDENTIAL_CHARSET 65 */ getCredentialCharset(final HttpParams params)66 public static String getCredentialCharset(final HttpParams params) { 67 if (params == null) { 68 throw new IllegalArgumentException("HTTP parameters may not be null"); 69 } 70 String charset = (String) params.getParameter 71 (AuthPNames.CREDENTIAL_CHARSET); 72 //@@@ TODO: inconsistent with JavaDoc in AuthPNames, 73 //@@@ TODO: check HTTP_ELEMENT_CHARSET first, or fix JavaDocs 74 if (charset == null) { 75 charset = HTTP.DEFAULT_PROTOCOL_CHARSET; 76 } 77 return charset; 78 } 79 80 81 /** 82 * Sets the charset to be used when encoding 83 * {@link org.apache.http.auth.Credentials}. 84 * 85 * @param charset The charset 86 */ setCredentialCharset(final HttpParams params, final String charset)87 public static void setCredentialCharset(final HttpParams params, final String charset) { 88 if (params == null) { 89 throw new IllegalArgumentException("HTTP parameters may not be null"); 90 } 91 params.setParameter(AuthPNames.CREDENTIAL_CHARSET, charset); 92 } 93 94 } 95