1 /*******************************************************************************
\r
2 * ============LICENSE_START====================================================
\r
4 * * ===========================================================================
\r
5 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
\r
6 * * Copyright © 2017 Amdocs
\r
7 * * ===========================================================================
\r
8 * * Licensed under the Apache License, Version 2.0 (the "License");
\r
9 * * you may not use this file except in compliance with the License.
\r
10 * * You may obtain a copy of the License at
\r
12 * * http://www.apache.org/licenses/LICENSE-2.0
\r
14 * * Unless required by applicable law or agreed to in writing, software
\r
15 * * distributed under the License is distributed on an "AS IS" BASIS,
\r
16 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
17 * * See the License for the specific language governing permissions and
\r
18 * * limitations under the License.
\r
19 * * ============LICENSE_END====================================================
\r
21 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
\r
23 ******************************************************************************/
\r
24 package com.att.cssa.rserv;
\r
26 import javax.servlet.http.HttpServletRequest;
\r
27 import javax.servlet.http.HttpServletResponse;
\r
29 import com.att.inno.env.Trans;
\r
32 * HTTP Code element, which responds to the essential "handle Method".
\r
34 * Use Native HttpServletRe[quest|sponse] calls for questions like QueryParameters (getParameter, etc)
\r
36 * Use local "pathParam" method to obtain in an optimized manner the path parameter, which must be interpreted by originating string
\r
38 * i.e. my/path/:id/:other/*
\r
44 public abstract class HttpCode<TRANS extends Trans, CONTEXT> {
\r
45 protected CONTEXT context;
\r
46 private String desc;
\r
47 protected String [] roles;
\r
48 private boolean all;
\r
50 // Package by design... Set by Route when linked
\r
53 public HttpCode(CONTEXT context, String description, String ... roles) {
\r
54 this.context = context;
\r
57 // Evaluate for "*" once...
\r
59 for(String srole : roles) {
\r
60 if("*".equals(srole)) {
\r
65 this.roles = all?null:roles;
\r
68 public abstract void handle(TRANS trans, HttpServletRequest req, HttpServletResponse resp) throws Exception;
\r
70 public String desc() {
\r
75 * Get the variable element out of the Path Parameter, as set by initial Code
\r
81 public String pathParam(HttpServletRequest req, String key) {
\r
82 return match.param(req.getPathInfo(), key);
\r
85 // Note: get Query Params from Request
\r
88 * Check for Authorization when set.
\r
90 * If no Roles set, then accepts all users
\r
95 public boolean isAuthorized(HttpServletRequest req) {
\r
98 for(String srole : roles) {
\r
99 if(req.isUserInRole(srole)) return true;
\r
105 public boolean no_cache() {
\r
109 public String toString() {
\r