acme.resources.SUB.SUB

class documentation

class SUB(Resource):

Constructor: SUB(dct, create)

Class for the <subscription> resource type.

Method	`activate`	This method is called to activate a resource, usually in a CREATE request.
Method	`childWillBeAdded`	Called before a child will be added to a resource.
Method	`deactivate`	Deactivate an active resource.
Method	`update`	Update, add or remove resource attributes.
Method	`validate`	Validate a resource.
Class Variable	`notificationManager`	Injected NotificationManager instance.
Class Variable	`validator`	Injected Validator instance.
Method	`_checkAllowedCHTY`	Check whether an observed child resource types are actually allowed by the parent.
Method	`_hasBlockingNET`	Check whether a list of Notification Event Types contains at least one of the blocking notification event types.
Method	`_hasDisallowedBlockingAttributes`	Check whether a dictionary contains "disallowed" attributes. "Disallowed" attributes are any of the resource specific attributes that are not allowed for the blocking Notification Event Types.
Method	`_hasDisallowedENCAttributes`	Check whether a dictionary contains "disallowed" Event Notification Criteria attributes.This is used mainly to validate the blocking-* Notification Event Types.
Class Variable	`_allowedENCAttributes`	These are the only allowed ENC attributes.
Class Variable	`_disallowedBlockingAttributes`	These attributes are not allowed in blocking-* subscription.

Inherited from Resource:

Method	`__contains__`	Implementation of the membership test operator.
Method	`__delitem__`	Implementation of the self[key\| operation for deleting attributes.
Method	`__eq__`	Test for equality of the resource to another resource.
Method	`__getattr__`	Map the normal object attribute access to the internal resource attribute dictionary.
Method	`__getitem__`	Implementation of the self[key\| operation for retrieving attributes.
Method	`__init__`	Initialization of a Resource instance.
Method	`__repr__`	Object representation as string.
Method	`__setitem__`	Implementation of the self[key] operation for assigning to attributes.
Method	`__str__`	String representation of the resource's attributes.
Method	`asDict`	Get the JSON resource representation.
Method	`attribute`	Return the value of an attribute.
Method	`canHaveChild`	Check whether resource is a valild child resource for this resource.
Method	`childAdded`	Called after a child resource was added to the resource.
Method	`childRemoved`	Called when a child resource of the resource was removed.
Method	`childUpdated`	Called when a child resource was updated.
Method	`createChildResourceFromDict`	Create a child resource from a JSON dictionary.
Method	`dbCreate`	Add the resource to the database.
Method	`dbDelete`	Delete the resource from the database.
Method	`dbReload`	Load a new copy of the same resource from the database.
Method	`dbReloadDict`	Reload the resource instance from the database.
Method	`dbUpdate`	Update the resource in the database.
Method	`decrementSubscriptionCounter`	Decrement the subscription counter for the resource.
Method	`delAttribute`	Delete the attribute 'key' from the resource.
Method	`getAttributes`	Get all attributes of the resource.
Method	`getCurrentOriginator`	Retrieve the current originator. This could be different from the originator / creator of the resource in case of the custodian attribute is set.
Method	`getFinalResourceAttribute`	Determine and return the final value of an attribute during an update.
Method	`getLocationCoordinates`	Retrieve a resource's location coordinates (internal attribute).
Method	`getOriginator`	Retrieve a resource's originator.
Method	`getRVI`	Retrieve a resource's release version indicator.
Method	`getSrn`	Retrieve a resource's full structured resource name.
Method	`getSubscriptionCounter`	Retrieve the subscription counter for the resource.
Method	`handleCreateRequest`	Process a CREATE request that is directed to a virtual resource.
Method	`handleDeleteRequest`	Process a DELETE request that is directed to a virtual resource.
Method	`handleNotification`	Process a notification request that is directed to a resource.
Method	`handleRetrieveRequest`	Process a RETRIEVE request that is directed to a virtual resource.
Method	`handleUpdateRequest`	Process a UPDATE request that is directed to a virtual resource.
Method	`hasAttribute`	Check whether an attribute exists for the resource.
Method	`hasAttributeDefined`	Test whether a resource supports the specified attribute. This method may be overwritten in sub-classes, for example for virtual resources.
Method	`incrementSubscriptionCounter`	Increment the subscription counter for the resource.
Method	`initialize`	This method is called when a new resource is created and before written to the database.
Method	`isAnnounced`	Test whether a the resource's type is an announced type.
Method	`isCreatedInternally`	Test whether a resource has been created for another resource.
Method	`isModifiedAfter`	Test whether this resource has been modified after another resource.
Method	`isVirtual`	Test whether the resource is a virtual resource.
Method	`retrieveParentResource`	Retrieve the parent resource of this resouce.
Method	`retrieveParentResourceRaw`	Retrieve the raw (!) parent resource of this resouce.
Method	`selectAttributes`	Determine the selected attributes for a partial retrieve of a resource.
Method	`setAttribute`	Assign a value to a resource attribute.
Method	`setCreatedInternally`	Save the resource ID for which this resource was created for.
Method	`setLocationCoordinates`	Set a resource's location coordinates (internal attribute).
Method	`setOriginator`	Set a resource's originator.
Method	`setResourceID`	Set the resource ID for the resource if not already set.
Method	`setResourceName`	Set the resource name.
Method	`setRVI`	Assign the release version for a resource.
Method	`setSrn`	Set a resource's full structured resource name.
Method	`structuredPath`	Determine the structured path of a resource.
Method	`typeAsString`	Return the resource type as a string. If the resource is a flex container, the specialization is added.
Method	`updated`	Signal to a resource that is was successfully updated.
Method	`willBeDeactivated`	This method is called before a resource will be deactivated.
Method	`willBeRetrieved`	This method is called before a resource will be send back in a RETRIEVE response.
Method	`willBeUpdated`	This method is called before a resource will be updated and before calling the `update()` method.
Class Variable	`__slots__`	Slots for the class.
Class Variable	`dispatcher`	Injected Dispatcher instance.
Class Variable	`factory`	Injected Factory instance.
Class Variable	`importer`	Injected Importer instance.
Class Variable	`requestManager`	Injected RequestManager instance.
Class Variable	`storage`	Injected Storage instance.
Instance Variable	`dict`	Dictionary for public and internal resource attributes.
Method	`_checkAndFixACPIreferences`	Check whether a referenced `ACP` resoure exists, and if yes, change the ID in the list to CSE relative unstructured format.
Method	`_normalizeURIAttribute`	Normalize the URLs in the given attribute.
Class Variable	`_excludeFromUpdate`	Resource attributes that are excluded when updating the resource
Instance Variable	`_originalDict`	Original dictionary as it was created. This is used for validation in activate() later.

def activate(self, parentResource: Resource, originator: str): ¶

overrides acme.resources.Resource.Resource.activate

This method is called to activate a resource, usually in a CREATE request.

This is not always the case, e.g. when a resource object is just used temporarly. NO notification on activation/creation happens in this method!

This method is implemented in sub-classes as well.

Parameters
parentResource:`Resource`	The resource's parent resource.
originator:`str`	The request's originator.

Raises
`BAD_REQUEST`	In case of an invalid attribute.

def childWillBeAdded(self, childResource: Resource, originator: str): ¶

overrides acme.resources.Resource.Resource.childWillBeAdded

Called before a child will be added to a resource.

This method is implemented in some sub-classes.

Parameters
childResource:`Resource`	Resource that will be added as a child to the resource.
originator:`str`	The request originator.

def deactivate(self, originator: str, parentResource: Resource): ¶

overrides acme.resources.Resource.Resource.deactivate

Deactivate an active resource.

This usually happens when creating the resource via a request. A subscription check for deletion is performed.

This method is implemented in sub-classes as well.

Parameters
originator:`str`	The requests originator that let to the deletion of the resource.
parentResource:`Resource`	The resource's parent resource.

def update(self, dct: JSON | None = None, originator: str | None = None, doValidateAttributes: bool | None = True): ¶

overrides acme.resources.Resource.Resource.update

Update, add or remove resource attributes.

A subscription check for update is performed.

This method is implemented in sub-classes as well.

Note

This method updates the resource in the database. It should be called only after all other checks where performed.

Parameters
dct:`JSON \| None`	An optional JSON dictionary with the attributes to be updated.
originator:`str \| None`	The optional requests originator that let to the update of the resource.
doValidateAttributes:`bool \| None`	If True optionally call the resource's `validate()` method.

Raises
`CONTENTS_UNACCEPTABLE`	In case of a resource mismatch.
`BAD_REQUEST`	In case of an invalid attribute.
`INTERNAL_SERVER_ERROR`	In case the parent resource coudln't be retrieved.

def validate(self, originator: str | None = None, dct: JSON | None = None, parentResource: Resource | None = None): ¶

overrides acme.resources.Resource.Resource.validate

Validate a resource.

Usually called within activate() or update() methods.

This method is implemented in some sub-classes.

Raises: BAD_REQUEST: In case of a validation error.

Parameters
originator:`str \| None`	Optional request originator
dct:`JSON \| None`	Updated attributes to validate
parentResource:`Resource \| None`	The parent resource

notificationManager: NotificationManager = ¶

overrides acme.resources.Resource.Resource.notificationManager

Injected NotificationManager instance.

validator: Validator = ¶

overrides acme.resources.Resource.Resource.validator

Injected Validator instance.

def _checkAllowedCHTY(self, parentResource: Resource, chty: list[ResourceTypes]): ¶

Check whether an observed child resource types are actually allowed by the parent.

Parameters
parentResource:`Resource`	The resource to check.
chty:`list[ResourceTypes]`	A list of resource types to check.

Raises
`BAD_REQUEST`	In case the observed child resource type is not allowed.

def _hasBlockingNET(self, net: list[NotificationEventType]) -> bool: ¶

Check whether a list of Notification Event Types contains at least one of the blocking notification event types.

Parameters
net:`list[NotificationEventType]`	List of Notification Event Types.

Returns
`bool`	True, if the list contains at least one of the blocking NotificationEventType.

def _hasDisallowedBlockingAttributes(self, dct: JSON) -> bool: ¶

Check whether a dictionary contains "disallowed" attributes. "Disallowed" attributes are any of the resource specific attributes that are not allowed for the blocking Notification Event Types.

Parameters
dct:`JSON`	Either a resource dict or an update dict.

Returns
`bool`	True if the dct has any disallowed attributes.

def _hasDisallowedENCAttributes(self, dct: JSON) -> bool: ¶

Check whether a dictionary contains "disallowed" Event Notification Criteria attributes.This is used mainly to validate the blocking-* Notification Event Types.

Parameters
dct:`JSON`	A Event Notification Criteria structure.

Returns
`bool`	True if the dct has any disallowed attributes.

_allowedENCAttributes: set[str] = ¶

These are the only allowed ENC attributes.

_disallowedBlockingAttributes: list[str] = ¶

These attributes are not allowed in blocking-* subscription.