JSONConfigDefaults (JSONUtil 1.2 API)

java.lang.Object
- org.kopitubruk.util.json.JSONConfigDefaults

All Implemented Interfaces:

Serializable, JSONConfigDefaultsMBean
```
public class JSONConfigDefaults
extends Object
implements JSONConfigDefaultsMBean, Serializable
```
This class provides a singleton object which is used to change static defaults used by JSONConfig and it is used as an MBean to allow JMX clients with MBean support to view and modify the defaults.
Keep in mind that affects all new JSONConfig objects created in the same class loader, including those created by toJSON methods which don't take a JSONConfig, which could have undesirable side effects depending upon your app. Use with care, if at all. All data in this class is static. The only reason that there is an instance or instance methods is to support MBean access to the defaults. A few defaults are only available programmatically. Those are accessed statically.
It is possible to configure the default values of these flags via JNDI such as is typically available in a web application by adding values to your application's environment under java:/comp/env/org/kopitubruk/util/json. That way you can do things like having all of the validation turned on in development and testing servers and turn it off in production servers for faster performance, without changing any code.
Example for Tomcat, assuming your app is named "MyApp", in $CATALINA_BASE/conf/Catalina/host/MyApp.xml in order to disable property name validation:
```
 <Context path="/MyApp">
   <Environment name="org/kopitubruk/util/json/validatePropertyNames" type="java.lang.Boolean" value="false" override="false" />
 </Context>
```
These are the names and their normal defaults if you don't change them. See the setters for these for descriptions of what they do.
Validation related options.
- validatePropertyNames = true
- detectDataStructureLoops = true
- escapeBadIdentifierCodePoints = false
Safe alternate encoding options.
- encodeNumericStringsAsNumbers = false
- escapeNonAscii = false
- unEscapeWherePossible = false
- escapeSurrogates = false
Allow generation of certain types of non-standard JSON.

Could cause problems for some things that take JSON. Defaults are for standard JSON. Be careful about changing these.
- quoteIdentifier = true
- useECMA6 = false
- allowReservedWordsInIdentifiers = false
It is possible to set the default locale in JNDI using the name "locale" and a String value that is a valid locale string that will get passed to Locale.forLanguageTag(String).
It is possible to see and modify the default values of all of the boolean flags at runtime if you have a JMX client with MBean support connected to your server. It will be in org.kopitubruk.util.json.JSONConfig. You can disable MBean registration by setting a boolean variable named registerMBean to false in the environment as shown above for the flags.
There is some limited logging for access of JNDI and the MBean server. Most of it is debug, so you won't see it unless you have debug logging enabled for this package/class. It might be useful to enable debug logging for this class if you are having trouble with those.
You can disable JNDI lookups, MBean registration or logging by defining boolean system properties for org.kopitubruk.util.json.useJNDI, org.kopitubruk.util.json.registerMBean or org.kopitubruk.util.json.logging respectively as false. System properties may be set on the java command line using the "-D" flag or possibly programmatically if your program has permission to do it and does so before this class is loaded.
Author:

Bill Davidson

See Also:

JSONConfig, Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addNumberFormat(Class<? extends Number> numericClass, NumberFormat fmt)` Add a default number format for a particular type that extends Number.
`static void`	`addNumberFormat(Number numericType, NumberFormat fmt)` Add a default number format for a particular type that extends Number.
`static void`	`clearMBean()` When this package is used by a webapp, and you have an MBean server in your environment, then you should create a ServletContextListener and call this in its ServletContextListener.contextDestroyed(ServletContextEvent) method to remove the MBean when the webapp is unloaded or reloaded.
`void`	`clearNumberFormats()` Clear any default number formats.
`static JSONConfigDefaults`	`getInstance()` Return the JSONConfigDefaults singleton instance.
`static Locale`	`getLocale()` Set a default locale for new JSONConfig objects to use.
`static NumberFormat`	`getNumberFormat(Class<? extends Number> numericClass)` Get the number format for the given class.
`static NumberFormat`	`getNumberFormat(Number num)` Get the number format for the class of the given numeric type.
`boolean`	`isAllowReservedWordsInIdentifiers()` Get the default for allowing reserved words in identifiers.
`boolean`	`isDetectDataStructureLoops()` Get the default detect data structure loops policy.
`boolean`	`isEncodeNumericStringsAsNumbers()` Get the default encode numeric strings as numbers policy.
`boolean`	`isEscapeBadIdentifierCodePoints()` Get the default escape bad identifier code points policy.
`boolean`	`isEscapeNonAscii()` Get the default quote non-ASCII policy.
`boolean`	`isEscapeSurrogates()` The default escape surrogates policy.
`boolean`	`isQuoteIdentifier()` Get the default quote identifier policy.
`boolean`	`isUnEscapeWherePossible()` The default unEscape policy.
`boolean`	`isUseECMA6()` Get the default escape ECMAScript 6 code points policy.
`boolean`	`isValidatePropertyNames()` Get the default validate property names policy.
`static void`	`removeNumberFormat(Class<? extends Number> numericClass)` Remove the requested class from the default number formats.
`void`	`setAllowReservedWordsInIdentifiers(boolean dflt)` Set default flag for allowing reserved words in identifiers.
`void`	`setCodeDefaults()` Reset all defaults to their original unmodified values.
`void`	`setDetectDataStructureLoops(boolean dflt)` Set the default flag for forcing quotes on identifiers.
`void`	`setEncodeNumericStringsAsNumbers(boolean dflt)` Set the default flag for encoding of numeric strings as numbers.
`void`	`setEscapeBadIdentifierCodePoints(boolean dflt)` If true, then any bad code points in identifiers will be escaped.
`void`	`setEscapeNonAscii(boolean dflt)` Set the default flag for forcing escaping of non-ASCII characters.
`void`	`setEscapeSurrogates(boolean dflt)` If true, then surrogates will be escaped.
`static void`	`setLocale(Locale locale)` Set a default locale for new JSONConfig objects to use.
`void`	`setQuoteIdentifier(boolean dflt)` Set the default flag for forcing quotes on identifiers.
`void`	`setUnEscapeWherePossible(boolean dflt)` Set default flag for undoing inline escapes in strings.
`void`	`setUseECMA6(boolean dflt)` Set the default flag for using ECMAScript 6 code points to encode Unicode escapes.
`void`	`setValidatePropertyNames(boolean dflt)` Set the default flag for validation of property names.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static JSONConfigDefaults getInstance()
```
    Return the JSONConfigDefaults singleton instance.
    
    Returns:
    
    the JSONConfigDefaults singleton instance.
  - clearMBean
```
public static void clearMBean()
```
    When this package is used by a webapp, and you have an MBean server in your environment, then you should create a ServletContextListener and call this in its ServletContextListener.contextDestroyed(ServletContextEvent) method to remove the MBean when the webapp is unloaded or reloaded.
```
 public void contextDestroyed( ServletContextEvent sce )
 {
     JSONConfigDefaults.clearMBean();
 }
 
```
    You should add it to your web.xml for your webapp like this (assuming you named it org.myDomain.web.app.AppCleanUp).
```
 <listener>
   <listener-class>org.myDomain.web.app.AppCleanUp</listener-class>
 </listener>
```
    Note that the logging from this method may not work if the logging is removed/disabled before this method is called.
  - getLocale
```
public static Locale getLocale()
```
    Set a default locale for new JSONConfig objects to use.
    
    Returns:
    
    the default locale.
  - setLocale
```
public static void setLocale(Locale locale)
```
    Set a default locale for new JSONConfig objects to use.
    
    Parameters:
    
    locale - the default locale.
  - addNumberFormat
```
public static void addNumberFormat(Class<? extends Number> numericClass,
                                   NumberFormat fmt)
```
    Add a default number format for a particular type that extends Number. This will be applied to all new JSONConfig objects that are created after this in the same class loader.
    
    Parameters:
    
    numericClass - The class.
    
    fmt - The number format.
  - addNumberFormat
```
public static void addNumberFormat(Number numericType,
                                   NumberFormat fmt)
```
    Add a default number format for a particular type that extends Number. This will be applied to all new JSONConfig objects that are created after this in the same class loader.
    
    Parameters:
    
    numericType - The object.
    
    fmt - The number format.
  - getNumberFormat
```
public static NumberFormat getNumberFormat(Class<? extends Number> numericClass)
```
    Get the number format for the given class.
    
    Parameters:
    
    numericClass - A class.
    
    Returns:
    
    A number format or null if one has not been set.
  - getNumberFormat
