Interface FacilitiesManagerImplApi

All Known Implementing Classes:

FacilitiesManagerImpl

public interface FacilitiesManagerImplApi

Facility manager can create a new facility or find an existing facility.

You must get an instance of FacilityManager from PerunSession:

   PerunSession perunSession = ...;
   FacilityManager gm = perunSession.getPerun().getFacilityManager();

Author:

Michal Prochazka, Slavek Licehammer

Method Summary

Modifier and Type	Method	Description
Host	addHost(PerunSession perunSession, Host host, Facility facility)	Adds host to the Facility.
void	addOwner(PerunSession perunSession, Facility facility, Owner owner)	Deprecated.
boolean	banExists(PerunSession sess, int banId)	Get true if any band defined by id exists for any user and facility.
boolean	banExists(PerunSession sess, int userId, int facilityId)	Get true if any ban for user and facility exists.
void	checkFacilityExists(PerunSession perunSession, Facility facility)	Check if facility exists in underlaying data source.
void	checkHostExists(PerunSession sess, Host host)
Facility	createFacility(PerunSession perunSession, Facility facility)	Inserts facility into DB.
void	deleteFacility(PerunSession perunSession, Facility facility)	Deletes facility by id.
void	deleteFacilityOwners(PerunSession perunSession, Facility facility)	Deletes all facility owners.
boolean	facilityExists(PerunSession perunSession, Facility facility)	Check if facility exists in underlaying data source.
List<Group>	getAdminGroups(PerunSession sess, Facility facility)	Gets list of all group administrators of the Facility.
List<User>	getAdmins(PerunSession sess, Facility facility)	Gets list of all user administrators of the Facility.
List<BanOnFacility>	getAllExpiredBansOnFacilities(PerunSession sess)	Get all expired bans on any facility to now date
List<Facility>	getAllowedFacilities(PerunSession sess, Member member)	Return all allowed facilities of the member.
List<Facility>	getAllowedFacilities(PerunSession sess, User user)	Return all allowed facilities of the user.
List<Member>	getAllowedMembers(PerunSession sess, Facility facility)	Return all members, which are "allowed" on facility through any resource disregarding their possible expired status in a group.
List<Member>	getAllowedMembers(PerunSession sess, Facility facility, Service service)	Return all members, which are "allowed" on facility through any resource assigned to the given service.
List<User>	getAllowedUsers(PerunSession sess, Facility facility)	Return all users, which are "allowed" on facility through any member/resource.
List<Vo>	getAllowedVos(PerunSession perunSession, Facility facility)	Return all VO which can use this facility.
List<Resource>	getAssignedResources(PerunSession perunSession, Facility facility)	Returns all resources assigned to the facility.
List<Resource>	getAssignedResources(PerunSession perunSession, Facility facility, Vo specificVo, Service specificService)	Returns all resources assigned to the facility with optionally VO and Service specified.
List<RichResource>	getAssignedRichResources(PerunSession perunSession, Facility facility)	Returns all rich resources assigned to the facility.
List<RichResource>	getAssignedRichResources(PerunSession perunSession, Facility facility, Service service)	Returns all rich resources assigned to the facility and service.
List<User>	getAssignedUsers(PerunSession sess, Facility facility)	Return all users assigned to Facility.
List<User>	getAssignedUsers(PerunSession sess, Facility facility, Service service)	Returns list of Users assigned with chosen Facility containing resources where service is assigned.
List<Member>	getAssociatedMembers(PerunSession sess, Facility facility, User user)	Return all members, which are associated with the facility and belong to given user.
List<User>	getAssociatedUsers(PerunSession sess, Facility facility)	Return all users, which are associated with facility through any member/resource.
BanOnFacility	getBan(PerunSession sess, int userId, int faclityId)	Get specific facility ban.
BanOnFacility	getBanById(PerunSession sess, int banId)	Get Ban for user on facility by it's id
List<BanOnFacility>	getBansForFacility(PerunSession sess, int facilityId)	Get all users bans for facility
List<BanOnFacility>	getBansForUser(PerunSession sess, int userId)	Get all facilities bans for user.
List<User>	getDirectAdmins(PerunSession perunSession, Facility facility)	Gets list of direct user administrators of the Facility.
List<Facility>	getFacilities(PerunSession perunSession)	List all facilities.
List<Facility>	getFacilitiesByAttribute(PerunSession sess, Attribute attribute)	Returns all facilities which have set the attribute with the value.
List<Facility>	getFacilitiesByAttributePartialMatch(PerunSession sess, AttributeDefinition attrDef, String value)	Partial search for facilities with the attribute 'attrDef' set to a similar value to 'value'
List<Facility>	getFacilitiesByDestination(PerunSession perunSession, String destination)	Searches for the Facilities by theirs destination.
List<Facility>	getFacilitiesByHostName(PerunSession sess, String hostname)	Return all facilities where exists host with the specific hostname
List<Facility>	getFacilitiesByIds(PerunSession perunSession, List<Integer> ids)	Gets facilities by their ids.
int	getFacilitiesCount(PerunSession perunSession)	Get count of all facilities.
List<Facility>	getFacilitiesWhereUserIsAdmin(PerunSession sess, User user)	Get all facilities where the user is admin.
Facility	getFacilityById(PerunSession perunSession, int id)	Searches for the Facility with specified id.
Facility	getFacilityByName(PerunSession perunSession, String name)	Searches for the Facility by its name.
Facility	getFacilityForHost(PerunSession sess, Host host)	Return facility which has the host.
Host	getHostById(PerunSession sess, int id)	Get the host by its ID.
List<Host>	getHosts(PerunSession perunSession, Facility facility)	List hosts from facility.
List<Host>	getHostsByHostname(PerunSession sess, String hostname)	Get all hosts with this hostname (from all facilities).
int	getHostsCount(PerunSession perunSession, Facility facility)	Count hosts in the facility.
List<Facility>	getOwnerFacilities(PerunSession perunSession, Owner owner)	Returns list of all facilities owned by the owner.
List<Owner>	getOwners(PerunSession perunSession, Facility facility)	Deprecated.
boolean	hostExists(PerunSession sess, Host host)
void	removeAllServiceDenials(int facilityId)	Remove all service denials on given facility.
void	removeBan(PerunSession sess, int banId)	Remove ban by id from facilities bans.
void	removeBan(PerunSession sess, int userId, int facilityId)	Remove ban by user_id and facility_id.
void	removeHost(PerunSession perunSession, Host host)	Remove hosts from the Facility.
void	removeOwner(PerunSession perunSession, Facility facility, Owner owner)	Deprecated.
List<Facility>	searchForFacilities(PerunSession sess, String searchString, boolean includeIDs)	Similarity substring search in all facilities based on name, description and optionally in IDs
List<Facility>	searchForFacilities(PerunSession sess, String searchString, Set<Integer> facilityIds, boolean includeIDs)	Similarity substring search in provided facilities based on name, description and optionally ID
BanOnFacility	setBan(PerunSession sess, BanOnFacility banOnFacility)	Set ban for user on facility
void	setOwners(PerunSession perunSession, Facility facility, List<Owner> owners)	Deprecated.
BanOnFacility	updateBan(PerunSession sess, BanOnFacility banOnFacility)	Update description and validity timestamp of specific ban.
Facility	updateFacility(PerunSession perunSession, Facility facility)	Updates facility in DB.

