org.apache.http.entity.ContentType Maven / Gradle / Ivy
The newest version!
/*
* ====================================================================
* 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* Content-Type header.
*/
@Override
public String toString() {
final CharArrayBuffer buf = new CharArrayBuffer(64);
buf.append(this.mimeType);
if (this.params != null) {
buf.append("; ");
BasicHeaderValueFormatterHC4.INSTANCE.formatParameters(buf, this.params, false);
} else if (this.charset != null) {
buf.append("; charset=");
buf.append(this.charset.name());
}
return buf.toString();
}
private static boolean valid(final String s) {
for (int i = 0; i < s.length(); i++) {
final char ch = s.charAt(i);
if (ch == '"' || ch == ',' || ch == ';') {
return false;
}
}
return true;
}
/**
* Creates a new instance of {@link ContentType}.
*
* @param mimeType MIME type. It may not be null or empty. It may not contain
* characters <">, <;>, <,> reserved by the HTTP specification.
* @param charset charset.
* @return content type
*/
public static ContentType create(final String mimeType, final Charset charset) {
final String type = Args.notBlank(mimeType, "MIME type").toLowerCase(Locale.US);
Args.check(valid(type), "MIME type may not contain reserved characters");
return new ContentType(type, charset);
}
/**
* Creates a new instance of {@link ContentType} without a charset.
*
* @param mimeType MIME type. It may not be null or empty. It may not contain
* characters <">, <;>, <,> reserved by the HTTP specification.
* @return content type
*/
public static ContentType create(final String mimeType) {
return new ContentType(mimeType, (Charset) null);
}
/**
* Creates a new instance of {@link ContentType}.
*
* @param mimeType MIME type. It may not be null or empty. It may not contain
* characters <">, <;>, <,> reserved by the HTTP specification.
* @param charset charset. It may not contain characters <">, <;>, <,> reserved by the HTTP
* specification. This parameter is optional.
* @return content type
* @throws UnsupportedCharsetException Thrown when the named charset is not available in
* this instance of the Java virtual machine
*/
public static ContentType create(
final String mimeType, final String charset) throws UnsupportedCharsetException {
return create(mimeType, !TextUtils.isBlank(charset) ? Charset.forName(charset) : null);
}
private static ContentType create(final HeaderElement helem) {
final String mimeType = helem.getName();
final NameValuePair[] params = helem.getParameters();
return new ContentType(mimeType, params != null && params.length > 0 ? params : null);
}
/**
* Parses textual representation of Content-Type value.
*
* @param s text
* @return content type
* @throws ParseException if the given text does not represent a valid
* Content-Type value.
* @throws UnsupportedCharsetException Thrown when the named charset is not available in
* this instance of the Java virtual machine
*/
public static ContentType parse(
final String s) throws ParseException, UnsupportedCharsetException {
Args.notNull(s, "Content type");
final CharArrayBuffer buf = new CharArrayBuffer(s.length());
buf.append(s);
final ParserCursor cursor = new ParserCursor(0, s.length());
final HeaderElement[] elements = BasicHeaderValueParserHC4.INSTANCE.parseElements(buf, cursor);
if (elements.length > 0) {
return create(elements[0]);
} else {
throw new ParseException("Invalid content type: " + s);
}
}
/**
* Extracts Content-Type value from {@link HttpEntity} exactly as
* specified by the Content-Type header of the entity. Returns null
* if not specified.
*
* @param entity HTTP entity
* @return content type
* @throws ParseException if the given text does not represent a valid
* Content-Type value.
* @throws UnsupportedCharsetException Thrown when the named charset is not available in
* this instance of the Java virtual machine
*/
public static ContentType get(
final HttpEntity entity) throws ParseException, UnsupportedCharsetException {
if (entity == null) {
return null;
}
final Header header = entity.getContentType();
if (header != null) {
final HeaderElement[] elements = header.getElements();
if (elements.length > 0) {
return create(elements[0]);
}
}
return null;
}
/**
* Extracts Content-Type value from {@link HttpEntity} or returns the default value
* {@link #DEFAULT_TEXT} if not explicitly specified.
*
* @param entity HTTP entity
* @return content type
* @throws ParseException if the given text does not represent a valid
* Content-Type value.
* @throws UnsupportedCharsetException Thrown when the named charset is not available in
* this instance of the Java virtual machine
*/
public static ContentType getOrDefault(
final HttpEntity entity) throws ParseException, UnsupportedCharsetException {
final ContentType contentType = get(entity);
return contentType != null ? contentType : DEFAULT_TEXT;
}
/**
* Creates a new instance with this MIME type and the given Charset.
*
* @param charset charset
* @return a new instance with this MIME type and the given Charset.
* @since 4.3
*/
public ContentType withCharset(final Charset charset) {
return create(this.getMimeType(), charset);
}
/**
* Creates a new instance with this MIME type and the given Charset name.
*
* @param charset name
* @return a new instance with this MIME type and the given Charset name.
* @throws UnsupportedCharsetException Thrown when the named charset is not available in
* this instance of the Java virtual machine
* @since 4.3
*/
public ContentType withCharset(final String charset) {
return create(this.getMimeType(), charset);
}
}