class documentation

class CSERegistrar:

View In Hierarchy

Structure to hold the CSE registrar information.

Method __deepcopy__ Create a deep copy of the CSERegistrar object. This skips private attributes and None values.
Method __repr__ Return a string representation of the CSERegistrar object.
Method __str__ String representation of the CSERegistrar object.
Method reInit Post initialization actions. Set various internal attributes based on the registrar's attributes.
Method restart Restart the registrar internal attributes.
Method toDict Return a dictionary representation of the CSERegistrar object.
Class Variable address The address of the registrar.
Class Variable cseID The CSE-ID of the registrar.
Class Variable excludeCSRAttributes Attributes to exclude from CSR.
Class Variable INCSEcseID The CSE-ID of the IN-CSE on the top-level of the CSE deployment tree.
Class Variable originator The originator of the sending requesrs to the registrar.
Class Variable resourceName The resource name of the regiftrar.
Class Variable root The root of the registrar.
Class Variable security Security information for the registrar.
Class Variable serialization The serialization for the registrar.
Class Variable spID The service provider ID of the registrar.
Instance Variable csrOnRegistrarSRN The SP-relative structured resource name to the CSR on the registrar. This is set after the registration.
Instance Variable localCSRRN The resource name for the local CSR.
Instance Variable registrarAbsoluteCSI The registrar CSE's absolute CSE-ID.
Instance Variable registrarCSESRN The registrar CSE's SP-relative structured resource name. This is set after the registration.
Instance Variable registrarCSEURL The registrar CSE URL. This is set after the registration.
Instance Variable registrarCSRRN The resource name for the remote CSR.
Class Variable _configurationSection The configuration section for the registrar.
Instance Variable _registrarCSEBaseResource The registrar's CSEBase resource. This is set after the registration.
def __deepcopy__(self, memo: dict[int, Any]) -> CSERegistrar:

Create a deep copy of the CSERegistrar object. This skips private attributes and None values.

Parameters
memo:dict[int, Any]Memoization dictionary for deepcopy.
Returns
CSERegistrarDeep copy of the CSERegistrar object.
def __repr__(self) -> str:

Return a string representation of the CSERegistrar object.

Returns
strString representation of the CSERegistrar object.
def __str__(self) -> str:

String representation of the CSERegistrar object.

Returns
strString representation of the CSERegistrar object.
def reInit(self):

Post initialization actions. Set various internal attributes based on the registrar's attributes.

This is called after the CSERegistrar object is created, so that the attributes are available.

def restart(self):

Restart the registrar internal attributes.

def toDict(self) -> dict:

Return a dictionary representation of the CSERegistrar object.

This is used for serialization and debugging.

Returns
dictDictionary representation of the CSERegistrar object.
address: str =

The address of the registrar.

cseID: str =

The CSE-ID of the registrar.

excludeCSRAttributes: list[str] =

Attributes to exclude from CSR.

INCSEcseID: str =

The CSE-ID of the IN-CSE on the top-level of the CSE deployment tree.

originator: str =

The originator of the sending requesrs to the registrar.

resourceName: str =

The resource name of the regiftrar.

root: str =

The root of the registrar.

Security information for the registrar.

serialization: str | ContentSerializationType =

The serialization for the registrar.

spID: str =

The service provider ID of the registrar.

csrOnRegistrarSRN: str | None =

The SP-relative structured resource name to the CSR on the registrar. This is set after the registration.

localCSRRN: str | None =

The resource name for the local CSR.

registrarAbsoluteCSI: str | None =

The registrar CSE's absolute CSE-ID.

registrarCSESRN: str | None =

The registrar CSE's SP-relative structured resource name. This is set after the registration.

registrarCSEURL: str | None =

The registrar CSE URL. This is set after the registration.

registrarCSRRN: str | None =

The resource name for the remote CSR.

_configurationSection: str | None =

The configuration section for the registrar.

_registrarCSEBaseResource: Resource | None =

The registrar's CSEBase resource. This is set after the registration.