https://github.com/jcasbin/jdbc-adapter
JDBC adapter for Casbin
https://github.com/jcasbin/jdbc-adapter
access-control adapter authorization jcasbin mybatis orm storage-driver
Last synced: 14 days ago
JSON representation
JDBC adapter for Casbin
- Host: GitHub
- URL: https://github.com/jcasbin/jdbc-adapter
- Owner: jcasbin
- License: apache-2.0
- Created: 2018-08-02T11:50:20.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T14:02:51.000Z (7 months ago)
- Last Synced: 2025-03-29T15:04:32.675Z (about 1 month ago)
- Topics: access-control, adapter, authorization, jcasbin, mybatis, orm, storage-driver
- Language: Java
- Homepage: https://github.com/casbin/jcasbin
- Size: 101 KB
- Stars: 35
- Watchers: 4
- Forks: 39
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JDBC Adapter
====
[](https://codebeat.co/projects/github-com-jcasbin-jdbc-adapter-master)
[](https://github.com/jcasbin/jdbc-adapter/actions/workflows/maven-ci.yml)
[](https://codecov.io/gh/jcasbin/jdbc-adapter)
[](https://www.javadoc.io/doc/org.casbin/jdbc-adapter)
[](https://mvnrepository.com/artifact/org.casbin/jdbc-adapter/latest)
[](https://discord.gg/S5UjpzGZjN)
JDBC Adapter is the [JDBC](https://en.wikipedia.org/wiki/Java_Database_Connectivity) adapter for [jCasbin](https://github.com/casbin/jcasbin). With this library, jCasbin can load policy from JDBC supported database or save policy to it.
Based on [Supported JDBC Drivers and Databases](https://docs.oracle.com/cd/E19226-01/820-7688/gawms/index.html), The currently supported databases are:
- MySQL
- Java DB
- Oracle
- PostgreSQL
- DB2
- Sybase
- Microsoft SQL Server
## Installation
For Maven:
```xml
org.casbin
jdbc-adapter
LATEST
```
**Notice:**
Since version 2.0.2, jdbc-adapter adds an ``id`` field to the database table structure by default.
If you want to upgrade to 2.0.2 - 2.2.0, you have to add the ``id`` field manually. It is recommended to add the ``id`` field. If you don't want to add the ``id`` field, please use 2.2.1+.
## Simple Example
```java
package com.company.test;
import org.casbin.adapter.JDBCAdapter;
import org.casbin.jcasbin.main.Enforcer;
import com.mysql.cj.jdbc.MysqlDataSource;
public class Test {
public static void main() {
String driver = "com.mysql.cj.jdbc.Driver";
String url = "jdbc:mysql://localhost:3306/db_name";
String username = "root";
String password = "123456";
// The adapter will use the table named "casbin_rule".
// Use driver, url, username and password to initialize a JDBC adapter.
JDBCAdapter a = new JDBCAdapter(driver, url, username, password);
// Recommend use DataSource to initialize a JDBC adapter.
// Implementer of DataSource interface, such as hikari, c3p0, durid, etc.
MysqlDataSource dataSource = new MysqlDataSource();
dataSource.setURL(url);
dataSource.setUser(username);
dataSource.setPassword(password);
a = JDBCAdapter(dataSource);
Enforcer e = new Enforcer("examples/rbac_model.conf", a);
// Check the permission.
e.enforce("alice", "data1", "read");
// Modify the policy.
// e.addPolicy(...);
// e.removePolicy(...);
// Save the policy back to DB.
e.savePolicy();
// Close the connection.
a.close();
}
}
```
## Getting Help
- [jCasbin](https://github.com/casbin/jcasbin)
## License
This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.