////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
////

:apidocs: https://docs.spring.io/spring-security/site/docs/{springSecurityVersion}/apidocs/
:apidocs_spring: https://docs.spring.io/spring-framework/docs/{springFrameworkVersion}/javadoc-api/
:htmlsingle: https://docs.spring.io/spring-security/reference/{springSecurityVersion}/
:spring_framework_reference: https://docs.spring.io/spring-framework/reference/{springFrameworkVersion}/

= Grails Spring Security Plugins - Combined Reference Documentation
:revnumber: {projectVersion}
:doctype: book
:encoding: utf-8
:lang: en
:toc: left
:toclevels: 3
:numbered:
:icons: font
:source-highlighter: prettify
:idprefix:
:idseparator: -

include::introduction.adoc[]

include::whatsNew.adoc[]

include::upgrading.adoc[]

// =====================================================================
// Core Plugin
// =====================================================================

== Core Plugin

include::{core-docs-dir}/introduction.adoc[leveloffset=+1]

include::{core-docs-dir}/whatsNew.adoc[leveloffset=+1]

include::{core-docs-dir}/domainClasses.adoc[leveloffset=+1]

include::{core-docs-dir}/requestMappings.adoc[leveloffset=+1]

include::{core-docs-dir}/helperClasses.adoc[leveloffset=+1]

include::{core-docs-dir}/events.adoc[leveloffset=+1]

include::{core-docs-dir}/domainClassProperties.adoc[leveloffset=+1]

include::{core-docs-dir}/authentication.adoc[leveloffset=+1]

include::{core-docs-dir}/authenticationProviders.adoc[leveloffset=+1]

include::{core-docs-dir}/userDetailsService.adoc[leveloffset=+1]

include::{core-docs-dir}/passwords.adoc[leveloffset=+1]

include::{core-docs-dir}/urlProperties.adoc[leveloffset=+1]

include::{core-docs-dir}/hierarchicalRoles.adoc[leveloffset=+1]

include::{core-docs-dir}/switchUser.adoc[leveloffset=+1]

include::{core-docs-dir}/filters.adoc[leveloffset=+1]

include::{core-docs-dir}/channelSecurity.adoc[leveloffset=+1]

include::{core-docs-dir}/ip.adoc[leveloffset=+1]

include::{core-docs-dir}/sessionFixation.adoc[leveloffset=+1]

include::{core-docs-dir}/logoutHandlers.adoc[leveloffset=+1]

include::{core-docs-dir}/voters.adoc[leveloffset=+1]

include::{core-docs-dir}/miscProperties.adoc[leveloffset=+1]

include::{core-docs-dir}/configurationProperties.adoc[leveloffset=+1]

include::{core-docs-dir}/tutorials.adoc[leveloffset=+1]

include::{core-docs-dir}/examples.adoc[leveloffset=+1]

include::{core-docs-dir}/controllerMethods.adoc[leveloffset=+1]

include::{core-docs-dir}/i18n.adoc[leveloffset=+1]

include::{core-docs-dir}/scripts.adoc[leveloffset=+1]

include::{core-docs-dir}/debugging.adoc[leveloffset=+1]

=== API Reference

The Core plugin Groovydoc API documentation is available at https://apache.github.io/grails-spring-security/{projectVersion}/core-plugin/groovydoc/index.html[Core Plugin API Reference].

// =====================================================================
// ACL Plugin
// =====================================================================

== ACL Plugin

include::{acl-docs-dir}/introduction.adoc[leveloffset=+1]

include::{acl-docs-dir}/installing.adoc[leveloffset=+1]

include::{acl-docs-dir}/usage.adoc[leveloffset=+1]

include::{acl-docs-dir}/tutorial.adoc[leveloffset=+1]

include::{acl-docs-dir}/sampleApp.adoc[leveloffset=+1]

include::{acl-docs-dir}/AclUtilService.adoc[leveloffset=+1]

include::{acl-docs-dir}/Scripts.adoc[leveloffset=+1]

include::{acl-docs-dir}/TagLibraries.adoc[leveloffset=+1]

include::{acl-docs-dir}/history.adoc[leveloffset=+1]

=== API Reference

The ACL plugin Groovydoc API documentation is available at https://apache.github.io/grails-spring-security/{projectVersion}/acl-plugin/groovydoc/index.html[ACL Plugin API Reference].

// =====================================================================
// CAS Plugin
// =====================================================================

== CAS Plugin

include::{cas-docs-dir}/introduction.adoc[leveloffset=+1]