Method Details

addHost

Host addHost(PerunSession perunSession,
 Host host,
 Facility facility)

Adds host to the Facility.

Parameters:

perunSession -

host -

facility - return host

addOwner

@Deprecated
void addOwner(PerunSession perunSession,
 Facility facility,
 Owner owner)
       throws OwnerAlreadyAssignedException

Deprecated.

Add owner of the facility

Parameters:

perunSession -

facility -

owner -

Throws:

InternalErrorException

OwnerAlreadyAssignedException

banExists

boolean banExists(PerunSession sess,
 int userId,
 int facilityId)

Get true if any ban for user and facility exists.

Parameters:

sess -

userId - id of user

facilityId - id of facility

Returns:

true if ban exists

Throws:

InternalErrorException

banExists

boolean banExists(PerunSession sess,
 int banId)

Get true if any band defined by id exists for any user and facility.

Parameters:

sess -

banId - id of ban

Returns:

true if ban exists

Throws:

InternalErrorException

checkFacilityExists

void checkFacilityExists(PerunSession perunSession,
 Facility facility)
                  throws FacilityNotExistsException

Check if facility exists in underlaying data source.

Parameters:

perunSession -

facility -

Throws:

InternalErrorException

FacilityNotExistsException

checkHostExists

void checkHostExists(PerunSession sess,
 Host host)
              throws HostNotExistsException

