cz.ues.core.qos

Interface UESQoS

@UESService
public interface UESQoS

The QoS service is used for setting and getting a QoS limits for the access roles or territory.

Since:

UES8-08

Method Summary

Methods

Modifier and Type	Method and Description
UESAccessRoleGetQoS	getAccessRoleQoS(UESURI accessRoleUri) Returns a DTO representing QoS for a specific access role.
UESTerritoryGetQoS	getTerritoryQoS(UESURI territoryUri) Returns a DTO representing QoS for a specific territory.
void	setAccessRoleQoS(UESURI accessRoleUri, UESAccessRoleSetQoS setQoS) Sets QoS for a specific access role.
void	setTerritoryQoS(UESURI territoryUri, UESTerritorySetQoS setQoS) Sets QoS for a specific territory.

Method Detail

getTerritoryQoS

@UESCommand(stereotype=READ)

UESTerritoryGetQoS getTerritoryQoS(UESURI territoryUri)
throws UESQoSRTException

Returns a DTO representing QoS for a specific territory. The values represents a requests limit per particular period. Special values are 0 (no request is allowed) and -1 (unlimited).

Parameters:

territoryUri - UESURI of the territory for which QoS will be returned.

Returns:

DTO with an actual QoS setting for a territory, provided by the territoryUri parameter.

Throws:

UESQoSRTException

Since:

UES8-08

setTerritoryQoS

@UESCommand(stereotype=UPDATE)

void setTerritoryQoS(UESURI territoryUri,
UESTerritorySetQoS setQoS)
throws UESQoSRTException

Sets QoS for a specific territory. You must specify at least one value from UESTerritorySetQoS DTO provided as parameter 'setQoS'. If you don't define some values in the DTO so they stay untouched for existing QoS limits. If no QoS exists for the territory, than new one is created and undefined parameters in DTO are set to -1 (unlimited).

Parameters:

territoryUri - UESURI of a territory for which a QoS is to be set.

setQoS - DTO containing attributes for setting QoS.

Throws:

UESQoSRTException

Since:

UES8-08

getAccessRoleQoS

@UESCommand(stereotype=READ)

UESAccessRoleGetQoS getAccessRoleQoS(UESURI accessRoleUri)
throws UESQoSRTException

Returns a DTO representing QoS for a specific access role. The values represents a requests limit per particular period. Special values are 0 (no request is allowed) and -1 (unlimited).

Parameters:

accessRoleUri - UESURI of the access role for which QoS will be returned.

Returns:

DTO with an actual QoS setting for an access role, provided by the accessRoleUri parameter.

Throws:

UESQoSRTException

Since:

UES8-08

setAccessRoleQoS

@UESCommand(stereotype=UPDATE)

void setAccessRoleQoS(UESURI accessRoleUri,
UESAccessRoleSetQoS setQoS)
throws UESQoSRTException

Sets QoS for a specific access role. You must specify at least one value from UESAccessRoleSetQoS DTO provided as parameter 'setQoS'. If you don't define some values in the DTO, so they stay untouched for existing QoS limits. If no QoS exists for the access role, than new one is created and undefined parameters in DTO are set to -1 (unlimited).

Parameters:

accessRoleUri - UESURI of a access role for which QoS is to be set.

setQoS - Object containing attributes for setting QoS.

Throws:

UESQoSRTException

Since:

UES8-08