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.EvaluatorMetaData;
048: import org.obe.client.api.repository.ObjectAlreadyExistsException;
049: import org.obe.client.api.repository.ObjectNotFoundException;
050: import org.obe.client.api.repository.RepositoryException;
051: import org.obe.spi.WorkflowService;
052: import org.obe.spi.evaluator.Evaluator;
053:
054: /**
055: * Provides management and registration for pluggable script evaluators.
056: *
057: * @author Adrian Price
058: */
059: public interface EvaluatorFactory extends WorkflowService {
060: String SERVICE_NAME = "EvaluatorFactory";
061:
062: /**
063: * Registers an evaluator.
064: *
065: * @param eval The evaluator definition.
066: * @throws ObjectAlreadyExistsException if the
067: * content type is already registered.
068: * @throws RepositoryException if the evaluator could not be registered
069: * for some other reason.
070: */
071: void createEvaluator(EvaluatorMetaData eval)
072: throws RepositoryException;
073:
074: /**
075: * Unregisters an evaluator.
076: *
077: * @param contentType The MIME content type for the scripting language.
078: * @throws ObjectNotFoundException if an evaluator
079: * for <code>contentType</code> is not registered.
080: * @throws RepositoryException if the evaluator could not be unregistered
081: * for some other reason.
082: */
083: void deleteEvaluator(String contentType) throws RepositoryException;
084:
085: /**
086: * Updates an evaluator.
087: *
088: * @param eval The evaluator definition.
089: * @throws ObjectNotFoundException if an evaluator
090: * for the content type in question is not registered.
091: * @throws RepositoryException if the evaluator could not be updated for
092: * some other reason.
093: */
094: void updateEvaluator(EvaluatorMetaData eval)
095: throws RepositoryException;
096:
097: /**
098: * Finds all evaluator types known to the repository. This method is
099: * intended to support design-time clients and management applications.
100: *
101: * @param locale The locale in which the results should be formatted.
102: * @return All evaluator types.
103: * @throws RepositoryException if an error occurred.
104: */
105: EvaluatorMetaData[] findEvaluatorTypes(String locale)
106: throws RepositoryException;
107:
108: /**
109: * Returns information about the specified evaluator type. This method is
110: * intended to support design-time clients and management applications.
111: *
112: * @param className The evaluator type (i.e., the fully qualified name of
113: * the implementation class).
114: * @param locale The locale in which the results should be formatted.
115: * @return Information about the specified evaluator type.
116: * @throws ObjectNotFoundException if the
117: * evaluator type is unknown.
118: * @throws RepositoryException if some other error occurred.
119: */
120: EvaluatorMetaData findEvaluatorType(String className, String locale)
121: throws RepositoryException;
122:
123: /**
124: * Finds meta-data for all evaluators. This method is intended to support
125: * design-time clients and management applications.
126: *
127: * @return The list of all evaluators.
128: * @throws RepositoryException if an error occurred.
129: */
130: EvaluatorMetaData[] findEvaluatorMetaData()
131: throws RepositoryException;
132:
133: /**
134: * Finds meta-data for an evaluator. This method is intended to support
135: * design-time clients and management applications.
136: *
137: * @param contentType The MIME content type for the scripting language.
138: * @return Meta-data about the requested evaluator.
139: * @throws ObjectNotFoundException if an evaluator
140: * for <code>contentType</code> is not registered.
141: * @throws RepositoryException if some other error occurred.
142: */
143: EvaluatorMetaData findEvaluatorMetaData(String contentType)
144: throws RepositoryException;
145:
146: /**
147: * Finds an evaluator. This method is called by the engine at run-time when
148: * it needs to execute the evaluator with the given ID.
149: *
150: * @param contentType The MIME content type for the scripting language.
151: * @return The requested evaluator.
152: * @throws ObjectNotFoundException if an evaluator
153: * for <code>contentType</code> is not registered.
154: * @throws RepositoryException if some other error occurred.
155: */
156: Evaluator findEvaluator(String contentType)
157: throws RepositoryException;
158: }
|