aboutsummaryrefslogtreecommitdiffstats
path: root/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/authz/impl/package.html
blob: 0d051db325d0262185b8874df009422272681fc8 (plain)
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
#-------------------------------------------------------------------------------
# ============LICENSE_START==================================================
# * org.onap.dmaap
# * ===========================================================================
# * Copyright � 2017 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====================================================
# *
# * ECOMP is a trademark and service mark of AT&T Intellectual Property.
# *
#-------------------------------------------------------------------------------

<html>
<head>
</head>
<body>
<p>
This package provides an implementation of the authorization-related interfaces 
defined by the <code>org.onap.dmaap.datarouter.authz</code> package, intended for
use with the provisioning server for Data Router Release 1.   In DR R1, we do not
have an external policy engine, so this implementation performs the authorization
locally.
</p>
<p>
In order to perform the authorization, this package needs access to provisioning data 
about feeds and subscriptions.  This package defines an interface
(<code>org.onap.dmaap.datarouter.authz.impl.ProvDataProvider</code>) through which it
expects to get this data.   The provisioning server code must provide an implementation
of this interface.
</p>
<p>
A software component that wishes to use this implementation must:
<ul>
<li>Provide an implementation of the 
<code>org.onap.dmaap.datarouter.authz.impl.ProvDataProvider</code>
interface.
</li>
<li>
Create an instance of the <code>ProvDataProvider</code> implementation.
<li>
Create an instance of the
<code>org.onap.dmaap.datarouter.authz.impl.ProvAuthorizer</code>
class defined in this package, passing it an instance of the <code>ProvDataProvider</code>
implementation.
</li>
</ul>
</p>
<p>
Example:
<pre>
<code>
ProvDataProvider dataProv = new MyDataProvider();
Authorizer authz = new ProvAuthorizer(dataProv);
</code>
</pre>
</body>
</html>