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 com.sun.org.apache.xerces.internal.utils.SecuritySupport;
29 import com.sun.xml.internal.stream.StaxEntityResolverWrapper;
30 import java.util.HashMap;
31 import javax.xml.XMLConstants;
32 import javax.xml.stream.XMLInputFactory;
33 import javax.xml.stream.XMLOutputFactory;
34 import javax.xml.stream.XMLResolver;
35
36 /**
37 * This class manages different properties related to Stax specification and its implementation.
38 * This class constructor also takes itself (PropertyManager object) as parameter and initializes the
39 * object with the property taken from the object passed.
40 *
41 * @author Neeraj Bajaj, neeraj.bajaj@sun.com
42 * @author K.Venugopal@sun.com
43 * @author Sunitha Reddy, sunitha.reddy@sun.com
44 */
45
46 public class PropertyManager {
47
48
49 public static final String STAX_NOTATIONS = "javax.xml.stream.notations";
50 public static final String STAX_ENTITIES = "javax.xml.stream.entities";
51
52 private static final String STRING_INTERNING = "http://xml.org/sax/features/string-interning";
53
54
55 /** Property identifier: access to external dtd */
56 protected static final String ACCESS_EXTERNAL_DTD = XMLConstants.ACCESS_EXTERNAL_DTD;
57
58 /** Property identifier: access to external schema */
59 protected static final String ACCESS_EXTERNAL_SCHEMA = XMLConstants.ACCESS_EXTERNAL_SCHEMA;
60
61 HashMap supportedProps = new HashMap();
62
63 public static final int CONTEXT_READER = 1;
64 public static final int CONTEXT_WRITER = 2;
65
66 /** Creates a new instance of PropertyManager */
67 public PropertyManager(int context) {
68 switch(context){
69 case CONTEXT_READER:{
70 initConfigurableReaderProperties();
71 break;
72 }
73 case CONTEXT_WRITER:{
74 initWriterProps();
75 break;
76 }
77 }
78 }
79
80 /**
81 * Initialize this object with the properties taken from passed PropertyManager object.
82 */
83 public PropertyManager(PropertyManager propertyManager){
84
85 HashMap properties = propertyManager.getProperties();
86 supportedProps.putAll(properties);
87 }
88
89 private HashMap getProperties(){
90 return supportedProps ;
91 }
92
93
94 /**
95 * Important point:
96 * 1. We are not exposing Xerces namespace property. Application should configure namespace through
97 * Stax specific property.
98 *
99 */
100 private void initConfigurableReaderProperties(){
101 //spec default values
102 supportedProps.put(XMLInputFactory.IS_NAMESPACE_AWARE, Boolean.TRUE);
103 supportedProps.put(XMLInputFactory.IS_VALIDATING, Boolean.FALSE);
104 supportedProps.put(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, Boolean.TRUE);
105 supportedProps.put(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, Boolean.TRUE);
106 supportedProps.put(XMLInputFactory.IS_COALESCING, Boolean.FALSE);
107 supportedProps.put(XMLInputFactory.SUPPORT_DTD, Boolean.TRUE);
108 supportedProps.put(XMLInputFactory.REPORTER, null);
109 supportedProps.put(XMLInputFactory.RESOLVER, null);
110 supportedProps.put(XMLInputFactory.ALLOCATOR, null);
111 supportedProps.put(STAX_NOTATIONS,null );
112
113 //zephyr (implementation) specific properties which can be set by the application.
114 //interning is always done
115 supportedProps.put(Constants.SAX_FEATURE_PREFIX + Constants.STRING_INTERNING_FEATURE , new Boolean(true));
116 //recognizing java encoding names by default
117 supportedProps.put(Constants.XERCES_FEATURE_PREFIX + Constants.ALLOW_JAVA_ENCODINGS_FEATURE, new Boolean(true)) ;
118 //in stax mode, namespace declarations are not added as attributes
119 supportedProps.put(Constants.ADD_NAMESPACE_DECL_AS_ATTRIBUTE , Boolean.FALSE) ;
120 supportedProps.put(Constants.READER_IN_DEFINED_STATE, new Boolean(true));
121 supportedProps.put(Constants.REUSE_INSTANCE, new Boolean(true));
122 supportedProps.put(Constants.ZEPHYR_PROPERTY_PREFIX + Constants.STAX_REPORT_CDATA_EVENT , new Boolean(false));
123 supportedProps.put(Constants.ZEPHYR_PROPERTY_PREFIX + Constants.IGNORE_EXTERNAL_DTD, Boolean.FALSE);
124 supportedProps.put(Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_DUPLICATE_ATTDEF_FEATURE, new Boolean(false));
125 supportedProps.put(Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_DUPLICATE_ENTITYDEF_FEATURE, new Boolean(false));
126 supportedProps.put(Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_UNDECLARED_ELEMDEF_FEATURE, new Boolean(false));
127
128 //For DOM/SAX, the secure feature is set to true by default
129 String accessExternal = SecuritySupport.getDefaultAccessProperty(
130 Constants.SP_ACCESS_EXTERNAL_DTD, Constants.EXTERNAL_ACCESS_DEFAULT);
131 supportedProps.put(ACCESS_EXTERNAL_DTD, accessExternal);
132
133 accessExternal = SecuritySupport.getDefaultAccessProperty(
134 Constants.SP_ACCESS_EXTERNAL_SCHEMA, Constants.EXTERNAL_ACCESS_DEFAULT);
135 supportedProps.put(ACCESS_EXTERNAL_SCHEMA, accessExternal);
136 }
137
138 private void initWriterProps(){
139 supportedProps.put(XMLOutputFactory.IS_REPAIRING_NAMESPACES , Boolean.FALSE);
140 //default value of escaping characters is 'true'
141 supportedProps.put(Constants.ESCAPE_CHARACTERS , Boolean.TRUE);
142 supportedProps.put(Constants.REUSE_INSTANCE, new Boolean(true));
143 }
144
145 /**
146 * public void reset(){
147 * supportedProps.clear() ;
148 * }
149 */
150 public boolean containsProperty(String property){
151 return supportedProps.containsKey(property) ;
152 }
153
154 public Object getProperty(String property){
155 return supportedProps.get(property);
156 }
157
158 public void setProperty(String property, Object value){
159 String equivalentProperty = null ;
160 if(property == XMLInputFactory.IS_NAMESPACE_AWARE || property.equals(XMLInputFactory.IS_NAMESPACE_AWARE)){
161 equivalentProperty = Constants.XERCES_FEATURE_PREFIX + Constants.NAMESPACES_FEATURE ;
162 }
163 else if(property == XMLInputFactory.IS_VALIDATING || property.equals(XMLInputFactory.IS_VALIDATING)){
164 if( (value instanceof Boolean) && ((Boolean)value).booleanValue()){
165 throw new java.lang.IllegalArgumentException("true value of isValidating not supported") ;
166 }
167 }
168 else if(property == STRING_INTERNING || property.equals(STRING_INTERNING)){
169 if( (value instanceof Boolean) && !((Boolean)value).booleanValue()){
170 throw new java.lang.IllegalArgumentException("false value of " + STRING_INTERNING + "feature is not supported") ;
171 }
172 }
173 else if(property == XMLInputFactory.RESOLVER || property.equals(XMLInputFactory.RESOLVER)){
174 //add internal stax property
175 supportedProps.put( Constants.XERCES_PROPERTY_PREFIX + Constants.STAX_ENTITY_RESOLVER_PROPERTY , new StaxEntityResolverWrapper((XMLResolver)value)) ;
176 }
177 supportedProps.put(property, value ) ;
178 if(equivalentProperty != null){
179 supportedProps.put(equivalentProperty, value ) ;
180 }
181 }
182
183 public String toString(){
184 return supportedProps.toString();
185 }
186
187 }//PropertyManager