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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/**
* ============LICENSE_START====================================================
* org.onap.ccsdk
* ===========================================================================
* Copyright (c) 2023 AT&T Intellectual Property. All rights reserved.
* ===========================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END====================================================
*
*/
package org.onap.ccsdk.apps.cadi.taf;
import org.onap.ccsdk.apps.cadi.Access;
import org.onap.ccsdk.apps.cadi.principal.TaggedPrincipal;
import org.onap.ccsdk.apps.cadi.util.Timing;
/**
* AbsTafResp
*
* Base class for TafResp (TAF Response Objects)
*
* @author Jonathan
*
*/
public abstract class AbsTafResp implements TafResp {
protected final Access access;
protected final String tafName;
// Note: Valid Resp is based on Principal being non-null
protected final TaggedPrincipal principal;
protected final String target;
protected final String desc;
private float timing;
/**
* AbsTafResp
*
* Set and hold
* Description (for logging)
* Principal (as created by derived class)
* Access (for access to underlying container, i.e. for Logging, auditing, ClassLoaders, etc)
*
* @param access
* @param tafname
* @param principal
* @param description
*/
public AbsTafResp(Access access, String tafname, TaggedPrincipal principal, String description) {
this.access = access;
this.tafName = tafname;
this.principal = principal;
this.target = principal==null?"unknown":principal.getName();
this.desc = description;
}
/**
* AbsTafResp
*
* Set and hold
* Description (for logging)
* Principal (as created by derived class)
* Access (for access to underlying container, i.e. for Logging, auditing, ClassLoaders, etc)
*
* @param access
* @param tafname
* @param principal
* @param description
*/
public AbsTafResp(Access access, String tafname, String target, String description) {
this.access = access;
this.tafName = tafname;
this.principal = null;
this.target = target;
this.desc = description;
}
/**
* isValid()
*
* Respond in the affirmative if the TAF was able to Authenticate
*/
public boolean isValid() {
return principal != null;
}
/**
* desc()
*
* Respond with description of response as given by the TAF
*/
public String desc() {
return desc;
}
/**
* isAuthenticated()
*
* Respond with the TAF's code of whether Authenticated, or suggested next steps
* default is either IS_AUTHENTICATED, or TRY_ANOTHER_TAF. The TAF can overload
* and suggest others, such as "NO_FURTHER_PROCESSING", if it can detect that this
* is some sort of security breach (i.e. Denial of Service)
*/
public RESP isAuthenticated() {
return principal==null?RESP.TRY_ANOTHER_TAF:RESP.IS_AUTHENTICATED;
}
/**
* getPrincipal()
*
* Return the principal created by the TAF based on Authentication.
*
* Returns "null" if Authentication failed (no principal)
*/
public TaggedPrincipal getPrincipal() {
return principal;
}
/* (non-Javadoc)
* @see org.onap.ccsdk.apps.cadi.taf.TafResp#getTarget()
*/
@Override
public String getTarget() {
return target;
}
/**
* getAccess()
*
* Get the Access object from the TAF, so that appropriate Logging, etc can be coordinated.
*/
public Access getAccess() {
return access;
}
/* (non-Javadoc)
* @see org.onap.ccsdk.apps.cadi.taf.TafResp#isFailedAttempt()
*/
public boolean isFailedAttempt() {
return false;
}
@Override
public float timing() {
return timing;
}
@Override
public void timing(final long start) {
timing = Timing.millis(start);
}
@Override
public String taf() {
return tafName;
}
}
|
