Package cz.metacentrum.perun.core.implApi

Interface ServicesManagerImplApi

All Known Implementing Classes:

ServicesManagerImpl

public interface ServicesManagerImplApi

Author:

Michal Prochazka <michalp@ics.muni.cz>, Slavek Licehammer <glory@ics.muni.cz>

Note: ServicesManager is not to be used directly by any client. ServicesManager's functionality is going to be encapsulated in the Controller's GeneralServiceManager.

Method Summary

Modifier and Type	Method	Description
void	addDestination(PerunSession perunSession, Service service, Facility facility, Destination destination)	Adds an destination for the facility and service.
void	addRequiredAttribute(PerunSession perunSession, Service service, AttributeDefinition attribute)	Mark the attribute as required for the service.
void	addRequiredAttributes(PerunSession perunSession, Service service, List<? extends AttributeDefinition> attributes)	Batch version of addRequiredAttribute
void	addServiceToServicesPackage(PerunSession perunSession, ServicesPackage servicesPackage, Service service)	Add the service to the package
void	blockServiceOnDestination(PerunSession session, int serviceId, int destinationId)	Block Service on specific Destination.
void	blockServiceOnFacility(PerunSession session, int serviceId, int facilityId)	Block Service on Facility.
void	checkServiceExists(PerunSession perunSession, Service service)	Check if service exists in underlaying data source.
void	checkServicesPackageExists(PerunSession perunSession, ServicesPackage servicesPackage)	Check if services package exists in underlaying data source.
Destination	createDestination(PerunSession sess, Destination destination)
Service	createService(PerunSession perunSession, Service service)	Creates new service.
ServicesPackage	createServicesPackage(PerunSession perunSession, ServicesPackage servicesPackage)	Insert a new package
void	deleteDestination(PerunSession sess, Destination destination)	Deletes destination.
void	deleteService(PerunSession perunSession, Service service)	Deletes the service.
void	deleteServicesPackage(PerunSession perunSession, ServicesPackage servicesPackage)	Remove the package
boolean	destinationExists(PerunSession sess, Destination destination)
boolean	destinationExists(PerunSession sess, Service service, Facility facility, Destination destination)	Determine if destination exists for specified facility and service.
List<RichDestination>	getAllRichDestinations(PerunSession perunSession, Facility facility)	Get list of all rich destinations defined for the facility.
List<RichDestination>	getAllRichDestinations(PerunSession perunSession, Service service)	Get list of all rich destinations defined for the service.
List<Resource>	getAssignedResources(PerunSession sess, Service service)	Get all resources which use this service.
List<Service>	getAssignedServices(PerunSession perunSession, Facility facility)	List all services associated with the facility (via resource).
List<Service>	getAssignedServices(PerunSession perunSession, Facility facility, Vo vo)	List all services associated with the facility and vo (via resource).
Destination	getDestination(PerunSession sess, String destination, String type)	Get destination by String destination and type
Destination	getDestinationById(PerunSession perunSession, int id)	Get destination by id
List<Destination>	getDestinations(PerunSession perunSession)	Get list of all destinations.
List<Destination>	getDestinations(PerunSession perunSession, Facility facility)	Get lists of all destinations for specific Facility
List<Destination>	getDestinations(PerunSession perunSession, Service service, Facility facility)	Get list of all destinations defined for the service and facility.
int	getDestinationsCount(PerunSession perunSession)	Get count of all destinations.
List<Destination>	getFacilitiesDestinations(PerunSession sess, Vo vo)	List all destinations for all facilities which are joined by resources to the VO.
List<RichDestination>	getRichDestinations(PerunSession perunSession, Facility facility, Service service)	Get list of all rich destinations defined for the service and the facility
Service	getServiceById(PerunSession perunSession, int id)	Get service by id.
Service	getServiceByName(PerunSession perunSession, String name)	Get service by name.
List<Service>	getServices(PerunSession perunSession)	get all services in perun
List<Service>	getServicesBlockedOnDestination(int destinationId)	Get Services blocked on Destination.
List<Service>	getServicesBlockedOnFacility(int facilityId)	Get Services blocked on Facility.
List<Service>	getServicesByAttributeDefinition(PerunSession sess, AttributeDefinition attributeDefinition)	Get all services with given attribute.
List<Service>	getServicesFromDestination(int destinationId)	Return list of services this destination points to.
List<Service>	getServicesFromServicesPackage(PerunSession perunSession, ServicesPackage servicesPackage)	List services stored in the packages
ServicesPackage	getServicesPackageById(PerunSession perunSession, int servicesPackageId)	Get package by Id
ServicesPackage	getServicesPackageByName(PerunSession sess, String name)	Get services package by name.
List<ServicesPackage>	getServicesPackages(PerunSession perunSession)	List packages
boolean	isServiceAssignedToFacility(PerunSession sess, Facility facility, Service service)	Checks whether given service is assigned to given facility (through some resource).
boolean	isServiceBlockedOnDestination(int serviceId, int destinationId)	Return TRUE if Service is blocked on Destination.
boolean	isServiceBlockedOnFacility(int serviceId, int facilityId)	Return TRUE if Service is blocked on Facility.
void	removeAllDestinations(PerunSession perunSession, Facility facility)	Removes all defined destinations for the facility.
void	removeAllDestinations(PerunSession perunSession, Service service, Facility facility)	Removes all defined destinations for the service and facility.
void	removeAllRequiredAttributes(PerunSession perunSession, Service service)	Detate all required attributes from service
void	removeDestination(PerunSession perunSession, Service service, Facility facility, Destination destination)	Removes an destination from the facility and service.
void	removeRequiredAttribute(PerunSession perunSession, Service service, AttributeDefinition attribute)	Remove required attribute from service.
void	removeRequiredAttributes(PerunSession perunSession, Service service, List<? extends AttributeDefinition> attributes)	Batch version of removeRequiredAttribute
void	removeServiceFromAllServicesPackages(PerunSession sess, Service service)	Remove Service from all Services Packages
void	removeServiceFromServicesPackage(PerunSession perunSession, ServicesPackage servicesPackage, Service service)	Remove Service from Services Package
boolean	serviceExists(PerunSession perunSession, Service service)	Check if service exists in underlaying data source.
boolean	servicesPackageExists(PerunSession perunSession, ServicesPackage servicesPackage)	Check if services package exists in underlaying data source.
void	unblockAllServicesOnDestination(int destination)	Unblock all blocked Services on specified Destination.
void	unblockAllServicesOnFacility(int facility)	Unblock all blocked Services on Facility.
void	unblockService(int serviceId)	Unblock Service everywhere.
void	unblockServiceOnDestination(int serviceId, int destinationId)	Unblock Service on specific Destination.
void	unblockServiceOnFacility(int serviceId, int facilityId)	Unblock Service on whole Facility.
void	updateService(PerunSession perunSession, Service service)	Updates the service.
void	updateServicesPackage(PerunSession perunSession, ServicesPackage servicesPackage)	Update package

