com.sun.faces.application.ByteArrayWebOutputStream Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsf-impl Show documentation
Show all versions of jsf-impl Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 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
* https://glassfish.dev.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 com.sun.faces.application;
import com.sun.faces.util.FacesLogger;
import javax.servlet.ServletOutputStream;
import javax.faces.FacesException;
import java.io.Writer;
import java.io.IOException;
import java.io.OutputStream;
import java.io.ByteArrayOutputStream;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.charset.CharsetDecoder;
import java.nio.charset.Charset;
import java.nio.charset.CharacterCodingException;
/**
* This steam converts byte content to character. This implementation allows us
* to query whether or not the writer has been flushed or closed. This is
* necessary to better mimic the actual Servlet response.
*/
class ByteArrayWebOutputStream extends ServletOutputStream {
public static final ServletOutputStream NOOP_STREAM = new NoOpOutputStream();
// Log instance for this class
private static final Logger LOGGER = FacesLogger.APPLICATION.getLogger();
private DirectByteArrayOutputStream baos;
private boolean committed;
public ByteArrayWebOutputStream() {
baos = new DirectByteArrayOutputStream(1024);
}
public void write(int n) {
baos.write(n);
}
/**
* It's important to not expose this as reset.
*/
public void resetByteArray() {
baos.reset();
}
public byte[] toByteArray() {
return baos.toByteArray();
}
/**
* Converts the buffered bytes into chars based on the
* specified encoding and writes them to the provided Writer.
*
* @param writer target Writer
* @param encoding character encoding
*/
public void writeTo(Writer writer, String encoding) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine("Converting buffered ServletOutputStream bytes"
+ " to chars using " + encoding);
}
ByteBuffer bBuff = baos.getByteBuffer();
CharsetDecoder decoder = Charset.forName(encoding).newDecoder();
try {
CharBuffer cBuff = decoder.decode(bBuff);
writer.write(cBuff.array());
} catch (CharacterCodingException cce) {
throw new FacesException(cce);
} catch (IOException ioe) {
throw new FacesException(ioe);
}
}
public boolean isCommitted() {
return committed;
}
@Override
public void close() throws IOException {
committed = true;
}
@Override
public void flush() throws IOException {
committed = true;
}
/**
* Write the buffered bytes to the provided OutputStream.
*
* @param stream the stream to write to
*/
public void writeTo(OutputStream stream) {
try {
stream.write(baos.getByteBuffer().array());
} catch (IOException ioe) {
throw new FacesException(ioe);
}
}
private static class DirectByteArrayOutputStream extends ByteArrayOutputStream {
// -------------------------------------------------------- Constructors
public DirectByteArrayOutputStream(int initialCapacity) {
super(initialCapacity);
}
// ------------------------------------------------------- PublicMethods
/**
* Return the buffer backing this ByteArrayOutputStream as a
* ByteBuffer.
*
* @return buf wrapped in a ByteBuffer
*/
public ByteBuffer getByteBuffer() {
return (ByteBuffer.wrap(buf, 0, count));
}
}
private static class NoOpOutputStream extends ServletOutputStream {
public void write(int b) throws IOException {
// no-op
}
@Override
public void write(byte b[]) throws IOException {
// no-op
}
@Override
public void write(byte b[], int off, int len) throws IOException {
// no-op
}
@Override
public void flush() throws IOException {
// no-op
}
@Override
public void close() throws IOException {
// no-op
}
protected NoOpOutputStream() {
// no-op
}
@Override
public void print(String s) throws IOException {
// no-op
}
@Override
public void print(boolean b) throws IOException {
// no-op
}
@Override
public void print(char c) throws IOException {
// no-op
}
@Override
public void print(int i) throws IOException {
// no-op
}
@Override
public void print(long l) throws IOException {
// no-op
}
@Override
public void print(float v) throws IOException {
// no-op
}
@Override
public void print(double v) throws IOException {
// no-op
}
@Override
public void println() throws IOException {
// no-op
}
@Override
public void println(String s) throws IOException {
// no-op
}
@Override
public void println(boolean b) throws IOException {
// no-op
}
@Override
public void println(char c) throws IOException {
// no-op
}
@Override
public void println(int i) throws IOException {
// no-op
}
@Override
public void println(long l) throws IOException {
// no-op
}
@Override
public void println(float v) throws IOException {
// no-op
}
@Override
public void println(double v) throws IOException {
// no-op
}
}
}