org.glassfish.jersey.message.MessageProperties Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012 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;
/**
* Jersey configuration properties for message & entity processing.
*
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public final class MessageProperties {
/**
* If set to {@code true} then XML root element tag name for collections will
* be derived from {@link javax.xml.bind.annotation.XmlRootElement @XmlRootElement}
* annotation value and won't be de-capitalized.
*
* The default value is {@code false}.
*
* The name of the configuration property is {@value}.
*/
public static final String JAXB_PROCESS_XML_ROOT_ELEMENT = "jersey.config.jaxb.collections.processXmlRootElement";
/**
* If set to {@code true} XML security features when parsing XML documents will be
* disabled.
*
* The default value is {@code false}.
*
* The name of the configuration property is {@value}.
*/
public static final String XML_SECURITY_DISABLE = "jersey.config.xml.security.disable";
/**
* If set to {@code true} indicates that produced XML output should be formatted
* if possible (see below).
*
* A XML message entity written by a {@link javax.ws.rs.ext.MessageBodyWriter}
* may be formatted for the purposes of human readability provided the respective
* {@code MessageBodyWriter} supports XML output formatting. All JAXB-based message
* body writers support this property.
*
* The default value is {@code false}.
*
* The name of the configuration property is {@value}.
*/
public static final String XML_FORMAT_OUTPUT = "jersey.config.xml.formatOutput";
/**
* Value of the property indicates the buffer size to be used for I/O operations
* on byte and character streams. The property value is expected to be a positive
* integer otherwise it will be ignored.
*
* The default value is {@value #IO_DEFAULT_BUFFER_SIZE}.
*
* The name of the configuration property is {@value}.
*/
public static final String IO_BUFFER_SIZE = "jersey.config.io.bufferSize";
/**
* The default buffer size ({@value}) for I/O operations on byte and character
* streams.
*/
public static final int IO_DEFAULT_BUFFER_SIZE = 8192;
/**
* If set to {@code true}, {@code DeflateEncoder deflate encoding interceptor} will use non-standard version
* of the deflate content encoding, skipping the zlib wrapper. Unfortunately, deflate encoding
* implementations in some products use this non-compliant version, hence the switch.
*
* The default value is {@code false}.
*
* The name of the configuration property is {@value}.
*/
public static final String DEFLATE_WITHOUT_ZLIB = "jersey.config.deflate.nozlib";
/**
* If set to {@code true}, {@link javax.ws.rs.ext.MessageBodyReader MessageBodyReaders} and
* {@link javax.ws.rs.ext.MessageBodyWriter MessageBodyWriters} will be ordered by rules from JAX-RS 1.x, where custom
* providers have always precedence; providers are sorted by {@link javax.ws.rs.core.MediaType} and afterwards by
* declaration distance - see {@link org.glassfish.jersey.message.internal.MessageBodyFactory.DeclarationDistanceComparator}.
* Otherwise JAX-RS 2.x ordering will be used, which sorts providers firstly by declaration distance, then by
* {@link javax.ws.rs.core.MediaType} and by origin (custom/provided).
*
* The default value is {@code false}.
*
* The name of the configuration property is {@value}.
*/
public static final String LEGACY_WORKERS_ORDERING = "jersey.config.workers.legacyOrdering";
private MessageProperties() {
// prevents instantiation
}
}