Package org.glassfish.jersey.message.internal

Class WriterInterceptorExecutor

  • All Implemented Interfaces:
    InterceptorContext, WriterInterceptorContext, org.glassfish.jersey.internal.inject.InjectionManagerSupplier, PropertiesDelegate
    public final class WriterInterceptorExecutor
extends Object
implements WriterInterceptorContext, org.glassfish.jersey.internal.inject.InjectionManagerSupplier
    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 message body writer execution interceptor is inserted, which writes entity to the output stream provided by the chain.
    Author:
    Miroslav Fuksa, Jakub Podlesak

    • Constructor Detail

      • WriterInterceptorExecutor

        public WriterInterceptorExecutor​(Object entity,
                                 Class<?> rawType,
                                 Type type,
                                 Annotation[] annotations,
                                 MediaType mediaType,
                                 MultivaluedMap<String,​Object> headers,
                                 PropertiesDelegate propertiesDelegate,
                                 OutputStream entityStream,
                                 MessageBodyWorkers workers,
                                 Iterable<WriterInterceptor> writerInterceptors,
                                 org.glassfish.jersey.internal.inject.InjectionManager injectionManager)
        Constructs a new executor to write given type to provided entityStream.
        Parameters:
        entity - entity object to be processed.
        rawType - raw Java entity type.
        type - generic Java entity type.
        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 Method.getParameterAnnotations.
        mediaType - media type of the HTTP entity.
        headers - mutable HTTP headers associated with HTTP entity.
        propertiesDelegate - request-scoped properties delegate.
        entityStream - InputStream from which an entity will be read. The stream is not closed after reading the entity.
        workers - Message body workers.
        writerInterceptors - Writer interceptors that are to be used to intercept writing of an entity.
        injectionManager - injection manager.

    • Method Detail

      • setOutputStream

        public void setOutputStream​(OutputStream os)
        Description copied from interface: WriterInterceptorContext
        Set a new output stream for the object to be written. For example, by wrapping it with another output stream. The JAX-RS runtime is responsible for closing the output stream that is set.
        Specified by:
        setOutputStream in interface WriterInterceptorContext
        Parameters:
        os - new output stream for the object to be written.

      • getInjectionManager

        public org.glassfish.jersey.internal.inject.InjectionManager getInjectionManager()
        Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManagerSupplier
        Get injection manager.
        Specified by:
        getInjectionManager in interface org.glassfish.jersey.internal.inject.InjectionManagerSupplier
        Returns:
        injection manager.

      • getProperty

        public Object getProperty​(String name)
        Description copied from interface: InterceptorContext
        Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

        A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

        A list of supported properties can be retrieved using InterceptorContext.getPropertyNames(). Custom property names should follow the same convention as package names.

        In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all the attributes available in the ServletRequest.

        Specified by:
        getProperty in interface InterceptorContext
        Specified by:
        getProperty in interface PropertiesDelegate
        Parameters:
        name - a String specifying the name of the property.
        Returns:
        an Object containing the value of the property, or null if no property exists matching the given name.
        See Also:
        InterceptorContext.getPropertyNames()

      • setProperty

        public void setProperty​(String name,
                        Object object)
        Description copied from interface: InterceptorContext
        Binds an object to a given property name in the current request/response exchange context. If the name specified is already used for a property, this method will replace the value of the property with the new value.

        A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

        A list of supported properties can be retrieved using InterceptorContext.getPropertyNames(). Custom property names should follow the same convention as package names.

        If a null value is passed, the effect is the same as calling the InterceptorContext.removeProperty(String) method.

        In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all the attributes available in the ServletRequest.

        Specified by:
        setProperty in interface InterceptorContext
        Specified by:
        setProperty in interface PropertiesDelegate
        Parameters:
        name - a String specifying the name of the property.
        object - an Object representing the property to be bound.

      • removeProperty

        public void removeProperty​(String name)
        Description copied from interface: InterceptorContext
        Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to InterceptorContext.getProperty(java.lang.String) to retrieve the property value will return null.

        In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all the attributes available in the ServletRequest.

        Specified by:
        removeProperty in interface InterceptorContext
        Specified by:
        removeProperty in interface PropertiesDelegate
        Parameters:
        name - a String specifying the name of the property to be removed.

      • getTracingLogger

        protected final TracingLogger getTracingLogger()
        Get tracing logger instance configured in via properties.
        Returns:
        tracing logger instance.

      • traceBefore

        protected final void traceBefore​(T interceptor,
                                 TracingLogger.Event event)
        Tracing support - log invocation of interceptor BEFORE context.proceed() call.
        Parameters:
        interceptor - invoked interceptor
        event - event type to be tested

      • traceAfter

        protected final void traceAfter​(T interceptor,
                                TracingLogger.Event event)
        Tracing support - log invocation of interceptor AFTER context.proceed() call.
        Parameters:
        interceptor - invoked interceptor
        event - event type to be tested

      • clearLastTracedInterceptor

        protected final void clearLastTracedInterceptor()
        Clear last traced interceptor information.

      • getAnnotations

        public Annotation[] getAnnotations()
        Description copied from interface: InterceptorContext
        Get an array of the annotations formally declared on the artifact that initiated the intercepted entity provider invocation. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Method.getParameterAnnotations(); if the server-side response entity instance is to be converted into an output stream, this will be the annotations on the matched resource method returned by Method.getAnnotations(). This method may return an empty array in case the interceptor is not invoked in a context of any particular resource method (e.g. as part of the client API), but will never return null.
        Specified by:
        getAnnotations in interface InterceptorContext
        Returns:
        annotations declared on the artifact that initiated the intercepted entity provider invocation.

      • setAnnotations

        public void setAnnotations​(Annotation[] annotations)
        Description copied from interface: InterceptorContext
        Update annotations on the formal declaration of the artifact that initiated the intercepted entity provider invocation. Calling this method has no effect in the client API.
        Specified by:
        setAnnotations in interface InterceptorContext
        Parameters:
        annotations - updated annotations declarataion of the artifact that initiated the intercepted entity provider invocation. Must not be null.

      • getType

        public Class getType()
        Description copied from interface: InterceptorContext
        Get Java type supported by corresponding message body provider.
        Specified by:
        getType in interface InterceptorContext
        Returns:
        java type supported by provider

      • setType

        public void setType​(Class type)
        Description copied from interface: InterceptorContext
        Update Java type before calling message body provider.
        Specified by:
        setType in interface InterceptorContext
        Parameters:
        type - java type for provider

      • setGenericType

        public void setGenericType​(Type genericType)
        Description copied from interface: InterceptorContext
        Update type of the object to be produced or written.
        Specified by:
        setGenericType in interface InterceptorContext
        Parameters:
        genericType - new type for object