Package net.datenwerke.security.service.security

Interface SecurityService

All Known Implementing Classes:

SecurityAllowEverythingService, SecurityServiceImpl

public interface SecurityService

Brings security to ReportServer.

Method Summary

Modifier and Type	Method	Description
void	assertActions(Object target, Class<? extends SecurityAction>... actions)
void	assertRights(Object target, Class<? extends Right>... rights)
void	assertRights(Collection<User> users, Object target, Class<? extends Right>... rights)
void	assertUserLoggedIn()
boolean	checkActions(Class<?> target, Class<? extends SecurityAction>... actions)
boolean	checkActions(SecurityTarget target, Class<? extends SecurityAction>... actions)	Tests whether the given SecurityActions are allowed to be performed by the given SecurityTarget or not.
boolean	checkActions(User user, Class<?> target, Class<? extends SecurityAction>... actions)
boolean	checkActions(User user, SecurityTarget target, Class<? extends SecurityAction>... actions)
boolean	checkRights(Class<?> target, Class<? extends Right>... rights)
boolean	checkRights(Class<?> target, Class<? extends Securee> securee, Class<? extends Right>... rights)	Tests whether the target has the specified rights.
boolean	checkRights(Object target, Class<? extends Right>... rights)
boolean	checkRights(SecurityTarget target, boolean requireInheritance, Class<? extends Securee> securee, Class<? extends Right>... rights)
boolean	checkRights(SecurityTarget target, Class<? extends Right>... rights)	Tests whether the SecurityTarget has the given Rights or not.
boolean	checkRights(SecurityTarget target, Class<? extends Securee> securee, Class<? extends Right>... rights)	Tests whether the target has the specified rights.
boolean	checkRights(User user, Class<?> target, Class<? extends Securee> securee, Class<? extends Right>... rights)
boolean	checkRights(User user, SecurityTarget target, boolean requireInheritance, Class<? extends Securee> securee, Class<? extends Right>... rights)
boolean	checkRights(User user, SecurityTarget target, Class<? extends Securee> securee, Class<? extends Right>... rights)	Tests whether the target has the specified rights.
Ace	createACE(Class<?> target)	Creates a new Ace and configures it with the given target
Ace	createACE(GenericSecurityTargetEntity entity)	Creates a new Ace and configures it with the given target
GenericSecurityTargetEntity	createGenericSecurityTargetEntity(Class<?> type)	Creates and returns a new instance of GenericSecurityTargetEntity with the generic target identifier of the given Class.
HierarchicalAce	createHierarchicalACE(Class<?> target)	Creates a new HierarchicalAce and configures it with the given target
Collection<Securee>	getAllRegisteredSecurees()	Returns a Collection of all registered Securees
List<String>	getDefaultSslProtocols()
List<String>	getEnabledSslProtocols()
Class<?>	getGenericTargetMarkerById(String id)	Returns the corresponding marker class.
String	getKnownHostsFile(boolean appendFileCheck)
Collection<Class<?>>	getRegisteredGenericSecurityTargets()	Returns a Collection of Classes of registered generic security targets
Collection<Securee>	getRegisteredSecureesForTarget(Class<?> target)	Returns a Collection of Securees matching the given target
Collection<Class<? extends SecurityTarget>>	getRegisteredSecurityTargets()	Returs a Collection of all registered SecurityTargets
String	getStrictHostKeyChecking(String key)
List<String>	getSupportedSslProtocols()
boolean	isEntitySecurityTarget(Class<?> type)	Tests if the given Class is a SecurityTarget
boolean	isGenericTarget(Class<?> type)	Tests if the given Class is a GenericSecurityTarget
boolean	isTypeSecured(Class<?> type)	Tests whether the Class has been registered.
GenericSecurityTargetEntity	loadGenericTarget(Class<?> type)	Loads a GenericSecurityTargetEntity by the generic target identifier of the given Class
GenericSecurityTargetEntity	loadGenericTargetByIdentifier(String id)	Loads a GenericSecurityTargetEntity by the given generic target identifier
Ace	merge(Ace ace)	Merges the given Ace with the representation in the database and returns the result.
Acl	merge(Acl acl)	Merges the given Acl with the representation in the database and returns the result.
GenericSecurityTargetEntity	merge(GenericSecurityTargetEntity targetEntity)	Merges the given GenericSecurityTargetEntity with the representation in the database and returns the result.
void	persist(Ace ace)	Persists the given Ace
void	persist(Acl acl)	Persists the given Acl.
void	registerSecuree(Securee securee)	Registers the given Securee with the system
void	registerSecurityTarget(Class<?>... types)	Registers a new type as a security target adding only the default rights.
void	registerSecurityTarget(Class<?> type, Securee securee)	Registers a security target identified by the given Class and Securee
void	registerSecurityTarget(SecurityTargetConfiguration... configs)	Allows a module to register one or more security targets.
void	remove(Ace ace)	Removes the given Ace from the database
void	remove(Acl acl)	Removes the given Acl from the database.

