org.glassfish.jersey.message.internal.MatchingEntityTag Maven / Gradle / Ivy
Show all versions of jaxrs-ri Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.message.internal;
import java.text.ParseException;
import java.util.Collections;
import java.util.Set;
import javax.ws.rs.core.EntityTag;
import org.glassfish.jersey.internal.LocalizationMessages;
/**
* A matching entity tag.
*
* Note that this type and it's super type cannot be used to create request
* header values for {@code If-Match} and {@code If-None-Match}
* of the form {@code If-Match: *} or {@code If-None-Match: *} as
* {@code *} is not a valid entity tag.
*
* @author Paul Sandoz
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public class MatchingEntityTag extends EntityTag {
/**
* An empty set that corresponds to {@code If-Match: *} or {@code If-None-Match: *}.
*/
public static final Set ANY_MATCH = Collections.emptySet();
/**
* Create new strongly validating entity tag.
*
* @param value ETag header value.
*/
public MatchingEntityTag(String value) {
super(value, false);
}
/**
* Create new matching entity tag.
*
* @param value ETag header value.
* @param weak should be set to false, if strong validation is required,
* otherwise should be set to true.
*/
public MatchingEntityTag(String value, boolean weak) {
super(value, weak);
}
/**
* Create new matching entity tag out of provided header reader.
*
* @param reader HTTP header content reader.
* @return a new matching entity tag.
* @throws ParseException in case the header could not be parsed.
*/
public static MatchingEntityTag valueOf(HttpHeaderReader reader) throws ParseException {
final CharSequence tagString = reader.getRemainder();
HttpHeaderReader.Event e = reader.next(false);
if (e == HttpHeaderReader.Event.QuotedString) {
return new MatchingEntityTag(reader.getEventValue().toString());
} else if (e == HttpHeaderReader.Event.Token) {
CharSequence ev = reader.getEventValue();
if (ev != null && ev.length() == 1 && 'W' == ev.charAt(0)) {
reader.nextSeparator('/');
return new MatchingEntityTag(reader.nextQuotedString().toString(), true);
}
}
throw new ParseException(LocalizationMessages.ERROR_PARSING_ENTITY_TAG(tagString), reader.getIndex());
}
}