org.glassfish.jersey.message.internal.WriterInterceptorExecutor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation
Show all versions of jaxrs-ri Show documentation
A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle
(jaxrs-ri.jar).
Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and
contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external
RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source
bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external
RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI
sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from
the command line.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-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.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Iterator;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.ws.rs.ProcessingException;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.MessageBodyWriter;
import javax.ws.rs.ext.WriterInterceptor;
import javax.ws.rs.ext.WriterInterceptorContext;
import org.glassfish.jersey.internal.LocalizationMessages;
import org.glassfish.jersey.internal.PropertiesDelegate;
import org.glassfish.jersey.internal.inject.ServiceLocatorSupplier;
import org.glassfish.jersey.message.MessageBodyWorkers;
import org.glassfish.hk2.api.ServiceLocator;
import jersey.repackaged.com.google.common.collect.Lists;
/**
* Represents writer interceptor chain executor for both client and server side.
* It constructs wrapped interceptor chain and invokes it. At the end of the chain
* a {@link MessageBodyWriter message body writer} execution interceptor is inserted,
* which writes entity to the output stream provided by the chain.
*
* @author Miroslav Fuksa
* @author Jakub Podlesak (jakub.podlesak at oracle.com)
*/
public final class WriterInterceptorExecutor extends InterceptorExecutor
implements WriterInterceptorContext, ServiceLocatorSupplier {
private static final Logger LOGGER = Logger.getLogger(WriterInterceptorExecutor.class.getName());
private OutputStream outputStream;
private final MultivaluedMap headers;
private Object entity;
private final Iterator iterator;
private int processedCount;
private final ServiceLocator serviceLocator;
/**
* Constructs a new executor to write given type to provided {@link InputStream entityStream}.
*
* @param entity entity object to be processed.
* @param rawType raw Java entity type.
* @param type generic Java entity type.
* @param annotations array of annotations on the declaration of the artifact
* that will be initialized with the produced instance. E.g. if the message
* body is to be converted into a method parameter, this will be the
* annotations on that parameter returned by
* {@code Method.getParameterAnnotations}.
* @param mediaType media type of the HTTP entity.
* @param headers mutable HTTP headers associated with HTTP entity.
* @param propertiesDelegate request-scoped properties delegate.
* @param entityStream {@link java.io.InputStream} from which an entity will be read. The stream is not
* closed after reading the entity.
* @param workers {@link org.glassfish.jersey.message.MessageBodyWorkers Message body workers}.
* @param writerInterceptors Writer interceptors that are to be used to intercept writing of an entity.
* @param serviceLocator Service locator.
*/
public WriterInterceptorExecutor(final Object entity, final Class rawType,
final Type type,
final Annotation[] annotations,
final MediaType mediaType,
final MultivaluedMap headers,
final PropertiesDelegate propertiesDelegate,
final OutputStream entityStream,
final MessageBodyWorkers workers,
final Iterable writerInterceptors,
final ServiceLocator serviceLocator) {
super(rawType, type, annotations, mediaType, propertiesDelegate);
this.entity = entity;
this.headers = headers;
this.outputStream = entityStream;
this.serviceLocator = serviceLocator;
final List effectiveInterceptors = Lists.newArrayList(writerInterceptors);
effectiveInterceptors.add(new TerminalWriterInterceptor(workers));
this.iterator = effectiveInterceptors.iterator();
this.processedCount = 0;
}
/**
* Returns next {@link WriterInterceptor interceptor} in the chain. Stateful method.
*
* @return Next interceptor.
*/
public WriterInterceptor getNextInterceptor() {
if (!iterator.hasNext()) {
return null;
}
return iterator.next();
}
/**
* Starts the interceptor chain execution.
*/
@Override
@SuppressWarnings("unchecked")
public void proceed() throws IOException {
final WriterInterceptor nextInterceptor = getNextInterceptor();
if (nextInterceptor == null) {
throw new ProcessingException(LocalizationMessages.ERROR_INTERCEPTOR_WRITER_PROCEED());
}
traceBefore(nextInterceptor, MsgTraceEvent.WI_BEFORE);
try {
nextInterceptor.aroundWriteTo(this);
} finally {
processedCount++;
traceAfter(nextInterceptor, MsgTraceEvent.WI_AFTER);
}
}
@Override
public Object getEntity() {
return entity;
}
@Override
public void setEntity(final Object entity) {
this.entity = entity;
}
@Override
public OutputStream getOutputStream() {
return this.outputStream;
}
@Override
public void setOutputStream(final OutputStream os) {
this.outputStream = os;
}
@Override
public MultivaluedMap getHeaders() {
return this.headers;
}
/**
* Get number of processed interceptors.
*
* @return number of processed interceptors.
*/
int getProcessedCount() {
return processedCount;
}
@Override
public ServiceLocator getServiceLocator() {
return serviceLocator;
}
/**
* Terminal writer interceptor which choose the appropriate {@link MessageBodyWriter}
* and writes the entity to the output stream. The order of actions is the following:
* 1. choose the appropriate {@link MessageBodyWriter}
* 2. if callback is defined then it retrieves size and passes it to the callback
* 3. writes the entity to the output stream
*
*/
private class TerminalWriterInterceptor implements WriterInterceptor {
private final MessageBodyWorkers workers;
public TerminalWriterInterceptor(final MessageBodyWorkers workers) {
super();
this.workers = workers;
}
@Override
@SuppressWarnings("unchecked")
public void aroundWriteTo(final WriterInterceptorContext context) throws WebApplicationException, IOException {
processedCount--; //this is not regular interceptor -> count down
traceBefore(null, MsgTraceEvent.WI_BEFORE);
try {
final TracingLogger tracingLogger = getTracingLogger();
if (tracingLogger.isLogEnabled(MsgTraceEvent.MBW_FIND)) {
tracingLogger.log(MsgTraceEvent.MBW_FIND,
context.getType().getName(),
(context.getGenericType() instanceof Class
? ((Class) context.getGenericType()).getName() : context.getGenericType()),
context.getMediaType(), java.util.Arrays.toString(context.getAnnotations()));
}
final MessageBodyWriter writer = workers.getMessageBodyWriter(context.getType(), context.getGenericType(),
context.getAnnotations(), context.getMediaType(), WriterInterceptorExecutor.this);
if (writer == null) {
LOGGER.log(Level.SEVERE, LocalizationMessages.ERROR_NOTFOUND_MESSAGEBODYWRITER(
context.getMediaType(), context.getType(), context.getGenericType()));
throw new MessageBodyProviderNotFoundException(LocalizationMessages.ERROR_NOTFOUND_MESSAGEBODYWRITER(
context.getMediaType(), context.getType(), context.getGenericType()));
}
invokeWriteTo(context, writer);
} finally {
clearLastTracedInterceptor();
traceAfter(null, MsgTraceEvent.WI_AFTER);
}
}
@SuppressWarnings("unchecked")
private void invokeWriteTo(final WriterInterceptorContext context, final MessageBodyWriter writer)
throws WebApplicationException, IOException {
final TracingLogger tracingLogger = getTracingLogger();
final long timestamp = tracingLogger.timestamp(MsgTraceEvent.MBW_WRITE_TO);
final UnCloseableOutputStream entityStream = new UnCloseableOutputStream(context.getOutputStream(), writer);
try {
writer.writeTo(context.getEntity(), context.getType(), context.getGenericType(), context.getAnnotations(),
context.getMediaType(), context.getHeaders(), entityStream);
} finally {
tracingLogger.logDuration(MsgTraceEvent.MBW_WRITE_TO, timestamp, writer);
}
}
}
/**
* {@link javax.ws.rs.ext.MessageBodyWriter}s should not close the given {@link java.io.OutputStream stream}. This output
* stream makes sure that the stream is not closed even if MBW tries to do it.
*/
private static class UnCloseableOutputStream extends OutputStream {
private final OutputStream original;
private final MessageBodyWriter writer;
private UnCloseableOutputStream(final OutputStream original, final MessageBodyWriter writer) {
this.original = original;
this.writer = writer;
}
@Override
public void write(final int i) throws IOException {
original.write(i);
}
@Override
public void write(final byte[] b) throws IOException {
original.write(b);
}
@Override
public void write(final byte[] b, final int off, final int len) throws IOException {
original.write(b, off, len);
}
@Override
public void flush() throws IOException {
original.flush();
}
@Override
public void close() throws IOException {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE, LocalizationMessages.MBW_TRYING_TO_CLOSE_STREAM(writer.getClass()));
}
}
}
}