Method Details

addDestination

void addDestination(PerunSession perunSession,
 Service service,
 Facility facility,
 Destination destination)
             throws DestinationAlreadyAssignedException

Adds an destination for the facility and service.

Parameters:

perunSession -

service -

facility -

destination - string contains destination address (mail, url, hostname, ...)

Throws:

InternalErrorException

DestinationAlreadyAssignedException - when the combination already exists

addRequiredAttribute

void addRequiredAttribute(PerunSession perunSession,
 Service service,
 AttributeDefinition attribute)
                   throws AttributeAlreadyAssignedException

Mark the attribute as required for the service. Required attribues are requisite for Service to run. If you add attribute which has a default attribute then this default attribute will be automatically add too.

Parameters:

perunSession - perunSession

service - service to which the attribute will be added

attribute - attribute to add

Throws:

InternalErrorException - if an exception raise in concrete implementation, the exception is wrapped in InternalErrorException

AttributeAlreadyAssignedException - if the attribute is already added

addRequiredAttributes

void addRequiredAttributes(PerunSession perunSession,
 Service service,
 List<? extends AttributeDefinition> attributes)
                    throws AttributeAlreadyAssignedException

Batch version of addRequiredAttribute

Throws:

AttributeAlreadyAssignedException

See Also:

• ServicesManager.addRequiredAttribute(PerunSession, Service, AttributeDefinition)

