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
|
/**
* ============LICENSE_START====================================================
* org.onap.aaf
* ===========================================================================
* Copyright (c) 2018 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.aaf.auth.rserv;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.onap.aaf.misc.env.Trans;
/**
* HTTP Code element, which responds to the essential "handle Method".
*
* Use Native HttpServletRe[quest|sponse] calls for questions like QueryParameters (getParameter, etc)
*
* Use local "pathParam" method to obtain in an optimized manner the path parameter, which must be interpreted by originating string
*
* i.e. my/path/:id/:other/*
*
* @author Jonathan
*
* @param <TRANS>
* @param <T>
*/
public abstract class HttpCode<TRANS extends Trans, CONTEXT> {
protected CONTEXT context;
private String desc;
protected String [] roles;
private boolean all;
// Package by design... Set by Route when linked
Match match;
public HttpCode(CONTEXT context, String description, String ... roles) {
this.context = context;
desc = description;
// Evaluate for "*" once...
all = false;
for (String srole : roles) {
if ("*".equals(srole)) {
all = true;
break;
}
}
this.roles = all?null:roles;
}
public abstract void handle(TRANS trans, HttpServletRequest req, HttpServletResponse resp) throws Exception;
public String desc() {
return desc;
}
/**
* Get the variable element out of the Path Parameter, as set by initial Code
*
* @param req
* @param key
* @return
*/
public String pathParam(HttpServletRequest req, String key) {
String rv = req.getParameter(key);
if (rv==null) {
rv = match.param(req.getPathInfo(), key);
if (rv!=null) {
rv = rv.trim();
if (rv.endsWith("/")) {
rv = rv.substring(0, rv.length()-1);
}
}
}
return rv;
}
// Note: get Query Params from Request
/**
* Check for Authorization when set.
*
* If no Roles set, then accepts all users
*
* @param req
* @return
*/
public boolean isAuthorized(HttpServletRequest req) {
if (all)return true;
if (roles!=null) {
for (String srole : roles) {
if (req.isUserInRole(srole)) return true;
}
}
return false;
}
public boolean noCache() {
return false;
}
public String toString() {
return desc;
}
}
|
