Package cz.metacentrum.perun.core.blImpl

Class ConsentsManagerBlImpl

java.lang.Object

cz.metacentrum.perun.core.blImpl.ConsentsManagerBlImpl

All Implemented Interfaces:

ConsentsManagerBl

public class ConsentsManagerBlImpl
extends Object
implements ConsentsManagerBl

Consents BL logic.

Author:

Radoslav Čerhák <r.cerhak@gmail.com>

Constructor Summary

Constructors

Constructor	Description
ConsentsManagerBlImpl(ConsentsManagerImplApi consentsManagerImpl)

Method Summary

Modifier and Type	Method	Description
void	addFacility(PerunSession sess, ConsentHub consentHub, Facility facility)	Adds facility to consent hub.
Consent	changeConsentStatus(PerunSession sess, Consent consent, ConsentStatus status)	Set consent status
void	checkConsentExists(PerunSession sess, Consent consent)	Check if consent exists in underlying data source.
void	checkConsentHubExists(PerunSession sess, ConsentHub consentHub)	Throws exception if consent hub does not exist.
boolean	consentHubExists(PerunSession sess, ConsentHub consentHub)	Returns true, if consent hub exists, false otherwise.
Consent	createConsent(PerunSession sess, Consent consent)	Creates a new consent with status 'UNSIGNED'.
ConsentHub	createConsentHub(PerunSession sess, ConsentHub consentHub)	Creates new consent hub.
void	deleteConsent(PerunSession sess, Consent consent)	Deletes consent
void	deleteConsentHub(PerunSession sess, ConsentHub consentHub)	Deletes consent hub.
void	evaluateConsents(PerunSession sess, ConsentHub consentHub)	Evaluates consents for given consent hub with enforced consents enabled.
void	evaluateConsents(PerunSession sess, Service service)	Consolidate consents using given service on consent hubs the service is assigned to.
List<Member>	evaluateConsents(PerunSession sess, Service service, Facility facility, List<Member> members)	This method runs in a new transaction!! Because it is used by getData methods which run in read-only serializable transactions.
List<Member>	evaluateConsents(PerunSession sess, Service service, Facility facility, List<Member> members, boolean consentEval)	This method runs in a new transaction!! Because it is used by getData methods which run in read-only serializable transactions.
List<ConsentHub>	getAllConsentHubs(PerunSession sess)	Get list of all Consent Hubs
List<Consent>	getAllConsents(PerunSession sess)	Gel all consents
Consent	getConsentById(PerunSession sess, int id)	Get consent object with specified id
Consent	getConsentForUserAndConsentHub(PerunSession sess, int userId, int consentHubId, ConsentStatus status)	Get consent for chosen user in specified consent hub with specified status
ConsentHub	getConsentHubByFacility(PerunSession sess, int facilityId)	Finds existing Consent Hub by facility id.
ConsentHub	getConsentHubById(PerunSession sess, int id)	Finds existing Consent Hub by id.
ConsentHub	getConsentHubByName(PerunSession sess, String name)	Finds existing Consent Hub by name.
List<ConsentHub>	getConsentHubsByService(PerunSession sess, int serviceId)	Finds all existing Consent Hubs by service id (consent hubs that have given service assigned through facilities).
List<Consent>	getConsentsForConsentHub(PerunSession sess, int id)	Get all consents for chosen ConsentHub
List<Consent>	getConsentsForConsentHub(PerunSession sess, int id, ConsentStatus status)	Get all consents for chosen ConsentHub with the specified status
List<Consent>	getConsentsForUser(PerunSession sess, int id)	Get all consents for chosen User
List<Consent>	getConsentsForUser(PerunSession sess, int id, ConsentStatus status)	Get all consents for chosen User with the specified status
List<Consent>	getConsentsForUserAndConsentHub(PerunSession sess, int userId, int consentHubId)	Get all consents for chosen user in specified consent hub
ConsentsManagerImplApi	getConsentsManagerImpl()
PerunBl	getPerunBl()
void	removeFacility(PerunSession sess, ConsentHub consentHub, Facility facility)	Removes facility from consent hub.
void	setPerunBl(PerunBl perunBl)
ConsentHub	updateConsentHub(PerunSession perunSession, ConsentHub consentHub)	Updates the ConsentHub.

Methods inherited from class java.lang.Object

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

Constructor Details

ConsentsManagerBlImpl

public ConsentsManagerBlImpl(ConsentsManagerImplApi consentsManagerImpl)

Method Details

addFacility

public void addFacility(PerunSession sess,
 ConsentHub consentHub,
 Facility facility)
                 throws FacilityAlreadyAssigned