addServiceToServicesPackage

void addServiceToServicesPackage(PerunSession perunSession,
 ServicesPackage servicesPackage,
 Service service)
                          throws ServiceAlreadyAssignedException

Add the service to the package

Parameters:

perunSession -

servicesPackage - services package to which the service supposed to be added

service - service to be added to the services package

Throws:

InternalErrorException

ServicesPackageNotExistsException

ServiceNotExistsException

ServiceAlreadyAssignedException

blockServiceOnDestination

void blockServiceOnDestination(PerunSession session,
 int serviceId,
 int destinationId)
                        throws ServiceAlreadyBannedException

Block Service on specific Destination. Service still can be propagated to other facility Destinations.

Parameters:

session -

serviceId - The Service to be blocked on this particular destination

destinationId - The destination on which we want to block the Service

Throws:

InternalErrorException

ServiceAlreadyBannedException

blockServiceOnFacility

void blockServiceOnFacility(PerunSession session,
 int serviceId,
 int facilityId)
                     throws ServiceAlreadyBannedException

Block Service on Facility. It won't be possible to propagate service on whole facility or any of its destinations.

Parameters:

session -

serviceId - The Service to be blocked on the Facility

facilityId - The Facility on which we want to block the Service

Throws:

InternalErrorException

ServiceAlreadyBannedException

checkServiceExists

void checkServiceExists(PerunSession perunSession,
 Service service)
                 throws ServiceNotExistsException

Check if service exists in underlaying data source.

Parameters:

perunSession - perun session

service - service to check

Throws:

InternalErrorException - if unexpected error occured

ServiceNotExistsException - if service doesn't exists

checkServicesPackageExists

void checkServicesPackageExists(PerunSession perunSession,
 ServicesPackage servicesPackage)
                         throws ServicesPackageNotExistsException

Check if services package exists in underlaying data source.

Parameters:

perunSession - perun session

servicesPackage - services package to check

Throws:

InternalErrorException - if unexpected error occur

ServicesPackageNotExistsException - if service doesn't exists

createDestination

Destination createDestination(PerunSession sess,
 Destination destination)

createService

Service createService(PerunSession perunSession,
 Service service)

Creates new service.

Parameters:

perunSession -

service -

Returns:

new service

createServicesPackage

ServicesPackage createServicesPackage(PerunSession perunSession,
 ServicesPackage servicesPackage)

Insert a new package

Parameters:

servicesPackage - package to be inserted

perunSession -

Returns:

ServicesPackage object completely filled (including Id)

Throws:

InternalErrorException

deleteDestination

void deleteDestination(PerunSession sess,
 Destination destination)
                throws DestinationAlreadyRemovedException,
RelationExistsException

Deletes destination.

Parameters:

sess -

destination - destination to be deleted

Throws:

InternalErrorException

DestinationAlreadyRemovedException - if there are 0 rows affected by deleting from DB

RelationExistsException - if the destination has some existing relations in DB

deleteService

void deleteService(PerunSession perunSession,
 Service service)
            throws ServiceAlreadyRemovedException

Deletes the service.

Parameters:

perunSession -

service -

Throws:

ServiceAlreadyRemovedException - if there are 0 rows affected by deleting from DB

deleteServicesPackage

void deleteServicesPackage(PerunSession perunSession,
 ServicesPackage servicesPackage)

Remove the package

Parameters:

perunSession -

servicesPackage - services package to be removed.

Throws:

ServicesPackageNotExistsException

destinationExists

boolean destinationExists(PerunSession sess,
 Service service,
 Facility facility,
 Destination destination)

Determine if destination exists for specified facility and service.

Parameters:

sess -

service -

facility -

destination -

Returns:

true if the destination exists for the facility and the resource

Throws:

InternalErrorException

destinationExists

boolean destinationExists(PerunSession sess,
 Destination destination)

getAllRichDestinations

List<RichDestination> getAllRichDestinations(PerunSession perunSession,
 Facility facility)

