diff --git a/.gitignore b/.gitignore index ff4181e..67af4db 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,9 @@ # Maven pom.xml.versionsBackup +target # Eclipse -target .project .classpath .settings + diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/COPYING @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 . + +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 . diff --git a/COPYING.LESSER.md b/COPYING.LESSER.md new file mode 100644 index 0000000..0927556 --- /dev/null +++ b/COPYING.LESSER.md @@ -0,0 +1,157 @@ +### GNU LESSER GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +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. diff --git a/pom.xml b/pom.xml index aaaf849..0bf02fc 100644 --- a/pom.xml +++ b/pom.xml @@ -13,18 +13,21 @@ 1.8 1.8 UTF-8 + + 5.9.0.202009080501-r org.eclipse.jgit org.eclipse.jgit - 5.9.0.202009080501-r + ${jgit.version} org.eclipse.jgit org.eclipse.jgit.ssh.jsch - 5.9.0.202009080501-r + ${jgit.version} + runtime junit @@ -42,6 +45,23 @@ + + maven-javadoc-plugin + + + javadoc + package + jar + + true + public + + https://download.eclipse.org/jgit/site/${jgit.version}/apidocs + + + + + org.apache.maven.plugins maven-surefire-plugin @@ -76,7 +96,7 @@ inteligr8-releases Inteligr8 Releases - http://repos.yateslong.us/nexus/repository/inteligr8-public + http://repos.inteligr8.com/nexus/repository/inteligr8-public default diff --git a/src/main/java/com/inteligr8/git/CachedGit.java b/src/main/java/com/inteligr8/git/CachedGit.java index 6083d0d..6344a9d 100644 --- a/src/main/java/com/inteligr8/git/CachedGit.java +++ b/src/main/java/com/inteligr8/git/CachedGit.java @@ -1,3 +1,17 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.util.List; @@ -11,20 +25,62 @@ import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.transport.RemoteConfig; import org.eclipse.jgit.transport.URIish; +/** + * This class extends the JGit {@link Git} class to include Git repository + * caching on the local disk. Cache entries are expunged by expiration of + * the least recently accessed Git repositories. + * + * WARNING A cached Git repository may be in a state different than what would + * be expected of a fresh cloned Git repository. + * + * @author brian@inteligr8.com + */ +@PublicApi public class CachedGit extends Git { + /** + * This constructor initializes this object using a JGit {@link Git} object. + * + * @param git A JGit Git object + */ public CachedGit(Git git) { super(git.getRepository()); } - + + /** + * This constructor initializes this object using a JGit + * {@link CloneCommand} object. The clone will be performed before this + * method returns. + * + * @param clone A JGit Git object + * @throws TransportException A network exception occurred + * @throws InvalidRemoteException The specified remote URL does not reference a Git repository + * @throws GitAPIException A JGit exception occurred + */ public CachedGit(CloneCommand clone) throws TransportException, InvalidRemoteException, GitAPIException { super(clone.call().getRepository()); } + /** + * This constructor initializes this object using a JGit {@link Repository} + * object. + * + * @param repo A JGit Repository object + */ public CachedGit(Repository repo) { super(repo); } + /** + * This method retrieves the URL of the specified Git remote. All cloned + * repositories will have a default remote named 'origin'. This is + * required for the unique identification of Git repositories by the + * caching mechanism. + * + * @param remoteName The name of a Git remote defined on the repository. + * @return A JGit URI + * @throws GitAPIException A JGit exception + */ public URIish getRemoteUrl(String remoteName) throws GitAPIException { List configs = this.remoteList().call(); for (RemoteConfig config : configs) @@ -33,6 +89,10 @@ public class CachedGit extends Git { return null; } + /** + * This method overrides the default behavior of {@link Git#close()}, + * opting to return this Git repository to the cache instead. + */ @Override public void close() { LocalRepositoryCache.getInstance().release(this); diff --git a/src/main/java/com/inteligr8/git/CompositeIterator.java b/src/main/java/com/inteligr8/git/CompositeIterator.java index 49beefe..8a7b399 100644 --- a/src/main/java/com/inteligr8/git/CompositeIterator.java +++ b/src/main/java/com/inteligr8/git/CompositeIterator.java @@ -1,3 +1,17 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.util.Collection; @@ -6,12 +20,26 @@ import java.util.LinkedList; import java.util.List; import java.util.NoSuchElementException; +/** + * This class implements an iterator that spans multiple Java collections. + * The {@link Iterator#remove()} method is implemented. + * + * @author brian@inteligr8.com + * + * @param A data type + */ public class CompositeIterator implements Iterator { private final List> iterators = new LinkedList>(); private final Iterator> iteratorIterators; private Iterator iterator; + /** + * This constructor initializes this object with an array of Java + * Collections. + * + * @param cs An array of collections + */ public CompositeIterator(@SuppressWarnings("unchecked") Collection... cs) { for (Collection c : cs) if (c != null && !c.isEmpty()) @@ -19,6 +47,9 @@ public class CompositeIterator implements Iterator { this.iteratorIterators = this.iterators.iterator(); } + /** + * @see Iterator#hasNext() + */ @Override public boolean hasNext() { if (this.iterator == null) { @@ -31,7 +62,10 @@ public class CompositeIterator implements Iterator { this.iterator = this.iteratorIterators.next(); return this.iterator.hasNext(); } - + + /** + * @see Iterator#next() + */ @Override public E next() { if (!this.hasNext()) @@ -39,4 +73,13 @@ public class CompositeIterator implements Iterator { return this.iterator.next(); } + /** + * @see Iterator#remove() + */ + @Override + public void remove() { + if (this.iterator != null) + this.iterator.remove(); + } + } diff --git a/src/main/java/com/inteligr8/git/CredentialedGit.java b/src/main/java/com/inteligr8/git/CredentialedGit.java index 67c7ea6..7b5437a 100644 --- a/src/main/java/com/inteligr8/git/CredentialedGit.java +++ b/src/main/java/com/inteligr8/git/CredentialedGit.java @@ -1,3 +1,17 @@ +/* + * 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 . + */ package com.inteligr8.git; import org.eclipse.jgit.api.CloneCommand; @@ -12,39 +26,79 @@ import org.eclipse.jgit.api.errors.TransportException; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.transport.CredentialsProvider; +/** + * This class extends the {@link ExtendedGit} class to include authentication + * related functionality. + * + * @author brian@inteligr8.com + */ +@PublicApi public class CredentialedGit extends ExtendedGit { private CredentialsProvider credProvider; - - public CredentialedGit(CloneCommand clone, CredentialsProvider creds) throws TransportException, InvalidRemoteException, GitAPIException { - this(clone.setCredentialsProvider(creds).call(), creds); - } - + + /** + * @param git A JGit Git object + * @param creds A JGit credential provider + * @see CachedGit#CachedGit(Git) + */ public CredentialedGit(Git git, CredentialsProvider creds) { super(git.getRepository()); this.credProvider = creds; } + /** + * @param clone A JGit CloneCommand object + * @param creds A JGit credential provider + * @throws TransportException A network exception occurred + * @throws InvalidRemoteException The specified remote URL does not reference a Git repository + * @throws GitAPIException A JGit exception occurred + * @see CachedGit#CachedGit(CloneCommand) + */ + public CredentialedGit(CloneCommand clone, CredentialsProvider creds) throws TransportException, InvalidRemoteException, GitAPIException { + this(clone.setCredentialsProvider(creds).call(), creds); + } + + /** + * @param repo A JGit Repository object + * @param creds A JGit credential provider + * @throws TransportException A network exception occurred + * @throws InvalidRemoteException The specified remote URL does not reference a Git repository + * @throws GitAPIException A JGit exception occurred + * @see CachedGit#CachedGit(Repository) + */ public CredentialedGit(Repository repo, CredentialsProvider creds) { super(repo); this.credProvider = creds; } + /** + * @return A JGit FetchCommand with embedded credentials + */ @Override public FetchCommand fetch() { return super.fetch().setCredentialsProvider(this.credProvider); } - + + /** + * @return A JGit LsRemoteCommand with embedded credentials + */ @Override public LsRemoteCommand lsRemote() { return super.lsRemote().setCredentialsProvider(this.credProvider); } - + + /** + * @return A JGit PullCommand with embedded credentials + */ @Override public PullCommand pull() { return super.pull().setCredentialsProvider(this.credProvider); } - + + /** + * @return A JGit PushCommand with embedded credentials + */ @Override public PushCommand push() { return super.push().setCredentialsProvider(this.credProvider); diff --git a/src/main/java/com/inteligr8/git/DeveloperException.java b/src/main/java/com/inteligr8/git/DeveloperException.java index 906c20d..0605770 100644 --- a/src/main/java/com/inteligr8/git/DeveloperException.java +++ b/src/main/java/com/inteligr8/git/DeveloperException.java @@ -1,12 +1,38 @@ +/* + * 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 . + */ package com.inteligr8.git; import org.slf4j.Logger; -public class DeveloperException extends RuntimeException { +/** + * This class implements an exception that is the fault of the developer; not + * the user, system, network, infrastructure, etc... The purpose of this is + * similar to an assertion. + * + * @author brian@inteligr8.com + */ +class DeveloperException extends RuntimeException { private static final long serialVersionUID = 1600616227925437703L; private static final String MESSAGE = "This is a bug that needs to be addressed by the developer"; + /** + * This constructor initializes this object using a logger and exception. + * @param logger A SLF4J logger + * @param cause An exception causing this exception + */ public DeveloperException(Logger logger, Throwable cause) { super(MESSAGE, cause); logger.error(MESSAGE); diff --git a/src/main/java/com/inteligr8/git/ExpiringMapListener.java b/src/main/java/com/inteligr8/git/ExpiringMapListener.java index dfee830..27f7b62 100644 --- a/src/main/java/com/inteligr8/git/ExpiringMapListener.java +++ b/src/main/java/com/inteligr8/git/ExpiringMapListener.java @@ -1,9 +1,39 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.util.Map.Entry; +/** + * This interface defines a set of listeners for expiring maps to use in a + * publisher-subscription development model. + * + * @author brian@inteligr8.com + * + * @param A key data taype + * @param A value data type + */ public interface ExpiringMapListener extends MapListener { - + + /** + * This method allows the implementing class to listen for the expiring of + * something from a java.util.Map. An expired entry does not trigger the + * remove() callback. + * + * @param entry A map entry; never null; key is never null; value may be null + */ void expired(Entry entry); } diff --git a/src/main/java/com/inteligr8/git/ExtendedGit.java b/src/main/java/com/inteligr8/git/ExtendedGit.java index 7804b8b..da9460d 100644 --- a/src/main/java/com/inteligr8/git/ExtendedGit.java +++ b/src/main/java/com/inteligr8/git/ExtendedGit.java @@ -1,3 +1,17 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.io.IOException; @@ -6,7 +20,6 @@ import java.util.Collection; import java.util.Collections; import java.util.Comparator; import java.util.HashSet; -import java.util.Iterator; import java.util.LinkedList; import java.util.List; import java.util.Set; @@ -20,7 +33,6 @@ import org.eclipse.jgit.api.errors.GitAPIException; import org.eclipse.jgit.api.errors.InvalidRemoteException; import org.eclipse.jgit.api.errors.TransportException; import org.eclipse.jgit.lib.Constants; -import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Ref; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.transport.RemoteConfig; @@ -28,22 +40,45 @@ import org.eclipse.jgit.transport.URIish; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * This class extends the {@link CachedGit} class to include additional utility + * functions. + * + * @author brian@inteligr8.com + */ +@PublicApi public class ExtendedGit extends CachedGit { private final Logger logger = LoggerFactory.getLogger(ExtendedGit.class); + /** + * @see CachedGit#CachedGit(Git) + */ public ExtendedGit(Git git) { super(git.getRepository()); } - + + /** + * @see CachedGit#CachedGit(CloneCommand) + */ public ExtendedGit(CloneCommand clone) throws TransportException, InvalidRemoteException, GitAPIException { super(clone.call().getRepository()); } - + + /** + * @see CachedGit#CachedGit(Repository) + */ public ExtendedGit(Repository repo) { super(repo); } + /** + * This method finds the Git remotes that exist on the specified hostname. + * + * @param hostname A Git URL hostname + * @return A collection of JGit remotes + * @throws GitAPIException A JGit exception + */ public Collection findRemotesByHostname(String hostname) throws GitAPIException { List matchingRemotes = new LinkedList<>(); @@ -61,6 +96,14 @@ public class ExtendedGit extends CachedGit { return matchingRemotes; } + /** + * This method finds the Git remotes that contain the specified branch. + * + * @param branchName A Git branch name + * @return A collection of Git remote names + * @throws IOException An I/O related issue occurred + * @throws GitAPIException A JGit exception occurred + */ public Collection findRemoteNames(String branchName) throws IOException, GitAPIException { List remoteNames = new LinkedList<>(); @@ -71,7 +114,16 @@ public class ExtendedGit extends CachedGit { return remoteNames; } - + + /** + * This method finds the Git remote refs for the specified branch. A + * remote ref is in the format "refs/remotes/{remote}/{branch}". + * + * @param branchName A Git branch name + * @return A collection of Git remote refs + * @throws IOException An I/O related issue occurred + * @throws GitAPIException A JGit exception occurred + */ public Collection findRemoteRefsByName(String branchName) throws IOException, GitAPIException { List refs = new LinkedList<>(); @@ -84,14 +136,38 @@ public class ExtendedGit extends CachedGit { return refs; } - + + /** + * This method effectively places the Git HEAD at the specified ref. It + * will do this by reseting the current state and switching the HEAD to the + * specified ref. This is useful when you are dealing with a formerly + * cached Git repository and you need it in a clean state. + * + * @param ref A Git local ref + * @return The same Git local ref + * @throws IllegalArgumentException The ref must already exist + * @throws IOException An I/O related issue occurred + * @throws GitAPIException A JGit exception occurred + */ public Ref resetAndCheckout(Ref ref) throws IOException, GitAPIException { if (!ref.getName().startsWith(Constants.R_HEADS)) throw new IllegalArgumentException("The '" + ref + "' is not a local ref"); return this._resetAndCheckout(ref); } - + + /** + * This method effectively places the Git HEAD at the specified branch. It + * will do this by reseting the current state and switching the HEAD to the + * specified ref. This is useful when you are dealing with a formerly + * cached Git repository and you need it in a clean state. + * + * @param branchName A Git branch name + * @return A Git local ref + * @throws IllegalArgumentException The branch must have already been checked out + * @throws IOException An I/O related issue occurred + * @throws GitAPIException A JGit exception occurred + */ public Ref resetAndCheckout(String branchName) throws IOException, GitAPIException { if (this.logger.isTraceEnabled()) this.logger.trace("resetOrCheckout('" + branchName + "')"); @@ -122,7 +198,8 @@ public class ExtendedGit extends CachedGit { /** * This method retrieves all branches, but excludes remote branches that are tracked with a local branch. - * @return + * + * @return A list of Git refs */ @Deprecated public List getAllUniqueBranches() throws GitAPIException { @@ -131,7 +208,8 @@ public class ExtendedGit extends CachedGit { /** * This method retrieves all branches, but excludes remote branches that are tracked with a local branch. - * @return + * + * @return A list of Git refs */ @Deprecated public List getAllUniqueBranches(String containsCommitish) throws GitAPIException { @@ -202,18 +280,5 @@ public class ExtendedGit extends CachedGit { return trimmedBranches; } - - @Deprecated - private boolean allSameCommit(Collection refs) { - if (refs.size() < 2) - return true; - - Iterator i = refs.iterator(); - ObjectId commit = i.next().getObjectId(); - while (i.hasNext()) - if (!commit.equals(i.next().getObjectId())) - return false; - return true; - } } diff --git a/src/main/java/com/inteligr8/git/GitUrl.java b/src/main/java/com/inteligr8/git/GitUrl.java index adb1caf..b077229 100644 --- a/src/main/java/com/inteligr8/git/GitUrl.java +++ b/src/main/java/com/inteligr8/git/GitUrl.java @@ -1,3 +1,17 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.net.URISyntaxException; @@ -6,6 +20,13 @@ import java.util.regex.Pattern; import org.eclipse.jgit.transport.URIish; +/** + * This class implements a wrapper around the JGit URI implementation. Its + * main purpose is to provide simple access to values parsed from the URL. + * + * @author brian@inteligr8.com + */ +@PublicApi public class GitUrl { private static final Pattern gitUrlPattern = Pattern.compile("(((ssh|http(s)?)://([^@]+@)?([^:/]+)(:[0-9]+)?/)|git@([^:]+):)([\\w\\.@\\:/\\-~]+)(\\.git)"); @@ -14,6 +35,12 @@ public class GitUrl { private final String hostname; private final String fullyQualifiedRepositoryName; + /** + * This constructor initializes this object using the JGit URI. + * + * @param url A JGit URI + * @throws IllegalArgumentException The URL format does not match the expected pattern + */ public GitUrl(URIish url) { this.url = url.toString(); @@ -24,19 +51,35 @@ public class GitUrl { this.hostname = matcher.group(6) != null ? matcher.group(6) : matcher.group(8); this.fullyQualifiedRepositoryName = matcher.group(9); } - + + /** + * This constructor initializes this object using a URL in the string + * format. It will validate the URL format. + * + * @param url A Git URL + * @throws IllegalArgumentException The URL format does not match the expected pattern + */ public GitUrl(String url) throws URISyntaxException { this(new URIish(url)); } + /** + * @return A Git URL + */ public String getUrl() { return this.url; } + /** + * @return The hostname (no port) of the Git URL + */ public String getHostname() { return this.hostname; } + /** + * @return The fully qualified repository name. This includes the full path specified after the hostname. + */ public String getFullyQualifiedRepositoryName() { return this.fullyQualifiedRepositoryName; } diff --git a/src/main/java/com/inteligr8/git/InterruptableSemaphore.java b/src/main/java/com/inteligr8/git/InterruptableSemaphore.java new file mode 100644 index 0000000..2c89825 --- /dev/null +++ b/src/main/java/com/inteligr8/git/InterruptableSemaphore.java @@ -0,0 +1,135 @@ +/* + * 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 . + */ +package com.inteligr8.git; + +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; + +/** + * This class implements the ability to interrupt threads waiting for available + * permits. + * + * @author brian@inteligr8.com + */ +public class InterruptableSemaphore extends Semaphore { + + private static final long serialVersionUID = 8346747352241823763L; + private final Object sync = new Object(); + + /** + * @see Semaphore#Semaphore(int) + */ + public InterruptableSemaphore(int permits) { + super(permits); + } + + /** + * @see Semaphore#Semaphore(int, boolean) + */ + public InterruptableSemaphore(int permits, boolean fair) { + super(permits, fair); + } + + /** + * @see Semaphore#acquire() + */ + @Override + public void acquire() throws InterruptedException { + synchronized (this.sync) { + super.acquire(); + } + } + + /** + * @see Semaphore#acquire(int) + */ + @Override + public void acquire(int permits) throws InterruptedException { + synchronized (this.sync) { + super.acquire(permits); + } + } + + /** + * @see Semaphore#acquireUninterruptibly() + */ + @Override + public void acquireUninterruptibly() { + synchronized (this.sync) { + super.acquireUninterruptibly(); + } + } + + /** + * @see Semaphore#acquireUninterruptibly(int) + */ + @Override + public void acquireUninterruptibly(int permits) { + synchronized (this.sync) { + super.acquireUninterruptibly(permits); + } + } + + /** + * @see Semaphore#tryAcquire() + */ + @Override + public boolean tryAcquire() { + synchronized (this.sync) { + return super.tryAcquire(); + } + } + + /** + * @see Semaphore#tryAcquire(int) + */ + @Override + public boolean tryAcquire(int permits) { + synchronized (this.sync) { + return super.tryAcquire(permits); + } + } + + /** + * @see Semaphore#tryAcquire(long, TimeUnit) + */ + @Override + public boolean tryAcquire(long timeout, TimeUnit unit) throws InterruptedException { + synchronized (this.sync) { + return super.tryAcquire(timeout, unit); + } + } + + /** + * @see Semaphore#tryAcquire(int, long, TimeUnit) + */ + @Override + public boolean tryAcquire(int permits, long timeout, TimeUnit unit) throws InterruptedException { + synchronized (this.sync) { + return super.tryAcquire(permits, timeout, unit); + } + } + + /** + * This method interrupts all the threads waiting to acquire permits. + */ + public void interruptQueuedThreads() { + synchronized (this.sync) { + for (Thread thread : this.getQueuedThreads()) + thread.interrupt(); + } + } + +} diff --git a/src/main/java/com/inteligr8/git/LRUExpiringHashMap.java b/src/main/java/com/inteligr8/git/LRUExpiringHashMap.java index d98b7b8..61deac4 100644 --- a/src/main/java/com/inteligr8/git/LRUExpiringHashMap.java +++ b/src/main/java/com/inteligr8/git/LRUExpiringHashMap.java @@ -1,3 +1,17 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.io.Serializable; @@ -12,7 +26,20 @@ import java.util.Set; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -// TODO need to implement the actual expiration schedule +/** + * This clsas implements a map that orders entries from least recently used + * (LRU) to most recently used. The LRU entries are subject to expiration. + * This map also supports the publication-subscription development model with + * listener registration. + * + * TODO this is not a fully-complaint implementation of a Java Map + * TODO need to implement the actual expiration schedule + * + * @author brian@inteligr8.com + * + * @param A key data type + * @param A value data type + */ public class LRUExpiringHashMap implements ListeningMap { private final Logger logger = LoggerFactory.getLogger(LRUExpiringHashMap.class); @@ -22,16 +49,34 @@ public class LRUExpiringHashMap implements ListeningM private final List> listeners = new LinkedList>(); private final long expirationTimeMillis; + /** + * This constructor creates a map with the specified expiration time + * limit for entries. + * + * @param expirationTimeInMinutes A time in minutes + * @see LinkedHashMap#LinkedHashMap() + */ public LRUExpiringHashMap(int expirationTimeInMinutes) { this.map = new LinkedHashMap<>(); this.expirationTimeMillis = expirationTimeInMinutes * 60L + 1000L; } + /** + * This constructor creates a map with the specified expiration time + * limit for entries and the specified initial capacity. + * + * @param expirationTimeInMinutes A time in minutes + * @param initialCapacity The initial capacity + * @see LinkedHashMap#LinkedHashMap(int) + */ public LRUExpiringHashMap(int expirationTimeInMinutes, int initialCapacity) { this.map = new LinkedHashMap<>(initialCapacity); this.expirationTimeMillis = expirationTimeInMinutes * 60L + 1000L; } + /** + * @see ListeningMap#addListener(MapListener) + */ @Override public void addListener(MapListener listener) { if (this.logger.isDebugEnabled()) @@ -39,41 +84,70 @@ public class LRUExpiringHashMap implements ListeningM this.listeners.add(listener); } + /** + * @see Map#containsKey(Object) + */ @Override public boolean containsKey(Object key) { return this.map.containsKey(key); } - + + /** + * @see Map#containsValue(Object) + */ @Override public boolean containsValue(Object value) { return this.map.containsValue(value); } - + + /** + * @see Map#entrySet() + */ @Override public Set> entrySet() { throw new UnsupportedOperationException(); } + /** + * @see Map#keySet() + */ @Override public Set keySet() { throw new UnsupportedOperationException(); } - + + /** + * @see Map#values() + */ @Override public Collection values() { throw new UnsupportedOperationException(); } + /** + * @see Map#isEmpty() + */ @Override public boolean isEmpty() { return this.map.isEmpty(); } + /** + * @see Map#size() + */ @Override public int size() { return this.map.size(); } + /** + * This method acts as defined by the {@link java.util.Map} interface. Of + * note, it resets the expiration timer on the entry accessed. It will + * also trigger any listener to {@link MapListener#accessed(java.util.Map.Entry)}. + * + * @see Map#get(Object) + * @see MapListener#accessed(java.util.Map.Entry) + */ @Override @SuppressWarnings("unchecked") public V get(Object key) { @@ -92,7 +166,15 @@ public class LRUExpiringHashMap implements ListeningM listener.accessed(new ExpiringHashMapEntry((K)key, evalue.getValue())); return evalue.getValue(); } - + + /** + * This method acts as defined by the {@link java.util.Map} interface. Of + * note, it starts the expiration timer on the new or updated entry. It + * will also trigger any listener to {@link MapListener#added(java.util.Map.Entry)}. + * + * @see Map#put(Object, Object) + * @see MapListener#added(java.util.Map.Entry) + */ @Override public V put(K key, V value) { ExpiringValue evalue = new ExpiringValue(value, System.currentTimeMillis() + this.expirationTimeMillis); @@ -101,7 +183,14 @@ public class LRUExpiringHashMap implements ListeningM listener.added(new ExpiringHashMapEntry(key, value)); return oldValue == null ? null : oldValue.getValue(); } - + + /** + * This method acts as defined by the {@link java.util.Map} interface. Of + * note, it will trigger any listener to {@link MapListener#cleared(java.util.Map.Entry)}. + * + * @see Map#clear() + * @see MapListener#cleared(java.util.Map.Entry) + */ @Override public void clear() { List entries = new LinkedList<>(); @@ -116,7 +205,14 @@ public class LRUExpiringHashMap implements ListeningM for (MapListener listener : this.listeners) listener.cleared(entry); } - + + /** + * This method acts as defined by the {@link java.util.Map} interface. Of + * note, it will trigger any listener to {@link MapListener#removed(java.util.Map.Entry)}. + * + * @see Map#remove(Object) + * @see MapListener#removed(java.util.Map.Entry) + */ @SuppressWarnings("unchecked") @Override public V remove(Object key) { @@ -132,22 +228,41 @@ public class LRUExpiringHashMap implements ListeningM listener.removed(new ExpiringHashMapEntry((K)key, evalue.getValue())); return evalue.getValue(); } - + + /** + * This method is currently not implemented. + * FIXME + */ @Override public void putAll(Map m) { throw new UnsupportedOperationException(); } + /** + * @see LinkedHashMap#hashCode() + */ @Override public int hashCode() { return this.map.hashCode(); } + /** + * @see LinkedHashMap#equals(Object) + */ @Override public boolean equals(Object obj) { return this.map.equals(obj); } + /** + * This method scans the underlying map for expired entries. Since the map + * is ordered, it will immediately find and expire all applicable entries + * on the O(e). This method will also trigger any listener to + * {@link ExpiringMapListener#expired(java.util.Map.Entry)}. + * + * At this time, expiration does not remove entries from the java.util.Map + * periodically. This method must be used to enforce the removal. + */ public void exipriationCheck() { // since these should be order, we could break out of this loop once we reach an unexpired entry List entries = new LinkedList<>(); @@ -172,6 +287,14 @@ public class LRUExpiringHashMap implements ListeningM ((ExpiringMapListener)listener).expired(entry); } + /** + * This method explicitly expires the specified entry. This will expire + * and remove the entry from the underlying map. This is functionality + * equivalent to {@link Map#remove(Object)} except it will trigger any + * listener to {@link ExpiringMapListener#expired(java.util.Map.Entry)}. + * + * @param key A map entry key + */ public void expire(K key) { if (this.logger.isDebugEnabled()) this.logger.debug("expiring key from map: " + key); @@ -189,6 +312,9 @@ public class LRUExpiringHashMap implements ListeningM ((ExpiringMapListener)listener).expired(new ExpiringHashMapEntry(key, evalue.getValue())); } + /** + * @see LinkedHashMap#toString() + */ @Override public String toString() { return this.map.toString(); diff --git a/src/main/java/com/inteligr8/git/ListeningMap.java b/src/main/java/com/inteligr8/git/ListeningMap.java index bd47e6d..7f79287 100644 --- a/src/main/java/com/inteligr8/git/ListeningMap.java +++ b/src/main/java/com/inteligr8/git/ListeningMap.java @@ -1,9 +1,37 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.util.Map; +/** + * This interface defines a means by which to assign map listeners to a map. + * + * @author brian@inteligr8.com + * + * @param A key data taype + * @param A value data type + */ public interface ListeningMap extends Map { + /** + * A method that allows for map listeners to be added to the implementing + * class. + * + * @param listener A map listener. + */ void addListener(MapListener listener); } diff --git a/src/main/java/com/inteligr8/git/LocalRepositoryCache.java b/src/main/java/com/inteligr8/git/LocalRepositoryCache.java index 61c4b02..714bf3f 100644 --- a/src/main/java/com/inteligr8/git/LocalRepositoryCache.java +++ b/src/main/java/com/inteligr8/git/LocalRepositoryCache.java @@ -1,3 +1,17 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.io.File; @@ -22,10 +36,22 @@ import org.eclipse.jgit.util.FileUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * This class implements a Git local repository cache with built-in expiration + * capabilities. + * + * @author brian@inteligr8.com + */ +@PublicApi public class LocalRepositoryCache { private static final LocalRepositoryCache INSTANCE = new LocalRepositoryCache(); + /** + * This is a standard singleton accessor. + * + * @return The only object of this class + */ public static LocalRepositoryCache getInstance() { return INSTANCE; } @@ -35,7 +61,7 @@ public class LocalRepositoryCache { private final Logger logger = LoggerFactory.getLogger(LocalRepositoryCache.class); private final LRUExpiringHashMap cachedGits = new LRUExpiringHashMap<>(30); - private final Map gitUrlSemaphores = new HashMap<>(); + private final Map gitUrlSemaphores = new HashMap<>(); final File cacheDirectory = new File(System.getProperty("java.io.tmpdir"), "git"); private int simultaneousThreadsPerGitRepo = 1; @@ -70,24 +96,51 @@ public class LocalRepositoryCache { this.clear(); } - public CachedGit acquire(String url) throws InterruptedException, InvalidRemoteException, RefNotFoundException, TransportException, GitAPIException { - return this.acquire(url, null, null); + /** + * @see LocalRepositoryCache#acquire(String, CredentialsProvider, String) + */ + public CachedGit acquire(String url) throws InterruptedException, InvalidRemoteException, TransportException, GitAPIException { + try { + return this.acquire(url, null, null); + } catch (RefNotFoundException rnfe) { + // this should never happen + throw new DeveloperException(this.logger, rnfe); + } } - - public CachedGit acquire(String url, CredentialsProvider creds) throws InterruptedException, InvalidRemoteException, RefNotFoundException, TransportException, GitAPIException { - return this.acquire(url, creds, null); + + /** + * @see LocalRepositoryCache#acquire(String, CredentialsProvider, String) + */ + public CachedGit acquire(String url, CredentialsProvider creds) throws InterruptedException, InvalidRemoteException, TransportException, GitAPIException { + try { + return this.acquire(url, creds, null); + } catch (RefNotFoundException rnfe) { + // this should never happen + throw new DeveloperException(this.logger, rnfe); + } } - + + /** + * @see LocalRepositoryCache#acquire(String, CredentialsProvider, String) + */ public CachedGit acquire(String url, String branch) throws InterruptedException, InvalidRemoteException, RefNotFoundException, TransportException, GitAPIException { return this.acquire(url, null, branch); } /** + * This method checks out the specified Git repository. The Git repository + * may have been retrieved from a cache. On success, the Git repository + * HEAD is guaranteed to be clean and at the specified branch. The branch + * will be current to the 'origin' remote no matter how long the Git + * repository has been cached. * - * @param url A URL for the Git Repository. - * @param creds A username/password for the Git Repository. - * @param branch A branch name of the branch in the Git Repository to start working on. - * @return A JGit object. + * You expected to close or release the CachedGit after complete. A close + * will effectively release the object back to the cache. + * + * @param url A URL to a Git Repository + * @param creds A username/password to the Git Repository; null will only work with public Git remotes + * @param branch A branch name of the branch in the Git Repository to start working on; null will let the Git remote decide + * @return A cached JGit Git object * @throws InterruptedException The JVM was interrupted while the thread was waiting for another request on the same Git Repository * @throws InvalidRemoteException The URL refers to nothing or an invalid Git Repository * @throws RefNotFoundException The branch does not exist in the Git Repository represented by the URL @@ -99,19 +152,31 @@ public class LocalRepositoryCache { if (this.logger.isTraceEnabled()) this.logger.trace("acquire('" + url + "', " + creds + ", '" + branch + "')"); - Semaphore semaphore = null; + // managing a semaphore per URL + // fringe case: multiple URLs could technically refer to the same repo; not a functional problem + InterruptableSemaphore semaphore = null; synchronized (this) { semaphore = this.gitUrlSemaphores.get(url); if (semaphore == null) - this.gitUrlSemaphores.put(url, semaphore = new Semaphore(this.simultaneousThreadsPerGitRepo)); + this.gitUrlSemaphores.put(url, semaphore = new InterruptableSemaphore(this.simultaneousThreadsPerGitRepo)); } File gitRepoDirectory = null; + // enter thread-restricted block semaphore.acquire(); try { + // only the specified number of threads will be allowed in here at the same time + + // have we already dealt with the specified Git repository in a prevoius request? and was it returned to the cache? CachedGit git = this.cachedGits.remove(url); if (git == null) { + // we are here because: + // - we have not seen this URL + // - we have not seen this URL in a while (expired) + // - we are in multi-threaded mode and another thread is working on the same remote Git repo + + // we need to use a UUID for the filename if supporting multiple threads String directoryBaseName; if (this.simultaneousThreadsPerGitRepo == 1) directoryBaseName = new GitUrl(url).getFullyQualifiedRepositoryName().replace('/', '_'); @@ -122,6 +187,8 @@ public class LocalRepositoryCache { this.logger.debug("Git directory cache for clone: " + gitRepoDirectory); if (gitRepoDirectory.exists()) { + // the Git repository already exists, but it shouldn't + // it probably does from a previous JVM instance that was not properly cleaned up if (this.logger.isInfoEnabled()) this.logger.info("Git Repository already exists; reusing: " + gitRepoDirectory); git = creds != null ? new CredentialedGit(Git.open(gitRepoDirectory), creds) : new ExtendedGit(Git.open(gitRepoDirectory)); @@ -129,33 +196,46 @@ public class LocalRepositoryCache { } if (git == null) { + // we are here for the same reasons above, except in the bad shutdown case + + // prepare the 'git clone' command CloneCommand clone = new CloneCommand() .setURI(url) .setDirectory(gitRepoDirectory); if (branch != null) clone.setBranch(branch); + // git clone if (this.logger.isDebugEnabled()) this.logger.debug("Cloning Git repository: " + url); git = creds != null ? new CredentialedGit(clone, creds) : new ExtendedGit(clone); if (this.logger.isInfoEnabled()) this.logger.info("Cloned Git Repository: " + new GitUrl(git.getRemoteUrl("origin")).getFullyQualifiedRepositoryName()); } else { + // we are here because we already have a cloned Git repo + + // cleaning the current HEAD if (this.logger.isDebugEnabled()) this.logger.debug("resetting Git"); git.reset().setMode(ResetType.HARD).call(); + + // getting latest remote refs from 'origin' remote git.fetch().call(); if (branch != null && !branch.equals(git.getRepository().getBranch())) { + // we care about the branch we are on, and we ain't on the right one + if (this.logger.isDebugEnabled()) this.logger.debug("switching Git branches: " + branch); if (git.getRepository().exactRef(Constants.R_HEADS + branch) == null) { + // we have not checked this branch out before, so create it based on the 'origin' remote ref git.checkout().setName(branch).setStartPoint("origin/" + branch).setCreateBranch(true).call(); } else { git.checkout().setName(branch).call(); } } + // fast forward the local branch and HEAD to the latest remote ref (fetched earlier in this method) if (this.logger.isDebugEnabled()) this.logger.debug("updating Git branch: " + git.getRepository().getBranch()); git.pull().call(); @@ -172,8 +252,18 @@ public class LocalRepositoryCache { semaphore.release(); throw gae; } + + // the semaphore is not released on successful execution of this method on purpose + // the caller will operate on the Git repository with complete exclusion + // the caller is expected to "release" it when done + // the CachedGit will ensure it is released on "close" and at worst, during garbage collection } + /** + * This method releases the specified JGit Git object back to the cache. + * + * @param git A cachable JGit Git object + */ public void release(CachedGit git) { if (this.logger.isTraceEnabled()) this.logger.trace("release('" + git.getRepository().getIdentifier() + "')"); @@ -195,15 +285,24 @@ public class LocalRepositoryCache { } } + /** + * This method resets this cache as if it were a clean startup. It will + * also remove the Git repositories from the local disk. Any actively used + * Git repositories may continue. Their subsequent release will result in + * them being added to the cache. All threads waiting to acquire a Git + * repository will be interrupted resulting in an InterruptedException. + */ public void clear() { if (this.logger.isTraceEnabled()) this.logger.trace("clear()"); this.cachedGits.clear(); - for (Semaphore semaphore : this.gitUrlSemaphores.values()) - ; // FIXME interrupt all the threads; releasing semaphores will not be enough - this.gitUrlSemaphores.clear(); + synchronized (this) { + for (InterruptableSemaphore semaphore : this.gitUrlSemaphores.values()) + semaphore.interruptQueuedThreads(); + this.gitUrlSemaphores.clear(); + } } private void expunge(Git git) { diff --git a/src/main/java/com/inteligr8/git/MapListener.java b/src/main/java/com/inteligr8/git/MapListener.java index bf09a67..3fe2ca5 100644 --- a/src/main/java/com/inteligr8/git/MapListener.java +++ b/src/main/java/com/inteligr8/git/MapListener.java @@ -1,15 +1,66 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.util.Map.Entry; +/** + * This interface defines a set of listeners for maps to use in a + * publisher-subscription development model. + * + * @author brian@inteligr8.com + * + * @param A key data taype + * @param A value data type + */ public interface MapListener { + /** + * This method allows the implementing class to listen for the addition of + * something to a java.util.Map. + * + * @param entry A map entry; never null; key is never null; value may be null + */ void added(Entry entry); - + + /** + * This method allows the implementing class to listen for the accessing of + * something on a java.util.Map. An access is not triggered by the + * containsKey() or containsValue() method. + * + * @param entry A map entry; never null; key is never null; value may be null + */ void accessed(Entry entry); - + + /** + * This method allows the implementing class to listen for the removal of + * something from a java.util.Map. A clear() will not trigger this + * callback. + * + * @param entry A map entry; never null; key is never null; value may be null + */ void removed(Entry entry); - + + /** + * This method allows the implementing class to listen for the clearing of + * everything from a java.util.Map. A remove() will not trigger this + * callback, even on the last removed entry. This will be called for each + * and every entry that was on the map at the time of it being cleared. + * + * @param entry A map entry; never null; key is never null; value may be null + */ void cleared(Entry entry); } diff --git a/src/main/java/com/inteligr8/git/PublicApi.java b/src/main/java/com/inteligr8/git/PublicApi.java new file mode 100644 index 0000000..cb6c897 --- /dev/null +++ b/src/main/java/com/inteligr8/git/PublicApi.java @@ -0,0 +1,25 @@ +/* + * 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 . + */ +package com.inteligr8.git; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Target; + +@Documented +@Target({ElementType.TYPE, ElementType.METHOD}) +public @interface PublicApi { + +} diff --git a/src/main/java/com/inteligr8/git/UniquePriorityFifoQueue.java b/src/main/java/com/inteligr8/git/UniquePriorityFifoQueue.java index c0aa0a0..cafd85e 100644 --- a/src/main/java/com/inteligr8/git/UniquePriorityFifoQueue.java +++ b/src/main/java/com/inteligr8/git/UniquePriorityFifoQueue.java @@ -1,3 +1,17 @@ +/* + * 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 . + */ package com.inteligr8.git; import java.util.Arrays; @@ -10,6 +24,19 @@ import java.util.Queue; import java.util.Set; import java.util.TreeSet; +/** + * This class implements a priority, then FIFO (first-in/first-out) queue that + * ignores entries when there is a duplicate already on the queue. + * + * A duplicate is determined by the typical combination of hashCode() and + * equals() of the objects in the queue. The priority is determined by a + * `java.util.Comparator` specified at queue construction. + * + * @author brian@inteligr8.com + * + * @param The data type of the elements in the queue. Uniqueness is determined by multiple possible factors. + */ +@PublicApi public class UniquePriorityFifoQueue implements Queue { private final Counter counter = new SimpleCounter(); @@ -17,22 +44,40 @@ public class UniquePriorityFifoQueue implements Queue { private final TreeSet> elements; // TreeSet does not check for uniqueness using hashCode, but using the comparator instead private final Set> uelements; + private final Object sync = new Object(); + /** + * This constructor defines a unique FIFO queue without any priority + * characteristics. + */ public UniquePriorityFifoQueue() { this.elements = new TreeSet>(); this.uelements = new HashSet>(); } + /** + * This constructor defines a unique FIFO queue without any priority + * characteristics. It also stages the queue with objects from the + * specified collection. + * + * @param c A collection of objects, whose data types are compatible with the queue's. + */ public UniquePriorityFifoQueue(Collection c) { this(); this.addAll(c); } - public UniquePriorityFifoQueue(final Comparator comparator) { + /** + * This constructor defines a unique priority FIFO queue. The priority is + * determined by the specified Comparator in ascending order. + * + * @param priorityComparator A comparator. "Less than" is of highest priority. + */ + public UniquePriorityFifoQueue(final Comparator priorityComparator) { this.elements = new TreeSet>(new Comparator>() { @Override public int compare(PriorityFifoElement o1, PriorityFifoElement o2) { - int compare = comparator.compare(o1.element, o2.element); + int compare = priorityComparator.compare(o1.element, o2.element); if (compare != 0) return compare; return o1.compareTo(o2); } @@ -40,36 +85,65 @@ public class UniquePriorityFifoQueue implements Queue { this.uelements = new HashSet>(); } + /** + * This method acts as specified in the Queue interface. It is worth + * noting that it will return false if the specified object is a duplicate + * of an object already in the queue. + * + * @see Queue#add(Object) + */ @Override public boolean add(T e) { PriorityFifoElement element = new PriorityFifoElement(e, this.counter); - return this.uelements.add(element) && this.elements.add(element); + synchronized (this.sync) { + return this.uelements.add(element) && this.elements.add(element); + } } - + + /** + * This method acts as specified in the Queue interface. It is worth + * noting that it will return false if all the objects in the specified + * Collection are duplicates of objects already in the queue. + * + * @see Queue#addAll(Collection) + */ @Override public boolean addAll(Collection c) { boolean anyAdded = false; if (c != null) for (T e : c) { PriorityFifoElement element = new PriorityFifoElement(e, this.counter); - if (this.uelements.add(element) && this.elements.add(element)) - anyAdded = true; + synchronized (this.sync) { + if (this.uelements.add(element) && this.elements.add(element)) + anyAdded = true; + } } return anyAdded; } + /** + * @see Queue#clear() + */ @Override public void clear() { - this.elements.clear(); - this.uelements.clear(); + synchronized (this.sync) { + this.elements.clear(); + this.uelements.clear(); + } } + /** + * @see Queue#contains(Object) + */ @SuppressWarnings("unchecked") @Override public boolean contains(Object o) { return this.uelements.contains(new PriorityFifoElement((T)o, this.fakeCounter)); } - + + /** + * @see Queue#containsAll(Collection) + */ @Override public boolean containsAll(Collection c) { if (c != null) for (Object o : c) @@ -77,17 +151,28 @@ public class UniquePriorityFifoQueue implements Queue { return false; return true; } - + + /** + * @see Queue#element() + */ @Override public T element() { return this.elements.iterator().next().element; } - + + /** + * @see Queue#isEmpty() + */ @Override public boolean isEmpty() { return this.elements.isEmpty(); } + /** + * This method does return an Interator that supports the remove() method. + * + * @see Queue#iterator() + */ @Override public Iterator iterator() { final Iterator> i = this.elements.iterator(); @@ -107,58 +192,95 @@ public class UniquePriorityFifoQueue implements Queue { @Override public void remove() { - i.remove(); - uelements.remove(this.lastElement); + synchronized (sync) { + i.remove(); + uelements.remove(this.lastElement); + } } }; } - + + /** + * This method acts as specified in the Queue interface. It is worth + * noting that it will return false if the specified object is a duplicate + * of an object already in the queue. + * + * @see Queue#offer(Object) + * @see UniquePriorityFifoQueue#add(Object) + */ @Override public boolean offer(T e) { + // not a capacity restricting queue, so just use add() return this.add(e); } - + + /** + * @see Queue#peek() + */ @Override public T peek() { Iterator> i = this.elements.iterator(); return i.hasNext() ? i.next().element : null; } - + + /** + * @see Queue#poll() + */ @Override public T poll() { - PriorityFifoElement element = this.elements.pollFirst(); - if (element == null) - return null; - this.uelements.remove(element); - return element.element; - } - - @Override - public T remove() { - PriorityFifoElement element = this.elements.pollFirst(); - if (element == null) - throw new NoSuchElementException(); - this.uelements.remove(element); - return element.element; + synchronized (this.sync) { + PriorityFifoElement element = this.elements.pollFirst(); + if (element == null) + return null; + this.uelements.remove(element); + return element.element; + } } + /** + * @see Queue#remove() + */ + @Override + public T remove() { + synchronized (this.sync) { + PriorityFifoElement element = this.elements.pollFirst(); + if (element == null) + throw new NoSuchElementException(); + this.uelements.remove(element); + return element.element; + } + } + + /** + * @see Queue#remove(Object) + */ @SuppressWarnings("unchecked") @Override public boolean remove(Object o) { PriorityFifoElement element = new PriorityFifoElement((T)o, this.fakeCounter); - this.uelements.remove(element); - element = this.find(element.element); - return this.elements.remove(element); + // doing the find before the sync block so the find doesn't block threads + PriorityFifoElement realElement = this.find(element.element); + + synchronized (this.sync) { + this.uelements.remove(element); + return this.elements.remove(realElement); + } } - + + /** + * @see Queue#removeAll(Collection) + */ @Override public boolean removeAll(Collection c) { if (c != null) for (Object o : c) this.remove(o); return true; } - + + /** + * @see Queue#retainAll(Collection) + */ @Override public boolean retainAll(Collection c) { Iterator> i = this.elements.iterator(); @@ -166,19 +288,27 @@ public class UniquePriorityFifoQueue implements Queue { PriorityFifoElement e = i.next(); T element = e.element; if (!c.contains(element)) { - i.remove(); - this.uelements.remove(e); + synchronized (this.sync) { + i.remove(); + this.uelements.remove(e); + } } } return true; } - + + /** + * @see Queue#size() + */ @Override public int size() { return this.elements.size(); } - + + /** + * @see Queue#toArray() + */ @SuppressWarnings("unchecked") @Override public Object[] toArray() { @@ -188,7 +318,10 @@ public class UniquePriorityFifoQueue implements Queue { ts[i] = ((PriorityFifoElement)objs[i]).element; return ts; } - + + /** + * @see Queue#toArray(Object[]) + */ @SuppressWarnings("unchecked") public U[] toArray(U[] a) { if (a.length < this.elements.size()) @@ -218,7 +351,9 @@ public class UniquePriorityFifoQueue implements Queue { public PriorityFifoElement(E element, Counter counter) { this.element = element; - this.fifoId = counter.next(); + synchronized (counter) { + this.fifoId = counter.next(); + } } @Override