org.fabric3.spi.generator.policy.PolicyRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation
SPIs for runtime extensions
There is a newer version: 2.0.1
/*
* Fabric3
* Copyright (c) 2009-2011 Metaform Systems
*
* Fabric3 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 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 General Public License for more details.
*
* You should have received a copy of the
* GNU General Public License along with Fabric3.
* If not, see .
*/
package org.fabric3.spi.generator.policy;

import java.net.URI;
import java.util.Collection;
import java.util.Set;
import javax.xml.namespace.QName;

import org.fabric3.model.type.definitions.AbstractPolicyDefinition;
import org.fabric3.model.type.definitions.PolicySet;

/**
 * Registry of binding types, implementation types, intents and policy sets within an SCA domain.
 *
 * @version $Rev: 9866 $ $Date: 2011-01-18 11:05:55 +0000 (Tue, 18 Jan 2011) $
 */
public interface PolicyRegistry {

    /**
     * Returns all the definitions of a given type.
     *
     * @param              definition type.
     * @param definitionClass definition class.
     * @return all definitions of the given type.
     */
     Collection getAllDefinitions(Class definitionClass);

    /**
     * Returns the definition of the specified type and qualified name.
     *
     * @param              dDefinition type.
     * @param name            qualified name of the definition object.
     * @param definitionClass definition class.
     * @return Requested definition object if available, otherwise null.
     */
     D getDefinition(QName name, Class definitionClass);

    /**
     * Returns the definitions of the specified type for the set of qualified names.
     *
     * @param              definition type.
     * @param names           qualified names of the definition object.
     * @param definitionClass definition class.
     * @return Requested definition object if available, otherwise null.
     */
     Set getDefinitions(Set names, Class definitionClass);

    /**
     * Returns a list of active PolicySets that use external attachment.
     *
     * @return the PolicySets
     */
    Set getExternalAttachmentPolicies();

    /**
     * Activates all the policy definitions in the specified contribution.
     *
     * @param uri The contribution uri.
     * @return the activated policy sets that need to be externally attached
     * @throws PolicyActivationException If unable to find definition.
     */
    Set activateDefinitions(URI uri) throws PolicyActivationException;

    /**
     * Deactivates all the policy definitions in the specified contribution.
     *
     * @param uri The contribution uri.
     * @return the activated policy sets that need to be externally detached
     * @throws PolicyActivationException If unable to find definition.
     */
    Set deactivateDefinitions(URI uri) throws PolicyActivationException;

}