Get list of all rich destinations defined for the facility.

Parameters:

perunSession -

facility -

Returns:

list of rich destinations defined for the facility

Throws:

InternalErrorException

getAllRichDestinations

List<RichDestination> getAllRichDestinations(PerunSession perunSession,
 Service service)

Get list of all rich destinations defined for the service.

Parameters:

perunSession -

service -

Returns:

list of rich destinations defined for the service

Throws:

InternalErrorException

getAssignedResources

List<Resource> getAssignedResources(PerunSession sess,
 Service service)

Get all resources which use this service.

Parameters:

sess -

service -

Returns:

list of resources

Throws:

InternalErrorException

getAssignedServices

List<Service> getAssignedServices(PerunSession perunSession,
 Facility facility)

List all services associated with the facility (via resource).

Parameters:

perunSession -

facility -

Returns:

list of services assigned to facility

Throws:

InternalErrorException

getAssignedServices

List<Service> getAssignedServices(PerunSession perunSession,
 Facility facility,
 Vo vo)

List all services associated with the facility and vo (via resource).

Parameters:

perunSession -

facility -

vo -

Returns:

list of services assigned to facility and vo

Throws:

InternalErrorException

getDestination

Destination getDestination(PerunSession sess,
 String destination,
 String type)
                    throws DestinationNotExistsException

Get destination by String destination and type

Parameters:

sess -

destination - Destination string representation

type - type of destination

Returns:

Destination

Throws:

InternalErrorException

DestinationNotExistsException

getDestinationById

Destination getDestinationById(PerunSession perunSession,
 int id)
                        throws DestinationNotExistsException

Get destination by id

Parameters:

perunSession -

id -

Returns:

Destination with the id

Throws:

InternalErrorException

DestinationNotExistsException

getDestinations

List<Destination> getDestinations(PerunSession perunSession,
 Service service,
 Facility facility)

Get list of all destinations defined for the service and facility.

Parameters:

perunSession -

service -

facility -

Returns:

list list of destinations defined for the service and facility

Throws:

InternalErrorException

getDestinations

List<Destination> getDestinations(PerunSession perunSession)

Get list of all destinations.

Parameters:

perunSession -

Returns:

list of all destinations for session

Throws:

InternalErrorException

getDestinations

List<Destination> getDestinations(PerunSession perunSession,
 Facility facility)

Get lists of all destinations for specific Facility

Parameters:

perunSession -

facility - the facility

Returns:

lists of all destinations for specific Facility

Throws:

InternalErrorException

getDestinationsCount

int getDestinationsCount(PerunSession perunSession)

Get count of all destinations.

Parameters:

perunSession -

Returns:

count of all destinations

Throws:

InternalErrorException

getFacilitiesDestinations

List<Destination> getFacilitiesDestinations(PerunSession sess,
 Vo vo)

List all destinations for all facilities which are joined by resources to the VO.

Parameters:

sess -

vo - vo for which we are searching destinations

Returns:

list of destinations

Throws:

InternalErrorException

getRichDestinations

List<RichDestination> getRichDestinations(PerunSession perunSession,
 Facility facility,
 Service service)

Get list of all rich destinations defined for the service and the facility

Parameters:

perunSession -

facility -

service -

Returns:

list of rich destinations defined for the service and the facility

Throws:

InternalErrorException

getServiceById

Service getServiceById(PerunSession perunSession,
 int id)
                throws ServiceNotExistsException

Get service by id.

Parameters:

perunSession -

id -

Returns:

service with specified id

Throws:

InternalErrorException

ServiceNotExistsException

getServiceByName

Service getServiceByName(PerunSession perunSession,
 String name)
                  throws ServiceNotExistsException

Get service by name.

Parameters:

perunSession -

name - name of the service

Returns:

service with specified name

Throws:

InternalErrorException

ServiceNotExistsException

getServices

List<Service> getServices(PerunSession perunSession)

get all services in perun

Parameters:

perunSession -

Returns:

all services in perun

Throws:

InternalErrorException

getServicesBlockedOnDestination

List<Service> getServicesBlockedOnDestination(int destinationId)

Get Services blocked on Destination.

