help_pages.devices_help_views
=============================

.. py:module:: help_pages.devices_help_views

.. autoapi-nested-parse::

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





Module Contents
---------------

.. py:class:: BaseHelpView

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


   Base help view that constructs the context.


   .. py:attribute:: template_name
      :value: 'help/help_page.html'



   .. py:attribute:: http_method_names
      :value: ('get',)



   .. py:attribute:: model


   .. py:attribute:: context_object_name
      :value: 'device'



   .. py:attribute:: page_category
      :value: 'devices'



   .. py:attribute:: page_name
      :type:  str


   .. py:attribute:: strategy
      :type:  help_pages.base.HelpPageStrategy


   .. py:method:: get_context_data(**kwargs)

      Gets the context data and builds the HelpPage.

      :param kwargs: Passed to super().get_context_data().

      :returns: The django context for the detail view.



.. py:class:: NoOnboardingCmpSharedSecretStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


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


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: DeviceNoOnboardingCmpSharedSecretHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'devices'



   .. py:attribute:: strategy


.. py:class:: OpcUaGdsNoOnboardingCmpSharedSecretHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



   .. py:attribute:: strategy


.. py:class:: NoOnboardingEstUsernamePasswordStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


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


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: DeviceNoOnboardingEstUsernamePasswordHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'devices'



   .. py:attribute:: strategy


.. py:class:: OpcUaGdsNoOnboardingEstUsernamePasswordHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



   .. py:attribute:: strategy


.. py:class:: OnboardingDomainCredentialCmpSharedSecretStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


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


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: DeviceOnboardingDomainCredentialCmpSharedSecretHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'devices'



   .. py:attribute:: strategy


.. py:class:: OpcUaGdsOnboardingDomainCredentialCmpSharedSecretHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



   .. py:attribute:: strategy


.. py:class:: OnboardingDomainCredentialEstUsernamePasswordStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


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


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: DeviceOnboardingDomainCredentialEstUsernamePasswordHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'devices'



   .. py:attribute:: strategy


.. py:class:: OpcUaGdsOnboardingDomainCredentialEstUsernamePasswordHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



   .. py:attribute:: strategy


.. py:class:: ApplicationCertificateWithCmpDomainCredentialStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


   Strategy for building the onboarding cmp app certificate help page.


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: DeviceApplicationCertificateWithCmpDomainCredentialHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'devices'



   .. py:attribute:: strategy


.. py:class:: OpcUaGdsApplicationCertificateWithCmpDomainCredentialHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



   .. py:attribute:: strategy


.. py:class:: ApplicationCertificateWithEstDomainCredentialStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


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


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: DeviceApplicationCertificateWithEstDomainCredentialHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'devices'



   .. py:attribute:: strategy


.. py:class:: OpcUaGdsApplicationCertificateWithEstDomainCredentialHelpView

   Bases: :py:obj:`BaseHelpView`


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


   .. py:attribute:: page_name
      :value: 'opc_ua_gds'



   .. py:attribute:: strategy


.. py:class:: OpcUaGdsPushOnboardingStrategy

   Bases: :py:obj:`help_pages.base.HelpPageStrategy`


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


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: OpcUaGdsPushApplicationCertificateStrategy

   Bases: :py:obj:`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.


   .. py:method:: build_sections(help_context)

      Builds the required sections.



.. py:class:: OpcUaGdsPushApplicationCertificateHelpView

   Bases: :py:obj:`BaseHelpView`


   Help view for OPC UA GDS Push application certificates.


   .. py:attribute:: page_name
      :value: 'devices'



   .. py:attribute:: strategy


.. py:class:: OpcUaGdsPushOnboardingHelpView

   Bases: :py:obj:`BaseHelpView`


   Help view for OPC UA GDS Push onboarding.


   .. py:attribute:: page_name
      :value: 'devices'



   .. py:attribute:: strategy