help_pages.devices_help_views

This module contains all views concerning the help pages used within the devices app.

Module Contents

class help_pages.devices_help_views.BaseHelpView[source]

Bases: trustpoint.page_context.PageContextMixin, django.views.generic.detail.DetailView[devices.models.DeviceModel]

Base help view that constructs the context.

template_name = 'help/help_page.html'[source]
http_method_names = ('get',)[source]
model[source]
context_object_name = 'device'[source]
page_category = 'devices'[source]
page_name: str[source]
strategy: help_pages.base.HelpPageStrategy[source]
get_context_data(**kwargs)[source]

Gets the context data and builds the HelpPage.

Parameters:

kwargs (Any) – Passed to super().get_context_data().

Returns:

The django context for the detail view.

Return type:

dict[str, Any]

class help_pages.devices_help_views.NoOnboardingCmpSharedSecretStrategy[source]

Bases: help_pages.base.HelpPageStrategy

Strategy for building the no-onboarding CMP shared-secret help page.

build_sections(help_context)[source]

Builds the required sections.

Parameters:

help_context (help_pages.base.HelpContext)

Return type:

tuple[list[help_pages.help_section.HelpSection], str]

class help_pages.devices_help_views.DeviceNoOnboardingCmpSharedSecretHelpView[source]

Bases: BaseHelpView

Help view for the case of no onboarding using CMP shared-secret for generic device abstractions.

page_name = 'devices'[source]
strategy[source]
class help_pages.devices_help_views.OpcUaGdsNoOnboardingCmpSharedSecretHelpView[source]

Bases: BaseHelpView

Help view for the case of no onboarding using CMP shared-secret for OPC-UA GDS abstractions.

page_name = 'opc_ua_gds'[source]
strategy[source]
class help_pages.devices_help_views.NoOnboardingEstUsernamePasswordStrategy[source]

Bases: help_pages.base.HelpPageStrategy

Strategy for building the no-onboarding EST username and password help page.

build_sections(help_context)[source]

Builds the required sections.

Parameters:

help_context (help_pages.base.HelpContext)

Return type:

tuple[list[help_pages.help_section.HelpSection], str]

class help_pages.devices_help_views.DeviceNoOnboardingEstUsernamePasswordHelpView[source]

Bases: BaseHelpView

Help view for the case of no onboarding using EST username and password generic device abstractions.

page_name = 'devices'[source]
strategy[source]
class help_pages.devices_help_views.OpcUaGdsNoOnboardingEstUsernamePasswordHelpView[source]

Bases: BaseHelpView

Help view for the case of no onboarding using EST username and password for OPC-UA GDS abstractions.

page_name = 'opc_ua_gds'[source]
strategy[source]
class help_pages.devices_help_views.OnboardingDomainCredentialCmpSharedSecretStrategy[source]

Bases: help_pages.base.HelpPageStrategy

Strategy for building the onboarding CMP shared-secret help page.

build_sections(help_context)[source]

Builds the required sections.

Parameters:

help_context (help_pages.base.HelpContext)

Return type:

tuple[list[help_pages.help_section.HelpSection], str]

class help_pages.devices_help_views.DeviceOnboardingDomainCredentialCmpSharedSecretHelpView[source]

Bases: BaseHelpView

Help view for the case of onboarding using CMP with a domain credential for generic device abstractions.

page_name = 'devices'[source]
strategy[source]
class help_pages.devices_help_views.OpcUaGdsOnboardingDomainCredentialCmpSharedSecretHelpView[source]

Bases: BaseHelpView

Help view for the case of onboarding using CMP with a domain credential for OPC-UA GDS abstractions.

page_name = 'opc_ua_gds'[source]
strategy[source]
class help_pages.devices_help_views.OnboardingDomainCredentialEstUsernamePasswordStrategy[source]

Bases: help_pages.base.HelpPageStrategy

Strategy for building the onboarding est username and password help page.

build_sections(help_context)[source]

Builds the required sections.

Parameters:

