(Quick Reference)
4 Configuration - Reference Documentation
Authors: Pavel Burov
Version: 1.0
4 Configuration
Basic Configuration
Make sure that you have installed and configured spring-security-core plugin before this step.
Calling 'grails s2-init-vkontakte' will make default configuration of plugin for you, make sure that you have configuration in your
Config.groovy
like:
grails.plugin.springsecurity.vkontakte.domain.className = '<your VkontakteUser domain>'
grails.plugin.springsecurity.vkontakte.appId = '<Vkontakte appId>'
grails.plugin.springsecurity.vkontakte.secret = '<Vkontakte secret>'
Or you can skip 'grails s2-init-vkontakte' step, and make such configuration by yourself.
When you have valid configuration you can put Vkontakte Connect button in you GSP:
<vkontakteAuth:connect />
Vkontakte configuration
Name | Default Value |
---|
grails.plugin.springsecurity.vkontakte.appId | must be specified |
grails.plugin.springsecurity.vkontakte.secret | must be specified |
Permissions
Name | Default Value |
---|
grails.plugin.springsecurity.vkontakte.permissions | |
See:
Vkontakte App permissionsDomain configuration
Name | Default Value |
---|
grails.plugin.springsecurity.vkontakte.domain.className | VkontakteUser |
grails.plugin.springsecurity.vkontakte.domain.userConnectionPropertyName | user |
grails.plugin.springsecurity.vkontakte.domain.userIdPropertyName | vkId |
Where:
.classname
- domain class name that will be used for authentication
.connectionPropertyName
- name of property that connects (belongsTo) to main app user (if you have two different domains, one for app user, one for Vkontakte user)
.userIdPropertyName
- name of property to hold Vkontakte user id
Authentication configuration
Name | Default Value |
---|
grails.plugin.springsecurity.vkontakte.autoCreate.enabled | true |
grails.plugin.springsecurity.vkontakte.autoCreate.roles | 'ROLE_USER', 'ROLE_VKONTAKTE' |
Where:
.autoCreate.enabled
- plugin will automatically create corresponding user for each new visitor authentication using Vkontakte
.autoCreate.roles
- default list of roles that will be assigned to create user
Filters configuration
Redirect
Name | Default Value |
---|
grails.plugin.springsecurity.vkontakte.filters.redirect.processUrl | '/j_spring_security_vkontakte_check' |
grails.plugin.springsecurity.vkontakte.filters.redirect.position | SecurityFilterPosition.OPENID_FILTER.order + 1 |
grails.plugin.springsecurity.vkontakte.filters.redirect.authenticationSuccessHandler | '' |
grails.plugin.springsecurity.vkontakte.filters.redirect.authenticationFailureHandler | '' |
grails.plugin.springsecurity.vkontakte.filters.redirect.successHandler | {} |
grails.plugin.springsecurity.vkontakte.filters.redirect.failureHandler | {} |
Where:
.filters.redirect.processUrl
- url that will be used for authentication
.filters.redirect.position
- filter position
.filters.redirect.authenticationSuccessHandler
- bean name to use as authentication successHandler
.filters.redirect.authenticationFailureHandler
- bean name to use as authentication FailureHandler
.filters.redirect.successHandler
- configuration for predefined handler
.filters.redirect.failureHandler
- configuration for predefined handler
Open API
Name | Default Value |
---|
grails.plugin.springsecurity.vkontakte.filters.openApi.processUrl | '/j_spring_security_vkontakte_open_api_check' |
grails.plugin.springsecurity.vkontakte.filters.openApi.position | SecurityFilterPosition.OPENID_FILTER.order + 2 |
grails.plugin.springsecurity.vkontakte.filters.openApi.authenticationSuccessHandler | '' |
grails.plugin.springsecurity.vkontakte.filters.openApi.authenticationFailureHandler | '' |
Where:
.filters.openApi.processUrl
- url that will be used for authentication
.filters.openApi.position
- filter position
.filters.openApi.authenticationSuccessHandler
- bean name to use as authentication successHandler
.filters.openApi.authenticationFailureHandler
- bean name to use as authentication FailureHandler