Description copied from interface: ConsentsManagerBl

Adds facility to consent hub.

Specified by:

addFacility in interface ConsentsManagerBl

Parameters:

sess - session

consentHub - consent hub

facility - facility to be added

Throws:

FacilityAlreadyAssigned - if facility is already assigned to consent hub

changeConsentStatus

public Consent changeConsentStatus(PerunSession sess,
 Consent consent,
 ConsentStatus status)
                            throws InvalidConsentStatusException

Description copied from interface: ConsentsManagerBl

Set consent status

Specified by:

changeConsentStatus in interface ConsentsManagerBl

Parameters:

sess - perun session

consent - consent

Returns:

consent

Throws:

InvalidConsentStatusException - if passed status value can not be set

checkConsentExists

public void checkConsentExists(PerunSession sess,
 Consent consent)
                        throws ConsentNotExistsException

Description copied from interface: ConsentsManagerBl

Check if consent exists in underlying data source.

Specified by:

checkConsentExists in interface ConsentsManagerBl

Parameters:

sess - PerunSession

consent - Consent to check

Throws:

ConsentNotExistsException - if consent doesn't exist

checkConsentHubExists

public void checkConsentHubExists(PerunSession sess,
 ConsentHub consentHub)
                           throws ConsentHubNotExistsException

Description copied from interface: ConsentsManagerBl

Throws exception if consent hub does not exist.

Specified by:

checkConsentHubExists in interface ConsentsManagerBl

Parameters:

sess - session

consentHub - consent hub

Throws:

ConsentHubNotExistsException - if consent hub does not exist

consentHubExists

public boolean consentHubExists(PerunSession sess,
 ConsentHub consentHub)

Description copied from interface: ConsentsManagerBl

Returns true, if consent hub exists, false otherwise.

Specified by:

consentHubExists in interface ConsentsManagerBl

Parameters:

sess - session

consentHub - consent hub

Returns:

whether consent hub exists

createConsent

public Consent createConsent(PerunSession sess,
 Consent consent)
                      throws ConsentExistsException,
ConsentHubNotExistsException,
UserNotExistsException

Description copied from interface: ConsentsManagerBl

Creates a new consent with status 'UNSIGNED'. Consent's attributes are computed based on the attributes of the user and the consent hub. Attributes in the consent are ignored!

If the user has already 'UNSIGNED' consent for the same consent hub, that consent is deleted and replaced with the new one.

Specified by:

createConsent in interface ConsentsManagerBl

Parameters:

sess - perun session

consent - Consent to create

Returns:

created consent

Throws:

ConsentExistsException - if consent already exists

ConsentHubNotExistsException - if consent hub doesn't exist

UserNotExistsException - if a user with consent's userId doesn't exist

createConsentHub

public ConsentHub createConsentHub(PerunSession sess,
 ConsentHub consentHub)
                            throws ConsentHubExistsException

Description copied from interface: ConsentsManagerBl

Creates new consent hub.

Specified by:

createConsentHub in interface ConsentsManagerBl

Parameters:

sess - session

consentHub - consent hub

Returns:

new consent hub

Throws:

ConsentHubExistsException - if consent hub with similar name exists

deleteConsent

public void deleteConsent(PerunSession sess,
 Consent consent)
                   throws ConsentNotExistsException

Description copied from interface: ConsentsManagerBl

Deletes consent

Specified by:

deleteConsent in interface ConsentsManagerBl

Parameters:

sess - perun session

consent - consent to delete

Throws:

ConsentNotExistsException - if consent doesn't exist

deleteConsentHub

public void deleteConsentHub(PerunSession sess,
 ConsentHub consentHub)
                      throws ConsentHubAlreadyRemovedException

Description copied from interface: ConsentsManagerBl

Deletes consent hub.

Specified by:

deleteConsentHub in interface ConsentsManagerBl

Parameters:

sess - session

consentHub - consent hub

Throws:

ConsentHubAlreadyRemovedException - if no such consent hub stored in db

evaluateConsents

public List<Member> evaluateConsents(PerunSession sess,
 Service service,
 Facility facility,
 List<Member> members)

Description copied from interface: ConsentsManagerBl

This method runs in a new transaction!! Because it is used by getData methods which run in read-only serializable transactions.

Returns members from the given members list that have a valid consent for the propagation of the service required attributes to the facility.

Users must have a consent for the facility's consent hub with status GRANTED and it contains all the required attributes.

If the user has no consent in any status that contains all the required attributes, a new UNSIGNED consent is created for the user.

If the consent logic is turned off on the instance (property forceConsents) or the facility's consent hub doesn't enforce consents, all members are returned and no unsigned consents for users are created.

