auth/auth-core/src/main/java/org/onap/aaf/auth/env/NullTrans.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   4  * ===========================================================================
   5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   6  * ===========================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END====================================================
  19  *
  20  */
  21
  22 package org.onap.aaf.auth.env;
  23
  24 import java.util.Date;
  25
  26 import javax.servlet.http.HttpServletRequest;
  27
  28 import org.onap.aaf.auth.org.Organization;
  29 import org.onap.aaf.cadi.Lur;
  30 import org.onap.aaf.cadi.Permission;
  31 import org.onap.aaf.cadi.principal.TaggedPrincipal;
  32 import org.onap.aaf.misc.env.Decryptor;
  33 import org.onap.aaf.misc.env.Encryptor;
  34 import org.onap.aaf.misc.env.LogTarget;
  35 import org.onap.aaf.misc.env.Slot;
  36 import org.onap.aaf.misc.env.StaticSlot;
  37 import org.onap.aaf.misc.env.TimeTaken;
  38
  39 /**
  40  * A NULL implementation of AuthzTrans, for use in DirectAAF Taf/Lurs
  41  */
  42 public class NullTrans implements AuthzTrans {
  43     private static final AuthzTrans singleton = new NullTrans();
  44
  45     public static final AuthzTrans singleton() {
  46         return singleton;
  47     }
  48
  49     private Date now;
  50
  51     public void checkpoint(String text) {}
  52     public void checkpoint(String text, int additionalFlag) {}
  53     public Metric auditTrail(int indent, StringBuilder sb, int... flag) {return null;}
  54
  55     @Override
  56     public Metric auditTrail(LogTarget lt, int indent, StringBuilder sb, int... flag) {
  57         return null;
  58     }
  59
  60     public LogTarget fatal() {
  61         return LogTarget.NULL;
  62     }
  63
  64     public LogTarget error() {
  65         return LogTarget.NULL;
  66     }
  67
  68     public LogTarget audit() {
  69         return LogTarget.NULL;
  70     }
  71
  72     /* (non-Javadoc)
  73      * @see com.att.env.Env#init()
  74      */
  75     @Override
  76     public LogTarget init() {
  77         return LogTarget.NULL;
  78     }
  79
  80     public LogTarget warn() {
  81         return LogTarget.NULL;
  82     }
  83
  84     public LogTarget info() {
  85         return LogTarget.NULL;
  86     }
  87
  88     public LogTarget debug() {
  89         return LogTarget.NULL;
  90     }
  91
  92     public LogTarget trace() {
  93         return LogTarget.NULL;
  94     }
  95
  96     @Override
  97     public TimeTaken start(String name, int flag, Object ... values) {
  98         return new TimeTaken(name,flag, values) {
  99             public void output(StringBuilder sb) {
 100                 sb.append(String.format(name,values));
 101                 sb.append(' ');
 102                 sb.append(millis());
 103                 sb.append("ms");
 104             }
 105         };
 106     }
 107
 108     @Override
 109     public String setProperty(String tag, String value) {
 110         return value;
 111     }
 112
 113     @Override
 114     public String getProperty(String tag) {
 115         return tag;
 116     }
 117
 118     @Override
 119     public String getProperty(String tag, String deflt) {
 120         return deflt;
 121     }
 122
 123     @Override
 124     public Decryptor decryptor() {
 125         return null;
 126     }
 127
 128     @Override
 129     public Encryptor encryptor() {
 130         return null;
 131     }
 132     @Override
 133     public AuthzTrans set(HttpServletRequest req) {
 134         return null;
 135     }
 136
 137     @Override
 138         public HttpServletRequest hreq() {
 139                 return null;
 140         }
 141
 142         @Override
 143     public String user() {
 144         return null;
 145     }
 146
 147     @Override
 148     public TaggedPrincipal getUserPrincipal() {
 149         return null;
 150     }
 151
 152     @Override
 153     public void setUser(TaggedPrincipal p) {
 154     }
 155
 156     @Override
 157     public String ip() {
 158         return null;
 159     }
 160
 161     @Override
 162     public int port() {
 163         return 0;
 164     }
 165     @Override
 166     public String meth() {
 167         return null;
 168     }
 169
 170     @Override
 171     public String path() {
 172         return null;
 173     }
 174
 175     @Override
 176     public void put(Slot slot, Object value) {
 177     }
 178     @Override
 179     public <T> T get(Slot slot, T deflt) {
 180         return null;
 181     }
 182     @Override
 183     public <T> T get(StaticSlot slot, T dflt) {
 184         return null;
 185     }
 186     @Override
 187     public Slot slot(String name) {
 188         return null;
 189     }
 190     @Override
 191     public AuthzEnv env() {
 192         return null;
 193     }
 194     @Override
 195     public String agent() {
 196         return null;
 197     }
 198
 199     @Override
 200     public void setLur(Lur lur) {
 201     }
 202
 203     @Override
 204     public boolean fish(Permission ... p) {
 205         return false;
 206     }
 207
 208     @Override
 209     public Organization org() {
 210         return Organization.NULL;
 211     }
 212
 213     @Override
 214     public void logAuditTrail(LogTarget lt) {
 215     }
 216
 217     /* (non-Javadoc)
 218      * @see org.onap.aaf.auth.env.test.AuthzTrans#requested(org.onap.aaf.auth.env.test.AuthzTrans.REQD_TYPE)
 219      */
 220     @Override
 221     public boolean requested(REQD_TYPE requested) {
 222         return false;
 223     }
 224
 225     /* (non-Javadoc)
 226      * @see org.onap.aaf.auth.env.test.AuthzTrans#requested(org.onap.aaf.auth.env.test.AuthzTrans.REQD_TYPE, boolean)
 227      */
 228     @Override
 229     public void requested(REQD_TYPE requested, boolean b) {
 230     }
 231
 232     @Override
 233     public Date now() {
 234         if (now==null) {
 235             now = new Date();
 236         }
 237         return now;
 238     }
 239 }
 240