EntityResolver.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:8k
源码类别:
xml/soap/webservice
开发平台:
C/C++
- /*
- * The Apache Software License, Version 1.1
- *
- * Copyright (c) 1999-2000 The Apache Software Foundation. All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Xerces" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation, and was
- * originally based on software copyright (c) 1999, International
- * Business Machines, Inc., http://www.ibm.com . For more information
- * on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- */
- /*
- * $Log: EntityResolver.hpp,v $
- * Revision 1.6 2000/03/02 19:54:34 roddey
- * This checkin includes many changes done while waiting for the
- * 1.1.0 code to be finished. I can't list them all here, but a list is
- * available elsewhere.
- *
- * Revision 1.5 2000/02/24 20:12:55 abagchi
- * Swat for removing Log from API docs
- *
- * Revision 1.4 2000/02/12 03:31:55 rahulj
- * Removed duplicate CVS Log entries.
- *
- * Revision 1.3 2000/02/12 01:27:19 aruna1
- * Documentation updated
- *
- * Revision 1.2 2000/02/06 07:47:57 rahulj
- * Year 2K copyright swat.
- *
- * Revision 1.1.1.1 1999/11/09 01:07:44 twl
- * Initial checkin
- *
- * Revision 1.3 1999/11/08 20:44:56 rahul
- * Swat for adding in Product name and CVS comment log variable.
- *
- */
- #ifndef ENTITYRESOLVER_HPP
- #define ENTITYRESOLVER_HPP
- #include <util/XercesDefs.hpp>
- class InputSource;
- /**
- * Basic interface for resolving entities.
- *
- * <p>If a SAX application needs to implement customized handling
- * for external entities, it must implement this interface and
- * register an instance with the SAX parser using the parser's
- * setEntityResolver method.</p>
- *
- * <p>The parser will then allow the application to intercept any
- * external entities (including the external DTD subset and external
- * parameter entities, if any) before including them.</p>
- *
- * <p>Many SAX applications will not need to implement this interface,
- * but it will be especially useful for applications that build
- * XML documents from databases or other specialised input sources,
- * or for applications that use URI types other than URLs.</p>
- *
- * <p>The following resolver would provide the application
- * with a special character stream for the entity with the system
- * identifier "http://www.myhost.com/today":</p>
- *
- *<pre>
- *#include <sax/EntityResolver.hpp>
- *#include <sax/InputSource.hpp>
- *
- *class MyResolver : public EntityResolver {
- * public:
- * InputSource resolveEntity (const XMLCh* const publicId,
- * const XMLCh* const systemId);
- * ...
- * };
- *
- * MyResolver::resolveEntity {
- * if (XMLString::compareString(systemId, "http://www.myhost.com/today")) {
- * MyReader* reader = new MyReader();
- * return new InputSource(reader);
- * } else {
- * return null;
- * }
- * }
- *
- *</pre>
- *
- * <p>The application can also use this interface to redirect system
- * identifiers to local URIs or to look up replacements in a catalog
- * (possibly by using the public identifier).</p>
- *
- * <p>The HandlerBase class implements the default behaviour for
- * this interface, which is simply always to return null (to request
- * that the parser use the default system identifier).</p>
- *
- * @see Parser#setEntityResolver
- * @see InputSource#InputSource
- * @see HandlerBase#HandlerBase
- */
- class SAX_EXPORT EntityResolver
- {
- public:
- /** @name Constructors and Destructor */
- //@{
- /** Default Constructor */
- EntityResolver()
- {
- }
- /** Destructor */
- virtual ~EntityResolver()
- {
- }
- //@}
- /** @name The EntityResolver interface */
- //@{
- /**
- * Allow the application to resolve external entities.
- *
- * <p>The Parser will call this method before opening any external
- * entity except the top-level document entity (including the
- * external DTD subset, external entities referenced within the
- * DTD, and external entities referenced within the document
- * element): the application may request that the parser resolve
- * the entity itself, that it use an alternative URI, or that it
- * use an entirely different input source.</p>
- *
- * <p>Application writers can use this method to redirect external
- * system identifiers to secure and/or local URIs, to look up
- * public identifiers in a catalogue, or to read an entity from a
- * database or other input source (including, for example, a dialog
- * box).</p>
- *
- * <p>If the system identifier is a URL, the SAX parser must
- * resolve it fully before reporting it to the application.</p>
- *
- * @param publicId The public identifier of the external entity
- * being referenced, or null if none was supplied.
- * @param systemId The system identifier of the external entity
- * being referenced.
- * @return An InputSource object describing the new input source,
- * or null to request that the parser open a regular
- * URI connection to the system identifier.
- * @exception SAXException Any SAX exception, possibly
- * wrapping another exception.
- * @exception IOException An IO exception,
- * possibly the result of creating a new InputStream
- * or Reader for the InputSource.
- * @see InputSource#InputSource
- */
- virtual InputSource* resolveEntity
- (
- const XMLCh* const publicId
- , const XMLCh* const systemId
- ) = 0;
- //@}
- private :
- /* Unimplemented constructors and operators */
- /* Copy constructor */
- EntityResolver(const EntityResolver&);
- /* Assignment operator */
- void operator=(const EntityResolver&);
- };
- #endif