Compare commits
88 Commits
Author | SHA1 | Date | |
---|---|---|---|
eb7ac34f5e | |||
b7ac0d25c9 | |||
271016dcf9 | |||
00ec8c972d | |||
2cd9cc9484 | |||
d4cd2f248c | |||
ac6f82a7f4 | |||
eb654c5488 | |||
0258cfcb9a | |||
6fc43b85f7 | |||
d29ccbef79 | |||
512f118354 | |||
21255bfb3d | |||
f84279a148 | |||
f10fd39e97 | |||
eaed628f00 | |||
44e82b3a6b | |||
ab920aedd7 | |||
ab6b0d8da7 | |||
c25988fc8f | |||
cd278bcc81 | |||
b64c408029 | |||
9a9a958913 | |||
37e8b63179 | |||
255a9c8e85 | |||
ec6e7cc15d | |||
2451c634b7 | |||
bcb7d4a7ed | |||
ed00346e71 | |||
c001576b65 | |||
8b13f06667 | |||
964cec0fb5 | |||
fe2e04f3af | |||
6cb7afd9f1 | |||
b1f0ba6d57 | |||
5df5388bd2 | |||
b6079a230d | |||
91398d23a4 | |||
5cda622082 | |||
e1191abaaa | |||
9dfd72c12e | |||
67ea4b72b3 | |||
a574154c20 | |||
5f4a56cd0e | |||
b1b19d8cb0 | |||
78ccdb5713 | |||
53d9c7381d | |||
3a003eff29 | |||
b2272e181c | |||
160766e0ef | |||
e167ac43cc | |||
e398099c15 | |||
a28fc13161 | |||
52c7e3cf6d | |||
b4d7d2a154 | |||
95730a9440 | |||
bd7413bb48 | |||
75c518801f | |||
556909f2e9 | |||
6fd42a8daf | |||
aea7a0d035 | |||
d3f10e4c00 | |||
b3bc04467b | |||
88c8657a34 | |||
2c4f4f7285 | |||
28b2478a08 | |||
dc63abc272 | |||
23c76c4bcf | |||
dd5d0f504a | |||
eaa55fa48e | |||
34d03a91e5 | |||
d62a941e64 | |||
2584b8d668 | |||
a756b05f6c | |||
4f9e4eaa4d | |||
2e0c98911e | |||
b91321c6f3 | |||
853b4e66cf | |||
97af0a0698 | |||
f2032df0f3 | |||
824b58bc13 | |||
41b7ee255a | |||
8d3f4559bd | |||
3f476bba5c | |||
5564513134 | |||
6292dde23b | |||
659f71c72c | |||
29214000c8 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -2,6 +2,9 @@
|
|||||||
target
|
target
|
||||||
pom.xml.versionsBackup
|
pom.xml.versionsBackup
|
||||||
|
|
||||||
|
# Maven Invoker
|
||||||
|
build.log
|
||||||
|
|
||||||
# Eclipse
|
# Eclipse
|
||||||
.project
|
.project
|
||||||
.classpath
|
.classpath
|
||||||
|
157
COPYING.LESSER.md
Normal file
157
COPYING.LESSER.md
Normal file
@@ -0,0 +1,157 @@
|
|||||||
|
### GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc.
|
||||||
|
<https://fsf.org/>
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates the
|
||||||
|
terms and conditions of version 3 of the GNU General Public License,
|
||||||
|
supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
#### 0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the
|
||||||
|
GNU General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License, other
|
||||||
|
than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
#### 1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
#### 2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
- a) under this License, provided that you make a good faith effort
|
||||||
|
to ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
- b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
#### 3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from a
|
||||||
|
header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
- a) Give prominent notice with each copy of the object code that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
- b) Accompany the object code with a copy of the GNU GPL and this
|
||||||
|
license document.
|
||||||
|
|
||||||
|
#### 4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that, taken
|
||||||
|
together, effectively do not restrict modification of the portions of
|
||||||
|
the Library contained in the Combined Work and reverse engineering for
|
||||||
|
debugging such modifications, if you also do each of the following:
|
||||||
|
|
||||||
|
- a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
- b) Accompany the Combined Work with a copy of the GNU GPL and this
|
||||||
|
license document.
|
||||||
|
- c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
- d) Do one of the following:
|
||||||
|
- 0) Convey the Minimal Corresponding Source under the terms of
|
||||||
|
this License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
- 1) Use a suitable shared library mechanism for linking with
|
||||||
|
the Library. A suitable mechanism is one that (a) uses at run
|
||||||
|
time a copy of the Library already present on the user's
|
||||||
|
computer system, and (b) will operate properly with a modified
|
||||||
|
version of the Library that is interface-compatible with the
|
||||||
|
Linked Version.
|
||||||
|
- e) Provide Installation Information, but only if you would
|
||||||
|
otherwise be required to provide such information under section 6
|
||||||
|
of the GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the Application
|
||||||
|
with a modified version of the Linked Version. (If you use option
|
||||||
|
4d0, the Installation Information must accompany the Minimal
|
||||||
|
Corresponding Source and Corresponding Application Code. If you
|
||||||
|
use option 4d1, you must provide the Installation Information in
|
||||||
|
the manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.)
|
||||||
|
|
||||||
|
#### 5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the Library
|
||||||
|
side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
- a) Accompany the combined library with a copy of the same work
|
||||||
|
based on the Library, uncombined with any other library
|
||||||
|
facilities, conveyed under the terms of this License.
|
||||||
|
- b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
#### 6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Library
|
||||||
|
as you received it specifies that a certain numbered version of the
|
||||||
|
GNU Lesser General Public License "or any later version" applies to
|
||||||
|
it, you have the option of following the terms and conditions either
|
||||||
|
of that published version or of any later version published by the
|
||||||
|
Free Software Foundation. If the Library as you received it does not
|
||||||
|
specify a version number of the GNU Lesser General Public License, you
|
||||||
|
may choose any version of the GNU Lesser General Public License ever
|
||||||
|
published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
675
COPYING.md
Normal file
675
COPYING.md
Normal file
@@ -0,0 +1,675 @@
|
|||||||
|
### GNU GENERAL PUBLIC LICENSE
|
||||||
|
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc.
|
||||||
|
<https://fsf.org/>
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
### Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom
|
||||||
|
to share and change all versions of a program--to make sure it remains
|
||||||
|
free software for all its users. We, the Free Software Foundation, use
|
||||||
|
the GNU General Public License for most of our software; it applies
|
||||||
|
also to any other work released this way by its authors. You can apply
|
||||||
|
it to your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you
|
||||||
|
have certain responsibilities if you distribute copies of the
|
||||||
|
software, or if you modify it: responsibilities to respect the freedom
|
||||||
|
of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the
|
||||||
|
manufacturer can do so. This is fundamentally incompatible with the
|
||||||
|
aim of protecting users' freedom to change the software. The
|
||||||
|
systematic pattern of such abuse occurs in the area of products for
|
||||||
|
individuals to use, which is precisely where it is most unacceptable.
|
||||||
|
Therefore, we have designed this version of the GPL to prohibit the
|
||||||
|
practice for those products. If such problems arise substantially in
|
||||||
|
other domains, we stand ready to extend this provision to those
|
||||||
|
domains in future versions of the GPL, as needed to protect the
|
||||||
|
freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish
|
||||||
|
to avoid the special danger that patents applied to a free program
|
||||||
|
could make it effectively proprietary. To prevent this, the GPL
|
||||||
|
assures that patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
### TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
#### 0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds
|
||||||
|
of works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of
|
||||||
|
an exact copy. The resulting work is called a "modified version" of
|
||||||
|
the earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user
|
||||||
|
through a computer network, with no transfer of a copy, is not
|
||||||
|
conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices" to
|
||||||
|
the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
#### 1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work for
|
||||||
|
making modifications to it. "Object code" means any non-source form of
|
||||||
|
a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users can
|
||||||
|
regenerate automatically from other parts of the Corresponding Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that same
|
||||||
|
work.
|
||||||
|
|
||||||
|
#### 2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not convey,
|
||||||
|
without conditions so long as your license otherwise remains in force.
|
||||||
|
You may convey covered works to others for the sole purpose of having
|
||||||
|
them make modifications exclusively for you, or provide you with
|
||||||
|
facilities for running those works, provided that you comply with the
|
||||||
|
terms of this License in conveying all material for which you do not
|
||||||
|
control copyright. Those thus making or running the covered works for
|
||||||
|
you must do so exclusively on your behalf, under your direction and
|
||||||
|
control, on terms that prohibit them from making any copies of your
|
||||||
|
copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under the
|
||||||
|
conditions stated below. Sublicensing is not allowed; section 10 makes
|
||||||
|
it unnecessary.
|
||||||
|
|
||||||
|
#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such
|
||||||
|
circumvention is effected by exercising rights under this License with
|
||||||
|
respect to the covered work, and you disclaim any intention to limit
|
||||||
|
operation or modification of the work as a means of enforcing, against
|
||||||
|
the work's users, your or third parties' legal rights to forbid
|
||||||
|
circumvention of technological measures.
|
||||||
|
|
||||||
|
#### 4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
#### 5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these
|
||||||
|
conditions:
|
||||||
|
|
||||||
|
- a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
- b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under
|
||||||
|
section 7. This requirement modifies the requirement in section 4
|
||||||
|
to "keep intact all notices".
|
||||||
|
- c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
- d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
#### 6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms of
|
||||||
|
sections 4 and 5, provided that you also convey the machine-readable
|
||||||
|
Corresponding Source under the terms of this License, in one of these
|
||||||
|
ways:
|
||||||
|
|
||||||
|
- a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
- b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the Corresponding
|
||||||
|
Source from a network server at no charge.
|
||||||
|
- c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
- d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
- e) Convey the object code using peer-to-peer transmission,
|
||||||
|
provided you inform other peers where the object code and
|
||||||
|
Corresponding Source of the work are being offered to the general
|
||||||
|
public at no charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal,
|
||||||
|
family, or household purposes, or (2) anything designed or sold for
|
||||||
|
incorporation into a dwelling. In determining whether a product is a
|
||||||
|
consumer product, doubtful cases shall be resolved in favor of
|
||||||
|
coverage. For a particular product received by a particular user,
|
||||||
|
"normally used" refers to a typical or common use of that class of
|
||||||
|
product, regardless of the status of the particular user or of the way
|
||||||
|
in which the particular user actually uses, or expects or is expected
|
||||||
|
to use, the product. A product is a consumer product regardless of
|
||||||
|
whether the product has substantial commercial, industrial or
|
||||||
|
non-consumer uses, unless such uses represent the only significant
|
||||||
|
mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to
|
||||||
|
install and execute modified versions of a covered work in that User
|
||||||
|
Product from a modified version of its Corresponding Source. The
|
||||||
|
information must suffice to ensure that the continued functioning of
|
||||||
|
the modified object code is in no case prevented or interfered with
|
||||||
|
solely because modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or
|
||||||
|
updates for a work that has been modified or installed by the
|
||||||
|
recipient, or for the User Product in which it has been modified or
|
||||||
|
installed. Access to a network may be denied when the modification
|
||||||
|
itself materially and adversely affects the operation of the network
|
||||||
|
or violates the rules and protocols for communication across the
|
||||||
|
network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
#### 7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders
|
||||||
|
of that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
- a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
- b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
- c) Prohibiting misrepresentation of the origin of that material,
|
||||||
|
or requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
- d) Limiting the use for publicity purposes of names of licensors
|
||||||
|
or authors of the material; or
|
||||||
|
- e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
- f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions
|
||||||
|
of it) with contractual assumptions of liability to the recipient,
|
||||||
|
for any liability that these contractual assumptions directly
|
||||||
|
impose on those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions; the
|
||||||
|
above requirements apply either way.
|
||||||
|
|
||||||
|
#### 8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your license
|
||||||
|
from a particular copyright holder is reinstated (a) provisionally,
|
||||||
|
unless and until the copyright holder explicitly and finally
|
||||||
|
terminates your license, and (b) permanently, if the copyright holder
|
||||||
|
fails to notify you of the violation by some reasonable means prior to
|
||||||
|
60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
#### 9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or run
|
||||||
|
a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
#### 10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
#### 11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims owned
|
||||||
|
or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within the
|
||||||
|
scope of its coverage, prohibits the exercise of, or is conditioned on
|
||||||
|
the non-exercise of one or more of the rights that are specifically
|
||||||
|
granted under this License. You may not convey a covered work if you
|
||||||
|
are a party to an arrangement with a third party that is in the
|
||||||
|
business of distributing software, under which you make payment to the
|
||||||
|
third party based on the extent of your activity of conveying the
|
||||||
|
work, and under which the third party grants, to any of the parties
|
||||||
|
who would receive the covered work from you, a discriminatory patent
|
||||||
|
license (a) in connection with copies of the covered work conveyed by
|
||||||
|
you (or copies made from those copies), or (b) primarily for and in
|
||||||
|
connection with specific products or compilations that contain the
|
||||||
|
covered work, unless you entered into that arrangement, or that patent
|
||||||
|
license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
#### 12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under
|
||||||
|
this License and any other pertinent obligations, then as a
|
||||||
|
consequence you may not convey it at all. For example, if you agree to
|
||||||
|
terms that obligate you to collect a royalty for further conveying
|
||||||
|
from those to whom you convey the Program, the only way you could
|
||||||
|
satisfy both those terms and this License would be to refrain entirely
|
||||||
|
from conveying the Program.
|
||||||
|
|
||||||
|
#### 13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
#### 14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in
|
||||||
|
detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Program
|
||||||
|
specifies that a certain numbered version of the GNU General Public
|
||||||
|
License "or any later version" applies to it, you have the option of
|
||||||
|
following the terms and conditions either of that numbered version or
|
||||||
|
of any later version published by the Free Software Foundation. If the
|
||||||
|
Program does not specify a version number of the GNU General Public
|
||||||
|
License, you may choose any version ever published by the Free
|
||||||
|
Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future versions
|
||||||
|
of the GNU General Public License can be used, that proxy's public
|
||||||
|
statement of acceptance of a version permanently authorizes you to
|
||||||
|
choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
#### 15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
||||||
|
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
||||||
|
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
||||||
|
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
||||||
|
CORRECTION.
|
||||||
|
|
||||||
|
#### 16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
||||||
|
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
||||||
|
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
||||||
|
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
||||||
|
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
||||||
|
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
||||||
|
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
|
#### 17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
### How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these
|
||||||
|
terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest to
|
||||||
|
attach them to the start of each source file to most effectively state
|
||||||
|
the exclusion of warranty; and each file should have at least the
|
||||||
|
"copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper
|
||||||
|
mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands \`show w' and \`show c' should show the
|
||||||
|
appropriate parts of the General Public License. Of course, your
|
||||||
|
program's commands might be different; for a GUI interface, you would
|
||||||
|
use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or
|
||||||
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
|
necessary. For more information on this, and how to apply and follow
|
||||||
|
the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your
|
||||||
|
program into proprietary programs. If your program is a subroutine
|
||||||
|
library, you may consider it more useful to permit linking proprietary
|
||||||
|
applications with the library. If this is what you want to do, use the
|
||||||
|
GNU Lesser General Public License instead of this License. But first,
|
||||||
|
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
|
26
README.md
Normal file
26
README.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
|
||||||
|
# Common ReST Client Library
|
||||||
|
|
||||||
|
This project provides a library for Spring and POJO-based REST client instantiation.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
First, you will need to include the library in your project.
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<project>
|
||||||
|
...
|
||||||
|
<dependencies>
|
||||||
|
...
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.inteligr8</groupId>
|
||||||
|
<artifactId>common-rest-client</artifactId>
|
||||||
|
<version>...</version>
|
||||||
|
</dependency>
|
||||||
|
...
|
||||||
|
</dependencies>
|
||||||
|
...
|
||||||
|
</project>
|
||||||
|
```
|
||||||
|
|
||||||
|
See the `cxf` and `jersey` branches for examples and more documentation.
|
193
pom.xml
193
pom.xml
@@ -1,24 +1,59 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
<groupId>com.inteligr8</groupId>
|
<groupId>com.inteligr8</groupId>
|
||||||
<artifactId>common-rest-api</artifactId>
|
<artifactId>common-rest-client</artifactId>
|
||||||
<version>1.0.0</version>
|
<version>3.0.0</version>
|
||||||
|
<packaging>jar</packaging>
|
||||||
|
|
||||||
<name>ReST API Client for Java</name>
|
<name>ReST API Client for Java</name>
|
||||||
|
<description>A common library for building REST API clients</description>
|
||||||
|
<url>https://bitbucket.org/inteligr8/common-rest-client</url>
|
||||||
|
|
||||||
|
<licenses>
|
||||||
|
<license>
|
||||||
|
<name>GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007</name>
|
||||||
|
<url>https://www.gnu.org/licenses/lgpl-3.0.txt</url>
|
||||||
|
</license>
|
||||||
|
</licenses>
|
||||||
|
|
||||||
|
<scm>
|
||||||
|
<connection>scm:git:https://bitbucket.org/inteligr8/common-rest-client.git</connection>
|
||||||
|
<developerConnection>scm:git:git@bitbucket.org:inteligr8/common-rest-client.git</developerConnection>
|
||||||
|
<url>https://bitbucket.org/inteligr8/common-rest-client</url>
|
||||||
|
</scm>
|
||||||
|
<organization>
|
||||||
|
<name>Inteligr8</name>
|
||||||
|
<url>https://www.inteligr8.com</url>
|
||||||
|
</organization>
|
||||||
|
<developers>
|
||||||
|
<developer>
|
||||||
|
<id>brian.long</id>
|
||||||
|
<name>Brian Long</name>
|
||||||
|
<email>brian@inteligr8.com</email>
|
||||||
|
<url>https://twitter.com/brianmlong</url>
|
||||||
|
</developer>
|
||||||
|
</developers>
|
||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
<project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
|
<project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
|
||||||
<maven.compiler.source>8</maven.compiler.source>
|
<maven.compiler.source>11</maven.compiler.source>
|
||||||
<maven.compiler.target>8</maven.compiler.target>
|
<maven.compiler.target>11</maven.compiler.target>
|
||||||
|
|
||||||
<junit.version>5.7.2</junit.version>
|
<junit.version>5.10.0</junit.version>
|
||||||
<spring.version>5.2.14.RELEASE</spring.version>
|
<spring.version>6.0.19</spring.version>
|
||||||
<jersey.version>2.34</jersey.version>
|
<jackson.version>2.17.2</jackson.version>
|
||||||
<cxf.version>3.3.2</cxf.version>
|
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>jakarta.annotation</groupId>
|
||||||
|
<artifactId>jakarta.annotation-api</artifactId>
|
||||||
|
<version>2.1.1</version>
|
||||||
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework</groupId>
|
<groupId>org.springframework</groupId>
|
||||||
<artifactId>spring-context</artifactId>
|
<artifactId>spring-context</artifactId>
|
||||||
@@ -27,52 +62,32 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.fasterxml.jackson.core</groupId>
|
<groupId>com.fasterxml.jackson.core</groupId>
|
||||||
<artifactId>jackson-databind</artifactId>
|
<artifactId>jackson-databind</artifactId>
|
||||||
<version>2.12.2</version>
|
<version>${jackson.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.fasterxml.jackson.jaxrs</groupId>
|
<groupId>com.fasterxml.jackson.jakarta.rs</groupId>
|
||||||
<artifactId>jackson-jaxrs-json-provider</artifactId>
|
<artifactId>jackson-jakarta-rs-json-provider</artifactId>
|
||||||
<version>2.12.2</version>
|
<version>${jackson.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.fasterxml.jackson.datatype</groupId>
|
||||||
|
<artifactId>jackson-datatype-jsr310</artifactId>
|
||||||
|
<version>${jackson.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.apache.commons</groupId>
|
||||||
|
<artifactId>commons-lang3</artifactId>
|
||||||
|
<version>3.14.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.slf4j</groupId>
|
<groupId>org.slf4j</groupId>
|
||||||
<artifactId>slf4j-api</artifactId>
|
<artifactId>slf4j-api</artifactId>
|
||||||
<version>1.7.29</version>
|
<version>2.0.13</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>jakarta.ws.rs</groupId>
|
<groupId>jakarta.ws.rs</groupId>
|
||||||
<artifactId>jakarta.ws.rs-api</artifactId>
|
<artifactId>jakarta.ws.rs-api</artifactId>
|
||||||
<version>2.1.6</version>
|
<version>3.1.0</version>
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.glassfish.jersey.ext</groupId>
|
|
||||||
<artifactId>jersey-proxy-client</artifactId>
|
|
||||||
<version>${jersey.version}</version>
|
|
||||||
<scope>provided</scope>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.apache.cxf</groupId>
|
|
||||||
<artifactId>cxf-rt-rs-client</artifactId>
|
|
||||||
<version>${cxf.version}</version>
|
|
||||||
<scope>provided</scope>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.glassfish.jersey.core</groupId>
|
|
||||||
<artifactId>jersey-client</artifactId>
|
|
||||||
<version>${jersey.version}</version>
|
|
||||||
<scope>test</scope>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.glassfish.jersey.inject</groupId>
|
|
||||||
<artifactId>jersey-hk2</artifactId>
|
|
||||||
<version>${jersey.version}</version>
|
|
||||||
<scope>test</scope>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.glassfish.jersey.media</groupId>
|
|
||||||
<artifactId>jersey-media-json-jackson</artifactId>
|
|
||||||
<version>${jersey.version}</version>
|
|
||||||
<scope>test</scope>
|
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.junit.jupiter</groupId>
|
<groupId>org.junit.jupiter</groupId>
|
||||||
@@ -89,7 +104,7 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.apache.httpcomponents</groupId>
|
<groupId>org.apache.httpcomponents</groupId>
|
||||||
<artifactId>httpclient</artifactId>
|
<artifactId>httpclient</artifactId>
|
||||||
<version>4.5.9</version>
|
<version>4.5.14</version>
|
||||||
<scope>test</scope>
|
<scope>test</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
@@ -98,7 +113,7 @@
|
|||||||
<plugins>
|
<plugins>
|
||||||
<plugin>
|
<plugin>
|
||||||
<artifactId>maven-surefire-plugin</artifactId>
|
<artifactId>maven-surefire-plugin</artifactId>
|
||||||
<version>3.0.0-M5</version>
|
<version>3.1.0</version>
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.junit.jupiter</groupId>
|
<groupId>org.junit.jupiter</groupId>
|
||||||
@@ -109,7 +124,7 @@
|
|||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
<plugin>
|
||||||
<artifactId>maven-failsafe-plugin</artifactId>
|
<artifactId>maven-failsafe-plugin</artifactId>
|
||||||
<version>3.0.0-M5</version>
|
<version>3.1.0</version>
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.junit.jupiter</groupId>
|
<groupId>org.junit.jupiter</groupId>
|
||||||
@@ -118,25 +133,69 @@
|
|||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
|
||||||
<groupId>io.repaint.maven</groupId>
|
|
||||||
<artifactId>tiles-maven-plugin</artifactId>
|
|
||||||
<version>2.21</version>
|
|
||||||
<extensions>true</extensions>
|
|
||||||
<configuration>
|
|
||||||
<filtering>true</filtering>
|
|
||||||
<tiles>
|
|
||||||
<tile>com.inteligr8:maven-public-deploy-tile:[1.0.0,2.0.0)</tile>
|
|
||||||
</tiles>
|
|
||||||
</configuration>
|
|
||||||
</plugin>
|
|
||||||
</plugins>
|
</plugins>
|
||||||
</build>
|
</build>
|
||||||
|
|
||||||
<pluginRepositories>
|
<profiles>
|
||||||
<pluginRepository>
|
<profile>
|
||||||
<id>inteligr8-releases</id>
|
<id>ossrh-release</id>
|
||||||
<url>http://repos.inteligr8.com/nexus/repository/inteligr8-public</url>
|
<properties>
|
||||||
</pluginRepository>
|
<maven.deploy.skip>true</maven.deploy.skip>
|
||||||
</pluginRepositories>
|
</properties>
|
||||||
</project>
|
<build>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<artifactId>maven-source-plugin</artifactId>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>source</id>
|
||||||
|
<phase>package</phase>
|
||||||
|
<goals><goal>jar-no-fork</goal></goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<artifactId>maven-javadoc-plugin</artifactId>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>javadoc</id>
|
||||||
|
<phase>package</phase>
|
||||||
|
<goals><goal>jar</goal></goals>
|
||||||
|
<configuration>
|
||||||
|
<show>public</show>
|
||||||
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<artifactId>maven-gpg-plugin</artifactId>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>sign</id>
|
||||||
|
<phase>verify</phase>
|
||||||
|
<goals><goal>sign</goal></goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.sonatype.plugins</groupId>
|
||||||
|
<artifactId>nexus-staging-maven-plugin</artifactId>
|
||||||
|
<version>1.6.13</version>
|
||||||
|
<configuration>
|
||||||
|
<serverId>ossrh</serverId>
|
||||||
|
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
|
||||||
|
<autoReleaseAfterClose>true</autoReleaseAfterClose>
|
||||||
|
</configuration>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>ossrh-deploy</id>
|
||||||
|
<phase>deploy</phase>
|
||||||
|
<goals><goal>deploy</goal></goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
</profile>
|
||||||
|
</profiles>
|
||||||
|
</project>
|
||||||
|
@@ -1,20 +0,0 @@
|
|||||||
package com.inteligr8.rs;
|
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientRequestContext;
|
|
||||||
import javax.ws.rs.client.ClientRequestFilter;
|
|
||||||
import javax.ws.rs.core.HttpHeaders;
|
|
||||||
|
|
||||||
public class AccessTokenRequestFilter implements ClientRequestFilter {
|
|
||||||
|
|
||||||
private final String token;
|
|
||||||
|
|
||||||
public AccessTokenRequestFilter(String token) {
|
|
||||||
this.token = token;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void filter(ClientRequestContext requestContext) {
|
|
||||||
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.token);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
27
src/main/java/com/inteligr8/rs/AuthorizationFilter.java
Executable file
27
src/main/java/com/inteligr8/rs/AuthorizationFilter.java
Executable file
@@ -0,0 +1,27 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.client.ClientRequestFilter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is a marker that allows the developer to segregate, restrict, or limit
|
||||||
|
* authorization specific implementations of the ClientRequestFilter.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public interface AuthorizationFilter extends ClientRequestFilter {
|
||||||
|
|
||||||
|
}
|
@@ -1,28 +0,0 @@
|
|||||||
package com.inteligr8.rs;
|
|
||||||
|
|
||||||
import java.io.UnsupportedEncodingException;
|
|
||||||
import java.util.Base64;
|
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientRequestContext;
|
|
||||||
import javax.ws.rs.client.ClientRequestFilter;
|
|
||||||
import javax.ws.rs.core.HttpHeaders;
|
|
||||||
|
|
||||||
public class BasicAuthRequestFilter implements ClientRequestFilter {
|
|
||||||
|
|
||||||
private final String username;
|
|
||||||
private final String password;
|
|
||||||
|
|
||||||
public BasicAuthRequestFilter(String username, String password) {
|
|
||||||
this.username = username;
|
|
||||||
this.password = password;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void filter(ClientRequestContext requestContext) throws UnsupportedEncodingException {
|
|
||||||
String userAndPass = this.username + ":" + this.password;
|
|
||||||
String userAndPassEncoded = Base64.getEncoder().encodeToString(userAndPass.getBytes("utf-8"));
|
|
||||||
|
|
||||||
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Basic " + userAndPassEncoded);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
59
src/main/java/com/inteligr8/rs/BasicAuthorizationFilter.java
Executable file
59
src/main/java/com/inteligr8/rs/BasicAuthorizationFilter.java
Executable file
@@ -0,0 +1,59 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import java.io.UnsupportedEncodingException;
|
||||||
|
import java.util.Base64;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
|
import jakarta.ws.rs.core.HttpHeaders;
|
||||||
|
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class implements a simple 2-credential (username & password) based
|
||||||
|
* authorization filter.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class BasicAuthorizationFilter implements AuthorizationFilter {
|
||||||
|
|
||||||
|
private final String username;
|
||||||
|
private final String password;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param username A username or access key.
|
||||||
|
* @param password A password or secret key.
|
||||||
|
*/
|
||||||
|
public BasicAuthorizationFilter(String username, String password) {
|
||||||
|
this.username = StringUtils.trimToNull(username);
|
||||||
|
this.password = StringUtils.trimToNull(password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method applies the 'Authorization' header to the {@link ClientRequestContext}.
|
||||||
|
*
|
||||||
|
* @param requestContext A request context.
|
||||||
|
* @throws UnsupportedEncodingException The 'utf-8' encoding is not supported.
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext) throws UnsupportedEncodingException {
|
||||||
|
String userAndPass = this.username + ":" + this.password;
|
||||||
|
String userAndPassEncoded = Base64.getEncoder().encodeToString(userAndPass.getBytes("utf-8"));
|
||||||
|
|
||||||
|
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Basic " + userAndPassEncoded);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
51
src/main/java/com/inteligr8/rs/BearerTokenAuthorizationFilter.java
Executable file
51
src/main/java/com/inteligr8/rs/BearerTokenAuthorizationFilter.java
Executable file
@@ -0,0 +1,51 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
|
import jakarta.ws.rs.core.HttpHeaders;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class implements a simple long living or proxied token-based
|
||||||
|
* authorization filter. The token is expected to be acquired outside of the
|
||||||
|
* purview of this library.
|
||||||
|
*
|
||||||
|
* If you have the full authorization header and not just the bearer token, use
|
||||||
|
* the {@link ForwardingAuthorizationFilter}.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class BearerTokenAuthorizationFilter implements AuthorizationFilter {
|
||||||
|
|
||||||
|
private final String token;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param token A 'Bearer' token.
|
||||||
|
*/
|
||||||
|
public BearerTokenAuthorizationFilter(String token) {
|
||||||
|
this.token = token;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method applies the 'Authorization' header to the {@link ClientRequestContext}.
|
||||||
|
*
|
||||||
|
* @param requestContext A request context.
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext) {
|
||||||
|
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.token);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,34 +1,153 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
package com.inteligr8.rs;
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientBuilder;
|
import java.util.concurrent.TimeUnit;
|
||||||
import javax.ws.rs.client.ClientRequestFilter;
|
|
||||||
import javax.ws.rs.client.WebTarget;
|
|
||||||
|
|
||||||
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
import jakarta.ws.rs.client.ClientBuilder;
|
||||||
|
import jakarta.ws.rs.client.WebTarget;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.databind.DeserializationFeature;
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import com.fasterxml.jackson.databind.SerializationFeature;
|
||||||
|
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
|
||||||
|
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Configured JAX-RS Client & WebTarget
|
* A class that provides pre-configured JAX-RS Client & WebTarget objects.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
*/
|
*/
|
||||||
public abstract class Client {
|
public abstract class Client {
|
||||||
|
|
||||||
protected abstract ClientConfiguration getConfig();
|
private final Object sync = new Object();
|
||||||
|
private jakarta.ws.rs.client.Client client;
|
||||||
|
|
||||||
public javax.ws.rs.client.Client getClient() {
|
/**
|
||||||
ClientRequestFilter authFilter = this.getConfig().getAuthorizationFilter();
|
* @return The client configuration.
|
||||||
|
*/
|
||||||
|
public abstract ClientConfiguration getConfig();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return A pre-configured JAX-RS client (no URL) with configured authorization.
|
||||||
|
*/
|
||||||
|
public final jakarta.ws.rs.client.Client getClient() {
|
||||||
|
synchronized (this.sync) {
|
||||||
|
if (this.client == null)
|
||||||
|
this.client = this.buildClient((AuthorizationFilter)null);
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.client;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param authFilter A dynamic authorization filter.
|
||||||
|
* @return A pre-configured JAX-RS client (no URL) with the specified authorization.
|
||||||
|
*/
|
||||||
|
public jakarta.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
|
||||||
|
if (authFilter == null) {
|
||||||
|
return this.getClient();
|
||||||
|
} else {
|
||||||
|
return this.buildClient(authFilter);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param authFilter A dynamic authorization filter.
|
||||||
|
* @return A pre-configured JAX-RS client (no URL) with the specified authorization.
|
||||||
|
*/
|
||||||
|
public final jakarta.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
|
||||||
|
ObjectMapper om = new ObjectMapper();
|
||||||
|
om.registerModules(new JavaTimeModule());
|
||||||
|
this.getConfig().configureJacksonMapper(om);
|
||||||
|
|
||||||
|
JacksonJsonProvider provider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
|
||||||
|
this.getConfig().configureJacksonProvider(provider);
|
||||||
|
|
||||||
|
if (this.getConfig().isWrapRootValueEnabled())
|
||||||
|
provider.enable(SerializationFeature.WRAP_ROOT_VALUE);
|
||||||
|
if (this.getConfig().isUnwrapRootValueEnabled())
|
||||||
|
provider.enable(DeserializationFeature.UNWRAP_ROOT_VALUE);
|
||||||
|
|
||||||
ClientBuilder clientBuilder = ClientBuilder.newBuilder()
|
ClientBuilder clientBuilder = ClientBuilder.newBuilder()
|
||||||
.register(new JacksonJaxbJsonProvider());
|
.register(provider)
|
||||||
|
.register(new LoggingFilter());
|
||||||
|
|
||||||
|
if (this.getConfig().getConnectTimeoutInMillis() != null)
|
||||||
|
clientBuilder.connectTimeout(this.getConfig().getConnectTimeoutInMillis(), TimeUnit.MILLISECONDS);
|
||||||
|
if (this.getConfig().getResponseTimeoutInMillis() != null)
|
||||||
|
clientBuilder.readTimeout(this.getConfig().getResponseTimeoutInMillis(), TimeUnit.MILLISECONDS);
|
||||||
|
|
||||||
|
if (authFilter == null)
|
||||||
|
authFilter = this.getConfig().createAuthorizationFilter();
|
||||||
if (authFilter != null)
|
if (authFilter != null)
|
||||||
clientBuilder.register(authFilter);
|
clientBuilder.register(authFilter);
|
||||||
|
this.buildClient(clientBuilder);
|
||||||
|
this.getConfig().configureClient(clientBuilder);
|
||||||
|
|
||||||
return clientBuilder.build();
|
return clientBuilder.build();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param clientBuilder A client builder
|
||||||
|
*/
|
||||||
|
public void buildClient(ClientBuilder clientBuilder) {
|
||||||
|
// for extension purposes
|
||||||
|
}
|
||||||
|
|
||||||
public WebTarget getTarget() {
|
/**
|
||||||
|
* @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization.
|
||||||
|
*/
|
||||||
|
public final WebTarget getTarget() {
|
||||||
return this.getClient()
|
return this.getClient()
|
||||||
.target(this.getConfig().getBaseUrl());
|
.target(this.getConfig().getBaseUrl());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param authFilter A dynamic authorization filter.
|
||||||
|
* @return A pre-configured JAX-RS target (client w/ base URL) with the specified authorization.
|
||||||
|
*/
|
||||||
|
public WebTarget getTarget(AuthorizationFilter authFilter) {
|
||||||
|
if (authFilter == null) {
|
||||||
|
return this.getTarget();
|
||||||
|
} else {
|
||||||
|
return this.getClient(authFilter)
|
||||||
|
.target(this.getConfig().getBaseUrl());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public abstract <T> T getApi(Class<T> apiClass);
|
/**
|
||||||
|
* This method retrieves a JAX-RS implementation of the specified API.
|
||||||
|
*
|
||||||
|
* @param <T> A JAX-RS annotated API class.
|
||||||
|
* @param apiClass A JAX-RS annotated API class.
|
||||||
|
* @return An instance of the API class.
|
||||||
|
*/
|
||||||
|
public final <T> T getApi(Class<T> apiClass) {
|
||||||
|
return this.getApi(null, apiClass);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method retrieves a JAX-RS implementation of the specified API with
|
||||||
|
* the specified authorization.
|
||||||
|
*
|
||||||
|
* @param <T> A JAX-RS annotated API class.
|
||||||
|
* @param authFilter A dynamic authorization filter.
|
||||||
|
* @param apiClass A JAX-RS annotated API class.
|
||||||
|
* @return An instance of the API class.
|
||||||
|
*/
|
||||||
|
public abstract <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,54 +1,208 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
package com.inteligr8.rs;
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
import java.net.URI;
|
import java.net.URI;
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientRequestFilter;
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
|
||||||
|
|
||||||
public abstract class ClientConfiguration {
|
import jakarta.ws.rs.client.ClientBuilder;
|
||||||
|
|
||||||
public abstract String getBaseUrl();
|
|
||||||
|
|
||||||
public abstract String getBasicAuthUsername();
|
|
||||||
|
|
||||||
public abstract String getBasicAuthPassword();
|
|
||||||
|
|
||||||
public abstract String getAccessToken();
|
|
||||||
|
|
||||||
public abstract String getOAuthTokenUrl();
|
|
||||||
|
|
||||||
public abstract String getOAuthClientId();
|
|
||||||
|
|
||||||
public abstract String getOAuthClientSecret();
|
|
||||||
|
|
||||||
public abstract String getOAuthAuthCode();
|
|
||||||
|
|
||||||
public abstract String getOAuthAuthRedirectUri();
|
|
||||||
|
|
||||||
public abstract String getOAuthUsername();
|
|
||||||
|
|
||||||
public abstract String getOAuthPassword();
|
|
||||||
|
|
||||||
public ClientRequestFilter getAuthorizationFilter() {
|
/**
|
||||||
if (this.getAccessToken() != null) {
|
* This interface defines the configurable parameters of the clients; primarily
|
||||||
return new AccessTokenRequestFilter(this.getAccessToken());
|
* their default authentication and authorization.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public interface ClientConfiguration {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The base or root URL of the service.
|
||||||
|
*/
|
||||||
|
String getBaseUrl();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The username for BASIC authentication.
|
||||||
|
*/
|
||||||
|
default String getBasicAuthUsername() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The corresponding password for the username in BASIC authentication.
|
||||||
|
*/
|
||||||
|
default String getBasicAuthPassword() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The client ID for Client Enforcement authentication.
|
||||||
|
*/
|
||||||
|
default String getClientId() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The corresponding client secret for the client ID in Client Enforcement authentication.
|
||||||
|
*/
|
||||||
|
default String getClientSecret() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The token for BEARER authorization.
|
||||||
|
*/
|
||||||
|
default String getBearerToken() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The token URL for OAuth authorization.
|
||||||
|
*/
|
||||||
|
default String getOAuthTokenUrl() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The client ID provided by the OAuth IdP administrator.
|
||||||
|
*/
|
||||||
|
default String getOAuthClientId() {
|
||||||
|
return this.getClientId();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The corresponding client secret for the client ID provided by the OAuth IdP administrator.
|
||||||
|
*/
|
||||||
|
default String getOAuthClientSecret() {
|
||||||
|
return this.getClientSecret();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The authorization code used in the OAuth Authorization Code flow.
|
||||||
|
*/
|
||||||
|
default String getOAuthAuthCode() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The redirect URL used in the OAuth Authorization Code flow.
|
||||||
|
*/
|
||||||
|
default String getOAuthAuthRedirectUri() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The username used in the OAuth Password Grant flow.
|
||||||
|
*/
|
||||||
|
default String getOAuthUsername() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The corresponding password for the username used in the OAuth Password Grant flow.
|
||||||
|
*/
|
||||||
|
default String getOAuthPassword() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
default Integer getConnectTimeoutInMillis() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
default Integer getResponseTimeoutInMillis() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.
|
||||||
|
*/
|
||||||
|
default boolean isUnwrapRootValueEnabled() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return true to enable Jackson WRAP_ROOT_VALUE feature; false otherwise.
|
||||||
|
*/
|
||||||
|
default boolean isWrapRootValueEnabled() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mapper A Jackson object mapper to configure.
|
||||||
|
*/
|
||||||
|
default void configureJacksonMapper(ObjectMapper mapper) {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param provider A Jackson Jakarta RS provider to configure.
|
||||||
|
*/
|
||||||
|
default void configureJacksonProvider(JacksonJsonProvider provider) {
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method creates an authorization filter based on the configuration
|
||||||
|
* available. A configuration element is considered to not be available
|
||||||
|
* when its value is null. If multiple configurations are specified, the
|
||||||
|
* filter is selected with the following precedence.
|
||||||
|
*
|
||||||
|
* - Bearer
|
||||||
|
* - OAuth Authorization Code
|
||||||
|
* - OAuth Password Grant
|
||||||
|
* - OAuth Client Credential
|
||||||
|
* - Basic
|
||||||
|
*
|
||||||
|
* @return An authorization filter; may be null
|
||||||
|
*/
|
||||||
|
default AuthorizationFilter createAuthorizationFilter() {
|
||||||
|
if (this.getBearerToken() != null) {
|
||||||
|
return new BearerTokenAuthorizationFilter(this.getBearerToken());
|
||||||
} else if (this.getOAuthTokenUrl() != null) {
|
} else if (this.getOAuthTokenUrl() != null) {
|
||||||
if (this.getOAuthAuthCode() != null) {
|
if (this.getOAuthAuthCode() != null) {
|
||||||
return new OAuthAuthorizationCodeRequestFilter(this.getOAuthTokenUrl(),
|
return new OAuthAuthorizationCodeAuthorizationFilter(this.getOAuthTokenUrl(),
|
||||||
this.getOAuthClientId(), this.getOAuthClientSecret(),
|
this.getOAuthClientId(), this.getOAuthClientSecret(),
|
||||||
this.getOAuthAuthCode(), URI.create(this.getOAuthAuthRedirectUri()));
|
this.getOAuthAuthCode(), URI.create(this.getOAuthAuthRedirectUri()));
|
||||||
} else if (this.getOAuthUsername() != null) {
|
} else if (this.getOAuthUsername() != null) {
|
||||||
return new OAuthPasswordGrantRequestFilter(this.getOAuthTokenUrl(),
|
return new OAuthPasswordGrantAuthorizationFilter(this.getOAuthTokenUrl(),
|
||||||
this.getOAuthClientId(), this.getOAuthClientSecret(),
|
this.getOAuthClientId(), this.getOAuthClientSecret(),
|
||||||
this.getOAuthUsername(), this.getOAuthPassword());
|
this.getOAuthUsername(), this.getOAuthPassword());
|
||||||
} else {
|
} else {
|
||||||
return new OAuthClientCredentialRequestFilter(this.getOAuthTokenUrl(),
|
return new OAuthClientCredentialAuthorizationFilter(this.getOAuthTokenUrl(),
|
||||||
this.getOAuthClientId(), this.getOAuthClientSecret());
|
this.getOAuthClientId(), this.getOAuthClientSecret());
|
||||||
}
|
}
|
||||||
|
} else if (this.getClientId() != null) {
|
||||||
|
return new ClientEnforcementAuthorizationFilter(this.getClientId(), this.getClientSecret());
|
||||||
} else if (this.getBasicAuthUsername() != null) {
|
} else if (this.getBasicAuthUsername() != null) {
|
||||||
return new BasicAuthRequestFilter(this.getBasicAuthUsername(), this.getBasicAuthPassword());
|
return new BasicAuthorizationFilter(this.getBasicAuthUsername(), this.getBasicAuthPassword());
|
||||||
} else {
|
} else {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A Jackson provider, logging filter, and authentication filter are already registered.
|
||||||
|
*
|
||||||
|
* @param clientBuilder A JAX-RS client builder to configure.
|
||||||
|
*/
|
||||||
|
default void configureClient(ClientBuilder clientBuilder) {
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,61 +0,0 @@
|
|||||||
package com.inteligr8.rs;
|
|
||||||
|
|
||||||
import java.util.LinkedList;
|
|
||||||
import java.util.List;
|
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientRequestFilter;
|
|
||||||
import javax.ws.rs.ext.RuntimeDelegate;
|
|
||||||
|
|
||||||
import org.apache.cxf.jaxrs.client.JAXRSClientFactory;
|
|
||||||
import org.apache.cxf.jaxrs.client.WebClient;
|
|
||||||
import org.apache.cxf.jaxrs.impl.RuntimeDelegateImpl;
|
|
||||||
import org.slf4j.Logger;
|
|
||||||
import org.slf4j.LoggerFactory;
|
|
||||||
import org.springframework.beans.factory.InitializingBean;
|
|
||||||
|
|
||||||
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configured JAX-RS Client & WebTarget & CXF WebClient for CXF
|
|
||||||
*/
|
|
||||||
public abstract class ClientCxfImpl extends Client implements InitializingBean {
|
|
||||||
|
|
||||||
private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class);
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void afterPropertiesSet() {
|
|
||||||
if (RuntimeDelegate.getInstance() == null) {
|
|
||||||
this.logger.info("Setting JAX-RS runtime delegate to the CXF library");
|
|
||||||
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
|
|
||||||
} else if (RuntimeDelegate.getInstance() instanceof RuntimeDelegateImpl) {
|
|
||||||
this.logger.info("JAX-RS runtime delegate already the CXF library");
|
|
||||||
} else {
|
|
||||||
this.logger.warn("Setting JAX-RS runtime delegate to the CXF library; was: " + RuntimeDelegate.getInstance().getClass().getName());
|
|
||||||
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this.logger.isInfoEnabled())
|
|
||||||
this.logger.info("API Base URL: " + this.getConfig().getBaseUrl());
|
|
||||||
}
|
|
||||||
|
|
||||||
public WebClient getCxfClient() {
|
|
||||||
List<Object> providersAndFilters = new LinkedList<Object>();
|
|
||||||
providersAndFilters.add(new JacksonJaxbJsonProvider());
|
|
||||||
|
|
||||||
ClientRequestFilter authFilter = this.getConfig().getAuthorizationFilter();
|
|
||||||
if (authFilter != null)
|
|
||||||
providersAndFilters.add(authFilter);
|
|
||||||
|
|
||||||
// we can't use JAXRSClientFactory with a JAXRS client (duh!)
|
|
||||||
// so we need to create a CXF client
|
|
||||||
WebClient client = WebClient.create(this.getConfig().getBaseUrl(), providersAndFilters);
|
|
||||||
|
|
||||||
return client;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public <T> T getApi(Class<T> apiClass) {
|
|
||||||
return JAXRSClientFactory.fromClient(this.getCxfClient(), apiClass);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
@@ -0,0 +1,65 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
|
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class is the base for implementations of client authorization similar
|
||||||
|
* to OAuth-based flows.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class ClientEnforcementAuthorizationFilter implements AuthorizationFilter {
|
||||||
|
|
||||||
|
private final String clientId;
|
||||||
|
private final String clientSecret;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This constructor creates a client authorization filter using a client ID
|
||||||
|
* registered with the endpoint.
|
||||||
|
*
|
||||||
|
* @param clientId An endpoint provided client ID.
|
||||||
|
*/
|
||||||
|
public ClientEnforcementAuthorizationFilter(String clientId) {
|
||||||
|
this(clientId, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This constructor creates a client authorization filter using a client ID
|
||||||
|
* registered with the endpoint, and the corresponding client secret.
|
||||||
|
*
|
||||||
|
* @param clientId An endpoint provided client ID.
|
||||||
|
* @param clientSecret A secret corresponding to the client ID.
|
||||||
|
*/
|
||||||
|
public ClientEnforcementAuthorizationFilter(String clientId, String clientSecret) {
|
||||||
|
this.clientId = StringUtils.trimToNull(clientId);
|
||||||
|
this.clientSecret = StringUtils.trimToNull(clientSecret);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method applies the client headers to the {@link ClientRequestContext}.
|
||||||
|
*
|
||||||
|
* @param requestContext A request context.
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext) {
|
||||||
|
requestContext.getHeaders().add("client_id", this.clientId);
|
||||||
|
requestContext.getHeaders().add("client_secret", this.clientSecret);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
79
src/main/java/com/inteligr8/rs/ClientImpl.java
Normal file
79
src/main/java/com/inteligr8/rs/ClientImpl.java
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import jakarta.annotation.PostConstruct;
|
||||||
|
import jakarta.ws.rs.client.ClientBuilder;
|
||||||
|
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A class that provides pre-configured JAX-RS Client & WebTarget objects
|
||||||
|
* for Jersey.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class ClientImpl extends Client {
|
||||||
|
|
||||||
|
private final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
|
||||||
|
|
||||||
|
private ClientConfiguration config;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This constructor is for Spring or POJO use.
|
||||||
|
* @param config The client configuration.
|
||||||
|
*/
|
||||||
|
public ClientImpl(ClientConfiguration config) {
|
||||||
|
this.config = config;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method registers the Jersey library as the default provider for the
|
||||||
|
* JAX-RS specification.
|
||||||
|
*/
|
||||||
|
@PostConstruct
|
||||||
|
public void register() {
|
||||||
|
this.logger.info("API Base URL: {}", this.getConfig().getBaseUrl());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param clientBuilder A client builder.
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void buildClient(ClientBuilder clientBuilder) {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The client configuration.
|
||||||
|
*/
|
||||||
|
public ClientConfiguration getConfig() {
|
||||||
|
return this.config;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method retrieves a JAX-RS implementation of the specified API with
|
||||||
|
* the specified authorization.
|
||||||
|
*
|
||||||
|
* @param authFilter A dynamic authorization filter.
|
||||||
|
* @param apiClass A JAX-RS annotation API class.
|
||||||
|
* @return An instance of the API class.
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) {
|
||||||
|
throw new UnsupportedOperationException();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,39 +0,0 @@
|
|||||||
package com.inteligr8.rs;
|
|
||||||
|
|
||||||
import javax.ws.rs.ext.RuntimeDelegate;
|
|
||||||
|
|
||||||
import org.glassfish.jersey.client.proxy.WebResourceFactory;
|
|
||||||
import org.glassfish.jersey.internal.RuntimeDelegateImpl;
|
|
||||||
import org.slf4j.Logger;
|
|
||||||
import org.slf4j.LoggerFactory;
|
|
||||||
import org.springframework.beans.factory.InitializingBean;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configured JAX-RS Client & WebTarget for Jersey
|
|
||||||
*/
|
|
||||||
public abstract class ClientJerseyImpl extends Client implements InitializingBean {
|
|
||||||
|
|
||||||
private final Logger logger = LoggerFactory.getLogger(ClientJerseyImpl.class);
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void afterPropertiesSet() {
|
|
||||||
if (RuntimeDelegate.getInstance() == null) {
|
|
||||||
this.logger.info("Setting JAX-RS runtime delegate to the Jersey library");
|
|
||||||
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
|
|
||||||
} else if (RuntimeDelegate.getInstance() instanceof RuntimeDelegateImpl) {
|
|
||||||
this.logger.info("JAX-RS runtime delegate already the Jersey library");
|
|
||||||
} else {
|
|
||||||
this.logger.warn("Setting JAX-RS runtime delegate to the Jersey library; was: " + RuntimeDelegate.getInstance().getClass().getName());
|
|
||||||
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this.logger.isInfoEnabled())
|
|
||||||
this.logger.info("API Base URL: " + this.getConfig().getBaseUrl());
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public <T> T getApi(Class<T> apiClass) {
|
|
||||||
return WebResourceFactory.newResource(apiClass, this.getTarget());
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
51
src/main/java/com/inteligr8/rs/ForwardingAuthorizationFilter.java
Executable file
51
src/main/java/com/inteligr8/rs/ForwardingAuthorizationFilter.java
Executable file
@@ -0,0 +1,51 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
|
import jakarta.ws.rs.core.HttpHeaders;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class implements a proxied or forwarded authorization header based
|
||||||
|
* authorization filter. The authorization header is expected to be acquired
|
||||||
|
* outside of the purview of this library.
|
||||||
|
*
|
||||||
|
* If you have a bearer token and not the full authorization header, use the
|
||||||
|
* {@link BearerTokenAuthorizationFilter}.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class ForwardingAuthorizationFilter implements AuthorizationFilter {
|
||||||
|
|
||||||
|
private final String authorizationHeaderValue;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param authorizationHeaderValue A previously used or formulated 'Authorization' header.
|
||||||
|
*/
|
||||||
|
public ForwardingAuthorizationFilter(String authorizationHeaderValue) {
|
||||||
|
this.authorizationHeaderValue = authorizationHeaderValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method applies the 'Authorization' header to the {@link ClientRequestContext}.
|
||||||
|
*
|
||||||
|
* @param requestContext A request context.
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext) {
|
||||||
|
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, this.authorizationHeaderValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
86
src/main/java/com/inteligr8/rs/LoggingFilter.java
Normal file
86
src/main/java/com/inteligr8/rs/LoggingFilter.java
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
|
import jakarta.ws.rs.client.ClientRequestFilter;
|
||||||
|
import jakarta.ws.rs.client.ClientResponseContext;
|
||||||
|
import jakarta.ws.rs.client.ClientResponseFilter;
|
||||||
|
import jakarta.ws.rs.core.Form;
|
||||||
|
import jakarta.ws.rs.core.MediaType;
|
||||||
|
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.annotation.JsonInclude.Include;
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is an JAX-RS filter for the logging of any JAX-RS request/response for
|
||||||
|
* debugging purposes. When used, it will write to 'jaxrs.request' and
|
||||||
|
* 'jaxrs.response' loggers at the 'trace' level.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class LoggingFilter implements ClientRequestFilter, ClientResponseFilter {
|
||||||
|
|
||||||
|
private final Logger loggerRequest = LoggerFactory.getLogger("jaxrs.request");
|
||||||
|
private final Logger loggerResponse = LoggerFactory.getLogger("jaxrs.response");
|
||||||
|
|
||||||
|
protected final ObjectMapper om = new ObjectMapper().setSerializationInclusion(Include.NON_NULL);
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext) throws IOException {
|
||||||
|
if (this.loggerRequest.isTraceEnabled())
|
||||||
|
this.logAnyRequest(requestContext, this.loggerRequest);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected void logAnyRequest(ClientRequestContext requestContext, Logger logger) throws IOException {
|
||||||
|
if (MediaType.APPLICATION_JSON_TYPE.equals(requestContext.getMediaType())) {
|
||||||
|
logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(),
|
||||||
|
this.om.writeValueAsString(requestContext.getEntity()));
|
||||||
|
} else if (MediaType.APPLICATION_FORM_URLENCODED_TYPE.equals(requestContext.getMediaType())) {
|
||||||
|
if (requestContext.getEntity() instanceof Form) {
|
||||||
|
logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(),
|
||||||
|
((Form)requestContext.getEntity()).asMap());
|
||||||
|
} else {
|
||||||
|
logger.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri());
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
this.logUnhandledRequest(requestContext, logger);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
protected void logUnhandledRequest(ClientRequestContext requestContext, Logger logger) throws IOException {
|
||||||
|
if (requestContext.getMediaType() != null) {
|
||||||
|
logger.trace("request '{}': {} {}", requestContext.getMediaType(), requestContext.getMethod(), requestContext.getUri());
|
||||||
|
} else {
|
||||||
|
logger.trace("request: {} {}", requestContext.getMethod(), requestContext.getUri());
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) throws IOException {
|
||||||
|
if (this.loggerResponse.isTraceEnabled()) {
|
||||||
|
this.loggerResponse.trace("response: {} ", this.om.writeValueAsString(responseContext.getStatus()));
|
||||||
|
// WARN body is stream, which would need to be replaced after read
|
||||||
|
this.loggerResponse.warn("response: NOT YET SUPPORTED");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -0,0 +1,95 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import java.net.URI;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.core.Form;
|
||||||
|
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class implements the OAuth Authorization Code flow as an authorization
|
||||||
|
* filter.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizationFilter {
|
||||||
|
|
||||||
|
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||||
|
|
||||||
|
private final String code;
|
||||||
|
private final URI redirectUri;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param tokenUrl The URL to the OAuth IdP token service.
|
||||||
|
* @param clientId The ID provided by the OAuth IdP administrator.
|
||||||
|
* @param code The authorization code acquired from the OAuth IdP from a user outside the purview of this library.
|
||||||
|
*/
|
||||||
|
public OAuthAuthorizationCodeAuthorizationFilter(String tokenUrl, String clientId, String code) {
|
||||||
|
this(tokenUrl, clientId, null, code);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param tokenUrl The URL to the OAuth IdP token service.
|
||||||
|
* @param clientId The ID provided by the OAuth IdP administrator.
|
||||||
|
* @param code The authorization code acquired from the OAuth IdP from a user outside the purview of this library.
|
||||||
|
* @param redirectUri The URL for the OAuth IdP to redirect after successful authorization.
|
||||||
|
*/
|
||||||
|
public OAuthAuthorizationCodeAuthorizationFilter(String tokenUrl, String clientId, String code, URI redirectUri) {
|
||||||
|
this(tokenUrl, clientId, null, code, redirectUri);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param tokenUrl The URL to the OAuth IdP token service.
|
||||||
|
* @param clientId The ID provided by the OAuth IdP administrator.
|
||||||
|
* @param clientSecret The passcode provided by the OAuth IdP administrator.
|
||||||
|
* @param code The authorization code acquired from the OAuth IdP from a user outside the purview of this library.
|
||||||
|
*/
|
||||||
|
public OAuthAuthorizationCodeAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String code) {
|
||||||
|
this(tokenUrl, clientId, clientSecret, code, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param tokenUrl The URL to the OAuth IdP token service.
|
||||||
|
* @param clientId The ID provided by the OAuth IdP administrator.
|
||||||
|
* @param clientSecret The passcode provided by the OAuth IdP administrator.
|
||||||
|
* @param code The authorization code acquired from the OAuth IdP from a user outside the purview of this library.
|
||||||
|
* @param redirectUri The URL for the OAuth IdP to redirect after successful authorization.
|
||||||
|
*/
|
||||||
|
public OAuthAuthorizationCodeAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String code, URI redirectUri) {
|
||||||
|
super(tokenUrl, clientId, clientSecret);
|
||||||
|
|
||||||
|
this.code = StringUtils.trimToNull(code);
|
||||||
|
this.redirectUri = redirectUri;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected Form createForm() {
|
||||||
|
this.logger.debug("Using OAuth grant_type 'authorization_code'");
|
||||||
|
Form form = new Form().param("grant_type", "authorization_code");
|
||||||
|
if (this.redirectUri != null)
|
||||||
|
form.param("redirect_uri", this.redirectUri.toString());
|
||||||
|
return form;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void extendFormSensitive(Form form) {
|
||||||
|
form.param("code", this.code);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,40 +0,0 @@
|
|||||||
package com.inteligr8.rs;
|
|
||||||
|
|
||||||
import java.net.URI;
|
|
||||||
|
|
||||||
import javax.ws.rs.core.Form;
|
|
||||||
|
|
||||||
public class OAuthAuthorizationCodeRequestFilter extends OAuthRequestFilter {
|
|
||||||
|
|
||||||
private final String code;
|
|
||||||
private final URI redirectUri;
|
|
||||||
|
|
||||||
public OAuthAuthorizationCodeRequestFilter(String tokenUrl, String clientId, String code) {
|
|
||||||
this(tokenUrl, clientId, null, code);
|
|
||||||
}
|
|
||||||
|
|
||||||
public OAuthAuthorizationCodeRequestFilter(String tokenUrl, String clientId, String code, URI redirectUri) {
|
|
||||||
this(tokenUrl, clientId, null, code, redirectUri);
|
|
||||||
}
|
|
||||||
|
|
||||||
public OAuthAuthorizationCodeRequestFilter(String tokenUrl, String clientId, String clientSecret, String code) {
|
|
||||||
this(tokenUrl, clientId, clientSecret, code, null);
|
|
||||||
}
|
|
||||||
|
|
||||||
public OAuthAuthorizationCodeRequestFilter(String tokenUrl, String clientId, String clientSecret, String code, URI redirectUri) {
|
|
||||||
super(tokenUrl, clientId, clientSecret);
|
|
||||||
|
|
||||||
this.code = code;
|
|
||||||
this.redirectUri = redirectUri;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
protected Form createForm() {
|
|
||||||
Form form = new Form().param("grant_type", "authorization_code")
|
|
||||||
.param("code", this.code);
|
|
||||||
if (this.redirectUri != null)
|
|
||||||
form.param("redirect_uri", this.redirectUri.toString());
|
|
||||||
return form;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
206
src/main/java/com/inteligr8/rs/OAuthAuthorizationFilter.java
Executable file
206
src/main/java/com/inteligr8/rs/OAuthAuthorizationFilter.java
Executable file
@@ -0,0 +1,206 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.WebApplicationException;
|
||||||
|
import jakarta.ws.rs.client.Client;
|
||||||
|
import jakarta.ws.rs.client.ClientBuilder;
|
||||||
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
|
import jakarta.ws.rs.client.Entity;
|
||||||
|
import jakarta.ws.rs.client.WebTarget;
|
||||||
|
import jakarta.ws.rs.core.Form;
|
||||||
|
import jakarta.ws.rs.core.HttpHeaders;
|
||||||
|
import jakarta.ws.rs.core.Response;
|
||||||
|
import jakarta.ws.rs.core.Response.Status.Family;
|
||||||
|
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class is the base for implementations of OAuth authorization flows.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
|
||||||
|
|
||||||
|
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||||
|
|
||||||
|
private final String tokenUrl;
|
||||||
|
private final String clientId;
|
||||||
|
private final String clientSecret;
|
||||||
|
private final String scope;
|
||||||
|
private String accessToken;
|
||||||
|
private long expiration;
|
||||||
|
private String refreshToken;
|
||||||
|
private Long refreshTokenExpiration;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This constructor creates an OAuth-based authorization filter using the
|
||||||
|
* OAuth identity provider token URL and a client ID registered with the
|
||||||
|
* same OAuth identity provider.
|
||||||
|
*
|
||||||
|
* @param tokenUrl An OAuth identity provider token URL.
|
||||||
|
* @param clientId An OAuth identity provider client ID.
|
||||||
|
*/
|
||||||
|
public OAuthAuthorizationFilter(String tokenUrl, String clientId) {
|
||||||
|
this(tokenUrl, clientId, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This constructor creates an OAuth-based authorization filter using the
|
||||||
|
* OAuth identity provider token URL, client ID registered with the
|
||||||
|
* same OAuth identity provider, and the corresponding client secret.
|
||||||
|
*
|
||||||
|
* @param tokenUrl An OAuth identity provider token URL.
|
||||||
|
* @param clientId An OAuth identity provider client ID.
|
||||||
|
* @param clientSecret A secret corresponding to the client ID.
|
||||||
|
*/
|
||||||
|
public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret) {
|
||||||
|
this(tokenUrl, clientId, clientSecret, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This constructor creates an OAuth-based authorization filter using the
|
||||||
|
* OAuth identity provider token URL, client ID registered with the
|
||||||
|
* same OAuth identity provider, the corresponding client secret, and OAuth
|
||||||
|
* scope.
|
||||||
|
*
|
||||||
|
* @param tokenUrl An OAuth identity provider token URL.
|
||||||
|
* @param clientId An OAuth identity provider client ID.
|
||||||
|
* @param clientSecret A secret corresponding to the client ID.
|
||||||
|
* @param scope An OAuth scope.
|
||||||
|
*/
|
||||||
|
public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String scope) {
|
||||||
|
this.tokenUrl = tokenUrl;
|
||||||
|
this.clientId = StringUtils.trimToNull(clientId);
|
||||||
|
this.clientSecret = StringUtils.trimToNull(clientSecret);
|
||||||
|
this.scope = StringUtils.trimToNull(scope);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method applies the 'Authorization' header to the {@link ClientRequestContext}.
|
||||||
|
*
|
||||||
|
* @param requestContext A request context.
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext) {
|
||||||
|
if (this.accessToken == null) {
|
||||||
|
this.requestToken();
|
||||||
|
} else if (System.currentTimeMillis() >= this.expiration) {
|
||||||
|
this.logger.trace("Access token expired; retrieving new one with refresh token");
|
||||||
|
|
||||||
|
if (this.refreshTokenExpiration != null && System.currentTimeMillis() >= this.refreshTokenExpiration.longValue()) {
|
||||||
|
this.logger.debug("Refresh token expired; performing full authentication");
|
||||||
|
this.refreshToken = null;
|
||||||
|
this.requestToken();
|
||||||
|
} else {
|
||||||
|
try {
|
||||||
|
this.requestToken();
|
||||||
|
} catch (WebApplicationException wae) {
|
||||||
|
if (wae.getResponse().getStatusInfo().getFamily() == Family.CLIENT_ERROR) {
|
||||||
|
this.logger.debug("Received OAuth response {} using refresh token; performing full authentication", wae.getResponse().getStatus());
|
||||||
|
this.refreshToken = null;
|
||||||
|
this.requestToken();
|
||||||
|
} else {
|
||||||
|
throw wae;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.accessToken);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method manages the acquisition and refreshing of tokens, per the
|
||||||
|
* standard OAuth process.
|
||||||
|
*/
|
||||||
|
private void requestToken() {
|
||||||
|
Form form;
|
||||||
|
|
||||||
|
if (this.refreshToken != null) {
|
||||||
|
form = this.createRefreshForm();
|
||||||
|
} else {
|
||||||
|
form = this.createForm();
|
||||||
|
}
|
||||||
|
|
||||||
|
form.param("client_id", this.clientId);
|
||||||
|
if (this.scope != null)
|
||||||
|
form.param("scope", this.scope);
|
||||||
|
|
||||||
|
this.logger.trace("Sending OAuth request: {}", form);
|
||||||
|
|
||||||
|
if (this.refreshToken != null) {
|
||||||
|
this.extendRefreshFormSensitive(form);
|
||||||
|
} else {
|
||||||
|
this.extendFormSensitive(form);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.clientSecret != null)
|
||||||
|
form.param("client_secret", this.clientSecret);
|
||||||
|
|
||||||
|
Entity<Form> entity = Entity.form(form);
|
||||||
|
|
||||||
|
Client client = ClientBuilder.newBuilder()
|
||||||
|
.register(new JacksonJsonProvider())
|
||||||
|
.build();
|
||||||
|
WebTarget target = client.target(this.tokenUrl);
|
||||||
|
|
||||||
|
long requestSendTime = System.currentTimeMillis();
|
||||||
|
|
||||||
|
Response response = target.request().post(entity);
|
||||||
|
|
||||||
|
this.logger.debug("Received OAuth response: {}", response.getStatus());
|
||||||
|
|
||||||
|
@SuppressWarnings("unchecked")
|
||||||
|
Map<String, Object> responseMap = response.readEntity(Map.class);
|
||||||
|
|
||||||
|
this.logger.trace("Received OAuth response: {}", responseMap);
|
||||||
|
|
||||||
|
if (response.getStatusInfo().getFamily() != Family.SUCCESSFUL) {
|
||||||
|
String code = (String) responseMap.get("error");
|
||||||
|
if (code != null) {
|
||||||
|
String description = (String) responseMap.get("error_description");
|
||||||
|
throw new WebApplicationException(code + ": " + description, response.getStatus());
|
||||||
|
} else {
|
||||||
|
throw new WebApplicationException(response);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
this.accessToken = (String)responseMap.get("access_token");
|
||||||
|
this.expiration = requestSendTime + ((Number)responseMap.get("expires_in")).longValue() * 1000L;
|
||||||
|
this.refreshToken = (String)responseMap.get("refresh_token");
|
||||||
|
if (responseMap.containsKey("refresh_token_expires_in"))
|
||||||
|
this.refreshTokenExpiration = requestSendTime + ((Number)responseMap.get("refresh_token_expires_in")).longValue() * 1000L;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected Form createRefreshForm() {
|
||||||
|
return new Form().param("grant_type", "refresh_token")
|
||||||
|
.param("refresh_token", this.refreshToken);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected abstract Form createForm();
|
||||||
|
|
||||||
|
protected void extendRefreshFormSensitive(Form form) {
|
||||||
|
}
|
||||||
|
|
||||||
|
protected abstract void extendFormSensitive(Form form);
|
||||||
|
|
||||||
|
}
|
51
src/main/java/com/inteligr8/rs/OAuthClientCredentialAuthorizationFilter.java
Executable file
51
src/main/java/com/inteligr8/rs/OAuthClientCredentialAuthorizationFilter.java
Executable file
@@ -0,0 +1,51 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.core.Form;
|
||||||
|
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class implements the OAuth Client Credential flow as an authorization
|
||||||
|
* filter.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorizationFilter {
|
||||||
|
|
||||||
|
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param tokenUrl The URL to the OAuth IdP token service.
|
||||||
|
* @param clientId The ID provided by the OAuth IdP administrator.
|
||||||
|
* @param clientSecret The passcode provided by the OAuth IdP administrator.
|
||||||
|
*/
|
||||||
|
public OAuthClientCredentialAuthorizationFilter(String tokenUrl, String clientId, String clientSecret) {
|
||||||
|
super(tokenUrl, clientId, clientSecret);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected Form createForm() {
|
||||||
|
this.logger.debug("Using OAuth grant_type 'client_credentials'");
|
||||||
|
return new Form().param("grant_type", "client_credentials");
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void extendFormSensitive(Form form) {
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,16 +0,0 @@
|
|||||||
package com.inteligr8.rs;
|
|
||||||
|
|
||||||
import javax.ws.rs.core.Form;
|
|
||||||
|
|
||||||
public class OAuthClientCredentialRequestFilter extends OAuthRequestFilter {
|
|
||||||
|
|
||||||
public OAuthClientCredentialRequestFilter(String tokenUrl, String clientId, String clientSecret) {
|
|
||||||
super(tokenUrl, clientId, clientSecret);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
protected Form createForm() {
|
|
||||||
return new Form().param("grant_type", "client_credentials");
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
71
src/main/java/com/inteligr8/rs/OAuthPasswordGrantAuthorizationFilter.java
Executable file
71
src/main/java/com/inteligr8/rs/OAuthPasswordGrantAuthorizationFilter.java
Executable file
@@ -0,0 +1,71 @@
|
|||||||
|
/*
|
||||||
|
* This program is free software: you can redistribute it and/or modify it
|
||||||
|
* under the terms of the GNU Lesser General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or (at your
|
||||||
|
* option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
* more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License along
|
||||||
|
* with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.core.Form;
|
||||||
|
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class implements the OAuth Password Grant flow as an authorization
|
||||||
|
* filter.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFilter {
|
||||||
|
|
||||||
|
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||||
|
|
||||||
|
private final String username;
|
||||||
|
private final String password;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param tokenUrl The URL to the OAuth IdP token service.
|
||||||
|
* @param clientId The ID provided by the OAuth IdP administrator.
|
||||||
|
* @param username A username provided by either the OAuth IdP administrator or one of its integrated providers.
|
||||||
|
* @param password The corresponding password for the username parameter.
|
||||||
|
*/
|
||||||
|
public OAuthPasswordGrantAuthorizationFilter(String tokenUrl, String clientId, String username, String password) {
|
||||||
|
this(tokenUrl, clientId, null, username, password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param tokenUrl The URL to the OAuth IdP token service.
|
||||||
|
* @param clientId The ID provided by the OAuth IdP administrator.
|
||||||
|
* @param clientSecret The passcode provided by the OAuth IdP administrator.
|
||||||
|
* @param username A username provided by either the OAuth IdP administrator or one of its integrated providers.
|
||||||
|
* @param password The corresponding password for the username parameter.
|
||||||
|
*/
|
||||||
|
public OAuthPasswordGrantAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String username, String password) {
|
||||||
|
super(tokenUrl, clientId, clientSecret);
|
||||||
|
this.username = StringUtils.trimToNull(username);
|
||||||
|
this.password = StringUtils.trimToNull(password);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected Form createForm() {
|
||||||
|
this.logger.debug("Using OAuth grant_type 'password': {}", this.username);
|
||||||
|
return new Form().param("grant_type", "password")
|
||||||
|
.param("username", this.username);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void extendFormSensitive(Form form) {
|
||||||
|
form.param("password", this.password);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,27 +0,0 @@
|
|||||||
package com.inteligr8.rs;
|
|
||||||
|
|
||||||
import javax.ws.rs.core.Form;
|
|
||||||
|
|
||||||
public class OAuthPasswordGrantRequestFilter extends OAuthRequestFilter {
|
|
||||||
|
|
||||||
private final String username;
|
|
||||||
private final String password;
|
|
||||||
|
|
||||||
public OAuthPasswordGrantRequestFilter(String tokenUrl, String clientId, String username, String password) {
|
|
||||||
this(tokenUrl, clientId, null, username, password);
|
|
||||||
}
|
|
||||||
|
|
||||||
public OAuthPasswordGrantRequestFilter(String tokenUrl, String clientId, String clientSecret, String username, String password) {
|
|
||||||
super(tokenUrl, clientId, clientSecret);
|
|
||||||
this.username = username;
|
|
||||||
this.password = password;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
protected Form createForm() {
|
|
||||||
return new Form().param("grant_type", "password")
|
|
||||||
.param("username", this.username)
|
|
||||||
.param("password", this.password);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
@@ -1,85 +0,0 @@
|
|||||||
package com.inteligr8.rs;
|
|
||||||
|
|
||||||
import java.util.Map;
|
|
||||||
|
|
||||||
import javax.ws.rs.WebApplicationException;
|
|
||||||
import javax.ws.rs.client.ClientBuilder;
|
|
||||||
import javax.ws.rs.client.ClientRequestContext;
|
|
||||||
import javax.ws.rs.client.ClientRequestFilter;
|
|
||||||
import javax.ws.rs.client.Entity;
|
|
||||||
import javax.ws.rs.client.WebTarget;
|
|
||||||
import javax.ws.rs.core.Form;
|
|
||||||
import javax.ws.rs.core.HttpHeaders;
|
|
||||||
|
|
||||||
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
|
||||||
|
|
||||||
public abstract class OAuthRequestFilter implements ClientRequestFilter {
|
|
||||||
|
|
||||||
private final String tokenUrl;
|
|
||||||
private final String clientId;
|
|
||||||
private final String clientSecret;
|
|
||||||
private final String scope;
|
|
||||||
private String accessToken;
|
|
||||||
private long expiration;
|
|
||||||
private String refreshToken;
|
|
||||||
|
|
||||||
public OAuthRequestFilter(String tokenUrl, String clientId) {
|
|
||||||
this(tokenUrl, clientId, null);
|
|
||||||
}
|
|
||||||
|
|
||||||
public OAuthRequestFilter(String tokenUrl, String clientId, String clientSecret) {
|
|
||||||
this(tokenUrl, clientId, clientSecret, null);
|
|
||||||
}
|
|
||||||
|
|
||||||
public OAuthRequestFilter(String tokenUrl, String clientId, String clientSecret, String scope) {
|
|
||||||
this.tokenUrl = tokenUrl;
|
|
||||||
this.clientId = clientId;
|
|
||||||
this.clientSecret = clientSecret;
|
|
||||||
this.scope = scope;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void filter(ClientRequestContext requestContext) {
|
|
||||||
if (this.accessToken == null || System.currentTimeMillis() > this.expiration)
|
|
||||||
this.requestToken();
|
|
||||||
|
|
||||||
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.accessToken);
|
|
||||||
}
|
|
||||||
|
|
||||||
private void requestToken() {
|
|
||||||
Form form;
|
|
||||||
|
|
||||||
if (this.refreshToken != null) {
|
|
||||||
form = new Form().param("grant_type", "refresh_token")
|
|
||||||
.param("refresh_token", this.refreshToken);
|
|
||||||
} else {
|
|
||||||
form = this.createForm();
|
|
||||||
}
|
|
||||||
|
|
||||||
form.param("clientId", this.clientId);
|
|
||||||
if (this.clientSecret != null)
|
|
||||||
form.param("clientSecret", this.clientSecret);
|
|
||||||
if (this.scope != null)
|
|
||||||
form.param("scope", this.scope);
|
|
||||||
|
|
||||||
Entity<Form> entity = Entity.form(form);
|
|
||||||
|
|
||||||
WebTarget target = ClientBuilder.newBuilder()
|
|
||||||
.register(new JacksonJaxbJsonProvider())
|
|
||||||
.build()
|
|
||||||
.target(this.tokenUrl);
|
|
||||||
|
|
||||||
@SuppressWarnings("unchecked")
|
|
||||||
Map<String, Object> response = target.request().post(entity, Map.class);
|
|
||||||
|
|
||||||
if (response.containsKey("error"))
|
|
||||||
throw new WebApplicationException((String)response.get("error"), 400);
|
|
||||||
|
|
||||||
this.accessToken = (String)response.get("access_token");
|
|
||||||
this.expiration = System.currentTimeMillis() + ((Number)response.get("expires_in")).longValue() * 1000L;
|
|
||||||
this.refreshToken = (String)response.get("refresh_token");
|
|
||||||
}
|
|
||||||
|
|
||||||
protected abstract Form createForm();
|
|
||||||
|
|
||||||
}
|
|
Reference in New Issue
Block a user