File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\model\PasswordParameterDefinition.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Romain Seguy
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.model;
25
26 import net.sf.json.JSONObject;
27 import org.kohsuke.stapler.StaplerRequest;
28 import org.kohsuke.stapler.DataBoundConstructor;
29 import hudson.Extension;
30 import hudson.util.Secret;
31
32 /**
33 * Parameter whose value is a {@link Secret} and is hidden from the UI.
34 *
35 * @author Kohsuke Kawaguchi
36 * @since 1.319
37 */
38 public class PasswordParameterDefinition extends SimpleParameterDefinition {
39
40 private Secret defaultValue;
41
42 @DataBoundConstructor
43 public PasswordParameterDefinition(String name, String defaultValue, String description) {
44 super(name, description);
45 this.defaultValue = Secret.fromString(defaultValue);
46 }
47
48 @Override
49 public ParameterDefinition copyWithDefaultValue(ParameterValue defaultValue) {
50 if (defaultValue instanceof PasswordParameterValue) {
51 PasswordParameterValue value = (PasswordParameterValue) defaultValue;
52 return new PasswordParameterDefinition(getName(), Secret.toString(value.getValue()), getDescription());
53 } else {
54 return this;
55 }
56 }
57
58 @Override
59 public ParameterValue createValue(String value) {
60 return new PasswordParameterValue(getName(), value, getDescription());
61 }
62
63 @Override
64 public PasswordParameterValue createValue(StaplerRequest req, JSONObject jo) {
65 PasswordParameterValue value = req.bindJSON(PasswordParameterValue.class, jo);
66 value.setDescription(getDescription());
67 return value;
68 }
69
70 @Override
71 public ParameterValue getDefaultParameterValue() {
72 return new PasswordParameterValue(getName(), getDefaultValue(), getDescription());
73 }
74
75 public String getDefaultValue() {
76 return Secret.toString(defaultValue);
77 }
78
79 // kept for backward compatibility
80 public void setDefaultValue(String defaultValue) {
81 this.defaultValue = Secret.fromString(defaultValue);
82 }
83
84 @Extension
85 public final static class ParameterDescriptorImpl extends ParameterDescriptor {
86 @Override
87 public String getDisplayName() {
88 return Messages.PasswordParameterDefinition_DisplayName();
89 }
90
91 @Override
92 public String getHelpFile() {
93 return "/help/parameter/string.html";
94 }
95 }
96 }
97