Method Details

registerSecuree

void registerSecuree(Securee securee)

Registers the given Securee with the system

Parameters:

securee - The Securee

getAllRegisteredSecurees

Collection<Securee> getAllRegisteredSecurees()

Returns a Collection of all registered Securees

Returns:

A Collection of Securees

registerSecurityTarget

void registerSecurityTarget(SecurityTargetConfiguration... configs)

Allows a module to register one or more security targets.

Parameters:

configs - One or more instances of SecurityTargetConfiguration

registerSecurityTarget

void registerSecurityTarget(Class<?> type,
 Securee securee)

Registers a security target identified by the given Class and Securee

Parameters:

type - The Class

securee - The Securee

registerSecurityTarget

void registerSecurityTarget(Class<?>... types)

Registers a new type as a security target adding only the default rights.

Parameters:

types - One or more Classes to be registered

getRegisteredSecureesForTarget

Collection<Securee> getRegisteredSecureesForTarget(Class<?> target)

Returns a Collection of Securees matching the given target

Parameters:

target - A Class defining the type of the target

Returns:

A Collection of Securees

getRegisteredGenericSecurityTargets

Collection<Class<?>> getRegisteredGenericSecurityTargets()

Returns a Collection of Classes of registered generic security targets

Returns:

A Collection of Classes

getRegisteredSecurityTargets

Collection<Class<? extends SecurityTarget>> getRegisteredSecurityTargets()

Returs a Collection of all registered SecurityTargets

Returns:

A Collection of SecurityTargets

checkRights

boolean checkRights(SecurityTarget target,
 Class<? extends Right>... rights)

Tests whether the SecurityTarget has the given Rights or not.

Parameters:

target - The SecurityTarget

rights - A list of Rights to test

Returns:

true if the tests passed; false otherwise

checkRights

boolean checkRights(Object target,
 Class<? extends Right>... rights)

checkRights

boolean checkRights(SecurityTarget target,
 Class<? extends Securee> securee,
 Class<? extends Right>... rights)

Tests whether the target has the specified rights.

Parameters:

target - The SecurityTarget

securee - The Securee

rights - A list of Rights to test

Returns:

true if the tests passed; false otherwise

checkActions

boolean checkActions(SecurityTarget target,
 Class<? extends SecurityAction>... actions)

Tests whether the given SecurityActions are allowed to be performed by the given SecurityTarget or not.

Parameters:

target - The SecurityTarget

actions - A list of SecurityActions

Returns:

true if the tests passed; false otherwise

checkRights

boolean checkRights(User user,
 SecurityTarget target,
 Class<? extends Securee> securee,
 Class<? extends Right>... rights)

Tests whether the target has the specified rights.

Parameters:

user - The User

target -

securee -

rights -

checkRights

boolean checkRights(User user,
 SecurityTarget target,
 boolean requireInheritance,
 Class<? extends Securee> securee,
 Class<? extends Right>... rights)

checkRights

boolean checkRights(SecurityTarget target,
 boolean requireInheritance,
 Class<? extends Securee> securee,
 Class<? extends Right>... rights)

checkActions

boolean checkActions(User user,
 SecurityTarget target,
 Class<? extends SecurityAction>... actions)

checkRights

boolean checkRights(Class<?> target,
 Class<? extends Securee> securee,
 Class<? extends Right>... rights)

Tests whether the target has the specified rights.

Parameters:

target -

rights -

checkRights

boolean checkRights(Class<?> target,
 Class<? extends Right>... rights)

checkActions

boolean checkActions(Class<?> target,
 Class<? extends SecurityAction>... actions)

checkRights

boolean checkRights(User user,
 Class<?> target,
 Class<? extends Securee> securee,
 Class<? extends Right>... rights)

