Source Code Cross Referenced for ResourceRepository.java in  » Workflow-Engines » obe-1.0 » org » obe » spi » service » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Workflow Engines » obe 1.0 » org.obe.spi.service 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        /*--
002:
003:         Copyright (C) 2002-2005 Adrian Price.
004:         All rights reserved.
005:
006:         Redistribution and use in source and binary forms, with or without
007:         modification, are permitted provided that the following conditions
008:         are met:
009:
010:         1. Redistributions of source code must retain the above copyright
011:            notice, this list of conditions, and the following disclaimer.
012:
013:         2. Redistributions in binary form must reproduce the above copyright
014:            notice, this list of conditions, and the disclaimer that follows
015:            these conditions in the documentation and/or other materials
016:            provided with the distribution.
017:
018:         3. The names "OBE" and "Open Business Engine" must not be used to
019:         	endorse or promote products derived from this software without prior
020:         	written permission.  For written permission, please contact
021:         	adrianprice@sourceforge.net.
022:
023:         4. Products derived from this software may not be called "OBE" or
024:         	"Open Business Engine", nor may "OBE" or "Open Business Engine"
025:         	appear in their name, without prior written permission from
026:         	Adrian Price (adrianprice@users.sourceforge.net).
027:
028:         THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
029:         WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
030:         OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
031:         DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
032:         INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
033:         (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
034:         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
035:         HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
036:         STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
037:         IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
038:         POSSIBILITY OF SUCH DAMAGE.
039:
040:         For more information on OBE, please see
041:         <http://obe.sourceforge.net/>.
042:
043:         */
044:
045:        package org.obe.spi.service;
046:
047:        import org.obe.client.api.repository.ObjectAlreadyExistsException;
048:        import org.obe.client.api.repository.ObjectNotFoundException;
049:        import org.obe.client.api.repository.RepositoryException;
050:        import org.obe.client.api.repository.ResourceMetaData;
051:        import org.obe.spi.WorkflowService;
052:        import org.xml.sax.EntityResolver;
053:
054:        import javax.xml.transform.URIResolver;
055:        import java.io.InputStream;
056:
057:        /**
058:         * A repository for XML documents, schemas, DTDs, transforms and templates. The
059:         * repository can also be used as a SAX EntityResolver.
060:         *
061:         * @author Adrian Price
062:         */
063:        public interface ResourceRepository extends WorkflowService,
064:                EntityResolver, URIResolver {
065:
066:            String SERVICE_NAME = "ResourceRepository";
067:
068:            /**
069:             * Type key for XML document instances.
070:             */
071:            String XML = "xml";
072:            /**
073:             * Type key for XML Document Type Definitions.
074:             */
075:            String DTD = "dtd";
076:            /**
077:             * Type key for XML Schemas.
078:             */
079:            String XSD = "xsd";
080:            /**
081:             * Type key for XML Stylesheets and Transformations.
082:             */
083:            String XSL = "xsl";
084:            /**
085:             * Type key for Web Services Description Language.
086:             */
087:            String WSDL = "wsdl";
088:            /**
089:             * Type key for Velocity templates.
090:             */
091:            String VM = "vm";
092:
093:            /**
094:             * Finds all entity types known to the repository.  This method is intended
095:             * to support design-time clients and management applications.
096:             *
097:             * @param locale The locale in which the results should be formatted.
098:             * @return All entity types.
099:             * @throws RepositoryException if an error occurred.
100:             */
101:            ResourceMetaData[] findXMLTypes(String locale)
102:                    throws RepositoryException;
103:
104:            /**
105:             * Returns information about the specified XML type.  This method is
106:             * intended to support design-time clients and management applications.
107:             *
108:             * @param type   The entity type: {@link #XML}, {@link #DTD}, {@link #XSD},
109:             *               {@link #XSL}, {@link #VM}.
110:             * @param locale The locale in which the results should be formatted.
111:             * @return Information about the specified entity type.
112:             * @throws ObjectNotFoundException if the entity type is unknown.
113:             * @throws RepositoryException     if some other error occurred.
114:             */
115:            ResourceMetaData findXMLType(String type, String locale)
116:                    throws RepositoryException;
117:
118:            /**
119:             * Registers an XML entity. The <code>entity</code> meta-data must contain
120:             * non-null {@link ResourceMetaData#getContent() content}.
121:             *
122:             * @param entity The entity definition.
123:             * @throws ObjectAlreadyExistsException if the entity ID is already
124:             *                                      registered.
125:             * @throws RepositoryException          if the entity could not be registered some
126:             *                                      other reason.
127:             */
128:            void createEntity(ResourceMetaData entity)
129:                    throws RepositoryException;
130:
131:            /**
132:             * Unregisters an XML entity.
133:             *
134:             * @param id The entity ID (publicId if it has one, otherwise systemId).
135:             * @throws ObjectNotFoundException if the entity ID is not registered.
136:             * @throws RepositoryException     if the entity could not be unregistered for
137:             *                                 some other reason.
138:             */
139:            void deleteEntity(String id) throws RepositoryException;
140:
141:            /**
142:             * Updates an XML entity.  If the <code>entity</code> meta-data contains
143:             * non-null {@link ResourceMetaData#getContent() content}, the repository
144:             * persists the updated content.  Otherwise, any existing content remains
145:             * intact.
146:             *
147:             * @param entity The entity definition.
148:             * @throws ObjectNotFoundException if the entity ID is not registered.
149:             * @throws RepositoryException     if the entity could not be updated for some
150:             *                                 other reason.
151:             */
152:            void updateEntity(ResourceMetaData entity)
153:                    throws RepositoryException;
154:
155:            /**
156:             * Finds meta-data for all entities.  This method is intended to support
157:             * design-time clients and management applications.
158:             *
159:             * @param includeContent <code>true</code> if the
160:             *                       {@link ResourceMetaData#getContent() content} property of the returned
161:             *                       meta-data objects should be populated with the content of the XML
162:             *                       entities.
163:             * @return The list of all entities.
164:             * @throws RepositoryException if an error occurred.
165:             */
166:            ResourceMetaData[] findXMLMetaData(boolean includeContent)
167:                    throws RepositoryException;
168:
169:            /**
170:             * Finds meta-data for an XML entity.  This method is intended to support
171:             * design-time clients and management applications.
172:             *
173:             * @param id             The entity ID.
174:             * @param includeContent <code>true</code> if the
175:             *                       {@link ResourceMetaData#getContent() content} property of the returned
176:             *                       meta-data object should be populated with the content of the XML entity.
177:             * @return Meta-data about the requested entity.
178:             * @throws ObjectNotFoundException if the entity ID is not registered.
179:             * @throws RepositoryException     if some other error occurred.
180:             */
181:            ResourceMetaData findXMLMetaData(String id, boolean includeContent)
182:                    throws RepositoryException;
183:
184:            /**
185:             * Opens an XML entity for reading.  This method is called by the engine at
186:             * run-time when it needs to resolve the entity from the given ID.
187:             *
188:             * @param id The entity ID.
189:             * @return The requested entity.
190:             * @throws ObjectNotFoundException if the entity ID is not registered.
191:             * @throws RepositoryException     if some other error occurred.
192:             */
193:            InputStream findEntity(String id) throws RepositoryException;
194:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.