Opc.Ua.Configuration.xml 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Opc.Ua.Configuration</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Opc.Ua.Configuration.IApplicationMessageDlg">
  8. <summary>
  9. Interface to create application callbacks.
  10. </summary>
  11. </member>
  12. <member name="M:Opc.Ua.Configuration.IApplicationMessageDlg.Message(System.String,System.Boolean)">
  13. <summary>
  14. The application message.
  15. </summary>
  16. <param name="text">The text of the message.</param>
  17. <param name="ask">If the application should ask the user.</param>
  18. </member>
  19. <member name="M:Opc.Ua.Configuration.IApplicationMessageDlg.ShowAsync">
  20. <summary>
  21. Show the message and return result.
  22. </summary>
  23. </member>
  24. <member name="T:Opc.Ua.Configuration.ApplicationInstance">
  25. <summary>
  26. A class that install, configures and runs a UA application.
  27. </summary>
  28. </member>
  29. <member name="M:Opc.Ua.Configuration.ApplicationInstance.#ctor">
  30. <summary>
  31. Initializes a new instance of the <see cref="T:Opc.Ua.Configuration.ApplicationInstance"/> class.
  32. </summary>
  33. </member>
  34. <member name="M:Opc.Ua.Configuration.ApplicationInstance.#ctor(Opc.Ua.ApplicationConfiguration)">
  35. <summary>
  36. Initializes a new instance of the <see cref="T:Opc.Ua.Configuration.ApplicationInstance"/> class.
  37. </summary>
  38. <param name="applicationConfiguration">The application configuration.</param>
  39. </member>
  40. <member name="P:Opc.Ua.Configuration.ApplicationInstance.ApplicationName">
  41. <summary>
  42. Gets or sets the name of the application.
  43. </summary>
  44. <value>The name of the application.</value>
  45. </member>
  46. <member name="P:Opc.Ua.Configuration.ApplicationInstance.ApplicationType">
  47. <summary>
  48. Gets or sets the type of the application.
  49. </summary>
  50. <value>The type of the application.</value>
  51. </member>
  52. <member name="P:Opc.Ua.Configuration.ApplicationInstance.ConfigSectionName">
  53. <summary>
  54. Gets or sets the name of the config section containing the path to the application configuration file.
  55. </summary>
  56. <value>The name of the config section.</value>
  57. </member>
  58. <member name="P:Opc.Ua.Configuration.ApplicationInstance.ConfigurationType">
  59. <summary>
  60. Gets or sets the type of configuration file.
  61. </summary>
  62. <value>The type of configuration file.</value>
  63. </member>
  64. <member name="P:Opc.Ua.Configuration.ApplicationInstance.Server">
  65. <summary>
  66. Gets the server.
  67. </summary>
  68. <value>The server.</value>
  69. </member>
  70. <member name="P:Opc.Ua.Configuration.ApplicationInstance.ApplicationConfiguration">
  71. <summary>
  72. Gets the application configuration used when the Start() method was called.
  73. </summary>
  74. <value>The application configuration.</value>
  75. </member>
  76. <member name="P:Opc.Ua.Configuration.ApplicationInstance.NoGdsAgentAdmin">
  77. <summary>
  78. Gets or sets a flag that indicates whether the application will be set up for management with the GDS agent.
  79. </summary>
  80. <value>If true the application will not be visible to the GDS local agent after installation.</value>
  81. </member>
  82. <member name="P:Opc.Ua.Configuration.ApplicationInstance.MessageDlg">
  83. <summary>
  84. Get or set the message dialog.
  85. </summary>
  86. </member>
  87. <member name="M:Opc.Ua.Configuration.ApplicationInstance.ProcessCommandLine">
  88. <summary>
  89. Processes the command line.
  90. </summary>
  91. <returns>
  92. True if the arguments were processed; False otherwise.
  93. </returns>
  94. </member>
  95. <member name="M:Opc.Ua.Configuration.ApplicationInstance.StartAsService(Opc.Ua.ServerBase)">
  96. <summary>
  97. Starts the UA server as a Windows Service.
  98. </summary>
  99. <param name="server">The server.</param>
  100. </member>
  101. <member name="M:Opc.Ua.Configuration.ApplicationInstance.Start(Opc.Ua.ServerBase)">
  102. <summary>
  103. Starts the UA server.
  104. </summary>
  105. <param name="server">The server.</param>
  106. </member>
  107. <member name="M:Opc.Ua.Configuration.ApplicationInstance.Stop">
  108. <summary>
  109. Stops the UA server.
  110. </summary>
  111. </member>
  112. <member name="M:Opc.Ua.Configuration.ApplicationInstance.FixupAppConfig(Opc.Ua.ApplicationConfiguration)">
  113. <summary>
  114. Helper to replace localhost with the hostname
  115. in the application uri and base adresses of the
  116. configuration.
  117. </summary>
  118. <param name="configuration"></param>
  119. </member>
  120. <member name="M:Opc.Ua.Configuration.ApplicationInstance.LoadAppConfig(System.Boolean,System.String,Opc.Ua.ApplicationType,System.Type,System.Boolean)">
  121. <summary>
  122. Loads the configuration.
  123. </summary>
  124. </member>
  125. <member name="M:Opc.Ua.Configuration.ApplicationInstance.LoadApplicationConfiguration(System.String,System.Boolean)">
  126. <summary>
  127. Loads the application configuration.
  128. </summary>
  129. </member>
  130. <member name="M:Opc.Ua.Configuration.ApplicationInstance.LoadApplicationConfiguration(System.Boolean)">
  131. <summary>
  132. Loads the application configuration.
  133. </summary>
  134. </member>
  135. <member name="M:Opc.Ua.Configuration.ApplicationInstance.CheckApplicationInstanceCertificate(System.Boolean,System.UInt16)">
  136. <summary>
  137. Checks for a valid application instance certificate.
  138. </summary>
  139. <param name="silent">if set to <c>true</c> no dialogs will be displayed.</param>
  140. <param name="minimumKeySize">Minimum size of the key.</param>
  141. </member>
  142. <member name="M:Opc.Ua.Configuration.ApplicationInstance.CheckApplicationInstanceCertificate(System.Boolean,System.UInt16,System.UInt16)">
  143. <summary>
  144. Checks for a valid application instance certificate.
  145. </summary>
  146. <param name="silent">if set to <c>true</c> no dialogs will be displayed.</param>
  147. <param name="minimumKeySize">Minimum size of the key.</param>
  148. <param name="lifeTimeInMonths">The lifetime in months.</param>
  149. </member>
  150. <member name="M:Opc.Ua.Configuration.ApplicationInstance.CertificateValidator_CertificateValidation(Opc.Ua.CertificateValidator,Opc.Ua.CertificateValidationEventArgs)">
  151. <summary>
  152. Handles a certificate validation error.
  153. </summary>
  154. </member>
  155. <member name="M:Opc.Ua.Configuration.ApplicationInstance.CheckApplicationInstanceCertificate(Opc.Ua.ApplicationConfiguration,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Boolean,System.UInt16)">
  156. <summary>
  157. Creates an application instance certificate if one does not already exist.
  158. </summary>
  159. </member>
  160. <member name="M:Opc.Ua.Configuration.ApplicationInstance.CheckDomainsInCertificate(Opc.Ua.ApplicationConfiguration,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Boolean)">
  161. <summary>
  162. Checks that the domains in the server addresses match the domains in the certificates.
  163. </summary>
  164. </member>
  165. <member name="M:Opc.Ua.Configuration.ApplicationInstance.CreateApplicationInstanceCertificate(Opc.Ua.ApplicationConfiguration,System.UInt16,System.UInt16)">
  166. <summary>
  167. Creates the application instance certificate.
  168. </summary>
  169. <param name="configuration">The configuration.</param>
  170. <param name="keySize">Size of the key.</param>
  171. <param name="lifeTimeInMonths">The lifetime in months.</param>
  172. <returns>The new certificate</returns>
  173. </member>
  174. <member name="M:Opc.Ua.Configuration.ApplicationInstance.DeleteApplicationInstanceCertificate(Opc.Ua.ApplicationConfiguration)">
  175. <summary>
  176. Deletes an existing application instance certificate.
  177. </summary>
  178. <param name="configuration">The configuration instance that stores the configurable information for a UA application.</param>
  179. </member>
  180. <member name="M:Opc.Ua.Configuration.ApplicationInstance.AddToTrustedStore(Opc.Ua.ApplicationConfiguration,System.Security.Cryptography.X509Certificates.X509Certificate2)">
  181. <summary>
  182. Adds the certificate to the Trusted Certificate Store
  183. </summary>
  184. <param name="configuration">The application's configuration which specifies the location of the TrustedStore.</param>
  185. <param name="certificate">The certificate to register.</param>
  186. </member>
  187. <member name="M:Opc.Ua.Configuration.ApplicationInstance.ApproveMessage(System.String,System.Boolean)">
  188. <summary>
  189. Show a message for approval and return result.
  190. </summary>
  191. <param name="message"></param>
  192. <param name="silent"></param>
  193. <returns>True if approved, false otherwise.</returns>
  194. </member>
  195. </members>
  196. </doc>