diff options
Diffstat (limited to 'src/api/burn')
8 files changed, 86 insertions, 11 deletions
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs index 44d77359..25413790 100644 --- a/src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/Engine.cs | |||
@@ -259,9 +259,9 @@ namespace WixToolset.BootstrapperApplicationApi | |||
259 | } | 259 | } |
260 | 260 | ||
261 | /// <inheritdoc/> | 261 | /// <inheritdoc/> |
262 | public void SetUpdateSource(string url) | 262 | public void SetUpdateSource(string url, string authorizationHeader) |
263 | { | 263 | { |
264 | this.engine.SetUpdateSource(url); | 264 | this.engine.SetUpdateSource(url, authorizationHeader); |
265 | } | 265 | } |
266 | 266 | ||
267 | /// <inheritdoc/> | 267 | /// <inheritdoc/> |
@@ -271,9 +271,9 @@ namespace WixToolset.BootstrapperApplicationApi | |||
271 | } | 271 | } |
272 | 272 | ||
273 | /// <inheritdoc/> | 273 | /// <inheritdoc/> |
274 | public void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password) | 274 | public void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password, string authorizationHeader) |
275 | { | 275 | { |
276 | this.engine.SetDownloadSource(packageOrContainerId, payloadId, url, user, password); | 276 | this.engine.SetDownloadSource(packageOrContainerId, payloadId, url, user, password, authorizationHeader); |
277 | } | 277 | } |
278 | 278 | ||
279 | /// <inheritdoc/> | 279 | /// <inheritdoc/> |
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs index c7b0c003..13702757 100644 --- a/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/IBootstrapperEngine.cs | |||
@@ -129,14 +129,15 @@ namespace WixToolset.BootstrapperApplicationApi | |||
129 | ); | 129 | ); |
130 | 130 | ||
131 | /// <summary> | 131 | /// <summary> |
132 | /// See <see cref="IEngine.SetDownloadSource(string, string, string, string, string)"/>. | 132 | /// See <see cref="IEngine.SetDownloadSource(string, string, string, string, string, string)"/>. |
133 | /// </summary> | 133 | /// </summary> |
134 | void SetDownloadSource( | 134 | void SetDownloadSource( |
135 | [MarshalAs(UnmanagedType.LPWStr)] string wzPackageOrContainerId, | 135 | [MarshalAs(UnmanagedType.LPWStr)] string wzPackageOrContainerId, |
136 | [MarshalAs(UnmanagedType.LPWStr)] string wzPayloadId, | 136 | [MarshalAs(UnmanagedType.LPWStr)] string wzPayloadId, |
137 | [MarshalAs(UnmanagedType.LPWStr)] string wzUrl, | 137 | [MarshalAs(UnmanagedType.LPWStr)] string wzUrl, |
138 | [MarshalAs(UnmanagedType.LPWStr)] string wzUser, | 138 | [MarshalAs(UnmanagedType.LPWStr)] string wzUser, |
139 | [MarshalAs(UnmanagedType.LPWStr)] string wzPassword | 139 | [MarshalAs(UnmanagedType.LPWStr)] string wzPassword, |
140 | [MarshalAs(UnmanagedType.LPWStr)] string wzAuthorizationHeader | ||
140 | ); | 141 | ); |
141 | 142 | ||
142 | /// <summary> | 143 | /// <summary> |
@@ -219,7 +220,8 @@ namespace WixToolset.BootstrapperApplicationApi | |||
219 | /// Sets the URL to the update feed. | 220 | /// Sets the URL to the update feed. |
220 | /// </summary> | 221 | /// </summary> |
221 | void SetUpdateSource( | 222 | void SetUpdateSource( |
222 | [MarshalAs(UnmanagedType.LPWStr)] string url | 223 | [MarshalAs(UnmanagedType.LPWStr)] string url, |
224 | [MarshalAs(UnmanagedType.LPWStr)] string wzAuthorizationHeader | ||
223 | ); | 225 | ); |
224 | 226 | ||
225 | /// <summary> | 227 | /// <summary> |
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/IDefaultBootstrapperApplication.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/IDefaultBootstrapperApplication.cs index ad51b2be..1ff12c28 100644 --- a/src/api/burn/WixToolset.BootstrapperApplicationApi/IDefaultBootstrapperApplication.cs +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/IDefaultBootstrapperApplication.cs | |||
@@ -37,14 +37,14 @@ namespace WixToolset.BootstrapperApplicationApi | |||
37 | /// <summary> | 37 | /// <summary> |
38 | /// Fired when the engine has begun acquiring the payload or container. | 38 | /// Fired when the engine has begun acquiring the payload or container. |
39 | /// The BA can change the source using <see cref="IEngine.SetLocalSource(String, String, String)"/> | 39 | /// The BA can change the source using <see cref="IEngine.SetLocalSource(String, String, String)"/> |
40 | /// or <see cref="IEngine.SetDownloadSource(String, String, String, String, String)"/>. | 40 | /// or <see cref="IEngine.SetDownloadSource(String, String, String, String, String, String)"/>. |
41 | /// </summary> | 41 | /// </summary> |
42 | event EventHandler<CacheAcquireBeginEventArgs> CacheAcquireBegin; | 42 | event EventHandler<CacheAcquireBeginEventArgs> CacheAcquireBegin; |
43 | 43 | ||
44 | /// <summary> | 44 | /// <summary> |
45 | /// Fired when the engine has completed the acquisition of the payload or container. | 45 | /// Fired when the engine has completed the acquisition of the payload or container. |
46 | /// The BA can change the source using <see cref="IEngine.SetLocalSource(String, String, String)"/> | 46 | /// The BA can change the source using <see cref="IEngine.SetLocalSource(String, String, String)"/> |
47 | /// or <see cref="IEngine.SetDownloadSource(String, String, String, String, String)"/>. | 47 | /// or <see cref="IEngine.SetDownloadSource(String, String, String, String, String, String)"/>. |
48 | /// </summary> | 48 | /// </summary> |
49 | event EventHandler<CacheAcquireCompleteEventArgs> CacheAcquireComplete; | 49 | event EventHandler<CacheAcquireCompleteEventArgs> CacheAcquireComplete; |
50 | 50 | ||
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs index bd78409b..03ceed06 100644 --- a/src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/IEngine.cs | |||
@@ -156,7 +156,8 @@ namespace WixToolset.BootstrapperApplicationApi | |||
156 | /// Sets the URL to the update feed. | 156 | /// Sets the URL to the update feed. |
157 | /// </summary> | 157 | /// </summary> |
158 | /// <param name="url">URL of the update feed.</param> | 158 | /// <param name="url">URL of the update feed.</param> |
159 | void SetUpdateSource(string url); | 159 | /// <param name="authorizationHeader">Additional proxy authentication header. Not currently used.</param> |
160 | void SetUpdateSource(string url, string authorizationHeader); | ||
160 | 161 | ||
161 | /// <summary> | 162 | /// <summary> |
162 | /// Set the local source for a package or container. | 163 | /// Set the local source for a package or container. |
@@ -174,7 +175,8 @@ namespace WixToolset.BootstrapperApplicationApi | |||
174 | /// <param name="url">The new url.</param> | 175 | /// <param name="url">The new url.</param> |
175 | /// <param name="user">The user name for proxy authentication.</param> | 176 | /// <param name="user">The user name for proxy authentication.</param> |
176 | /// <param name="password">The password for proxy authentication.</param> | 177 | /// <param name="password">The password for proxy authentication.</param> |
177 | void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password); | 178 | /// <param name="authorizationHeader">Additional proxy authentication header. Not currently used.</param> |
179 | void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password, string authorizationHeader); | ||
178 | 180 | ||
179 | /// <summary> | 181 | /// <summary> |
180 | /// Sets numeric variables for the engine. | 182 | /// Sets numeric variables for the engine. |
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md b/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md new file mode 100644 index 00000000..eeedbf9f --- /dev/null +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md | |||
@@ -0,0 +1,37 @@ | |||
1 | # WixToolset.BootstrapperApplicationApi - managed BootstrapperApplication API | ||
2 | |||
3 | The `WixToolset.BootstrapperApplicationApi` package contains the SDK for building managed BootstrapperApplications. | ||
4 | |||
5 | [Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] | ||
6 | |||
7 | |||
8 | ## Open Source Maintenance Fee | ||
9 | |||
10 | To ensure the long-term sustainability of this project, users of this package who generate revenue must pay an [Open Source Maintenance Fee][osmf]. While the source code is freely available under the terms of the [LICENSE][license], this package and other aspects of the project require [adherence to the Open Source Maintenance Fee EULA][eula]. | ||
11 | |||
12 | To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). | ||
13 | |||
14 | |||
15 | ## Getting started | ||
16 | |||
17 | BAFunctions are native-code DLLs (typically written in C++) that let you supplement the behavior of WixStdBA, rather than writing an entirely new BA to tweak existing BA behavior. | ||
18 | |||
19 | The best way to learn is via the samples at: https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions | ||
20 | |||
21 | |||
22 | ## Additional resources | ||
23 | |||
24 | * [WiX Website][web] | ||
25 | * [WiX Documentation][docs] | ||
26 | * [WiX Issue Tracker][issues] | ||
27 | * [WiX Discussions][discussions] | ||
28 | |||
29 | |||
30 | [web]: https://www.firegiant.com/wixtoolset/ | ||
31 | [docs]: https://docs.firegiant.com/wixtoolset/ | ||
32 | [issues]: https://github.com/wixtoolset/issues/issues | ||
33 | [discussions]: https://github.com/orgs/wixtoolset/discussions | ||
34 | [sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ | ||
35 | [osmf]: https://opensourcemaintenancefee.org/ | ||
36 | [license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT | ||
37 | [eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt | ||
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec b/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec index 63acc895..73fef99b 100644 --- a/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec | |||
@@ -7,6 +7,7 @@ | |||
7 | <description>$description$</description> | 7 | <description>$description$</description> |
8 | <authors>$authors$</authors> | 8 | <authors>$authors$</authors> |
9 | <icon>icon.png</icon> | 9 | <icon>icon.png</icon> |
10 | <readme>README.md</readme> | ||
10 | <license type="file">OSMFEULA.txt</license> | 11 | <license type="file">OSMFEULA.txt</license> |
11 | <requireLicenseAcceptance>true</requireLicenseAcceptance> | 12 | <requireLicenseAcceptance>true</requireLicenseAcceptance> |
12 | <tags>$packageTags$</tags> | 13 | <tags>$packageTags$</tags> |
@@ -25,6 +26,7 @@ | |||
25 | <files> | 26 | <files> |
26 | <file src="$eulaTxt$" /> | 27 | <file src="$eulaTxt$" /> |
27 | <file src="$iconPng$" /> | 28 | <file src="$iconPng$" /> |
29 | <file src="$projectFolder$\README.md" /> | ||
28 | 30 | ||
29 | <file src="$projectFolder$\build\WixToolset.BootstrapperApplicationApi.props" target="build\" /> | 31 | <file src="$projectFolder$\build\WixToolset.BootstrapperApplicationApi.props" target="build\" /> |
30 | 32 | ||
diff --git a/src/api/burn/bextutil/README.md b/src/api/burn/bextutil/README.md new file mode 100644 index 00000000..cee7e98c --- /dev/null +++ b/src/api/burn/bextutil/README.md | |||
@@ -0,0 +1,30 @@ | |||
1 | # WixToolset.BootstrapperExtensionApi - extend WiX Bootstrapper Engine | ||
2 | |||
3 | The `WixToolset.BootstrapperExtensionApi` package contains the SDK for extending the WiX Bootstrapper Engine, better known as "burn". | ||
4 | |||
5 | [Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] | ||
6 | |||
7 | |||
8 | ## Open Source Maintenance Fee | ||
9 | |||
10 | To ensure the long-term sustainability of this project, users of this package who generate revenue must pay an [Open Source Maintenance Fee][osmf]. While the source code is freely available under the terms of the [LICENSE][license], this package and other aspects of the project require [adherence to the Open Source Maintenance Fee EULA][eula]. | ||
11 | |||
12 | To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). | ||
13 | |||
14 | |||
15 | ## Additional resources | ||
16 | |||
17 | * [WiX Website][web] | ||
18 | * [WiX Documentation][docs] | ||
19 | * [WiX Issue Tracker][issues] | ||
20 | * [WiX Discussions][discussions] | ||
21 | |||
22 | |||
23 | [web]: https://www.firegiant.com/wixtoolset/ | ||
24 | [docs]: https://docs.firegiant.com/wixtoolset/ | ||
25 | [issues]: https://github.com/wixtoolset/issues/issues | ||
26 | [discussions]: https://github.com/orgs/wixtoolset/discussions | ||
27 | [sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ | ||
28 | [osmf]: https://opensourcemaintenancefee.org/ | ||
29 | [license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT | ||
30 | [eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt | ||
diff --git a/src/api/burn/bextutil/bextutil.nuspec b/src/api/burn/bextutil/bextutil.nuspec index f790e0b8..065b72a3 100644 --- a/src/api/burn/bextutil/bextutil.nuspec +++ b/src/api/burn/bextutil/bextutil.nuspec | |||
@@ -7,6 +7,7 @@ | |||
7 | <description>$description$</description> | 7 | <description>$description$</description> |
8 | <authors>$authors$</authors> | 8 | <authors>$authors$</authors> |
9 | <icon>icon.png</icon> | 9 | <icon>icon.png</icon> |
10 | <readme>README.md</readme> | ||
10 | <license type="file">OSMFEULA.txt</license> | 11 | <license type="file">OSMFEULA.txt</license> |
11 | <requireLicenseAcceptance>true</requireLicenseAcceptance> | 12 | <requireLicenseAcceptance>true</requireLicenseAcceptance> |
12 | <tags>$packageTags$</tags> | 13 | <tags>$packageTags$</tags> |
@@ -21,6 +22,7 @@ | |||
21 | <files> | 22 | <files> |
22 | <file src="$eulaTxt$" /> | 23 | <file src="$eulaTxt$" /> |
23 | <file src="$iconPng$" /> | 24 | <file src="$iconPng$" /> |
25 | <file src="$projectFolder$\README.md" /> | ||
24 | <file src="$projectFolder$\build\$id$.props" target="build\" /> | 26 | <file src="$projectFolder$\build\$id$.props" target="build\" /> |
25 | <file src="$projectFolder$\inc\*" target="build\native\include" /> | 27 | <file src="$projectFolder$\inc\*" target="build\native\include" /> |
26 | <file src="$projectFolder$\..\inc\BootstrapperExtensionTypes.h" target="build\native\include" /> | 28 | <file src="$projectFolder$\..\inc\BootstrapperExtensionTypes.h" target="build\native\include" /> |