1 /*
2 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.org.apache.xerces.internal.impl;
27
28 import java.util.HashMap;
29 import javax.xml.stream.XMLInputFactory;
30 import javax.xml.stream.XMLOutputFactory;
31 import javax.xml.stream.XMLResolver;
32
33 import com.sun.xml.internal.stream.StaxEntityResolverWrapper;
34
35 /**
36 * This class manages different properties related to Stax specification and its implementation.
37 * This class constructor also takes itself (PropertyManager object) as parameter and initializes the
38 * object with the property taken from the object passed.
39 *
40 * @author Neeraj Bajaj, neeraj.bajaj@sun.com
41 * @author K.Venugopal@sun.com
42 * @author Sunitha Reddy, sunitha.reddy@sun.com
43 */
44
45 public class PropertyManager {
46
47
48 public static final String STAX_NOTATIONS = "javax.xml.stream.notations";
49 public static final String STAX_ENTITIES = "javax.xml.stream.entities";
50
51 private static final String STRING_INTERNING = "http://xml.org/sax/features/string-interning";
52
53
54 HashMap supportedProps = new HashMap();
55
56 public static final int CONTEXT_READER = 1;
57 public static final int CONTEXT_WRITER = 2;
58
59 /** Creates a new instance of PropertyManager */
60 public PropertyManager(int context) {
61 switch(context){
62 case CONTEXT_READER:{
63 initConfigurableReaderProperties();
64 break;
65 }
66 case CONTEXT_WRITER:{
67 initWriterProps();
68 break;
69 }
70 }
71 }
72
73 /**
74 * Initialize this object with the properties taken from passed PropertyManager object.
75 */
76 public PropertyManager(PropertyManager propertyManager){
77
78 HashMap properties = propertyManager.getProperties();
79 supportedProps.putAll(properties);
80 }
81
82 private HashMap getProperties(){
83 return supportedProps ;
84 }
85
86
87 /**
88 * Important point:
89 * 1. We are not exposing Xerces namespace property. Application should configure namespace through
90 * Stax specific property.
91 *
92 */
93 private void initConfigurableReaderProperties(){
94 //spec default values
95 supportedProps.put(XMLInputFactory.IS_NAMESPACE_AWARE, Boolean.TRUE);
96 supportedProps.put(XMLInputFactory.IS_VALIDATING, Boolean.FALSE);
97 supportedProps.put(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, Boolean.TRUE);
98 supportedProps.put(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, Boolean.TRUE);
99 supportedProps.put(XMLInputFactory.IS_COALESCING, Boolean.FALSE);
100 supportedProps.put(XMLInputFactory.SUPPORT_DTD, Boolean.TRUE);
101 supportedProps.put(XMLInputFactory.REPORTER, null);
102 supportedProps.put(XMLInputFactory.RESOLVER, null);
103 supportedProps.put(XMLInputFactory.ALLOCATOR, null);
104 supportedProps.put(STAX_NOTATIONS,null );
105
106 //zephyr (implementation) specific properties which can be set by the application.
107 //interning is always done
108 supportedProps.put(Constants.SAX_FEATURE_PREFIX + Constants.STRING_INTERNING_FEATURE , new Boolean(true));
109 //recognizing java encoding names by default
110 supportedProps.put(Constants.XERCES_FEATURE_PREFIX + Constants.ALLOW_JAVA_ENCODINGS_FEATURE, new Boolean(true)) ;
111 //in stax mode, namespace declarations are not added as attributes
112 supportedProps.put(Constants.ADD_NAMESPACE_DECL_AS_ATTRIBUTE , Boolean.FALSE) ;
113 supportedProps.put(Constants.READER_IN_DEFINED_STATE, new Boolean(true));
114 supportedProps.put(Constants.REUSE_INSTANCE, new Boolean(true));
115 supportedProps.put(Constants.ZEPHYR_PROPERTY_PREFIX + Constants.STAX_REPORT_CDATA_EVENT , new Boolean(false));
116 supportedProps.put(Constants.ZEPHYR_PROPERTY_PREFIX + Constants.IGNORE_EXTERNAL_DTD, Boolean.FALSE);
117 supportedProps.put(Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_DUPLICATE_ATTDEF_FEATURE, new Boolean(false));
118 supportedProps.put(Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_DUPLICATE_ENTITYDEF_FEATURE, new Boolean(false));
119 supportedProps.put(Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_UNDECLARED_ELEMDEF_FEATURE, new Boolean(false));
120 }
121
122 private void initWriterProps(){
123 supportedProps.put(XMLOutputFactory.IS_REPAIRING_NAMESPACES , Boolean.FALSE);
124 //default value of escaping characters is 'true'
125 supportedProps.put(Constants.ESCAPE_CHARACTERS , Boolean.TRUE);
126 supportedProps.put(Constants.REUSE_INSTANCE, new Boolean(true));
127 }
128
129 /**
130 * public void reset(){
131 * supportedProps.clear() ;
132 * }
133 */
134 public boolean containsProperty(String property){
135 return supportedProps.containsKey(property) ;
136 }
137
138 public Object getProperty(String property){
139 return supportedProps.get(property);
140 }
141
142 public void setProperty(String property, Object value){
143 String equivalentProperty = null ;
144 if(property == XMLInputFactory.IS_NAMESPACE_AWARE || property.equals(XMLInputFactory.IS_NAMESPACE_AWARE)){
145 equivalentProperty = Constants.XERCES_FEATURE_PREFIX + Constants.NAMESPACES_FEATURE ;
146 }
147 else if(property == XMLInputFactory.IS_VALIDATING || property.equals(XMLInputFactory.IS_VALIDATING)){
148 if( (value instanceof Boolean) && ((Boolean)value).booleanValue()){
149 throw new java.lang.IllegalArgumentException("true value of isValidating not supported") ;
150 }
151 }
152 else if(property == STRING_INTERNING || property.equals(STRING_INTERNING)){
153 if( (value instanceof Boolean) && !((Boolean)value).booleanValue()){
154 throw new java.lang.IllegalArgumentException("false value of " + STRING_INTERNING + "feature is not supported") ;
155 }
156 }
157 else if(property == XMLInputFactory.RESOLVER || property.equals(XMLInputFactory.RESOLVER)){
158 //add internal stax property
159 supportedProps.put( Constants.XERCES_PROPERTY_PREFIX + Constants.STAX_ENTITY_RESOLVER_PROPERTY , new StaxEntityResolverWrapper((XMLResolver)value)) ;
160 }
161 supportedProps.put(property, value ) ;
162 if(equivalentProperty != null){
163 supportedProps.put(equivalentProperty, value ) ;
164 }
165 }
166
167 public String toString(){
168 return supportedProps.toString();
169 }
170
171 }//PropertyManager