001/*
002 *  Copyright 2016 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.core.right;
017
018import java.util.Set;
019
020/**
021 * This interface is for getting, from a single object, a set of object. When calling {@link RightManager#hasRight(org.ametys.core.user.UserIdentity, String, Object)},
022 * the object is converted into a set of objects and the rights are checked on all those converted objects.
023 */
024public interface RightContextConvertor
025{
026    /**
027     * Converts the object.
028     * @param object The initial object
029     * @return The converted objects. A non-null set, that does not contains the initial object. So if you do not support the object to convert, you must return an empty set.
030     */
031    public Set<Object> convert(Object object);
032}