org.intellimate.izou.security

Class PermissionModule

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.security.PermissionModule

All Implemented Interfaces:

Identifiable, MainProvider

Direct Known Subclasses:

AudioPermissionModule, FilePermissionModule, ReflectionPermissionModule, RootPermission, SocketPermissionModule

public abstract class PermissionModule
extends IzouModule

A PermissionModule defines basic permissions in Izou. A permission in Izou is defined as service that is generally allowed, yet the addOn has to be registered in order to use the service.

For example, socket connections are generally allowed for Izou addOns yet in order to use them their usage has to be declared in the addon_config.properties file of the addOn.

Thus PermissionModule implements a registration system for services like socket connection.

Field Summary

Fields inherited from class org.intellimate.izou.util.IzouModule

log, main

Method Summary

Modifier and Type	Method and Description
abstract boolean	canCheckPermission(Permission permission) returns true if able to check permissions
abstract void	checkPermission(Permission permission, AddOnModel addon) Checks if the given addOn is allowed to access the requested service.
SecurityManager	getSecurityManager() returns an instance of SecurityManager
boolean	isRegistered(AddOnModel addon) Checks if an addOn is registered with this PermissionModule
void	registerAddOn(AddOnModel addon) Adds an addOn to the registered addOns list for this PermissionModule
protected <X extends IzouPermissionException> void	registerOrThrow(AddOnModel addOn, java.util.function.Supplier<X> exceptionSupplier, java.util.function.Function<ro.fortsoft.pf4j.PluginDescriptor,Boolean> checkPermission) registers the addon if checkPermission returns true, else throws the exception provided by the exceptionSupplier.

Methods inherited from class org.intellimate.izou.util.IzouModule

debug, debug, error, error, fatal, fatal, getID, getMain

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Method Detail

getSecurityManager

public SecurityManager getSecurityManager()

returns an instance of SecurityManager

Returns:

the SecurityManager

canCheckPermission

public abstract boolean canCheckPermission(Permission permission)

returns true if able to check permissions

Parameters:

permission - the permission to check

Returns:

true if able to, false if not

registerAddOn

public void registerAddOn(AddOnModel addon)

Adds an addOn to the registered addOns list for this PermissionModule

Parameters:

addon - the Identifiable to add

isRegistered

public boolean isRegistered(AddOnModel addon)

Checks if an addOn is registered with this PermissionModule

Parameters:

addon - the identifiable to check

Returns:

true if the addOn is registered, else false

checkPermission

public abstract void checkPermission(Permission permission,
                                     AddOnModel addon)
                              throws SecurityException

Checks if the given addOn is allowed to access the requested service.

Parameters:

addon - the identifiable to check

permission - the Permission to check

Throws:

SecurityException - thrown if the addOn is not allowed to access its requested service

registerOrThrow

protected <X extends IzouPermissionException> void registerOrThrow(AddOnModel addOn,
                                                                   java.util.function.Supplier<X> exceptionSupplier,
                                                                   java.util.function.Function<ro.fortsoft.pf4j.PluginDescriptor,Boolean> checkPermission)

registers the addon if checkPermission returns true, else throws the exception provided by the exceptionSupplier. If the Addon was not added through PF4J it gets ignored

Parameters:

addOn - the addon to check

checkPermission - returns true if eligible for registering