Parameters:

destinationId - ID of Destination to get blocked Services for.

Returns:

List of blocked Services.

getServicesBlockedOnFacility

List<Service> getServicesBlockedOnFacility(int facilityId)

Get Services blocked on Facility.

Parameters:

facilityId - ID of Facility to get blocked Services for.

Returns:

List of blocked Services.

getServicesByAttributeDefinition

List<Service> getServicesByAttributeDefinition(PerunSession sess,
 AttributeDefinition attributeDefinition)

Get all services with given attribute.

Parameters:

sess - perun session

attributeDefinition -

Returns:

all services with given attribute

Throws:

InternalErrorException

getServicesFromDestination

List<Service> getServicesFromDestination(int destinationId)

Return list of services this destination points to.

Parameters:

destinationId - ID of destination

Returns:

Services associated with this destination.

getServicesFromServicesPackage

List<Service> getServicesFromServicesPackage(PerunSession perunSession,
 ServicesPackage servicesPackage)

List services stored in the packages

Parameters:

servicesPackage - the package from which we want to list the services

Returns:

list consisting services

Throws:

InternalErrorException

ServicesPackageNotExistsException

getServicesPackageById

ServicesPackage getServicesPackageById(PerunSession perunSession,
 int servicesPackageId)
                                throws ServicesPackageNotExistsException

Get package by Id

Parameters:

servicesPackageId - id of the package we want to retrieve

perunSession -

Returns:

package

Throws:

InternalErrorException

ServicesPackageNotExistsException

getServicesPackageByName

ServicesPackage getServicesPackageByName(PerunSession sess,
 String name)
                                  throws ServicesPackageNotExistsException

Get services package by name.

Parameters:

sess -

name -

Returns:

package

Throws:

InternalErrorException

ServicesPackageNotExistsException

getServicesPackages

List<ServicesPackage> getServicesPackages(PerunSession perunSession)

List packages

Parameters:

perunSession -

Returns:

list of packages in the DB

Throws:

InternalErrorException

isServiceAssignedToFacility

boolean isServiceAssignedToFacility(PerunSession sess,
 Facility facility,
 Service service)

Checks whether given service is assigned to given facility (through some resource).

Parameters:

sess - session

facility - facility

service - service

Returns:

true if service is assigned to given facility, false otherwise

isServiceBlockedOnDestination

boolean isServiceBlockedOnDestination(int serviceId,
 int destinationId)

Return TRUE if Service is blocked on Destination.

Parameters:

serviceId - ID of Service to check on.

destinationId - ID of Destination to check on.

Returns:

TRUE if Service is blocked on Destination / FALSE otherwise

isServiceBlockedOnFacility

boolean isServiceBlockedOnFacility(int serviceId,
 int facilityId)

Return TRUE if Service is blocked on Facility.

Parameters:

serviceId - ID of Service to check on.

facilityId - ID of Facility to check on.

Returns:

TRUE if Service is blocked on Facility / FALSE otherwise

removeAllDestinations

void removeAllDestinations(PerunSession perunSession,
 Service service,
 Facility facility)

Removes all defined destinations for the service and facility.

Parameters:

perunSession -

service -

facility -

Throws:

InternalErrorException

removeAllDestinations

void removeAllDestinations(PerunSession perunSession,
 Facility facility)

Removes all defined destinations for the facility.

Parameters:

perunSession -

facility - the facility

Throws:

InternalErrorException

removeAllRequiredAttributes

void removeAllRequiredAttributes(PerunSession perunSession,
 Service service)

Detate all required attributes from service

Parameters:

perunSession - perunSession

service - service from which the attributes will be removed

Throws:

InternalErrorException - if an exception raise in concrete implementation, the exception is wrapped in InternalErrorException

ServiceNotExistsException - if the service doesn't exists in underlaying data source

removeDestination

void removeDestination(PerunSession perunSession,
 Service service,
 Facility facility,
 Destination destination)
                throws DestinationAlreadyRemovedException

Removes an destination from the facility and service.

Parameters:

perunSession -

service -

facility -

destination - string contains destination address (mail, url, hostname, ...)

Throws:

InternalErrorException

DestinationAlreadyRemovedException

removeRequiredAttribute

void removeRequiredAttribute(PerunSession perunSession,
 Service service,
 AttributeDefinition attribute)
                      throws AttributeNotAssignedException

Remove required attribute from service. TODO If you try to remove attribute which is default for other Required attribute ...

Parameters:

perunSession - perunSession

service - service from which the attribute will be removed

attribute - attribute to remove

Throws:

InternalErrorException - if an exception raise in concrete implementation, the exception is wrapped in InternalErrorException

AttributeNotAssignedException

ServiceNotExistsException - if the service doesn't exists in underlaying data source

removeRequiredAttributes

void removeRequiredAttributes(PerunSession perunSession,
 Service service,
 List<? extends AttributeDefinition> attributes)
                       throws AttributeNotAssignedException

Batch version of removeRequiredAttribute

Throws:

AttributeNotAssignedException

See Also:

• ServicesManager.removeRequiredAttribute(PerunSession, Service, AttributeDefinition)

removeServiceFromAllServicesPackages

void removeServiceFromAllServicesPackages(PerunSession sess,
 Service service)

Remove Service from all Services Packages

Parameters:

perunSession -

service - service that will be removed from the services package

Throws:

InternalErrorException

ServiceNotExistsException

ServiceAlreadyRemovedFromServicePackageException - there are 0 rows affected by removing service from service package in DB

removeServiceFromServicesPackage

void removeServiceFromServicesPackage(PerunSession perunSession,
 ServicesPackage servicesPackage,
 Service service)
                               throws ServiceAlreadyRemovedFromServicePackageException

Remove Service from Services Package

Parameters:

perunSession -

servicesPackage - services package from which the service supposed to be removed

service - service that will be removed from the services package

Throws:

InternalErrorException

ServicesPackageNotExistsException

ServiceNotExistsException

ServiceAlreadyRemovedFromServicePackageException - there are 0 rows affected by removing service from service package in DB

serviceExists

boolean serviceExists(PerunSession perunSession,
 Service service)

Check if service exists in underlaying data source.

Parameters:

perunSession - perun session

service - service to check

Returns:

true if service exists in underlaying data source, false otherwise

Throws:

InternalErrorException - if unexpected error occured

servicesPackageExists

boolean servicesPackageExists(PerunSession perunSession,
 ServicesPackage servicesPackage)

Check if services package exists in underlaying data source.

Parameters:

perunSession - perun session

servicesPackage - services package to check

Returns:

true if services package exists in underlaying data source, false otherwise

Throws:

InternalErrorException - if unexpected error occur

unblockAllServicesOnDestination

void unblockAllServicesOnDestination(int destination)

Unblock all blocked Services on specified Destination.

Parameters:

destination - ID of Destination we want to unblock all Services.

unblockAllServicesOnFacility

void unblockAllServicesOnFacility(int facility)

Unblock all blocked Services on Facility.

Parameters:

facility - ID of Facility we want to unblock all Services.

unblockService

void unblockService(int serviceId)

Unblock Service everywhere. If was not blocked, nothing happens.

Parameters:

serviceId - ID of Service to unblock.

unblockServiceOnDestination

void unblockServiceOnDestination(int serviceId,
 int destinationId)

Unblock Service on specific Destination. If was not blocked, nothing happens.

Parameters:

serviceId - ID of Service to unblock on Destination.

destinationId - ID of Destination to unblock Service on.

unblockServiceOnFacility

void unblockServiceOnFacility(int serviceId,
 int facilityId)

Unblock Service on whole Facility. If was not blocked, nothing happens.

Parameters:

serviceId - ID of Service to unblock on Facility.

facilityId - ID of Facility to unblock Service on.

updateService

void updateService(PerunSession perunSession,
 Service service)

Updates the service.

Parameters:

perunSession -

service -

updateServicesPackage

void updateServicesPackage(PerunSession perunSession,
 ServicesPackage servicesPackage)

Update package

Parameters:

servicesPackage - with which is the old one supposed to be updated :-)

perunSession -

Throws:

InternalErrorException

ServicesPackageNotExistsException