All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.cxf.jaxrs.impl.ResponseImpl Maven / Gradle / Ivy

Go to download

Apache CXF Bundle Jar

There is a newer version: 3.0.0-milestone2
Show newest version
/**
 * 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.cxf.jaxrs.impl;

import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;

import javax.ws.rs.MessageProcessingException;
import javax.ws.rs.core.EntityTag;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.Link;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.NewCookie;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status.Family;
import javax.ws.rs.ext.ReaderInterceptor;

import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.jaxrs.provider.ProviderFactory;
import org.apache.cxf.jaxrs.utils.HttpUtils;
import org.apache.cxf.jaxrs.utils.JAXRSUtils;
import org.apache.cxf.message.Message;
import org.apache.cxf.message.MessageUtils;

public final class ResponseImpl extends Response {
    private int status;
    private Object entity;
    private Annotation[] entityAnnotations; 
    private MultivaluedMap metadata;
    
    private Message responseMessage;
    private boolean entityClosed;    
    private boolean entityBufferred;
    private Object lastEntity;
    
    ResponseImpl(int s) {
        this.status = s;
    }
    
    ResponseImpl(int s, Object e) {
        this.status = s;
        this.entity = e;
    }
    
    void addMetadata(MultivaluedMap meta) { 
        this.metadata = meta;
    }
    
    public void setStatus(int s) { 
        this.status = s;
    }
    
    public void setEntity(Object e, Annotation[] anns) { 
        this.entity = e;
        this.entityAnnotations = anns;
    }
    
    public void setEntityAnnotations(Annotation[] anns) { 
        this.entityAnnotations = anns;
    }
    
    public Annotation[] getEntityAnnotations() {
        return entityAnnotations;
    }

    //TODO: This method is needed because on the client side the
    // Response processing is done after the chain completes, thus
    // PhaseInterceptorChain.getCurrentMessage() returns null.
    // The refactoring will be required
    public void setMessage(Message message) {
        this.responseMessage = message;
    }
    
    public int getStatus() {
        return status;
    }

    public StatusType getStatusInfo() {
        return new Response.StatusType() {

            public Family getFamily() {
                return Response.Status.Family.familyOf(ResponseImpl.this.status);
            }

            public String getReasonPhrase() {
                Response.Status statusEnum = Response.Status.fromStatusCode(ResponseImpl.this.status); 
                return statusEnum != null ? statusEnum.getReasonPhrase() : "";
            }

            public int getStatusCode() {
                return ResponseImpl.this.status;
            } 
            
        };
    }
    
    public Object getEntity() {
        return lastEntity != null ? lastEntity : entity;
    }

    public boolean hasEntity() {
        return getEntity() != null;
    }
    
    public MultivaluedMap getMetadata() {
        return getHeaders();
    }
    
    public MultivaluedMap getHeaders() {
        return metadata;
    }
    
    public MultivaluedMap getStringHeaders() {
        MetadataMap headers = new MetadataMap(metadata.size());
        for (Map.Entry> entry : metadata.entrySet()) {
            headers.put(entry.getKey(), toListOfStrings(entry.getValue()));
        }
        return headers;
    }

    private String getHeader(String header) {
        Object value = metadata.getFirst(header);
        return value == null ? null : value.toString();
    }
    
    public String getHeaderString(String header) {
        List methodValues = metadata.get(header);
        return HttpUtils.getHeaderString(toListOfStrings(methodValues));
    }
    
    // This conversion is needed as some values may not be Strings
    private List toListOfStrings(List values) {
        if (values == null) {
            return null; 
        } else {
            List stringValues = new ArrayList(values.size());
            for (Object value : values) {
                stringValues.add(value.toString());
            }
            return stringValues;
        }
    }
    
    public Set getAllowedMethods() {
        List methodValues = metadata.get(HttpHeaders.ALLOW);
        if (methodValues == null) {
            return Collections.emptySet();
        } else {
            Set methods = new HashSet();
            for (Object o : methodValues) {
                methods.add(o.toString());
            }
            return methods;
        }
    }

    
    
    public Map getCookies() {
        List cookieValues = metadata.get(HttpHeaders.SET_COOKIE);
        if (cookieValues == null) {
            return Collections.emptyMap();
        } else {
            Map cookies = new HashMap();
            for (Object o : cookieValues) {
                NewCookie newCookie = NewCookie.valueOf(o.toString());
                cookies.put(newCookie.getName(), newCookie);
            }
            return cookies;
        }
    }

    public Date getDate() {
        return doGetDate(HttpHeaders.DATE);
    }

    private Date doGetDate(String dateHeader) {
        return HttpUtils.getHttpDate(getHeader(dateHeader));
    }
    
    public EntityTag getEntityTag() {
        String header = getHeader(HttpHeaders.ETAG);
        return header == null ? null : EntityTag.valueOf(header);
    }

    public Locale getLanguage() {
        return HttpUtils.getLocale(getHeader(HttpHeaders.CONTENT_LANGUAGE));
    }

    public Date getLastModified() {
        return doGetDate(HttpHeaders.LAST_MODIFIED);
    }

    public int getLength() {
        return HttpUtils.getContentLength(getHeader(HttpHeaders.CONTENT_LENGTH));
    }

    public URI getLocation() {
        String header = getHeader(HttpHeaders.LOCATION);
        return header == null ? null : URI.create(header);
    }

    public MediaType getMediaType() {
        String header = getHeader(HttpHeaders.CONTENT_TYPE);
        return header == null ? null : JAXRSUtils.toMediaType(header);
    }
    
    public boolean hasLink(String relation) {
        return getLink(relation) != null;
    }
    
    public Link getLink(String relation) {
        Set> entries = getAllLinks().entrySet();
        for (Map.Entry entry : entries) {
            if (entry.getKey().contains(relation)) {
                return entry.getValue();
            }
        }
        return null;
    }

    public Link.Builder getLinkBuilder(String relation) {
        return Link.fromLink(getLink(relation));
    }

    public Set getLinks() {
        return new HashSet(getAllLinks().values());
    }

    private Map getAllLinks() {
        List linkValues = metadata.get(HttpHeaders.LINK);
        if (linkValues == null) {
            return Collections.emptyMap();
        } else {
            Map links = new HashMap();
            for (Object o : linkValues) {
                Link link = Link.valueOf(o.toString());
                links.put(link.getRel(), link);
            }
            return links;
        }
    }
    
    public  T readEntity(Class cls) throws MessageProcessingException, IllegalStateException {
        return readEntity(cls, new Annotation[]{});
    }

    public  T readEntity(GenericType genType) throws MessageProcessingException, IllegalStateException {
        return readEntity(genType, new Annotation[]{});
    }

    public  T readEntity(Class cls, Annotation[] anns) throws MessageProcessingException,
        IllegalStateException {
        
        return doReadEntity(cls, cls, anns);
    }

    @SuppressWarnings("unchecked")
    public  T readEntity(GenericType genType, Annotation[] anns) throws MessageProcessingException,
        IllegalStateException {
        return doReadEntity((Class)genType.getRawType(), 
                            genType.getType(), anns);
    }
    
    public  T doReadEntity(Class cls, Type t, Annotation[] anns) throws MessageProcessingException,
        IllegalStateException {
        
        checkEntityIsClosed();
        
        if (lastEntity != null && cls.isAssignableFrom(lastEntity.getClass())
            && !(lastEntity instanceof InputStream)) {
            return cls.cast(lastEntity);
        } 
        
        if (entity instanceof InputStream) {
            
            MediaType mediaType = getMediaType();
            if (mediaType == null) {
                mediaType = MediaType.WILDCARD_TYPE;
            }
            
            List readers = ProviderFactory.getInstance(responseMessage)
                .createMessageBodyReaderInterceptor(cls, t, anns, mediaType, 
                                                    responseMessage.getExchange().getOutMessage());
            if (readers != null) {
                try {
                    if (entityBufferred) {
                        InputStream.class.cast(entity).reset();
                    }
                    
                    responseMessage.put(Message.PROTOCOL_HEADERS, this.getMetadata());
                    lastEntity = JAXRSUtils.readFromMessageBodyReader(readers, cls, t, 
                                                                           anns, 
                                                                           InputStream.class.cast(entity), 
                                                                           mediaType, 
                                                                           responseMessage);
                    if (!entityBufferred && responseStreamCanBeClosed(cls)) {
                        InputStream.class.cast(entity).close();
                        entity = null;
                    } 
                    
                    return castLastEntity();
                } catch (Exception ex) {
                    throw new MessageProcessingException(ex);
                }
            } else {
                throw new MessageProcessingException("No message body reader for class: " + cls);
            }
        } else if (entity != null && cls.isAssignableFrom(entity.getClass())) {
            lastEntity = entity;
            return castLastEntity();
        }
        
        throw new IllegalStateException("The entity is not backed by an input stream, entity class is : "
            + entity != null ? entity.getClass().getName() : null);
        
    }
    
    @SuppressWarnings("unchecked")
    private  T castLastEntity() {
        return (T)lastEntity;
    }
    
    protected boolean responseStreamCanBeClosed(Class cls) {
        return cls != InputStream.class
            && MessageUtils.isTrue(responseMessage.getContextualProperty("response.stream.auto.close"));
    }
    
    public boolean bufferEntity() throws MessageProcessingException {
        checkEntityIsClosed();
        if (!entityBufferred && entity instanceof InputStream) {
            try {
                InputStream oldEntity = (InputStream)entity;
                entity = IOUtils.loadIntoBAIS(oldEntity);
                oldEntity.close();
                entityBufferred = true;
            } catch (IOException ex) {
                throw new MessageProcessingException(ex);
            }
        }
        return entityBufferred;
    }

    public void close() throws MessageProcessingException {
        if (!entityClosed) {
            if (!entityBufferred && entity instanceof InputStream) {
                try {
                    ((InputStream)entity).close();
                } catch (IOException ex) {
                    throw new MessageProcessingException(ex);
                }
            }
            entity = null;
            entityClosed = true;
        }
        
    }
    
    private void checkEntityIsClosed() {
        if (entityClosed) {
            throw new IllegalStateException("Entity is not available");
        }
    }
}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy