1 /****************************************************************
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 ****************************************************************/
19
20 package org.apache.james.jspf.parser;
21
22 import org.apache.james.jspf.core.exceptions.PermErrorException;
23 import org.apache.james.jspf.terms.Configuration;
24
25 import java.util.Collection;
26
27 /**
28 * A TermsFactory define the list of known TermDefinition and create new Terms
29 * based on its own Definition and a Configuration
30 */
31 public interface TermsFactory {
32
33 /**
34 * Create a new term starting from the TermDefinition created by this factory
35 *
36 * @param klass the TermDefinition.getTermDef (returned by this factory)
37 * @param subres (the configuration)
38 * @return the generated object
39 * @throws PermErrorException if something goes wrong
40 * @throws InstantiationException
41 */
42 public Object createTerm(Class klass, Configuration subres)
43 throws PermErrorException, InstantiationException;
44
45 /**
46 * Return the collection of known Mechanisms
47 *
48 * @return a Collection of TermDefinition
49 */
50 public Collection getMechanismsCollection();
51
52 /**
53 * Return the collection of known Modifiers
54 *
55 * @return a Collection of TermDefinition
56 */
57 public Collection getModifiersCollection();
58
59 }