resources.openmrs.org Open in urlscan Pro
13.32.121.29  Public Scan

Form analysis
0 forms found in the DOM

Text Content

JavaScript is disabled on your browser.
 * Overview
 * Package
 * Class
 * Use
 * Tree
 * Deprecated
 * Index
 * Help

 * PREV CLASS
 * NEXT CLASS

 * FRAMES
 * NO FRAMES

 * All Classes


 * SUMMARY: 
 * NESTED | 
 * FIELD | 
 * CONSTR | 
 * METHOD

 * DETAIL: 
 * FIELD | 
 * CONSTR | 
 * METHOD

org.springframework.http.converter.json


CLASS MAPPINGJACKSONHTTPMESSAGECONVERTER

 * java.lang.Object
 * * org.springframework.http.converter.AbstractHttpMessageConverter<Object>
   * * org.springframework.http.converter.json.MappingJacksonHttpMessageConverter

 * All Implemented Interfaces:
   org.springframework.http.converter.GenericHttpMessageConverter<Object>,
   org.springframework.http.converter.HttpMessageConverter<Object>
   
   --------------------------------------------------------------------------------
   
   
   public class MappingJacksonHttpMessageConverter
   extends org.springframework.http.converter.AbstractHttpMessageConverter<Object>
   implements org.springframework.http.converter.GenericHttpMessageConverter<Object>
   
   Implementation of HttpMessageConverter that can read and write JSON using
   Jackson's ObjectMapper.
   
   This converter can be used to bind to typed beans, or untyped HashMap
   instances.
   
   By default, this converter supports application/json. This can be overridden
   by setting the supportedMediaTypes property.
   
   Since: Spring 3.0 Author: Arjen Poutsma See Also:MappingJacksonJsonView


 * * FIELD SUMMARY
     
     Fields  Modifier and Type Field and Description static Charset
     DEFAULT_CHARSET 
     
     
     * FIELDS INHERITED FROM
       CLASS ORG.SPRINGFRAMEWORK.HTTP.CONVERTER.ABSTRACTHTTPMESSAGECONVERTER
       
       logger
   
   
   * CONSTRUCTOR SUMMARY
     
     Constructors  Constructor and Description
     MappingJacksonHttpMessageConverter()
     Construct a new MappingJacksonHttpMessageConverter.
   
   
   * METHOD SUMMARY
     
     Methods  Modifier and Type Method and Description boolean
     canRead(Class<?> clazz, org.springframework.http.MediaType mediaType) 
     boolean canRead(Type type, Class<?> contextClass,
     org.springframework.http.MediaType mediaType)  boolean
     canWrite(Class<?> clazz, org.springframework.http.MediaType mediaType) 
     protected org.codehaus.jackson.type.JavaType getJavaType(Type type,
     Class<?> contextClass)
     Return the Jackson JavaType for the specified type and context class.
     protected org.codehaus.jackson.JsonEncoding
     getJsonEncoding(org.springframework.http.MediaType contentType)
     Determine the JSON encoding to use for the given content type.
     org.codehaus.jackson.map.ObjectMapper getObjectMapper()
     Return the underlying ObjectMapper for this view.
     Object read(Type type, Class<?> contextClass,
     org.springframework.http.HttpInputMessage inputMessage)  protected Object
     readInternal(Class<?> clazz,
     org.springframework.http.HttpInputMessage inputMessage)  void
     setJsonPrefix(String jsonPrefix)
     Specify a custom prefix to use for this view's JSON output.
     void setObjectMapper(org.codehaus.jackson.map.ObjectMapper objectMapper)
     Set the ObjectMapper for this view.
     void setPrefixJson(boolean prefixJson)
     Indicate whether the JSON output by this view should be prefixed with "{}
     &&".
     void setPrettyPrint(boolean prettyPrint)
     Whether to use the org.codehaus.jackson.impl.DefaultPrettyPrinter when
     writing JSON.
     protected boolean supports(Class<?> clazz)  protected void
     writeInternal(Object object,
     org.springframework.http.HttpOutputMessage outputMessage) 
     
     
     * METHODS INHERITED FROM
       CLASS ORG.SPRINGFRAMEWORK.HTTP.CONVERTER.ABSTRACTHTTPMESSAGECONVERTER
       
       canRead, canWrite, getContentLength, getDefaultContentType,
       getSupportedMediaTypes, read, setSupportedMediaTypes, write
     
     
     * METHODS INHERITED FROM CLASS JAVA.LANG.OBJECT
       
       clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
       wait, wait, wait
     
     
     * METHODS INHERITED FROM
       INTERFACE ORG.SPRINGFRAMEWORK.HTTP.CONVERTER.HTTPMESSAGECONVERTER
       
       getSupportedMediaTypes, read, write


 * * FIELD DETAIL
     
     * DEFAULT_CHARSET
       
       public static final Charset DEFAULT_CHARSET
   
   
   * CONSTRUCTOR DETAIL
     
     * MAPPINGJACKSONHTTPMESSAGECONVERTER
       
       public MappingJacksonHttpMessageConverter()
       
       Construct a new MappingJacksonHttpMessageConverter.
   
   
   * METHOD DETAIL
     
     * SETOBJECTMAPPER
       
       public void setObjectMapper(org.codehaus.jackson.map.ObjectMapper objectMapper)
       
       Set the ObjectMapper for this view. If not set, a default ObjectMapper is
       used.
       
       Setting a custom-configured ObjectMapper is one way to take further
       control of the JSON serialization process. For example, an extended
       SerializerFactory can be configured that provides custom serializers for
       specific types. The other option for refining the serialization process
       is to use Jackson's provided annotations on the types to be serialized,
       in which case a custom-configured ObjectMapper is unnecessary.
     
     * GETOBJECTMAPPER
       
       public org.codehaus.jackson.map.ObjectMapper getObjectMapper()
       
       Return the underlying ObjectMapper for this view.
     
     * SETJSONPREFIX
       
       public void setJsonPrefix(String jsonPrefix)
       
       Specify a custom prefix to use for this view's JSON output. Default is
       none.
       See Also:setPrefixJson(boolean)
     
     * SETPREFIXJSON
       
       public void setPrefixJson(boolean prefixJson)
       
       Indicate whether the JSON output by this view should be prefixed with "{}
       &&". Default is false.
       
       Prefixing the JSON string in this manner is used to help prevent JSON
       Hijacking. The prefix renders the string syntactically invalid as a
       script so that it cannot be hijacked. This prefix does not affect the
       evaluation of JSON, but if JSON validation is performed on the string,
       the prefix would need to be ignored.
       
       See Also:setJsonPrefix(java.lang.String)
     
     * SETPRETTYPRINT
       
       public void setPrettyPrint(boolean prettyPrint)
       
       Whether to use the org.codehaus.jackson.impl.DefaultPrettyPrinter when
       writing JSON. This is a shortcut for setting up an ObjectMapper as
       follows:
       
        ObjectMapper mapper = new ObjectMapper();
        mapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true);
        converter.setObjectMapper(mapper);
        
       
       The default value is false.
     
     * CANREAD
       
       public boolean canRead(Class<?> clazz,
                     org.springframework.http.MediaType mediaType)
       
       Specified by: canRead in
       interface org.springframework.http.converter.HttpMessageConverter<Object>
       Overrides: canRead in
       class org.springframework.http.converter.AbstractHttpMessageConverter<Object>
     
     * CANREAD
       
       public boolean canRead(Type type,
                     Class<?> contextClass,
                     org.springframework.http.MediaType mediaType)
       
       Specified by: canRead in
       interface org.springframework.http.converter.GenericHttpMessageConverter<Object>
     
     * CANWRITE
       
       public boolean canWrite(Class<?> clazz,
                      org.springframework.http.MediaType mediaType)
       
       Specified by: canWrite in
       interface org.springframework.http.converter.HttpMessageConverter<Object>
       Overrides: canWrite in
       class org.springframework.http.converter.AbstractHttpMessageConverter<Object>
     
     * SUPPORTS
       
       protected boolean supports(Class<?> clazz)
       
       Specified by: supports in
       class org.springframework.http.converter.AbstractHttpMessageConverter<Object>
     
     * READINTERNAL
       
       protected Object readInternal(Class<?> clazz,
                         org.springframework.http.HttpInputMessage inputMessage)
                              throws IOException,
                                     org.springframework.http.converter.HttpMessageNotReadableException
       
       Specified by: readInternal in
       class org.springframework.http.converter.AbstractHttpMessageConverter<Object>
       Throws: IOException
       org.springframework.http.converter.HttpMessageNotReadableException
     
     * READ
       
       public Object read(Type type,
                 Class<?> contextClass,
                 org.springframework.http.HttpInputMessage inputMessage)
                   throws IOException,
                          org.springframework.http.converter.HttpMessageNotReadableException
       
       Specified by: read in
       interface org.springframework.http.converter.GenericHttpMessageConverter<Object>
       Throws: IOException
       org.springframework.http.converter.HttpMessageNotReadableException
     
     * WRITEINTERNAL
       
       protected void writeInternal(Object object,
                        org.springframework.http.HttpOutputMessage outputMessage)
                             throws IOException,
                                    org.springframework.http.converter.HttpMessageNotWritableException
       
       Specified by: writeInternal in
       class org.springframework.http.converter.AbstractHttpMessageConverter<Object>
       Throws: IOException
       org.springframework.http.converter.HttpMessageNotWritableException
     
     * GETJAVATYPE
       
       protected org.codehaus.jackson.type.JavaType getJavaType(Type type,
                                                    Class<?> contextClass)
       
       Return the Jackson JavaType for the specified type and context class.
       
       The default implementation returns
       TypeFactory.type(java.lang.reflect.Type) or TypeFactory.type(type,
       TypeFactory.type(contextClass)), but this can be overridden in
       subclasses, to allow for custom generic collection handling. For
       instance:
       
        protected JavaType getJavaType(Type type) {
          if (type instanceof Class && List.class.isAssignableFrom((Class)type)) {
            return TypeFactory.collectionType(ArrayList.class, MyBean.class);
          } else {
            return super.getJavaType(type);
          }
        }
        
       
       Parameters:type - the type to return the java type forcontextClass - a
       context class for the target type, for example a class in which the
       target type appears in a method signature, can be null Returns:the java
       type
     
     * GETJSONENCODING
       
       protected org.codehaus.jackson.JsonEncoding getJsonEncoding(org.springframework.http.MediaType contentType)
       
       Determine the JSON encoding to use for the given content type.
       Parameters:contentType - the media type as requested by the caller
       Returns:the JSON encoding to use (never null)

 * Overview
 * Package
 * Class
 * Use
 * Tree
 * Deprecated
 * Index
 * Help

 * PREV CLASS
 * NEXT CLASS

 * FRAMES
 * NO FRAMES

 * All Classes


 * SUMMARY: 
 * NESTED | 
 * FIELD | 
 * CONSTR | 
 * METHOD

 * DETAIL: 
 * FIELD | 
 * CONSTR | 
 * METHOD

Copyright © 2015 OpenMRS Inc.. All Rights Reserved.