include::{cas-docs-dir}/usage.adoc[leveloffset=+1]

include::{cas-docs-dir}/configuration.adoc[leveloffset=+1]

include::{cas-docs-dir}/history.adoc[leveloffset=+1]

=== API Reference

The CAS plugin Groovydoc API documentation is available at https://apache.github.io/grails-spring-security/{projectVersion}/cas-plugin/groovydoc/index.html[CAS Plugin API Reference].

// =====================================================================
// LDAP Plugin
// =====================================================================

== LDAP Plugin

include::{ldap-docs-dir}/introduction.adoc[leveloffset=+1]

include::{ldap-docs-dir}/usage.adoc[leveloffset=+1]

include::{ldap-docs-dir}/configuration.adoc[leveloffset=+1]

=== API Reference

The LDAP plugin Groovydoc API documentation is available at https://apache.github.io/grails-spring-security/{projectVersion}/ldap-plugin/groovydoc/index.html[LDAP Plugin API Reference].

// =====================================================================
// OAuth2 Plugin
// =====================================================================

== OAuth2 Plugin

include::{oauth2-docs-dir}/introduction.adoc[leveloffset=+1]

include::{oauth2-docs-dir}/installation.adoc[leveloffset=+1]

include::{oauth2-docs-dir}/configuration.adoc[leveloffset=+1]

include::{oauth2-docs-dir}/extensions.adoc[leveloffset=+1]

=== API Reference

The OAuth2 plugin Groovydoc API documentation is available at https://apache.github.io/grails-spring-security/{projectVersion}/oauth2-plugin/groovydoc/index.html[OAuth2 Plugin API Reference].

// =====================================================================
// REST Plugin
// =====================================================================

== REST Plugin

include::{rest-docs-dir}/introduction.adoc[leveloffset=+1]

include::{rest-docs-dir}/whatsNew60.adoc[leveloffset=+1]

include::{rest-docs-dir}/whatsNew50.adoc[leveloffset=+1]

include::{rest-docs-dir}/whatsNew20.adoc[leveloffset=+1]

include::{rest-docs-dir}/whatsNew15.adoc[leveloffset=+1]

include::{rest-docs-dir}/whatsNew14.adoc[leveloffset=+1]

include::{rest-docs-dir}/configuration.adoc[leveloffset=+1]

include::{rest-docs-dir}/events.adoc[leveloffset=+1]

include::{rest-docs-dir}/authentication.adoc[leveloffset=+1]

include::{rest-docs-dir}/tokenGeneration.adoc[leveloffset=+1]

include::{rest-docs-dir}/tokenStorage.adoc[leveloffset=+1]

include::{rest-docs-dir}/tokenRendering.adoc[leveloffset=+1]

include::{rest-docs-dir}/tokenValidation.adoc[leveloffset=+1]

include::{rest-docs-dir}/cors.adoc[leveloffset=+1]

include::{rest-docs-dir}/oauth.adoc[leveloffset=+1]

include::{rest-docs-dir}/debugging.adoc[leveloffset=+1]

include::{rest-docs-dir}/faq.adoc[leveloffset=+1]

=== API Reference

The REST plugin Groovydoc API documentation is available at https://apache.github.io/grails-spring-security/{projectVersion}/rest-plugin/groovydoc/index.html[REST Plugin API Reference].

// =====================================================================
// UI Plugin
// =====================================================================

== UI Plugin

include::{ui-docs-dir}/introduction.adoc[leveloffset=+1]

include::{ui-docs-dir}/user.adoc[leveloffset=+1]

include::{ui-docs-dir}/role.adoc[leveloffset=+1]

include::{ui-docs-dir}/requestmap.adoc[leveloffset=+1]

include::{ui-docs-dir}/userRegistration.adoc[leveloffset=+1]

include::{ui-docs-dir}/forgotPassword.adoc[leveloffset=+1]

include::{ui-docs-dir}/acls.adoc[leveloffset=+1]

include::{ui-docs-dir}/persistentCookie.adoc[leveloffset=+1]

include::{ui-docs-dir}/configUI.adoc[leveloffset=+1]

include::{ui-docs-dir}/customization.adoc[leveloffset=+1]

include::{ui-docs-dir}/scripts.adoc[leveloffset=+1]

=== API Reference

The UI plugin Groovydoc API documentation is available at https://apache.github.io/grails-spring-security/{projectVersion}/ui-plugin/groovydoc/index.html[UI Plugin API Reference].
