Commit 7f8baa6f authored by Brian Long's avatar Brian Long
Browse files

initial checkin

parents

.gitignore

0 → 100644
+9 −0
Original line number Diff line number Diff line 
# Maven

target

pom.xml.versionsBackup



# Eclipse

.settings

.project

.classpath

COPYING.LESSER.md

0 → 100644
+157 −0
Original line number Diff line number Diff line 
### GNU LESSER GENERAL PUBLIC LICENSE



Version 3, 29 June 2007



Copyright (C) 2007 Free Software Foundation, Inc.

<https://fsf.org/>



Everyone is permitted to copy and distribute verbatim copies of this

license document, but changing it is not allowed.



This version of the GNU Lesser General Public License incorporates the

terms and conditions of version 3 of the GNU General Public License,

supplemented by the additional permissions listed below.



#### 0. Additional Definitions.



As used herein, "this License" refers to version 3 of the GNU Lesser

General Public License, and the "GNU GPL" refers to version 3 of the

GNU General Public License.



"The Library" refers to a covered work governed by this License, other

than an Application or a Combined Work as defined below.



An "Application" is any work that makes use of an interface provided

by the Library, but which is not otherwise based on the Library.

Defining a subclass of a class defined by the Library is deemed a mode

of using an interface provided by the Library.



A "Combined Work" is a work produced by combining or linking an

Application with the Library. The particular version of the Library

with which the Combined Work was made is also called the "Linked

Version".



The "Minimal Corresponding Source" for a Combined Work means the

Corresponding Source for the Combined Work, excluding any source code

for portions of the Combined Work that, considered in isolation, are

based on the Application, and not on the Linked Version.



The "Corresponding Application Code" for a Combined Work means the

object code and/or source code for the Application, including any data

and utility programs needed for reproducing the Combined Work from the

Application, but excluding the System Libraries of the Combined Work.



#### 1. Exception to Section 3 of the GNU GPL.



You may convey a covered work under sections 3 and 4 of this License

without being bound by section 3 of the GNU GPL.



#### 2. Conveying Modified Versions.



If you modify a copy of the Library, and, in your modifications, a

facility refers to a function or data to be supplied by an Application

that uses the facility (other than as an argument passed when the

facility is invoked), then you may convey a copy of the modified

version:



-   a) under this License, provided that you make a good faith effort

    to ensure that, in the event an Application does not supply the

    function or data, the facility still operates, and performs

    whatever part of its purpose remains meaningful, or

-   b) under the GNU GPL, with none of the additional permissions of

    this License applicable to that copy.



#### 3. Object Code Incorporating Material from Library Header Files.



The object code form of an Application may incorporate material from a

header file that is part of the Library. You may convey such object

code under terms of your choice, provided that, if the incorporated

material is not limited to numerical parameters, data structure

layouts and accessors, or small macros, inline functions and templates

(ten or fewer lines in length), you do both of the following:



-   a) Give prominent notice with each copy of the object code that

    the Library is used in it and that the Library and its use are

    covered by this License.

-   b) Accompany the object code with a copy of the GNU GPL and this

    license document.



#### 4. Combined Works.



You may convey a Combined Work under terms of your choice that, taken

together, effectively do not restrict modification of the portions of

the Library contained in the Combined Work and reverse engineering for

debugging such modifications, if you also do each of the following:



-   a) Give prominent notice with each copy of the Combined Work that

    the Library is used in it and that the Library and its use are

    covered by this License.

-   b) Accompany the Combined Work with a copy of the GNU GPL and this

    license document.

-   c) For a Combined Work that displays copyright notices during

    execution, include the copyright notice for the Library among

    these notices, as well as a reference directing the user to the

    copies of the GNU GPL and this license document.

-   d) Do one of the following:

    -   0) Convey the Minimal Corresponding Source under the terms of

        this License, and the Corresponding Application Code in a form

        suitable for, and under terms that permit, the user to

        recombine or relink the Application with a modified version of

        the Linked Version to produce a modified Combined Work, in the

        manner specified by section 6 of the GNU GPL for conveying

        Corresponding Source.

    -   1) Use a suitable shared library mechanism for linking with

        the Library. A suitable mechanism is one that (a) uses at run

        time a copy of the Library already present on the user's

        computer system, and (b) will operate properly with a modified

        version of the Library that is interface-compatible with the

        Linked Version.

