001package org.apache.archiva.redback.role.template;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.archiva.redback.role.RoleManagerException;
023import org.apache.archiva.redback.role.model.RedbackRoleModel;
024
025/**
026 * RoleModelValidator:
027 *
028 * @author: Jesse McConnell
029 */
030public interface RoleTemplateProcessor
031{
032
033    /**
034     * Creates a role instance from a template for the given resource and returns the id of the new role.
035     * @param model the model
036     * @param templateId the template identifier
037     * @param resource the resource to which the role is applied
038     * @return the id of the role
039     * @throws RoleManagerException if the access to the backend datastore failed
040     */
041    String create( RedbackRoleModel model, String templateId, String resource )
042        throws RoleManagerException;
043
044    /**
045     * Removes the role instance that belongs to the template from the datastore
046     * @param model the model
047     * @param templateId the template identifier
048     * @param resource the resource to which the role is applied
049     * @throws RoleManagerException if the access to the backend datastore failed
050     */
051    void remove( RedbackRoleModel model, String templateId, String resource )
052        throws RoleManagerException;
053
054
055    /**
056     * Returns the role id that identifies the role that is a instance of the given template for the given resource.
057     * @param templateId the template identifier
058     * @param resource the resource
059     * @return the role identifier
060     */
061    String getRoleId( String templateId, String resource );
062}