Spring Security
Go to file
Phillip Webb 81fe9fc640 Make all exception classes immutable
Update all exception classes so that they are fully immutable and cannot
be changed once they have been thrown.

Issue gh-8945
2020-08-24 17:33:07 -05:00
.github Change pipeline to run for all base branches 2020-06-17 16:05:41 -05:00
.idea Add Checkstyle configuration for IntelliJ IDEA 2019-08-09 16:21:30 -05:00
acl Use consistent modifier order 2020-08-24 17:33:07 -05:00
aspects Apply code cleanup rules to projects 2020-08-24 17:33:07 -05:00
bom Use spring-build-conventions Bom plugin 2018-01-09 11:27:34 -06:00
buildSrc Replace VersionsResourceTasks with WriteProperties 2020-03-13 13:26:54 -05:00
cas Apply code cleanup rules to projects 2020-08-24 17:33:07 -05:00
config Use consistent modifier order 2020-08-24 17:33:07 -05:00
core Use consistent modifier order 2020-08-24 17:33:07 -05:00
crypto Use consistent modifier order 2020-08-24 17:33:07 -05:00
data Apply code cleanup rules to projects 2020-08-24 17:33:07 -05:00
docs Fix typo in resource server docs 2020-08-06 14:11:13 +02:00
etc Make all exception classes immutable 2020-08-24 17:33:07 -05:00
gradle Use reactor-netty-http for snapshot build 2020-08-05 11:50:50 -04:00
itest Apply code cleanup rules to projects 2020-08-24 17:33:07 -05:00
ldap Use consistent modifier order 2020-08-24 17:33:07 -05:00
messaging Remove (non-Javadoc) comments 2020-08-24 17:33:07 -05:00
oauth2 Make all exception classes immutable 2020-08-24 17:33:07 -05:00
openid Remove (non-Javadoc) comments 2020-08-24 17:33:07 -05:00
remoting Remove (non-Javadoc) comments 2020-08-24 17:33:07 -05:00
rsocket Apply code cleanup rules to projects 2020-08-24 17:33:07 -05:00
saml2/saml2-service-provider Make all exception classes immutable 2020-08-24 17:33:07 -05:00
samples Remove superfluous comments 2020-08-24 17:33:07 -05:00
scripts Add custom release notes configuration file 2019-12-31 14:19:40 -05:00
taglibs Apply code cleanup rules to projects 2020-08-24 17:33:07 -05:00
test Use consistent modifier order 2020-08-24 17:33:07 -05:00
web Make all exception classes immutable 2020-08-24 17:33:07 -05:00
.editorconfig Use UTF-8 for Java sources and XML 2019-08-14 08:47:00 -05:00
.gitignore Ignore Lock Files 2020-02-07 13:59:05 -06:00
CONTRIBUTING.adoc Use `Closes gh-<number>` 2020-06-11 15:34:35 -05:00
Jenkinsfile Fix SNAPSHOT builds 2020-08-10 11:35:15 -05:00
LICENSE.txt Add LICENSE.txt 2020-04-15 16:44:13 -05:00
README.adoc Remove Travis pipeline and README badge 2020-06-17 16:07:32 -05:00
build.gradle Add Spring Checkstyle with all checks disabled 2020-08-24 17:33:07 -05:00
class_mapping_from_2.0.x.txt SEC-1148: Simple classname mapping from 2.0 to 3.0 2009-12-02 22:44:30 +00:00
gradle.properties Add spring-javaformat plugin 2020-08-10 16:24:44 -05:00
gradlew Update to Gradle 6.1.1 2020-02-04 23:36:47 -06:00
gradlew.bat Update to Gradle 5.5 2019-07-11 22:15:42 -04:00
notice.txt URL Cleanup 2019-03-19 23:53:23 -05:00
settings.gradle Upgrade to Gradle Enterprise Plugin 3.2 2020-03-27 12:44:12 -05:00

README.adoc

image::https://badges.gitter.im/Join%20Chat.svg[Gitter,link=https://gitter.im/spring-projects/spring-security?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge]

= Spring Security

Spring Security provides security services for the https://docs.spring.io[Spring IO Platform]. Spring Security 5.0 requires Spring 5.0 as
a minimum and also requires Java 8.

For a detailed list of features and access to the latest release, please visit https://spring.io/projects[Spring projects].

== Code of Conduct
Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[code of conduct]

== Downloading Artifacts
See https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts[downloading Spring artifacts] for Maven repository information.

== Documentation
Be sure to read the https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference].
Extensive JavaDoc for the Spring Security code is also available in the https://docs.spring.io/spring-security/site/docs/current/api/[Spring Security API Documentation].

== Quick Start
We recommend you visit https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference] and read the "Getting Started" page.

== Building from Source
Spring Security uses a https://gradle.org[Gradle]-based build system.
In the instructions below, https://vimeo.com/34436402[`./gradlew`] is invoked from the root of the source tree and serves as
a cross-platform, self-contained bootstrap mechanism for the build.

=== Prerequisites
https://help.github.com/set-up-git-redirect[Git] and the https://www.oracle.com/technetwork/java/javase/downloads[JDK8 build].

Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder extracted from the JDK download.

=== Check out sources
[indent=0]
----
git clone git@github.com:spring-projects/spring-security.git
----

=== Install all spring-\* jars into your local Maven cache
[indent=0]
----
./gradlew install
----

=== Compile and test; build all jars, distribution zips, and docs
[indent=0]
----
./gradlew build
----

Discover more commands with `./gradlew tasks`.
See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].

== Getting Support
Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow].
https://spring.io/services[Commercial support] is available too.

== Contributing
https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.adoc[contributor guidelines] for details.

== License
Spring Security is Open Source software released under the
https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].