Throws:

HostNotExistsException

createFacility

Facility createFacility(PerunSession perunSession,
 Facility facility)

Inserts facility into DB.

Parameters:

perunSession -

facility -

Throws:

InternalErrorException

deleteFacility

void deleteFacility(PerunSession perunSession,
 Facility facility)
             throws FacilityAlreadyRemovedException

Deletes facility by id.

Parameters:

perunSession -

facility -

Throws:

InternalErrorException

FacilityAlreadyRemovedException - if there are 0 rows affected by delete from DB

deleteFacilityOwners

void deleteFacilityOwners(PerunSession perunSession,
 Facility facility)

Deletes all facility owners.

Parameters:

perunSession -

facility -

Throws:

InternalErrorException

facilityExists

boolean facilityExists(PerunSession perunSession,
 Facility facility)

Check if facility exists in underlaying data source.

Parameters:

perunSession -

facility -

Returns:

true if facility exists in underlaying data source, false otherwise

Throws:

InternalErrorException

getAdminGroups

List<Group> getAdminGroups(PerunSession sess,
 Facility facility)

Gets list of all group administrators of the Facility.

Parameters:

sess -

facility -

Returns:

list of groups who are admins in the facility

Throws:

InternalErrorException

getAdmins

List<User> getAdmins(PerunSession sess,
 Facility facility)

Gets list of all user administrators of the Facility. If some group is administrator of the given group, all VALID members are included in the list.

Parameters:

sess -

facility -

Returns:

list of users who are admins in the facility

Throws:

InternalErrorException

getAllExpiredBansOnFacilities

List<BanOnFacility> getAllExpiredBansOnFacilities(PerunSession sess)

Get all expired bans on any facility to now date

Parameters:

sess -

Returns:

list of expired bans for any facility

Throws:

InternalErrorException

getAllowedFacilities

List<Facility> getAllowedFacilities(PerunSession sess,
 User user)

Return all allowed facilities of the user. It means all facilities, where is assigned through some resource and member is allowed on such resource.

Parameters:

sess -

user -

Returns:

List of allowed facilities of the user.

getAllowedFacilities

List<Facility> getAllowedFacilities(PerunSession sess,
 Member member)

Return all allowed facilities of the member. It means all facilities, where is assigned through some resource and member is allowed.

Parameters:

sess -

member -

Returns:

List of allowed facilities of the member.

getAllowedMembers

List<Member> getAllowedMembers(PerunSession sess,
 Facility facility)

Return all members, which are "allowed" on facility through any resource disregarding their possible expired status in a group. All members include all group statuses, through which they can be filtered if necessary.

Parameters:

sess -

facility -

Returns:

list of allowed members

Throws:

InternalErrorException

getAllowedMembers

List<Member> getAllowedMembers(PerunSession sess,
 Facility facility,
 Service service)

Return all members, which are "allowed" on facility through any resource assigned to the given service. Service settings decide whether expired group and expired VO members are returned as well. Disabled and invalid VO members are always ignored.

Parameters:

sess -

facility -

service -

Returns:

list of allowed members

getAllowedUsers

List<User> getAllowedUsers(PerunSession sess,
 Facility facility)