-   e) Provide Installation Information, but only if you would

    otherwise be required to provide such information under section 6

    of the GNU GPL, and only to the extent that such information is

    necessary to install and execute a modified version of the

    Combined Work produced by recombining or relinking the Application

    with a modified version of the Linked Version. (If you use option

    4d0, the Installation Information must accompany the Minimal

    Corresponding Source and Corresponding Application Code. If you

    use option 4d1, you must provide the Installation Information in

    the manner specified by section 6 of the GNU GPL for conveying

    Corresponding Source.)



#### 5. Combined Libraries.



You may place library facilities that are a work based on the Library

side by side in a single library together with other library

facilities that are not Applications and are not covered by this

License, and convey such a combined library under terms of your

choice, if you do both of the following:



-   a) Accompany the combined library with a copy of the same work

    based on the Library, uncombined with any other library

    facilities, conveyed under the terms of this License.

-   b) Give prominent notice with the combined library that part of it

    is a work based on the Library, and explaining where to find the

    accompanying uncombined form of the same work.



#### 6. Revised Versions of the GNU Lesser General Public License.



The Free Software Foundation may publish revised and/or new versions

of the GNU Lesser General Public License from time to time. Such new

versions will be similar in spirit to the present version, but may

differ in detail to address new problems or concerns.



Each version is given a distinguishing version number. If the Library

as you received it specifies that a certain numbered version of the

GNU Lesser General Public License "or any later version" applies to

it, you have the option of following the terms and conditions either

of that published version or of any later version published by the

Free Software Foundation. If the Library as you received it does not

specify a version number of the GNU Lesser General Public License, you

may choose any version of the GNU Lesser General Public License ever

published by the Free Software Foundation.



If the Library as you received it specifies that a proxy can decide

whether future versions of the GNU Lesser General Public License shall

apply, that proxy's public statement of acceptance of any version is

permanent authorization for you to choose that version for the

Library.

COPYING.md

0 → 100644
+675 −0

File added.

Preview size limit exceeded, changes collapsed.

README.md

0 → 100644
+65 −0
Original line number Diff line number Diff line 


# Artifact Ban Maven Plugin



This is a maven plugin that allows for developers and organizations to ban Maven artifacts.  We are keenly aware of the capability in the `maven-enforcer-plugin`.  Instead of simply generating an error when a banned artifact is referenced, this plugin prevents the artifact from being downloaded as well.  This is crucial within certain organizations with strict security scans that crawl the Maven cache.



## Usage



```xml

<project>

    ...

    <build>

        ...

        <plugins>

            ...

            <plugin>

                <groupId>com.inteligr8</groupId>

                <artifactId>ban-maven-plugin</artifactId>

                <version>...</version>

                <extensions>true</extensions>

                <configuration>

                    <includes>

                        <artifact>

                            <groupId>...<groupId>

                            <artifactId>...<artifactId>

                            <version>...</version>

                        </artifact>

                        <artifact>

                            <groupIdRegex>...<groupIdRegex>

                            <artifactIdRegex>...<artifactIdRegex>

                            <version>...</version>

                        </artifact>

                        <artifact>com.inteligr8:ban-maven-plugin:[,1.0.0)</artifact>

                        <artifact>log4j:log4j</artifact>

                        <artifact>org\.springframework.*::[,4.0.0.RELEASE)</artifact>

                    </includes>

                    <excludes>

                    	   <artifact>

                    	       ....

                    	   </artifact>

                    </excludes>

                </configuration>

            </plugin>

            ...

        </plugins>

        ...

    </build>

    ...

</project>

```



The `extensions` elements is critical.  Without it, the plugin does nothing.  With it, the plugin is able to detected ban artifacts before they are downloaded.



If no `includes` are provided, then no artifacts will be banned.  An *included* artifact is a banned artifact.  An *excluded* artifact is not banned.  It is the opposite of what you may think.