```
public static NumberFormat getNumberFormat(Number num)
```
    Get the number format for the class of the given numeric type.
    
    Parameters:
    
    num - An object that implements Number.
    
    Returns:
    
    A number format or null if one has not been set.
  - removeNumberFormat
```
public static void removeNumberFormat(Class<? extends Number> numericClass)
```
    Remove the requested class from the default number formats.
    
    Parameters:
    
    numericClass - The class.
  - setCodeDefaults
```
public void setCodeDefaults()
```
    Reset all defaults to their original unmodified values. This overrides JNDI and previous MBean changes.
    
    Specified by:
    
    setCodeDefaults in interface JSONConfigDefaultsMBean
  - clearNumberFormats
```
public void clearNumberFormats()
```
    Clear any default number formats. Accessible via MBean server.
    
    Specified by:
    
    clearNumberFormats in interface JSONConfigDefaultsMBean
  - isValidatePropertyNames
```
public boolean isValidatePropertyNames()
```
    Get the default validate property names policy. Accessible via MBean server.
    
    Specified by:
    
    isValidatePropertyNames in interface JSONConfigDefaultsMBean
    
    Returns:
    
    The default validate property names policy.
  - setValidatePropertyNames
```
public void setValidatePropertyNames(boolean dflt)
```
    Set the default flag for validation of property names. This will affect all new JSONConfig objects created after this call within the same class loader. Accessible via MBean server.
    
    Specified by:
    
    setValidatePropertyNames in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - If true, then property names will be validated by default.
  - isDetectDataStructureLoops
```
public boolean isDetectDataStructureLoops()
```
    Get the default detect data structure loops policy. Accessible via MBean server.
    
    Specified by:
    
    isDetectDataStructureLoops in interface JSONConfigDefaultsMBean
    
    Returns:
    
    The default detect data structure loops policy.
  - setDetectDataStructureLoops
```
public void setDetectDataStructureLoops(boolean dflt)
```
    Set the default flag for forcing quotes on identifiers. This will affect all new JSONConfig objects created after this call within the same class loader. Accessible via MBean server.
    
    Specified by:
    
    setDetectDataStructureLoops in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - If true, then all identifiers will be quoted.
  - isEscapeBadIdentifierCodePoints
```
public boolean isEscapeBadIdentifierCodePoints()
```
    Get the default escape bad identifier code points policy. Accessible via MBean server.
    
    Specified by:
    
    isEscapeBadIdentifierCodePoints in interface JSONConfigDefaultsMBean
    
    Returns:
    
    The default escape bad identifier code points policy.
  - setEscapeBadIdentifierCodePoints
```
public void setEscapeBadIdentifierCodePoints(boolean dflt)
```
    If true, then any bad code points in identifiers will be escaped. Default is false. Accessible via MBean server.
    
    Specified by:
    
    setEscapeBadIdentifierCodePoints in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - the escapeBadIdentifierCodePoints to set
  - isEncodeNumericStringsAsNumbers
```
public boolean isEncodeNumericStringsAsNumbers()
```
    Get the default encode numeric strings as numbers policy. Accessible via MBean server.
    
    Specified by:
    
    isEncodeNumericStringsAsNumbers in interface JSONConfigDefaultsMBean
    
    Returns:
    
    The default encode numeric strings as numbers policy.
  - setEncodeNumericStringsAsNumbers
```
public void setEncodeNumericStringsAsNumbers(boolean dflt)
```
    Set the default flag for encoding of numeric strings as numbers. Accessible via MBean server.
    
    Specified by:
    
    setEncodeNumericStringsAsNumbers in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - If true, then strings that look like numbers will be encoded as numbers.
  - isEscapeNonAscii
```
public boolean isEscapeNonAscii()
```
    Get the default quote non-ASCII policy. Accessible via MBean server.
    
    Specified by:
    
    isEscapeNonAscii in interface JSONConfigDefaultsMBean
    
    Returns:
    
    The default quote non-ASCII policy.
  - setEscapeNonAscii
```
public void setEscapeNonAscii(boolean dflt)
```
    Set the default flag for forcing escaping of non-ASCII characters. This will affect all new JSONConfig objects created after this call within the same class loader. Accessible via MBean server.
    
    Specified by:
    
    setEscapeNonAscii in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - If true, then all non-ASCII will be Unicode escaped.
  - isUnEscapeWherePossible