Return all users, which are "allowed" on facility through any member/resource.

Parameters:

sess -

facility -

Returns:

list of allowed users

getAllowedVos

List<Vo> getAllowedVos(PerunSession perunSession,
 Facility facility)

Return all VO which can use this facility. (VO must have the resource which belongs to this facility).

Parameters:

perunSession -

facility -

Returns:

list of Vos

Throws:

InternalErrorException

getAssignedResources

List<Resource> getAssignedResources(PerunSession perunSession,
 Facility facility)

Returns all resources assigned to the facility.

Parameters:

perunSession -

facility -

Returns:

list of resources assigned to the facility

Throws:

InternalErrorException

getAssignedResources

List<Resource> getAssignedResources(PerunSession perunSession,
 Facility facility,
 Vo specificVo,
 Service specificService)

Returns all resources assigned to the facility with optionally VO and Service specified.

Parameters:

perunSession -

facility -

specificVo -

specificService -

Returns:

list of resources assigned to the facility with optionally filter for VO and Service.

Throws:

InternalErrorException

getAssignedRichResources

List<RichResource> getAssignedRichResources(PerunSession perunSession,
 Facility facility)

Returns all rich resources assigned to the facility.

Parameters:

perunSession -

facility -

Returns:

list of rich resources assigned to the facility

Throws:

InternalErrorException

getAssignedRichResources

List<RichResource> getAssignedRichResources(PerunSession perunSession,
 Facility facility,
 Service service)

Returns all rich resources assigned to the facility and service.

Parameters:

perunSession -

facility -

service -

Returns:

list of rich resources assigned to the facility and service

Throws:

InternalErrorException

getAssignedUsers

List<User> getAssignedUsers(PerunSession sess,
 Facility facility)

Return all users assigned to Facility.

Parameters:

sess -

facility -

Returns:

list of user

Throws:

InternalErrorException

getAssignedUsers

List<User> getAssignedUsers(PerunSession sess,
 Facility facility,
 Service service)

Returns list of Users assigned with chosen Facility containing resources where service is assigned.

Parameters:

sess -

facility -

service -

Returns:

list of Users

Throws:

InternalErrorException

getAssociatedMembers

List<Member> getAssociatedMembers(PerunSession sess,
 Facility facility,
 User user)

Return all members, which are associated with the facility and belong to given user. Does not require ACTIVE group-resource status or any specific member status.

Parameters:

sess -

facility -

user -

Returns:

list of associated members

Throws:

InternalErrorException

getAssociatedUsers

List<User> getAssociatedUsers(PerunSession sess,
 Facility facility)

Return all users, which are associated with facility through any member/resource. Does not require ACTIVE group-resource status.

Parameters:

sess -

facility -

Returns:

list of allowed users

getBan

BanOnFacility getBan(PerunSession sess,
 int userId,
 int faclityId)
              throws BanNotExistsException

Get specific facility ban.

Parameters:

sess -

userId - the user id

faclityId - the facility id

Returns:

specific facility ban

Throws:

InternalErrorException

BanNotExistsException

getBanById

BanOnFacility getBanById(PerunSession sess,
 int banId)
                  throws BanNotExistsException

Get Ban for user on facility by it's id

Parameters:

sess -

banId - the ban id

Returns:

facility ban by it's id

Throws:

InternalErrorException

BanNotExistsException

getBansForFacility

List<BanOnFacility> getBansForFacility(PerunSession sess,
 int facilityId)

Get all users bans for facility

Parameters:

sess -

facilityId - the facility id

Returns:

list of all users bans on facility

Throws:

InternalErrorException

getBansForUser

List<BanOnFacility> getBansForUser(PerunSession sess,
 int userId)

Get all facilities bans for user.

Parameters:

sess -

userId - the user id

Returns:

list of bans for user on any facility

Throws:

InternalErrorException

getDirectAdmins

List<User> getDirectAdmins(PerunSession perunSession,
 Facility facility)

