001 /****************************************************************
002 * Licensed to the Apache Software Foundation (ASF) under one *
003 * or more contributor license agreements. See the NOTICE file *
004 * distributed with this work for additional information *
005 * regarding copyright ownership. The ASF licenses this file *
006 * to you under the Apache License, Version 2.0 (the *
007 * "License"); you may not use this file except in compliance *
008 * with the License. You may obtain a copy of the License at *
009 * *
010 * http://www.apache.org/licenses/LICENSE-2.0 *
011 * *
012 * Unless required by applicable law or agreed to in writing, *
013 * software distributed under the License is distributed on an *
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
015 * KIND, either express or implied. See the License for the *
016 * specific language governing permissions and limitations *
017 * under the License. *
018 ****************************************************************/
019
020 package org.apache.james.jspf.parser;
021
022 import org.apache.james.jspf.core.exceptions.PermErrorException;
023 import org.apache.james.jspf.terms.Configuration;
024
025 import java.util.Collection;
026
027 /**
028 * A TermsFactory define the list of known TermDefinition and create new Terms
029 * based on its own Definition and a Configuration
030 */
031 public interface TermsFactory {
032
033 /**
034 * Create a new term starting from the TermDefinition created by this factory
035 *
036 * @param klass the TermDefinition.getTermDef (returned by this factory)
037 * @param subres (the configuration)
038 * @return the generated object
039 * @throws PermErrorException if something goes wrong
040 * @throws InstantiationException
041 */
042 public Object createTerm(Class<?> klass, Configuration subres)
043 throws PermErrorException, InstantiationException;
044
045 /**
046 * Return the collection of known Mechanisms
047 *
048 * @return a Collection of TermDefinition
049 */
050 public Collection<TermDefinition> getMechanismsCollection();
051
052 /**
053 * Return the collection of known Modifiers
054 *
055 * @return a Collection of TermDefinition
056 */
057 public Collection<TermDefinition> getModifiersCollection();
058
059 }