org.apache.jackrabbit.oak.http.MediaRange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oak-http Show documentation
There is a newer version: 1.8.2
/*
 * 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.jackrabbit.oak.http;

import java.util.HashMap;
import java.util.Map;

import org.apache.tika.mime.MediaType;
import org.apache.tika.mime.MediaTypeRegistry;

public class MediaRange {

    private final MediaType type;

    private final double q;

    private static final int QRESOLUTION = 1000;
    private static double CORRECTIONFORSUBTYPEMATCH = 1f / (10 * QRESOLUTION);
    private static double CORRECTIONFORTYPEANDSUBTYPEMATCH = 2f / (10 * QRESOLUTION);
    
    public static MediaRange parse(String range, MediaTypeRegistry registry) {
        MediaType type = MediaType.parse(range);
        if (type == null) {
            return null;
        }
        type = registry.normalize(type);

        Map parameters =
                new HashMap(type.getParameters());
        String q = parameters.remove("q");
        if (q != null) {
            try {
                return new MediaRange(
                        new MediaType(type.getBaseType(), parameters),
                        Double.parseDouble(q));
            } catch (NumberFormatException e) {
                return null;
            }
        }

        return new MediaRange(type, 1.0);
    }

    public MediaRange(MediaType type, double q) {
        this.type = type;
        this.q = q;
    }

    /**
     * Matches the media range against the specified media type.
     * 
     * The "derived" quality value if computed from the specified q value (0 to
     * 1) by subtracting 1/10000 in case the subtype in the range is "*", or
     * 2/10000 if case both type and subtype are. This takes care of the
     * precedence specified in RFC 7231, Section 5.3.2.
     *
     * @param type
     *            type to match
     * @param registry
     *            media type registry
     * @return {@code 0.0} for "no match", the derived quality value if match
     */
    public double match(MediaType type, MediaTypeRegistry registry) {
        if (type.equals(this.type)) { // shortcut
            return q;
        }

        for (Map.Entry entry
                : this.type.getParameters().entrySet()) {
            String key = entry.getKey();
            String value = entry.getValue();
            if (!value.equals(type.getParameters().get(key))) {
                return 0.0;
            }
        }

        if (q > 0.0 && "*/*".equals(this.type.toString())) {
            return q - CORRECTIONFORTYPEANDSUBTYPEMATCH;
        } else if (q > 0.0 && "*".equals(this.type.getSubtype()) && type.getType().equals(this.type.getType())) {
            return q - CORRECTIONFORSUBTYPEMATCH;
        } else {
            return 0.0;
        }
    }

    public String toString() {
        return String.format("type=%s, q=%f", type, q);
    }
}