Gets list of direct user administrators of the Facility. 'Direct' means, there aren't included users, who are members of group administrators, in the returned list.

Parameters:

perunSession -

facility -

Throws:

InternalErrorException

getFacilities

List<Facility> getFacilities(PerunSession perunSession)

List all facilities.

Parameters:

perunSession -

Returns:

List of all Facilities within the Perun

Throws:

InternalErrorException

getFacilitiesByAttribute

List<Facility> getFacilitiesByAttribute(PerunSession sess,
 Attribute attribute)

Returns all facilities which have set the attribute with the value. Searching only def and opt attributes.

Parameters:

sess -

attribute -

Returns:

Throws:

InternalErrorException

getFacilitiesByAttributePartialMatch

List<Facility> getFacilitiesByAttributePartialMatch(PerunSession sess,
 AttributeDefinition attrDef,
 String value)

Partial search for facilities with the attribute 'attrDef' set to a similar value to 'value'

Parameters:

sess -

attrDef -

Returns:

Throws:

InternalErrorException

getFacilitiesByDestination

List<Facility> getFacilitiesByDestination(PerunSession perunSession,
 String destination)
                                   throws FacilityNotExistsException

Searches for the Facilities by theirs destination.

Parameters:

perunSession -

destination -

Returns:

Facility with specified name

Throws:

FacilityNotExistsException

InternalErrorException

getFacilitiesByHostName

List<Facility> getFacilitiesByHostName(PerunSession sess,
 String hostname)

Return all facilities where exists host with the specific hostname

Parameters:

sess -

hostname - specific hostname

Returns:

Throws:

InternalErrorException

getFacilitiesByIds

List<Facility> getFacilitiesByIds(PerunSession perunSession,
 List<Integer> ids)

Gets facilities by their ids. Silently skips non-existing facilities.

Parameters:

perunSession -

ids -

Returns:

list of facilities with specified ids

Throws:

InternalErrorException

getFacilitiesCount

int getFacilitiesCount(PerunSession perunSession)

Get count of all facilities.

Parameters:

perunSession -

Returns:

count of all facilities

Throws:

InternalErrorException

getFacilitiesWhereUserIsAdmin

List<Facility> getFacilitiesWhereUserIsAdmin(PerunSession sess,
 User user)

Get all facilities where the user is admin. Including facilities, where the user is a VALID member of authorized group.

Parameters:

sess -

user -

Returns:

list of facilities

Throws:

InternalErrorException

getFacilityById

Facility getFacilityById(PerunSession perunSession,
 int id)
                  throws FacilityNotExistsException

Searches for the Facility with specified id.

Parameters:

perunSession -

id -

Returns:

Facility with specified id

Throws:

FacilityNotExistsException

InternalErrorException

getFacilityByName

Facility getFacilityByName(PerunSession perunSession,
 String name)
                    throws FacilityNotExistsException

Searches for the Facility by its name.

Parameters:

perunSession -

name -

Returns:

Facility with specified name

Throws:

FacilityNotExistsException

InternalErrorException

getFacilityForHost

Facility getFacilityForHost(PerunSession sess,
 Host host)

Return facility which has the host.

Parameters:

sess -

host -

Returns:

facility

Throws:

InternalErrorException

getHostById

Host getHostById(PerunSession sess,
 int id)
          throws HostNotExistsException

Get the host by its ID.

Parameters:

sess -

id -

Returns:

host

Throws:

HostNotExistsException

InternalErrorException

getHosts

List<Host> getHosts(PerunSession perunSession,
 Facility facility)

List hosts from facility.

Parameters:

perunSession -

facility -

Returns:

hosts Hosts' id from the Cluster

Throws:

InternalErrorException

getHostsByHostname

List<Host> getHostsByHostname(PerunSession sess,
 String hostname)

Get all hosts with this hostname (from all facilities).

Parameters:

sess -

hostname -

Returns:

list of hosts by hostname

Throws:

InternalErrorException

getHostsCount

int getHostsCount(PerunSession perunSession,
 Facility facility)