Specified by:

evaluateConsents in interface ConsentsManagerBl

Parameters:

sess - perun session

service - the service

facility - the facility

members - the given members

evaluateConsents

public List<Member> evaluateConsents(PerunSession sess,
 Service service,
 Facility facility,
 List<Member> members,
 boolean consentEval)

Description copied from interface: ConsentsManagerBl

This method runs in a new transaction!! Because it is used by getData methods which run in read-only serializable transactions.

Returns members from the given members list that have a valid consent for the propagation of the service required attributes to the facility.

Users must have a consent for the facility's consent hub with status GRANTED and it contains all the required attributes.

If the user has no consent in any status that contains all the required attributes, a new UNSIGNED consent is created for the user.

If the consent logic is turned off on the instance (property forceConsents) or the facility's consent hub doesn't enforce consents, all members are returned and no unsigned consents for users are created.

If the consent evaluation is turned off (in CLI without the -c option), the members with UNSIGNED consent creation is skipped.

Specified by:

evaluateConsents in interface ConsentsManagerBl

Parameters:

sess - perun session

service - the service

facility - the facility

members - the given members

consentEval - if the consent evaluation should be performed

evaluateConsents

public void evaluateConsents(PerunSession sess,
 ConsentHub consentHub)

Description copied from interface: ConsentsManagerBl

Evaluates consents for given consent hub with enforced consents enabled.

For given ConsentHub, collects all attributes from services assigned to it and compares it against attributes from users' Consent objects that are assigned to resources of given ConsentHub object.

Service defines whether only active users will be evaluated or expired ones as well.

Specified by:

evaluateConsents in interface ConsentsManagerBl

Parameters:

sess - session

consentHub - consent hub

evaluateConsents

public void evaluateConsents(PerunSession sess,
 Service service)

Description copied from interface: ConsentsManagerBl

Consolidate consents using given service on consent hubs the service is assigned to.

Method finds all consent hubs that contain given service in any of its facilities and start consent consolidation for each consent hub (only selected service in consent hubs will be checked). Service defines whether only active users will be evaluated or expired ones as well. If new consent is created, attributes from ALL services under given consent hub are gathered for it.

Specified by:

evaluateConsents in interface ConsentsManagerBl

Parameters:

sess - session

service - service

getAllConsentHubs

public List<ConsentHub> getAllConsentHubs(PerunSession sess)

Description copied from interface: ConsentsManagerBl

Get list of all Consent Hubs

Specified by:

getAllConsentHubs in interface ConsentsManagerBl

Parameters:

sess - perun session

Returns:

list of Consent Hubs

getAllConsents

public List<Consent> getAllConsents(PerunSession sess)

Description copied from interface: ConsentsManagerBl

Gel all consents

Specified by:

getAllConsents in interface ConsentsManagerBl

Parameters:

sess - perun session

Returns:

all existing consents in the database

getConsentById

public Consent getConsentById(PerunSession sess,
 int id)
                       throws ConsentNotExistsException

Description copied from interface: ConsentsManagerBl

Get consent object with specified id

Specified by:

getConsentById in interface ConsentsManagerBl

Parameters:

sess - perun session

id - id of desired consent object

Returns:

consent object with specified id

Throws:

ConsentNotExistsException - thrown if consent with the id doesn't exist

getConsentForUserAndConsentHub

public Consent getConsentForUserAndConsentHub(PerunSession sess,
 int userId,
 int consentHubId,
 ConsentStatus status)
                                       throws ConsentNotExistsException

Description copied from interface: ConsentsManagerBl

Get consent for chosen user in specified consent hub with specified status

Specified by:

getConsentForUserAndConsentHub in interface ConsentsManagerBl

Parameters:

sess - perun session

userId - if of the user

consentHubId - id of the consent hub

status - specified status

Returns:

consent

Throws:

ConsentNotExistsException - thrown if consent with the id doesn't exist

getConsentHubByFacility

public ConsentHub getConsentHubByFacility(PerunSession sess,
 int facilityId)
                                   throws ConsentHubNotExistsException

Description copied from interface: ConsentsManagerBl

Finds existing Consent Hub by facility id.

Specified by:

getConsentHubByFacility in interface ConsentsManagerBl

Parameters:

sess - perun session

facilityId - facility for which consent hub is searched

Returns:

found Consent Hub

Throws:

ConsentHubNotExistsException - if Consent Hub doesn't exist

getConsentHubById

public ConsentHub getConsentHubById(PerunSession sess,
 int id)
                             throws ConsentHubNotExistsException

Description copied from interface: ConsentsManagerBl

Finds existing Consent Hub by id.

Specified by:

getConsentHubById in interface ConsentsManagerBl

Parameters:

sess - perun session

id - id of the Consent Hub you are looking for

Returns:

found Consent Hub

Throws:

ConsentHubNotExistsException - if Consent Hub doesn't exist

getConsentHubByName

public ConsentHub getConsentHubByName(PerunSession sess,
 String name)
                               throws ConsentHubNotExistsException

Description copied from interface: ConsentsManagerBl

Finds existing Consent Hub by name.

Specified by:

getConsentHubByName in interface ConsentsManagerBl

Parameters:

sess - perun session

name - name of the Consent Hub you are looking for

Returns:

found Consent Hub

Throws:

ConsentHubNotExistsException - if Consent Hub doesn't exist

getConsentHubsByService

public List<ConsentHub> getConsentHubsByService(PerunSession sess,
 int serviceId)
                                         throws ConsentHubNotExistsException

Description copied from interface: ConsentsManagerBl

Finds all existing Consent Hubs by service id (consent hubs that have given service assigned through facilities).

Specified by:

getConsentHubsByService in interface ConsentsManagerBl

Parameters:

sess - perun session

serviceId - service for which consent hubs is searched

Returns:

found Consent Hubs

Throws:

ConsentHubNotExistsException - if Consent Hub doesn't exist

getConsentsForConsentHub

public List<Consent> getConsentsForConsentHub(PerunSession sess,
 int id,
 ConsentStatus status)

Description copied from interface: ConsentsManagerBl

Get all consents for chosen ConsentHub with the specified status

Specified by:

getConsentsForConsentHub in interface ConsentsManagerBl

Parameters:

sess - perun session

id - id of the ConsentHub

status - status of the consent

Returns:

consents for chosen ConsentHub with the specified status

getConsentsForConsentHub

public List<Consent> getConsentsForConsentHub(PerunSession sess,
 int id)

Description copied from interface: ConsentsManagerBl

Get all consents for chosen ConsentHub

Specified by:

getConsentsForConsentHub in interface ConsentsManagerBl

Parameters:

sess - perun session

id - id of the ConsentHub

Returns:

consents for chosen ConsentHub

getConsentsForUser

public List<Consent> getConsentsForUser(PerunSession sess,
 int id,
 ConsentStatus status)

Description copied from interface: ConsentsManagerBl

Get all consents for chosen User with the specified status

Specified by:

getConsentsForUser in interface ConsentsManagerBl

Parameters:

sess - perun session

id - id of the User

status - status of the consent

Returns:

consents for chosen User with the specified status

getConsentsForUser

public List<Consent> getConsentsForUser(PerunSession sess,
 int id)

Description copied from interface: ConsentsManagerBl

Get all consents for chosen User

Specified by:

getConsentsForUser in interface ConsentsManagerBl

Parameters:

sess - perun session

id - id of the user

Returns:

consents for chosen User

getConsentsForUserAndConsentHub

public List<Consent> getConsentsForUserAndConsentHub(PerunSession sess,
 int userId,
 int consentHubId)

Description copied from interface: ConsentsManagerBl

Get all consents for chosen user in specified consent hub

Specified by:

getConsentsForUserAndConsentHub in interface ConsentsManagerBl

Parameters:

sess - perun session

userId - id of the user

consentHubId - id of the consent hub

Returns:

consents

getConsentsManagerImpl

public ConsentsManagerImplApi getConsentsManagerImpl()

getPerunBl

public PerunBl getPerunBl()

removeFacility

public void removeFacility(PerunSession sess,
 ConsentHub consentHub,
 Facility facility)
                    throws RelationNotExistsException,
ConsentHubAlreadyRemovedException

Description copied from interface: ConsentsManagerBl

Removes facility from consent hub. If it was the last facility on consent hub, deletes consent hub too.

Specified by:

removeFacility in interface ConsentsManagerBl

Parameters:

sess - session

consentHub - consent hub

facility - facility to be removed

Throws:

RelationNotExistsException - if facility is not assigned to consent hub

ConsentHubAlreadyRemovedException - if the last facility was removed and deletion of consent hub failed

setPerunBl

public void setPerunBl(PerunBl perunBl)

updateConsentHub

public ConsentHub updateConsentHub(PerunSession perunSession,
 ConsentHub consentHub)
                            throws ConsentHubExistsException

Description copied from interface: ConsentsManagerBl

Updates the ConsentHub. Ignores related facilities.

Specified by:

updateConsentHub in interface ConsentsManagerBl

Parameters:

perunSession - session

consentHub - consentHub

Returns:

updated consent hub

Throws:

ConsentHubExistsException - if consent hub with the same name exists