2 * ============LICENSE_START====================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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====================================================
22 package org.onap.aaf.cadi.enduser.test;
24 import java.io.IOException;
25 import java.net.ConnectException;
26 import java.security.GeneralSecurityException;
27 import java.util.Date;
28 import java.util.GregorianCalendar;
30 import org.onap.aaf.cadi.Access.Level;
31 import org.onap.aaf.cadi.CadiException;
32 import org.onap.aaf.cadi.LocatorException;
33 import org.onap.aaf.cadi.PropAccess;
34 import org.onap.aaf.cadi.aaf.Defaults;
35 import org.onap.aaf.cadi.client.Future;
36 import org.onap.aaf.cadi.client.Rcli;
37 import org.onap.aaf.cadi.client.Result;
38 import org.onap.aaf.cadi.client.Retryable;
39 import org.onap.aaf.cadi.config.Config;
40 import org.onap.aaf.cadi.oauth.TimedToken;
41 import org.onap.aaf.cadi.oauth.TokenClient;
42 import org.onap.aaf.cadi.oauth.TokenClientFactory;
43 import org.onap.aaf.cadi.oauth.TzClient;
44 import org.onap.aaf.cadi.util.FQI;
45 import org.onap.aaf.misc.env.APIException;
46 import org.onap.aaf.misc.env.util.Chrono;
48 import aafoauth.v2_0.Introspect;
49 import aafoauth.v2_0.Token;
52 public class OnapClientExample {
53 private static TokenClientFactory tcf;
54 private static PropAccess access;
56 public final static void main(final String args[]) {
57 // These Objects are expected to be Long-Lived... Construct once
60 // This method will allow you to set "cadi_prop_files" (or any other property) on Command line
61 access = new PropAccess(args);
63 // access = PropAccess();
64 // Note: This style will load "cadi_prop_files" from VM Args
66 // Token aware Client Factory
68 tcf = TokenClientFactory.instance(access);
69 } catch (APIException | GeneralSecurityException | IOException | CadiException e1) {
70 access.log(e1, "Unable to setup OAuth Client Factory, Fail Fast");
74 final int CALL_TIMEOUT = Integer.parseInt(access.getProperty(Config.AAF_CALL_TIMEOUT,Config.AAF_CALL_TIMEOUT_DEF));
77 //////////////////////////////////////////////////////////////////////
79 // Get and use an OAuth Client, which understands Token Management
80 //////////////////////////////////////////////////////////////////////
81 // Create a Token Client, that gets its tokens from expected OAuth Server
82 // In this example, it is AAF, but it can be the Alternate OAuth
84 TokenClient tc = tcf.newClient(Config.AAF_OAUTH2_TOKEN_URL); // can set your own timeout here (url, timeoutMilliseconds)
86 // Here's a trick to get the namespace out of a Fully Qualified AAF Identity (your MechID)
87 String ns = FQI.reverseDomain(tc.client_id());
88 System.out.printf("\nNote: The AAF Namespace of FQI (Fully Qualified Identity) %s is %s\n\n",tc.client_id(), ns);
90 // Now, we can get a Token. Note: for "scope", use AAF Namespaces to get AAF Permissions embedded in
91 // Note: getToken checks if Token is expired, if so, then refreshes before handing back.
92 Result<TimedToken> rtt = tc.getToken(ns,"org.onap.test"); // get multiple scopes
94 // Note: you can clear a Token's Disk/Memory presence by
95 // 1) removing the Token from the "token/outgoing" directory on the O/S
96 // 2) programmatically by calling "clearToken" with exact params as "getToken", when it has the same credentials set
97 // tc.clearToken("org.onap.aaf","org.onap.test");
99 // Result Object can be queried for success
101 TimedToken token = rtt.value;
102 print(token); // Take a look at what's in a Token
104 // Use this Token in your client calls with "Tokenized Client" (TzClient)
105 // These should NOT be used cross thread.
106 // Get Hello Service URL... roll your own in your own world.
107 final String endServicesURL = access.getProperty(Config.AAF_OAUTH2_HELLO_URL,Defaults.HELLO_URL);
110 TzClient helloClient = tcf.newTzClient(endServicesURL);
111 helloClient.setToken(tc.client_id(), token);
113 // This client call style, "best" call with "Retryable" inner class covers finding an available Service
114 // (when Multi-services exist) for the best service, based (currently) on distance.
116 // the "Generic" in Type gives a Return Value for the Code, which you can set on the "best" method
117 // Note that variables used in the inner class from this part of the code must be "final", see "CALL_TIMEOUT"
118 String rv = helloClient.best(new Retryable<String>() {
120 public String code(Rcli<?> client) throws CadiException, ConnectException, APIException {
121 Future<String> future = client.read("hello","text/plain");
122 // The "future" calling method allows you to do other processing, such as call more than one backend
123 // client before picking up the result
124 // If "get" matches the HTTP Code for the method (i.e. read HTTP Return value is 200), then
125 if(future.get(CALL_TIMEOUT)) {
126 // Client Returned expected value
129 throw new APIException(future.code() + future.body());
134 // You want to do something with returned value. Here, we say "hello"
135 System.out.printf("\nPositive Response from Hello: %s\n",rv);
138 //////////////////////////////////////////////////////////////////////
140 // As a Service, read Introspection information as proof of Authenticated Authorization
141 //////////////////////////////////////////////////////////////////////
142 // CADI Framework (i.e. CadiFilter) works with the Introspection to drive the J2EE interfaces (
143 // i.e. if(isUserInRole("ns.perm|instance|action")) {...
145 // Here, however, is a way to introspect via Java
147 // now, call Introspect (making sure right URLs are set in properties)
148 // We need a Different Introspect TokenClient, because different Endpoint (and usually different Services)
149 TokenClient tci = tcf.newClient(Config.AAF_OAUTH2_INTROSPECT_URL);
150 Result<Introspect> is = tci.introspect(token.getAccessToken());
152 // Note that AAF will add JSON set of Permissions as part of "Content:", legitimate extension of OAuth Structure
153 print(is.value); // do something with Introspect Object
155 access.printf(Level.ERROR, "Unable to introspect OAuth Token %s: %d %s\n",
156 token.getAccessToken(),rtt.code,rtt.error);
159 access.printf(Level.ERROR, "Unable to obtain OAuth Token: %d %s\n",rtt.code,rtt.error);
162 } catch (CadiException | LocatorException | APIException | IOException e) {
167 /////////////////////////////////////////////////////////////
168 // Examples of Object Access
169 /////////////////////////////////////////////////////////////
170 private static void print(Token t) {
171 GregorianCalendar exp_date = new GregorianCalendar();
172 exp_date.add(GregorianCalendar.SECOND, t.getExpiresIn());
173 System.out.printf("Access Token\n\tToken:\t\t%s\n\tToken Type:\t%s\n\tExpires In:\t%d (%s)\n\tScope:\t\t%s\n\tRefresh Token:\t%s\n",
177 Chrono.timeStamp(new Date(System.currentTimeMillis()+(t.getExpiresIn()*1000))),
179 t.getRefreshToken());
182 private static void print(Introspect ti) {
183 if(ti==null || ti.getClientId()==null) {
184 System.out.println("Empty Introspect");
187 Date exp = new Date(ti.getExp()*1000); // seconds
188 System.out.printf("Introspect\n"
189 + "\tAccessToken:\t%s\n"
190 + "\tClient-id:\t%s\n"
191 + "\tClient Type:\t%s\n"
193 + "\tUserName:\t%s\n"
194 + "\tExpires: \t%d (%s)\n"
196 + "\tContent:\t%s\n",
200 ti.isActive()?Boolean.TRUE.toString():Boolean.FALSE.toString(),
203 Chrono.timeStamp(exp),
205 ti.getContent()==null?"":ti.getContent());
207 System.out.println();