acmecse.resources.PCH_PCU.PCH_PCU

class documentation

class PCH_PCU(VirtualResource): (source)

Constructor: PCH_PCU(dct, create)

View In Hierarchy

Class for the PollingChannelURI (PCH_PCU) resource type. This is a virtual resource that represents the polling channel URI of a PollingChannel resource.

Method getAggregate Return the aggregated state internal attribute.
Method handleCreateRequest Handle a CREATE request. Fail with error code.
Method handleDeleteRequest Handle a DELETE request. Delete the latest resource.
Method handleNotifyRequest Handle a NOTIFY request to a PCU resource. At the PCU, only Responses are delivered. This method is called when a notification is directed to a non-request-reachable target.
Method handleRetrieveRequest Handle a RETRIEVE request. Return resource or block until available. At the PCU, only received requests are retrieved, otherwise this function does not return until a reqeust timeout occurs. Only the AE's originator has access to this virtual resource.
Method handleUpdateRequest Handle an UPDATE request. Fail with error code.
Method initialize This method is called when a new resource is created and before written to the database.
Method setAggregate Set the aggregated state for a polling channel. This usually reflects the state of the PCU's parent resource, and is maintained by it.
Class Variable requestManager Injected RequestManager instance.
Class Variable validator Injected Validator instance.

Inherited from VirtualResource:

Method retrieveLatestOldest Retrieve the latest or oldest instance of a container resource.
Class Variable dispatcher Injected Dispatcher instance.
Class Variable notificationManager Injected NotificationManager instance.

Inherited from Resource (via VirtualResource):

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 activate This method is called to activate a resource, usually in a CREATE request.
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 childWillBeAdded Called before a child will be added to a resource.
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 deactivate Deactivate an active resource.
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 handleNotification Process a notification request that is directed to a 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 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 update Update, add or remove resource attributes.
Method updated Signal to a resource that is was successfully updated.
Method validate Validate a resource.
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 factory Injected Factory instance.
Class Variable importer Injected Importer 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 getAggregate(self) -> bool: (source)

Return the aggregated state internal attribute.

Returns
boolBoolean, the agregated state.
def handleCreateRequest(self, request: CSERequest, id: str, originator: str) -> Result: (source)
overrides acmecse.resources.Resource.Resource.handleCreateRequest

Handle a CREATE request. Fail with error code.

def handleDeleteRequest(self, request: CSERequest, id: str, originator: str) -> Result: (source)
overrides acmecse.resources.Resource.Resource.handleDeleteRequest

Handle a DELETE request. Delete the latest resource.

def handleNotifyRequest(self, request: CSERequest, originator: str): (source)

Handle a NOTIFY request to a PCU resource. At the PCU, only Responses are delivered. This method is called when a notification is directed to a non-request-reachable target.

def handleRetrieveRequest(self, request: CSERequest | None = None, id: str | None = None, originator: str | None = None) -> Result: (source)
overrides acmecse.resources.Resource.Resource.handleRetrieveRequest

Handle a RETRIEVE request. Return resource or block until available. At the PCU, only received requests are retrieved, otherwise this function does not return until a reqeust timeout occurs. Only the AE's originator has access to this virtual resource.

Parameters
request:CSERequest | NoneMandatory for PCU. The original RETRIEVE request.
id:str | NoneUndocumented
originator:str | NoneRequest originator.
Returns
ResultResult instance, with the response set to embeddedRequest.
def handleUpdateRequest(self, request: CSERequest, id: str, originator: str) -> Result: (source)
overrides acmecse.resources.Resource.Resource.handleUpdateRequest

Handle an UPDATE request. Fail with error code.

def initialize(self, pi: str): (source)
overrides acmecse.resources.VirtualResource.VirtualResource.initialize

This method is called when a new resource is created and before written to the database.

Parameters
pi:strThe parent resource's ID.
def setAggregate(self, aggregate: bool | None): (source)

Set the aggregated state for a polling channel. This usually reflects the state of the PCU's parent resource, and is maintained by it.

This attribute is handled as an internal attribute and is only set for oneM2M Release 4 and up.

Parameters
aggregate:bool | NoneBoolean indicating whether requests shall be aggregated in a response.
requestManager: RequestManager = (source)
overrides acmecse.resources.Resource.Resource.requestManager

Injected RequestManager instance.

validator: Validator = (source)
overrides acmecse.resources.Resource.Resource.validator

Injected Validator instance.