help_context (help_pages.base.HelpContext)

Return type:

tuple[list[help_pages.help_section.HelpSection], str]

class help_pages.devices_help_views.DeviceOnboardingDomainCredentialEstUsernamePasswordHelpView[source]

Bases: BaseHelpView

Help view for the case of onboarding using EST username & password for generic device abstractions.

page_name = 'devices'[source]
strategy[source]
class help_pages.devices_help_views.OpcUaGdsOnboardingDomainCredentialEstUsernamePasswordHelpView[source]

Bases: BaseHelpView

Help view for the case of onboarding using EST username & password for OPC-UA GDS abstractions.

page_name = 'opc_ua_gds'[source]
strategy[source]
class help_pages.devices_help_views.ApplicationCertificateWithCmpDomainCredentialStrategy[source]

Bases: help_pages.base.HelpPageStrategy

Strategy for building the onboarding cmp app certificate help page.

build_sections(help_context)[source]

Builds the required sections.

Parameters:

help_context (help_pages.base.HelpContext)

Return type:

tuple[list[help_pages.help_section.HelpSection], str]

class help_pages.devices_help_views.DeviceApplicationCertificateWithCmpDomainCredentialHelpView[source]

Bases: BaseHelpView

Help view for the case of onboarding using CMP with client cert for generic device abstractions.

page_name = 'devices'[source]
strategy[source]
class help_pages.devices_help_views.OpcUaGdsApplicationCertificateWithCmpDomainCredentialHelpView[source]

Bases: BaseHelpView

Help view for the case of onboarding using CMP with client cert for OPC-UA GDS abstractions.

page_name = 'opc_ua_gds'[source]
strategy[source]
class help_pages.devices_help_views.ApplicationCertificateWithEstDomainCredentialStrategy[source]

Bases: help_pages.base.HelpPageStrategy

Strategy for building the onboarding EST username and password help page.

build_sections(help_context)[source]

Builds the required sections.

Parameters:

help_context (help_pages.base.HelpContext)

Return type:

tuple[list[help_pages.help_section.HelpSection], str]

class help_pages.devices_help_views.DeviceApplicationCertificateWithEstDomainCredentialHelpView[source]

Bases: BaseHelpView

Help view for the case of onboarding using EST with client cert for generic device abstractions.

page_name = 'devices'[source]
strategy[source]
class help_pages.devices_help_views.OpcUaGdsApplicationCertificateWithEstDomainCredentialHelpView[source]

Bases: BaseHelpView

Help view for the case of onboarding using EST with client cert for OPC-UA GDS abstractions.

page_name = 'opc_ua_gds'[source]
strategy[source]
class help_pages.devices_help_views.OpcUaGdsPushOnboardingStrategy[source]

Bases: help_pages.base.HelpPageStrategy

Strategy for building the OPC UA GDS Push onboarding help page.

build_sections(help_context)[source]

Builds the required sections.

Parameters:

help_context (help_pages.base.HelpContext)

Return type:

tuple[list[help_pages.help_section.HelpSection], str]

class help_pages.devices_help_views.OpcUaGdsPushApplicationCertificateStrategy[source]

Bases: OpcUaGdsPushOnboardingStrategy

Strategy for the OPC UA GDS Push application certificate help page.

Extends the base onboarding strategy with a periodic server certificate renewal configuration section.

build_sections(help_context)[source]

Builds the required sections.

Parameters:

help_context (help_pages.base.HelpContext)

Return type:

tuple[list[help_pages.help_section.HelpSection], str]

class help_pages.devices_help_views.OpcUaGdsPushApplicationCertificateHelpView[source]

Bases: BaseHelpView

Help view for OPC UA GDS Push application certificates.

page_name = 'devices'[source]
strategy[source]
class help_pages.devices_help_views.OpcUaGdsPushOnboardingHelpView[source]

Bases: BaseHelpView

Help view for OPC UA GDS Push onboarding.

page_name = 'devices'[source]
strategy[source]