org.appng.api.model.Authorizable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of appng-api Show documentation

the public API of appNG

There is a newer version: 1.24.5

/*
 * Copyright 2011-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.appng.api.model;

import java.io.Serializable;
import java.util.List;

/**
 * If a {@link Application} want's to authorize a domain object to several {@link Role}s, the domain-object needs to
 * implement {@link Authorizable}.

 * The {@link Role}s provided by the {@link Application} can be obtained by calling {@link Application#getRoles()}. Since
 * the {@link Role}s are maintained by appNG and not by the {@link Application} itself, the {@link Authorizable} just
 * needs to maintain the IDs of the authorized {@link Role}s.

 * When using JPA for persisting domain objects, this can easily be done by using a
 * {@code javax.persistence.ElementCollection}.
 * 
 *  * @ElementCollection
 * public List<Integer> getRoleIds() {
 * 	return roleIds;
 * }
 * 
 * 
 * @author Matthias Müller
 * 
 * @see Subject#isAuthorized(Authorizable)
 * @see Application#getRoles()
 */
public interface Authorizable extends Named {

	/**
	 * Returns a list containing the IDs of all {@link Role}s which are authorized to access this
	 * {@link Authorizable}.
	 * 
	 * @return a list containing the IDs of all {@link Role}s which are authorized to access this
	 *         {@link Authorizable}
	 */
	public List getRoleIds();

}