Count hosts in the facility.

Parameters:

perunSession -

facility -

Returns:

int The number of hosts present in the Cluster.

Throws:

InternalErrorException

getOwnerFacilities

List<Facility> getOwnerFacilities(PerunSession perunSession,
 Owner owner)

Returns list of all facilities owned by the owner.

Parameters:

perunSession -

owner -

Returns:

list of facilities owned by the owner

Throws:

InternalErrorException

getOwners

@Deprecated
List<Owner> getOwners(PerunSession perunSession,
 Facility facility)

Deprecated.

Returns owners of the facility.

Parameters:

perunSession -

facility -

Returns:

owners of specified facility

Throws:

InternalErrorException

hostExists

boolean hostExists(PerunSession sess,
 Host host)

removeAllServiceDenials

void removeAllServiceDenials(int facilityId)

Remove all service denials on given facility.

WARNING: this method should be removed in the future if the tasks module is merged into core module.

Parameters:

facilityId - facility id

Throws:

InternalErrorException - when db operation fails

removeBan

void removeBan(PerunSession sess,
 int banId)
        throws BanNotExistsException

Remove ban by id from facilities bans.

Parameters:

sess -

banId - id of specific ban

Throws:

InternalErrorException

BanNotExistsException

removeBan

void removeBan(PerunSession sess,
 int userId,
 int facilityId)
        throws BanNotExistsException

Remove ban by user_id and facility_id.

Parameters:

sess -

userId - the id of user

facilityId - the id of facility

Throws:

InternalErrorException

BanNotExistsException

removeHost

void removeHost(PerunSession perunSession,
 Host host)
         throws HostAlreadyRemovedException

Remove hosts from the Facility.

Parameters:

perunSession -

host -

Throws:

InternalErrorException

HostAlreadyRemovedException - if 0 rows affected by deleting from DB

removeOwner

@Deprecated
void removeOwner(PerunSession perunSession,
 Facility facility,
 Owner owner)
          throws OwnerAlreadyRemovedException

Deprecated.

Remove owner of the facility

Parameters:

perunSession -

facility -

owner -

Throws:

InternalErrorException

OwnerAlreadyRemovedException

searchForFacilities

List<Facility> searchForFacilities(PerunSession sess,
 String searchString,
 boolean includeIDs)

Similarity substring search in all facilities based on name, description and optionally in IDs

Parameters:

sess - session

searchString - string to search for

includeIDs - whether to search in IDs as well, used for PERUNADMINs

Returns:

list of matched facilities

searchForFacilities

List<Facility> searchForFacilities(PerunSession sess,
 String searchString,
 Set<Integer> facilityIds,
 boolean includeIDs)

Similarity substring search in provided facilities based on name, description and optionally ID

Parameters:

sess - session

searchString - string to search for

facilityIds - IDs of facilities to perform the search in

includeIDs - whether to search in IDs as well, used for PERUNADMINs

Returns:

list of matched facilities

setBan

BanOnFacility setBan(PerunSession sess,
 BanOnFacility banOnFacility)

Set ban for user on facility

Parameters:

sess -

banOnFacility - the ban

Returns:

ban on facility

Throws:

InternalErrorException

setOwners

@Deprecated
void setOwners(PerunSession perunSession,
 Facility facility,
 List<Owner> owners)

Deprecated.

Updates owners of facility

Parameters:

perunSession -

facility -

owners -

Throws:

InternalErrorException

updateBan

BanOnFacility updateBan(PerunSession sess,
 BanOnFacility banOnFacility)

Update description and validity timestamp of specific ban.

Parameters:

sess -

banOnFacility - ban to be updated

Returns:

updated ban

Throws:

InternalErrorException

updateFacility

Facility updateFacility(PerunSession perunSession,
 Facility facility)
                 throws FacilityExistsException

Updates facility in DB.

Parameters:

perunSession -

facility -

Throws:

InternalErrorException

FacilityExistsException - if the name of facility has been already used for different Facility