001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.bean.html5;
018
019import org.apache.juneau.annotation.*;
020import org.apache.juneau.internal.*;
021
022/**
023 * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-keygen-element">&lt;keygen&gt;</a>
024 * element.
025 *
026 * <p>
027 * The keygen element represents a key-pair generator control for forms. It generates a public/private
028 * key pair and submits the public key to the server. This element is deprecated in HTML5 and should
029 * not be used in new projects. Modern web applications should use Web Crypto API instead.
030 *
031 * <h5 class='section'>Examples:</h5>
032 * <p class='bcode w800'>
033 *    <jk>import static</jk> org.apache.juneau.bean.html5.HtmlBuilder.*;
034 * 
035 *    <jc>// Basic keygen with RSA key type</jc>
036 *    Keygen <jv>keygen1</jv> = <jsm>keygen</jsm>()
037 *       .name(<js>"userkey"</js>)
038 *       .keytype(<js>"RSA"</js>);
039 * 
040 *    <jc>// Keygen with challenge string</jc>
041 *    Keygen <jv>keygen2</jv> = <jsm>keygen</jsm>()
042 *       .name(<js>"certkey"</js>)
043 *       .keytype(<js>"RSA"</js>)
044 *       .challenge(<js>"server-challenge-string"</js>);
045 * 
046 *    <jc>// Keygen with form association</jc>
047 *    Keygen <jv>keygen3</jv> = <jsm>keygen</jsm>()
048 *       .name(<js>"formkey"</js>)
049 *       .keytype(<js>"DSA"</js>)
050 *       .form(<js>"myform"</js>);
051 * 
052 *    <jc>// Keygen with disabled state</jc>
053 *    Keygen <jv>keygen4</jv> = <jsm>keygen</jsm>()
054 *       .name(<js>"disabledkey"</js>)
055 *       .keytype(<js>"RSA"</js>)
056 *       .disabled(<jk>true</jk>);
057 * </p>
058 *
059 * <p>
060 * The following convenience methods are provided for constructing instances of this bean:
061 * <ul class='javatree'>
062 *    <li class='jc'>{@link HtmlBuilder}
063 *    <ul class='javatree'>
064 *       <li class='jm'>{@link HtmlBuilder#keygen() keygen()}
065 *    </ul>
066 * </ul>
067 * </p>
068 *
069 * <h5 class='section'>See Also:</h5><ul>
070 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
071 * </ul>
072 */
073@Bean(typeName="keygen")
074public class Keygen extends HtmlElementVoid {
075
076   /**
077    * Creates an empty {@link Keygen} element.
078    */
079   public Keygen() { /* Empty constructor. */ }
080
081   /**
082    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
083    *
084    * <p>
085    * Automatically focus the form control when the page is loaded.
086    *
087    * @param autofocus
088    *    The new value for this attribute.
089    *    Typically a {@link Boolean} or {@link String}.
090    * @return This object.
091    */
092   public Keygen autofocus(Object value) {
093      attr("autofocus", value);
094      return this;
095   }
096
097   /**
098    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-keygen-challenge">challenge</a> attribute.
099    *
100    * <p>
101    * Specifies a challenge string that will be packaged with the generated and signed public key.
102    * This is used for additional security in key generation processes.
103    *
104    * <p>
105    * The challenge string is typically provided by the server and used to verify the key generation.
106    *
107    * @param challenge The challenge string to package with the generated key.
108    * @return This object.
109    */
110   public Keygen challenge(String value) {
111      attr("challenge", value);
112      return this;
113   }
114
115   /**
116    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
117    *
118    * <p>
119    * Whether the form control is disabled.
120    *
121    * <p>
122    * This attribute uses deminimized values:
123    * <ul>
124    *    <li><jk>false</jk> - Attribute is not added</li>
125    *    <li><jk>true</jk> - Attribute is added as <js>"disabled"</js></li>
126    *    <li>Other values - Passed through as-is</li>
127    * </ul>
128    *
129    * @param disabled
130    *    The new value for this attribute.
131    *    Typically a {@link Boolean} or {@link String}.
132    * @return This object.
133    */
134   public Keygen disabled(Object value) {
135      attr("disabled", deminimize(value, "disabled"));
136      return this;
137   }
138
139   /**
140    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
141    *
142    * <p>
143    * Associates the keygen element with a form element by specifying the form's ID. This allows the keygen
144    * to be placed outside the form element while still being part of the form.
145    *
146    * <p>
147    * The value should match the ID of a form element in the same document.
148    *
149    * @param form The ID of the form element to associate with this keygen.
150    * @return This object.
151    */
152   public Keygen form(String value) {
153      attr("form", value);
154      return this;
155   }
156
157   /**
158    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-keygen-keytype">keytype</a> attribute.
159    *
160    * <p>
161    * Specifies the type of cryptographic key to generate.
162    *
163    * <p>
164    * Common values:
165    * <ul>
166    *    <li><js>"RSA"</js> - RSA key pair (default)</li>
167    *    <li><js>"DSA"</js> - DSA key pair</li>
168    *    <li><js>"EC"</js> - Elliptic curve key pair</li>
169    * </ul>
170    *
171    * @param keytype The type of cryptographic key to generate.
172    * @return This object.
173    */
174   public Keygen keytype(String value) {
175      attr("keytype", value);
176      return this;
177   }
178
179   /**
180    * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
181    *
182    * <p>
183    * Specifies the name of the keygen element. This name is used when the form is submitted and
184    * can be used to access the element via the form.elements API.
185    *
186    * <p>
187    * The name should be unique within the form and should not contain spaces or special characters.
188    *
189    * @param name The name of the keygen element for submission and API access.
190    * @return This object.
191    */
192   public Keygen name(String value) {
193      attr("name", value);
194      return this;
195   }
196
197   //-----------------------------------------------------------------------------------------------------------------
198   // Overridden methods
199   //-----------------------------------------------------------------------------------------------------------------
200   @Override /* Overridden from HtmlElement */
201   public Keygen _class(String value) {  // NOSONAR - Intentional naming.
202      super._class(value);
203      return this;
204   }
205
206   @Override /* Overridden from HtmlElement */
207   public Keygen accesskey(String value) {
208      super.accesskey(value);
209      return this;
210   }
211
212   @Override /* Overridden from HtmlElement */
213   public Keygen contenteditable(Object value) {
214      super.contenteditable(value);
215      return this;
216   }
217
218   @Override /* Overridden from HtmlElement */
219   public Keygen dir(String value) {
220      super.dir(value);
221      return this;
222   }
223
224   @Override /* Overridden from HtmlElement */
225   public Keygen hidden(Object value) {
226      super.hidden(value);
227      return this;
228   }
229
230   @Override /* Overridden from HtmlElement */
231   public Keygen id(String value) {
232      super.id(value);
233      return this;
234   }
235
236   @Override /* Overridden from HtmlElement */
237   public Keygen lang(String value) {
238      super.lang(value);
239      return this;
240   }
241
242   @Override /* Overridden from HtmlElement */
243   public Keygen onabort(String value) {
244      super.onabort(value);
245      return this;
246   }
247
248   @Override /* Overridden from HtmlElement */
249   public Keygen onblur(String value) {
250      super.onblur(value);
251      return this;
252   }
253
254   @Override /* Overridden from HtmlElement */
255   public Keygen oncancel(String value) {
256      super.oncancel(value);
257      return this;
258   }
259
260   @Override /* Overridden from HtmlElement */
261   public Keygen oncanplay(String value) {
262      super.oncanplay(value);
263      return this;
264   }
265
266   @Override /* Overridden from HtmlElement */
267   public Keygen oncanplaythrough(String value) {
268      super.oncanplaythrough(value);
269      return this;
270   }
271
272   @Override /* Overridden from HtmlElement */
273   public Keygen onchange(String value) {
274      super.onchange(value);
275      return this;
276   }
277
278   @Override /* Overridden from HtmlElement */
279   public Keygen onclick(String value) {
280      super.onclick(value);
281      return this;
282   }
283
284   @Override /* Overridden from HtmlElement */
285   public Keygen oncuechange(String value) {
286      super.oncuechange(value);
287      return this;
288   }
289
290   @Override /* Overridden from HtmlElement */
291   public Keygen ondblclick(String value) {
292      super.ondblclick(value);
293      return this;
294   }
295
296   @Override /* Overridden from HtmlElement */
297   public Keygen ondurationchange(String value) {
298      super.ondurationchange(value);
299      return this;
300   }
301
302   @Override /* Overridden from HtmlElement */
303   public Keygen onemptied(String value) {
304      super.onemptied(value);
305      return this;
306   }
307
308   @Override /* Overridden from HtmlElement */
309   public Keygen onended(String value) {
310      super.onended(value);
311      return this;
312   }
313
314   @Override /* Overridden from HtmlElement */
315   public Keygen onerror(String value) {
316      super.onerror(value);
317      return this;
318   }
319
320   @Override /* Overridden from HtmlElement */
321   public Keygen onfocus(String value) {
322      super.onfocus(value);
323      return this;
324   }
325
326   @Override /* Overridden from HtmlElement */
327   public Keygen oninput(String value) {
328      super.oninput(value);
329      return this;
330   }
331
332   @Override /* Overridden from HtmlElement */
333   public Keygen oninvalid(String value) {
334      super.oninvalid(value);
335      return this;
336   }
337
338   @Override /* Overridden from HtmlElement */
339   public Keygen onkeydown(String value) {
340      super.onkeydown(value);
341      return this;
342   }
343
344   @Override /* Overridden from HtmlElement */
345   public Keygen onkeypress(String value) {
346      super.onkeypress(value);
347      return this;
348   }
349
350   @Override /* Overridden from HtmlElement */
351   public Keygen onkeyup(String value) {
352      super.onkeyup(value);
353      return this;
354   }
355
356   @Override /* Overridden from HtmlElement */
357   public Keygen onload(String value) {
358      super.onload(value);
359      return this;
360   }
361
362   @Override /* Overridden from HtmlElement */
363   public Keygen onloadeddata(String value) {
364      super.onloadeddata(value);
365      return this;
366   }
367
368   @Override /* Overridden from HtmlElement */
369   public Keygen onloadedmetadata(String value) {
370      super.onloadedmetadata(value);
371      return this;
372   }
373
374   @Override /* Overridden from HtmlElement */
375   public Keygen onloadstart(String value) {
376      super.onloadstart(value);
377      return this;
378   }
379
380   @Override /* Overridden from HtmlElement */
381   public Keygen onmousedown(String value) {
382      super.onmousedown(value);
383      return this;
384   }
385
386   @Override /* Overridden from HtmlElement */
387   public Keygen onmouseenter(String value) {
388      super.onmouseenter(value);
389      return this;
390   }
391
392   @Override /* Overridden from HtmlElement */
393   public Keygen onmouseleave(String value) {
394      super.onmouseleave(value);
395      return this;
396   }
397
398   @Override /* Overridden from HtmlElement */
399   public Keygen onmousemove(String value) {
400      super.onmousemove(value);
401      return this;
402   }
403
404   @Override /* Overridden from HtmlElement */
405   public Keygen onmouseout(String value) {
406      super.onmouseout(value);
407      return this;
408   }
409
410   @Override /* Overridden from HtmlElement */
411   public Keygen onmouseover(String value) {
412      super.onmouseover(value);
413      return this;
414   }
415
416   @Override /* Overridden from HtmlElement */
417   public Keygen onmouseup(String value) {
418      super.onmouseup(value);
419      return this;
420   }
421
422   @Override /* Overridden from HtmlElement */
423   public Keygen onmousewheel(String value) {
424      super.onmousewheel(value);
425      return this;
426   }
427
428   @Override /* Overridden from HtmlElement */
429   public Keygen onpause(String value) {
430      super.onpause(value);
431      return this;
432   }
433
434   @Override /* Overridden from HtmlElement */
435   public Keygen onplay(String value) {
436      super.onplay(value);
437      return this;
438   }
439
440   @Override /* Overridden from HtmlElement */
441   public Keygen onplaying(String value) {
442      super.onplaying(value);
443      return this;
444   }
445
446   @Override /* Overridden from HtmlElement */
447   public Keygen onprogress(String value) {
448      super.onprogress(value);
449      return this;
450   }
451
452   @Override /* Overridden from HtmlElement */
453   public Keygen onratechange(String value) {
454      super.onratechange(value);
455      return this;
456   }
457
458   @Override /* Overridden from HtmlElement */
459   public Keygen onreset(String value) {
460      super.onreset(value);
461      return this;
462   }
463
464   @Override /* Overridden from HtmlElement */
465   public Keygen onresize(String value) {
466      super.onresize(value);
467      return this;
468   }
469
470   @Override /* Overridden from HtmlElement */
471   public Keygen onscroll(String value) {
472      super.onscroll(value);
473      return this;
474   }
475
476   @Override /* Overridden from HtmlElement */
477   public Keygen onseeked(String value) {
478      super.onseeked(value);
479      return this;
480   }
481
482   @Override /* Overridden from HtmlElement */
483   public Keygen onseeking(String value) {
484      super.onseeking(value);
485      return this;
486   }
487
488   @Override /* Overridden from HtmlElement */
489   public Keygen onselect(String value) {
490      super.onselect(value);
491      return this;
492   }
493
494   @Override /* Overridden from HtmlElement */
495   public Keygen onshow(String value) {
496      super.onshow(value);
497      return this;
498   }
499
500   @Override /* Overridden from HtmlElement */
501   public Keygen onstalled(String value) {
502      super.onstalled(value);
503      return this;
504   }
505
506   @Override /* Overridden from HtmlElement */
507   public Keygen onsubmit(String value) {
508      super.onsubmit(value);
509      return this;
510   }
511
512   @Override /* Overridden from HtmlElement */
513   public Keygen onsuspend(String value) {
514      super.onsuspend(value);
515      return this;
516   }
517
518   @Override /* Overridden from HtmlElement */
519   public Keygen ontimeupdate(String value) {
520      super.ontimeupdate(value);
521      return this;
522   }
523
524   @Override /* Overridden from HtmlElement */
525   public Keygen ontoggle(String value) {
526      super.ontoggle(value);
527      return this;
528   }
529
530   @Override /* Overridden from HtmlElement */
531   public Keygen onvolumechange(String value) {
532      super.onvolumechange(value);
533      return this;
534   }
535
536   @Override /* Overridden from HtmlElement */
537   public Keygen onwaiting(String value) {
538      super.onwaiting(value);
539      return this;
540   }
541
542   @Override /* Overridden from HtmlElement */
543   public Keygen spellcheck(Object value) {
544      super.spellcheck(value);
545      return this;
546   }
547
548   @Override /* Overridden from HtmlElement */
549   public Keygen style(String value) {
550      super.style(value);
551      return this;
552   }
553
554   @Override /* Overridden from HtmlElement */
555   public Keygen tabindex(Object value) {
556      super.tabindex(value);
557      return this;
558   }
559
560   @Override /* Overridden from HtmlElement */
561   public Keygen title(String value) {
562      super.title(value);
563      return this;
564   }
565
566   @Override /* Overridden from HtmlElement */
567   public Keygen translate(Object value) {
568      super.translate(value);
569      return this;
570   }
571}