```
public boolean isUnEscapeWherePossible()
```
    The default unEscape policy. Accessible via MBean server.
    
    Specified by:
    
    isUnEscapeWherePossible in interface JSONConfigDefaultsMBean
    
    Returns:
    
    the unEscape policy.
  - setUnEscapeWherePossible
```
public void setUnEscapeWherePossible(boolean dflt)
```
    Set default flag for undoing inline escapes in strings. Accessible via MBean server.
    
    Specified by:
    
    setUnEscapeWherePossible in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - If true then where possible, undo inline escapes in strings.
  - isEscapeSurrogates
```
public boolean isEscapeSurrogates()
```
    The default escape surrogates policy.
    
    Specified by:
    
    isEscapeSurrogates in interface JSONConfigDefaultsMBean
    
    Returns:
    
    the s_defaultEscapeSurrogates
  - setEscapeSurrogates
```
public void setEscapeSurrogates(boolean dflt)
```
    If true, then surrogates will be escaped.
    
    Specified by:
    
    setEscapeSurrogates in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - the defaultEscapeSurrogates to set
  - isQuoteIdentifier
```
public boolean isQuoteIdentifier()
```
    Get the default quote identifier policy.
    
    Specified by:
    
    isQuoteIdentifier in interface JSONConfigDefaultsMBean
    
    Returns:
    
    The default quote identifier policy.
  - setQuoteIdentifier
```
public void setQuoteIdentifier(boolean dflt)
```
    Set the default flag for forcing quotes on identifiers. This will affect all new JSONConfig objects created after this call within the same class loader. Accessible via MBean server.
    
    Specified by:
    
    setQuoteIdentifier in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - If true, then all identifiers will be quoted.
  - isUseECMA6
```
public boolean isUseECMA6()
```
    Get the default escape ECMAScript 6 code points policy. Accessible via MBean server.
    
    Specified by:
    
    isUseECMA6 in interface JSONConfigDefaultsMBean
    
    Returns:
    
    The default escape ECMAScript 6 code points policy.
  - setUseECMA6
```
public void setUseECMA6(boolean dflt)
```
    Set the default flag for using ECMAScript 6 code points to encode Unicode escapes. Accessible via MBean server.
    
    Specified by:
    
    setUseECMA6 in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - if true then ECMAScript 6 code points will be used to encode Unicode escapes as needed.
  - isAllowReservedWordsInIdentifiers
```
public boolean isAllowReservedWordsInIdentifiers()
```
    Get the default for allowing reserved words in identifiers.
    
    Specified by:
    
    isAllowReservedWordsInIdentifiers in interface JSONConfigDefaultsMBean
    
    Returns:
    
    the defaultAllowReservedWordsInIdentifiers
  - setAllowReservedWordsInIdentifiers
```
public void setAllowReservedWordsInIdentifiers(boolean dflt)
```
    Set default flag for allowing reserved words in identifiers.
    
    Specified by:
    
    setAllowReservedWordsInIdentifiers in interface JSONConfigDefaultsMBean
    
    Parameters:
    
    dflt - the defaultAllowReservedWordsInIdentifiers to set

Class JSONConfigDefaults

Validation related options.

Safe alternate encoding options.

Allow generation of certain types of non-standard JSON.

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

clearMBean

getLocale

setLocale

addNumberFormat

addNumberFormat

getNumberFormat

getNumberFormat

removeNumberFormat

setCodeDefaults

clearNumberFormats

isValidatePropertyNames

setValidatePropertyNames

isDetectDataStructureLoops

setDetectDataStructureLoops

isEscapeBadIdentifierCodePoints

setEscapeBadIdentifierCodePoints

isEncodeNumericStringsAsNumbers

setEncodeNumericStringsAsNumbers

isEscapeNonAscii

setEscapeNonAscii

isUnEscapeWherePossible

setUnEscapeWherePossible

isEscapeSurrogates

setEscapeSurrogates

isQuoteIdentifier

setQuoteIdentifier

isUseECMA6

setUseECMA6

isAllowReservedWordsInIdentifiers

setAllowReservedWordsInIdentifiers