If `groupId` is not provided, it is ignored in the matching process.  So it will match all artifact group IDs and the constraint will be for `artifactId` and `version` only.  The same is true for `artifactId` and `version`.  This means that `<includes><artifact></artifact></includes>` will ban every artifact.



If `groupId` and `groupIdRegex` are both provided, only `groupId` is used.  The same is true for `artifactId` and `artifactIdRegex`.  The `*Regex` values use standard Java regular expressions.  If using regular expressions, remember to escape the dots (`\.`) in group IDs.



The `version` element supports the standard Maven specification.  You can match a specific version like `1.0.0`.  Or you can match all versions before `1.2.17` like `[,1.2.17)`.  You can match all future versions after `1.2.17` (inclusive) with `[1.2.17,)`.



There is nothing stopping you from specifying two `artifact` elements with the exact same values.  So you can ban multiple version ranges of the same artifact by using multiple `artifact` elements.



If you *include* all versions by omitting the `version` element, you can still *exclude* (unban) certain versions, like `[1.2.17,)`.



It is recommended that you look into [Maven Tiles](https://github.com/repaint-io/maven-tiles) so you can use a tile to define your banned artifacts and side load them into all your projects.
 
 No newline at end of file

pom.xml

0 → 100644
+253 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>



<project xmlns="http://maven.apache.org/POM/4.0.0"

		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

		xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>



	<groupId>com.inteligr8</groupId>

	<artifactId>ban-maven-plugin</artifactId>

	<version>1.0-SNAPSHOT</version>

	<packaging>maven-plugin</packaging>



	<name>Ban Dependencies Maven Plugin</name>

	<description>A Maven plugin for banning dependencies from being downloaded or used</description>

	<url>https://bitbucket.org/inteligr8/ban-maven-plugin</url>



	<licenses>

		<license>

			<name>GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007</name>

			<url>https://www.gnu.org/licenses/lgpl-3.0.txt</url>

		</license>

	</licenses>



	<scm>

		<connection>scm:git:https://bitbucket.org/inteligr8/ban-maven-plugin.git</connection>

		<developerConnection>scm:git:git@bitbucket.org:inteligr8/ban-maven-plugin.git</developerConnection>

		<url>https://bitbucket.org/inteligr8/ban-maven-plugin</url>

	</scm>

	<organization>

		<name>Inteligr8</name>

		<url>https://www.inteligr8.com</url>

	</organization>

	<developers>

		<developer>

			<id>brian.long</id>

			<name>Brian Long</name>

			<email>brian@inteligr8.com</email>

			<url>https://twitter.com/brianmlong</url>

		</developer>

	</developers>



	<properties>

		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

		<maven.compiler.source>1.8</maven.compiler.source>

		<maven.compiler.target>1.8</maven.compiler.target>

		<maven.version>3.9.0</maven.version>

	</properties>



	<dependencies>

		<dependency>

			<groupId>org.apache.commons</groupId>

			<artifactId>commons-lang3</artifactId>

			<version>3.4</version>

		</dependency>

		<dependency>

			<groupId>org.apache.maven.shared</groupId>

			<artifactId>file-management</artifactId>

			<version>3.1.0</version>

		</dependency>

		<dependency>

			<groupId>org.apache.maven</groupId>

			<artifactId>maven-plugin-api</artifactId>

			<version>${maven.version}</version>

			<scope>provided</scope>

		</dependency>

		<dependency>

			<groupId>org.apache.maven.plugin-tools</groupId>

			<artifactId>maven-plugin-annotations</artifactId>

			<version>3.7.1</version>

			<scope>provided</scope>

		</dependency>

		<dependency>

			<groupId>org.apache.maven</groupId>

			<artifactId>maven-core</artifactId>

			<version>${maven.version}</version>

			<scope>provided</scope>

		</dependency>

		<dependency>

			<groupId>org.apache.maven.plugin-testing</groupId>

			<artifactId>maven-plugin-testing-harness</artifactId>

			<version>3.3.0</version>

			<scope>test</scope>

		</dependency>

		<dependency>

			<groupId>org.apache.maven</groupId>

			<artifactId>maven-compat</artifactId>

			<version>${maven.version}</version>

			<scope>test</scope>

		</dependency>

		<dependency>

			<groupId>junit</groupId>

			<artifactId>junit</artifactId>

			<version>4.12</version>

			<scope>test</scope>

		</dependency>

	</dependencies>

	

	<build>

		<plugins>

			<plugin>

				<artifactId>maven-plugin-plugin</artifactId>

				<version>3.7.1</version>

				<executions>

					<execution>

						<id>default-descriptor</id>

						<goals>

							<goal>descriptor</goal>

						</goals>

					</execution>

					<execution>

						<id>help-descriptor</id>

						<goals>

							<goal>helpmojo</goal>

						</goals>

					</execution>

				</executions>

			</plugin>

			<plugin>

				<groupId>org.eclipse.sisu</groupId>

				<artifactId>sisu-maven-plugin</artifactId>

				<version>0.3.5</version>

				<executions>

					<execution>

						<id>generate-index</id>

						<goals>

							<goal>main-index</goal>

						</goals>

					</execution>

				</executions>

			</plugin>

			<plugin>

				<groupId>org.codehaus.plexus</groupId>

				<artifactId>plexus-component-metadata</artifactId>

				<version>2.1.1</version>

				<executions>

					<execution>

						<goals>

							<goal>generate-metadata</goal>

						</goals>

					</execution>

				</executions>

			</plugin>

			<plugin>

				<artifactId>maven-invoker-plugin</artifactId>

				<version>3.4.0</version>

				<configuration>

					<projectsDirectory>${basedir}/src/it</projectsDirectory>

					<cloneProjectsTo>${project.build.directory}/it</cloneProjectsTo>

					<localRepositoryPath>${project.build.directory}/it-repo</localRepositoryPath>

					<mavenHome>${env.MAVEN_HOME}</mavenHome>

					<debug>true</debug>

					<ignoreFailures>true</ignoreFailures>

					<properties>

						<project.main.basedir>${basedir}</project.main.basedir>

					</properties>

				</configuration>

				<executions>

					<execution>

						<id>run-its</id>

						<goals>

							<goal>install</goal>

							<goal>run</goal>

						</goals>

					</execution>

				</executions>

			</plugin>

		</plugins>

	</build>

	

	<profiles>

		<profile>

			<id>run-it-1</id>

			<activation>

				<property>

					<name>run-it</name>

				</property>

			</activation>

			<build>

				<plugins>

					<plugin>

						<artifactId>maven-invoker-plugin</artifactId>

						<version>3.2.2</version>

						<executions>

							<execution>

								<id>run-its</id>

								<goals>

									<goal>install</goal>

									<goal>run</goal>

								</goals>

								<configuration>

									<pomIncludes>

										<pomInclude>${run-it}/pom.xml</pomInclude>

									</pomIncludes>

								</configuration>

							</execution>

						</executions>

					</plugin>

				</plugins>

			</build>

		</profile>

		<profile>

			<id>ossrh-release</id>

			<build>

				<plugins>

					<plugin>

						<artifactId>maven-source-plugin</artifactId>

						<executions>

							<execution>

								<id>source</id>

								<phase>package</phase>

								<goals><goal>jar-no-fork</goal></goals>

							</execution>

						</executions>

					</plugin>

					<plugin>

						<artifactId>maven-javadoc-plugin</artifactId>

						<executions>

							<execution>

								<id>javadoc</id>

								<phase>package</phase>

								<goals><goal>jar</goal></goals>

								<configuration>

									<show>public</show>

								</configuration>

							</execution>

						</executions>

					</plugin>

					<plugin>

						<artifactId>maven-gpg-plugin</artifactId>

						<executions>

							<execution>

								<id>sign</id>

								<phase>verify</phase>

								<goals><goal>sign</goal></goals>

							</execution>

						</executions>

					</plugin>

					<plugin>

						<groupId>org.sonatype.plugins</groupId>

						<artifactId>nexus-staging-maven-plugin</artifactId>

						<version>1.6.13</version>

						<extensions>true</extensions>

						<configuration>

							<serverId>ossrh</serverId>

							<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>

							<autoReleaseAfterClose>true</autoReleaseAfterClose>

						</configuration>

					</plugin>

				</plugins>

			</build>

		</profile>

	</profiles>

</project>