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;
31 import org.onap.aaf.cadi.Access.Level;
32 import org.onap.aaf.cadi.CadiException;
33 import org.onap.aaf.cadi.LocatorException;
34 import org.onap.aaf.cadi.PropAccess;
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.configure.Agent;
41 import org.onap.aaf.cadi.oauth.TimedToken;
42 import org.onap.aaf.cadi.oauth.TokenClient;
43 import org.onap.aaf.cadi.oauth.TokenClientFactory;
44 import org.onap.aaf.cadi.oauth.TzClient;
45 import org.onap.aaf.cadi.util.FQI;
46 import org.onap.aaf.misc.env.APIException;
47 import org.onap.aaf.misc.env.util.Chrono;
49 import aafoauth.v2_0.Introspect;
50 import aafoauth.v2_0.Token;
53 public class OnapClientExample {
54 private static TokenClientFactory tcf;
55 private static PropAccess access;
57 public final static void main(final String args[]) {
58 // These Objects are expected to be Long-Lived... Construct once
61 // This method will allow you to set "cadi_prop_files" (or any other property) on Command line
62 access = new PropAccess(args);
63 // Note: This style will load "cadi_prop_files" from VM Args
64 // access = PropAccess();
66 Map<String, String> aaf_urls = Agent.loadURLs(access);
67 Agent.fillMissing(access, aaf_urls);
69 // Token aware Client Factory
70 tcf = TokenClientFactory.instance(access);
71 } catch (APIException | GeneralSecurityException | IOException | CadiException e1) {
72 access.log(e1, "Unable to setup OAuth Client Factory, Fail Fast");
76 final int CALL_TIMEOUT = Integer.parseInt(access.getProperty(Config.AAF_CALL_TIMEOUT,Config.AAF_CALL_TIMEOUT_DEF));
79 //////////////////////////////////////////////////////////////////////
81 // Get and use an OAuth Client, which understands Token Management
82 //////////////////////////////////////////////////////////////////////
83 // Create a Token Client, that gets its tokens from expected OAuth Server
84 // In this example, it is AAF, but it can be the Alternate OAuth
86 TokenClient tc = tcf.newClient(Config.AAF_OAUTH2_TOKEN_URL); // can set your own timeout here (url, timeoutMilliseconds)
88 // Here's a trick to get the namespace out of a Fully Qualified AAF Identity (your MechID)
89 String ns = FQI.reverseDomain(tc.client_id());
90 System.out.printf("\nNote: The AAF Namespace of FQI (Fully Qualified Identity) %s is %s\n\n",tc.client_id(), ns);
92 // Now, we can get a Token. Note: for "scope", use AAF Namespaces to get AAF Permissions embedded in
93 // Note: getToken checks if Token is expired, if so, then refreshes before handing back.
94 Result<TimedToken> rtt = tc.getToken(ns,"org.onap.test"); // get multiple scopes
96 // Note: you can clear a Token's Disk/Memory presence by
97 // 1) removing the Token from the "token/outgoing" directory on the O/S
98 // 2) programmatically by calling "clearToken" with exact params as "getToken", when it has the same credentials set
99 // tc.clearToken("org.onap.aaf","org.onap.test");
101 // Result Object can be queried for success
103 TimedToken token = rtt.value;
104 print(token); // Take a look at what's in a Token
106 // Use this Token in your client calls with "Tokenized Client" (TzClient)
107 // These should NOT be used cross thread.
108 // Get Hello Service URL... roll your own in your own world.
109 final String endServicesURL = access.getProperty(Config.AAF_OAUTH2_HELLO_URL);
112 TzClient helloClient = tcf.newTzClient(endServicesURL);
113 helloClient.setToken(tc.client_id(), token);
115 // This client call style, "best" call with "Retryable" inner class covers finding an available Service
116 // (when Multi-services exist) for the best service, based (currently) on distance.
118 // the "Generic" in Type gives a Return Value for the Code, which you can set on the "best" method
119 // Note that variables used in the inner class from this part of the code must be "final", see "CALL_TIMEOUT"
120 String rv = helloClient.best(new Retryable<String>() {
122 public String code(Rcli<?> client) throws CadiException, ConnectException, APIException {
123 Future<String> future = client.read("hello","text/plain");
124 // The "future" calling method allows you to do other processing, such as call more than one backend
125 // client before picking up the result
126 // If "get" matches the HTTP Code for the method (i.e. read HTTP Return value is 200), then
127 if (future.get(CALL_TIMEOUT)) {
128 // Client Returned expected value
131 throw new APIException(future.code() + future.body());
136 // You want to do something with returned value. Here, we say "hello"
137 System.out.printf("\nPositive Response from Hello: %s\n",rv);
140 //////////////////////////////////////////////////////////////////////
142 // As a Service, read Introspection information as proof of Authenticated Authorization
143 //////////////////////////////////////////////////////////////////////
144 // CADI Framework (i.e. CadiFilter) works with the Introspection to drive the J2EE interfaces (
145 // i.e. if (isUserInRole("ns.perm|instance|action")) {...
147 // Here, however, is a way to introspect via Java
149 // now, call Introspect (making sure right URLs are set in properties)
150 // We need a Different Introspect TokenClient, because different Endpoint (and usually different Services)
151 TokenClient tci = tcf.newClient(Config.AAF_OAUTH2_INTROSPECT_URL);
152 Result<Introspect> is = tci.introspect(token.getAccessToken());
154 // Note that AAF will add JSON set of Permissions as part of "Content:", legitimate extension of OAuth Structure
155 print(is.value); // do something with Introspect Object
157 access.printf(Level.ERROR, "Unable to introspect OAuth Token %s: %d %s\n",
158 token.getAccessToken(),rtt.code,rtt.error);
161 access.printf(Level.ERROR, "Unable to obtain OAuth Token: %d %s\n",rtt.code,rtt.error);
164 } catch (CadiException | LocatorException | APIException | IOException e) {
169 /////////////////////////////////////////////////////////////
170 // Examples of Object Access
171 /////////////////////////////////////////////////////////////
172 private static void print(Token t) {
173 GregorianCalendar exp_date = new GregorianCalendar();
174 exp_date.add(GregorianCalendar.SECOND, t.getExpiresIn());
175 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",
179 Chrono.timeStamp(new Date(System.currentTimeMillis()+(t.getExpiresIn()*1000))),
181 t.getRefreshToken());
184 private static void print(Introspect ti) {
185 if (ti==null || ti.getClientId()==null) {
186 System.out.println("Empty Introspect");
189 Date exp = new Date(ti.getExp()*1000); // seconds
190 System.out.printf("Introspect\n"
191 + "\tAccessToken:\t%s\n"
192 + "\tClient-id:\t%s\n"
193 + "\tClient Type:\t%s\n"
195 + "\tUserName:\t%s\n"
196 + "\tExpires: \t%d (%s)\n"
198 + "\tContent:\t%s\n",
202 ti.isActive()?Boolean.TRUE.toString():Boolean.FALSE.toString(),
205 Chrono.timeStamp(exp),
207 ti.getContent()==null?"":ti.getContent());
209 System.out.println();