org.filesys.server.auth.acl.AccessControlFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jfileserver Show documentation

Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems

There is a newer version: 1.4.0

/*
 * Copyright (C) 2006-2010 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see .
 */

package org.filesys.server.auth.acl;

import java.util.Hashtable;

import org.springframework.extensions.config.ConfigElement;

/**
 * Access Control Factoy Class
 *
 * The AccessControlFactory class holds a table of available AccessControlParsers that are used
 * to generate AccessControl instances.
 *
 * An AccessControlParser has an associated unique type name that is used to call the appropriate parser.
 *
 * @author gkspencer
 */
public class AccessControlFactory {

    //	Access control parsers
    private Hashtable m_parsers;

    /**
     * Class constructor
     */
    public AccessControlFactory() {
        m_parsers = new Hashtable();
    }

    /**
     * Create an access control using the specified parameters
     *
     * @param type   String
     * @param params ConfigElement
     * @return AccessControl
     * @exception ACLParseException Error parsing the ACL
     * @exception InvalidACLTypeException Invalid ACL type
     */
    public final AccessControl createAccessControl(String type, ConfigElement params)
            throws ACLParseException, InvalidACLTypeException {

        //	Find the access control parser
        AccessControlParser parser = m_parsers.get(type);
        if (parser == null)
            throw new InvalidACLTypeException(type);

        //	Parse the parameters and create a new AccessControl instance
        return parser.createAccessControl(params);
    }

    /**
     * Add a parser to the list of available parsers
     *
     * @param parser AccessControlParser
     */
    public final void addParser(AccessControlParser parser) {
        m_parsers.put(parser.getType(), parser);
    }

    /**
     * Remove a parser from the available parser list
     *
     * @param type String
     * @return AccessControlParser
     */
    public final AccessControlParser removeParser(String type) {
        return m_parsers.remove(type);
    }
}