checkActions

boolean checkActions(User user,
 Class<?> target,
 Class<? extends SecurityAction>... actions)

isTypeSecured

boolean isTypeSecured(Class<?> type)

Tests whether the Class has been registered.

Parameters:

type - The Class to test

Returns:

true if the Class has been registered; false otherwise

isGenericTarget

boolean isGenericTarget(Class<?> type)

Tests if the given Class is a GenericSecurityTarget

Parameters:

type - The Class to test

Returns:

true if the given Class is a GenericSecurityTarget; false otherwise

isEntitySecurityTarget

boolean isEntitySecurityTarget(Class<?> type)

Tests if the given Class is a SecurityTarget

Parameters:

type - The Class to test

Returns:

true if the given Class is a SecurityTarget; false otherwise

createGenericSecurityTargetEntity

GenericSecurityTargetEntity createGenericSecurityTargetEntity(Class<?> type)

Creates and returns a new instance of GenericSecurityTargetEntity with the generic target identifier of the given Class.

Parameters:

type - The Class to use the generic target identifier from

Returns:

A new instance of GenericSecurityTargetEntity

merge

GenericSecurityTargetEntity merge(GenericSecurityTargetEntity targetEntity)

Merges the given GenericSecurityTargetEntity with the representation in the database and returns the result.

Parameters:

targetEntity - The GenericSecurityTargetEntity with the new data

Returns:

The merged GenericSecurityTargetEntity

loadGenericTarget

GenericSecurityTargetEntity loadGenericTarget(Class<?> type)

Loads a GenericSecurityTargetEntity by the generic target identifier of the given Class

Parameters:

type - The Class to get the generic target identifier

Returns:

The loaded GenericSecurityTargetEntity

loadGenericTargetByIdentifier

GenericSecurityTargetEntity loadGenericTargetByIdentifier(String id)

Loads a GenericSecurityTargetEntity by the given generic target identifier

Parameters:

id - The generic target identifier

Returns:

The loaded GenericSecurityTargetEntity

getGenericTargetMarkerById

Class<?> getGenericTargetMarkerById(String id)

Returns the corresponding marker class.

Parameters:

id - The id to identify the marker class

Returns:

The marker class

See Also:

• GenericSecurityTargetMarker
• GenericSecurityTarget

persist

void persist(Acl acl)

Persists the given Acl.

Parameters:

acl - The Acl to persist

merge

Acl merge(Acl acl)

Merges the given Acl with the representation in the database and returns the result.

Parameters:

acl - The Acl with the new data

Returns:

The merged Acl

remove

void remove(Acl acl)

Removes the given Acl from the database.

Parameters:

acl - The Acl to remove

persist

void persist(Ace ace)

Persists the given Ace

Parameters:

ace - The Ace to persist

merge

Ace merge(Ace ace)

Merges the given Ace with the representation in the database and returns the result.

Parameters:

ace - The Ace with the new data

Returns:

The merged Ace

remove

void remove(Ace ace)

Removes the given Ace from the database

Parameters:

ace - The Ace to remove from the database

createACE

Ace createACE(Class<?> target)

Creates a new Ace and configures it with the given target

Parameters:

target - The target Class

Returns:

The newly created Ace

createACE

Ace createACE(GenericSecurityTargetEntity entity)

Creates a new Ace and configures it with the given target

Parameters:

entity - A GenericSecurityTargetEntity holding the target marker id

Returns:

The newly created Ace

createHierarchicalACE

HierarchicalAce createHierarchicalACE(Class<?> target)

Creates a new HierarchicalAce and configures it with the given target

Parameters:

target - The target Class

Returns:

The newly created HierarchicalAce

assertRights

void assertRights(Object target,
 Class<? extends Right>... rights)

assertActions

void assertActions(Object target,
 Class<? extends SecurityAction>... actions)

assertRights

void assertRights(Collection<User> users,
 Object target,
 Class<? extends Right>... rights)

assertUserLoggedIn

void assertUserLoggedIn()

getSupportedSslProtocols

List<String> getSupportedSslProtocols()

getDefaultSslProtocols

List<String> getDefaultSslProtocols()

getEnabledSslProtocols

List<String> getEnabledSslProtocols()

getKnownHostsFile

String getKnownHostsFile(boolean appendFileCheck)

getStrictHostKeyChecking

String getStrictHostKeyChecking(String key)