-
Notifications
You must be signed in to change notification settings - Fork 234
/
IdCredentials.java
98 lines (91 loc) · 3.34 KB
/
IdCredentials.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
* The MIT License
*
* Copyright (c) 2011-2012, CloudBees, Inc., Stephen Connolly.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.cloudbees.plugins.credentials.common;
import com.cloudbees.plugins.credentials.Credentials;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.UUID;
import org.apache.commons.lang.StringUtils;
/**
* Credentials that have an unique ID that assists in retrieving the specific credential from a collection of
* {@link Credentials}.
* <p>
* Note: This credential interface is a marker interface
*
* @since 1.5
*/
@LegacyMixIn(preferred = StandardCredentials.class)
public interface IdCredentials extends Credentials {
/**
* Returns the ID.
*
* @return the ID.
*/
@NonNull
String getId();
/**
* The contract implementations of {@link #equals(Object)} and {@link #hashCode()} that implementations of
* this class must use as the basis for equality tests and as the hash code.
*
* @since 1.6
*/
final class Helpers {
/**
* Standard {@link #equals(Object)} implementation.
*
* @param self the {@code this} reference.
* @param o the other object.
* @return true if equal.
*/
public static boolean equals(IdCredentials self, Object o) {
if (self == o) {
return true;
}
if (!(o instanceof IdCredentials)) {
return false;
}
IdCredentials that = (IdCredentials) o;
return self.getId().equals(that.getId());
}
/**
* The standard {@link #hashCode()} implementation.
*
* @param self the {@code this} reference.
* @return the hash code.
*/
public static int hashCode(IdCredentials self) {
return self.getId().hashCode();
}
/**
* Returns either the id or a generated new id if the supplied id is missing.
*
* @param id the supplied id.
* @return either the id or a generated new id if the supplied id is missing.
*/
@NonNull
public static String fixEmptyId(@CheckForNull String id) {
return StringUtils.isEmpty(id) ? UUID.randomUUID().toString() : id;
}
}
}