Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Filter tenants based on domains name #4096

Merged
merged 5 commits into from
Oct 24, 2024
Merged

Filter tenants based on domains name #4096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6c317f3
Filter by domains in get tenants API
hwupathum Oct 22, 2024
a600793
Extract domain from filter in kernel level
hwupathum Oct 23, 2024
6ad453a
Rename filter attribute
hwupathum Oct 23, 2024
f53f3ed
Fix review comments
hwupathum Oct 23, 2024
d57b68c
Rename getCountOfTenants methods
hwupathum Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 89 additions & 29 deletions ...o2.carbon.user.core/src/main/java/org/wso2/carbon/user/core/tenant/JDBCTenantManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
import org.wso2.carbon.user.core.hybrid.HybridJDBCConstants;
import org.wso2.carbon.user.core.internal.UserStoreMgtDSComponent;
import org.wso2.carbon.user.core.jdbc.JDBCRealmConstants;
import org.wso2.carbon.user.core.model.ExpressionOperation;
import org.wso2.carbon.user.core.service.RealmService;
import org.wso2.carbon.user.core.util.DatabaseUtil;
import org.wso2.carbon.utils.CarbonUtils;
Expand Down Expand Up @@ -87,6 +88,12 @@ public class JDBCTenantManager implements TenantManager {
private static final String MARIADB = "mariadb";
private static final String POSTGRESQL = "postgresql";
private static final String H2 = "h2";
private static final String SPACE_SEPARATOR = " ";
private static final String DOMAIN_NAME = "domainName";
private static final String SQL_FILTER_STRING_ANY = "%";
private static final String SQL_WHERE_CLAUSE = "WHERE";
private static final String SQL_AND_CLAUSE = "AND";

/**
* Map which maps tenant domains to tenant IDs
* <p/>
Expand Down Expand Up @@ -562,12 +569,13 @@ public TenantSearchResult listTenants(Integer limit, Integer offset, String sort
throws UserStoreException {

TenantSearchResult tenantSearchResult = new TenantSearchResult();
String sortedOrder = sortBy + " " + sortOrder;
String sortedOrder = sortBy + SPACE_SEPARATOR + sortOrder;
String domainName = buildDomainNameFilter(filter);
try (Connection dbConnection = getDBConnection();
ResultSet resultSet = getTenantQueryResultSet(dbConnection, sortedOrder, offset, limit)) {
ResultSet resultSet = getTenantQueryResultSet(dbConnection, sortedOrder, offset, limit, domainName)) {
List<Tenant> tenantList = populateTenantList(resultSet);
tenantSearchResult.setTenantList(tenantList);
tenantSearchResult.setTotalTenantCount(getCountOfTenants());
tenantSearchResult.setTotalTenantCount(getTenantResultCount(domainName));
tenantSearchResult.setLimit(limit);
tenantSearchResult.setOffSet(offset);
tenantSearchResult.setSortBy(sortBy);
Expand Down Expand Up @@ -1274,12 +1282,23 @@ private StringBuilder printCurrentStackTrace() {
* @return number of tenant count.
* @throws UserStoreException Error when getting count of tenants.
*/
private int getCountOfTenants() throws UserStoreException {

String sqlStmt = TenantConstants.LIST_TENANTS_COUNT_SQL;
private int getTenantResultCount(String domainName) throws UserStoreException {

String sqlFilter = StringUtils.EMPTY;
if (StringUtils.isNotBlank(domainName)) {
hwupathum marked this conversation as resolved.
Show resolved Hide resolved
sqlFilter = SPACE_SEPARATOR + String.format(
domainName.contains(SQL_FILTER_STRING_ANY)
? TenantConstants.LIST_TENANTS_DOMAIN_FILTER_LIKE
: TenantConstants.LIST_TENANTS_DOMAIN_FILTER_EQUAL,
SQL_WHERE_CLAUSE);
}
String sqlStmt = TenantConstants.LIST_TENANTS_COUNT_SQL + sqlFilter;
int tenantCount = 0;
try (Connection dbConnection = getDBConnection();
PreparedStatement prepStmt = dbConnection.prepareStatement(sqlStmt)) {
if (StringUtils.isNotBlank(sqlFilter)) {
prepStmt.setString(1, domainName);
}
try (ResultSet rs = prepStmt.executeQuery()) {
if (rs.next()) {
tenantCount = Integer.parseInt(rs.getString(1));
Expand All @@ -1292,7 +1311,7 @@ private int getCountOfTenants() throws UserStoreException {
}

private ResultSet getTenantQueryResultSet(Connection dbConnection, String sortedOrder, Integer offset,
Integer limit) throws SQLException, UserStoreException {
Integer limit, String domainName) throws SQLException, UserStoreException {

String dbType;
try {
Expand All @@ -1305,51 +1324,92 @@ private ResultSet getTenantQueryResultSet(Connection dbConnection, String sorted
throw new UserStoreException(msg, e);
}
PreparedStatement prepStmt;
String sqlQuery;
String sqlQuery = TenantConstants.LIST_TENANTS_PAGINATED_SQL;
String sqlTail;
sqlQuery = TenantConstants.LIST_TENANTS_PAGINATED_SQL;
int offsetParameter;
int limitParameter;

String sqlFilter = StringUtils.EMPTY;
if (StringUtils.isNotBlank(domainName)) {
sqlFilter = String.format(
domainName.contains(SQL_FILTER_STRING_ANY)
? TenantConstants.LIST_TENANTS_DOMAIN_FILTER_LIKE
: TenantConstants.LIST_TENANTS_DOMAIN_FILTER_EQUAL,
SQL_AND_CLAUSE);
}

if (MYSQL.equalsIgnoreCase(dbType) || MARIADB.equalsIgnoreCase(dbType) || H2.equalsIgnoreCase(dbType)) {
sqlTail = String.format(TenantConstants.LIST_TENANTS_MYSQL_TAIL, sortedOrder);
sqlQuery = sqlQuery + sqlTail;
prepStmt = dbConnection.prepareStatement(sqlQuery);
prepStmt.setInt(1, offset);
prepStmt.setInt(2, limit);
offsetParameter = offset;
limitParameter = limit;
} else if (ORACLE.equalsIgnoreCase(dbType)) {
sqlQuery = TenantConstants.LIST_TENANTS_PAGINATED_ORACLE;
sqlTail = String.format(TenantConstants.LIST_TENANTS_ORACLE_TAIL, sortedOrder);
sqlQuery = sqlQuery + sqlTail;
prepStmt = dbConnection.prepareStatement(sqlQuery);
prepStmt.setInt(1, offset + limit);
prepStmt.setInt(2, offset);
offsetParameter = offset + limit;
limitParameter = offset;
} else if (MSSQL.equalsIgnoreCase(dbType)) {
sqlTail = String.format(TenantConstants.LIST_TENANTS_MSSQL_TAIL, sortedOrder);
sqlQuery = sqlQuery + sqlTail;
prepStmt = dbConnection.prepareStatement(sqlQuery);
prepStmt.setInt(1, offset);
prepStmt.setInt(2, limit);
offsetParameter = offset;
limitParameter = limit;
} else if (DB2.equalsIgnoreCase(dbType)) {
sqlQuery = TenantConstants.LIST_TENANTS_PAGINATED_DB2;
sqlTail = String.format(TenantConstants.LIST_TENANTS_DB2_TAIL, sortedOrder);
sqlQuery = sqlQuery + sqlTail;
prepStmt = dbConnection.prepareStatement(sqlQuery);
prepStmt.setInt(1, offset + 1);
prepStmt.setInt(2, offset + limit);
offsetParameter = offset + 1;
limitParameter = offset + limit;
} else if (POSTGRESQL.equalsIgnoreCase(dbType)) {
sqlTail = String.format(TenantConstants.LIST_TENANTS_POSTGRESQL_TAIL, sortedOrder);
sqlQuery = sqlQuery + sqlTail;
prepStmt = dbConnection.prepareStatement(sqlQuery);
prepStmt.setInt(1, limit);
prepStmt.setInt(2, offset);
offsetParameter = limit;
limitParameter = offset;
} else {
String message = "Error while loading tenant from DB: Database driver could not be identified" +
" or not supported.";
log.error(message);
throw new UserStoreException(message);
}
sqlQuery = sqlQuery + sqlFilter + sqlTail;
prepStmt = dbConnection.prepareStatement(sqlQuery);
if (StringUtils.isBlank(sqlFilter)) {
prepStmt.setInt(1, offsetParameter);
prepStmt.setInt(2, limitParameter);
} else {
prepStmt.setString(1, domainName);
prepStmt.setInt(2, offsetParameter);
prepStmt.setInt(3, limitParameter);
}
return prepStmt.executeQuery();
}

private String buildDomainNameFilter(String filter) {

if (StringUtils.isNotBlank(filter)) {
String[] filterArgs = filter.split(SPACE_SEPARATOR);
if (filterArgs.length == 3) {
String filterAttribute = filterArgs[0];
String operation = filterArgs[1];
String attributeValue = filterArgs[2];
if (StringUtils.equalsIgnoreCase(filterAttribute, DOMAIN_NAME)) {
return generateFilterString(operation, attributeValue);
}
}
}
return StringUtils.EMPTY;
}

private String generateFilterString(String operation, String attributeValue) {

String formattedFilter = null;
if (StringUtils.equalsIgnoreCase(operation, ExpressionOperation.SW.toString())) {
formattedFilter = attributeValue + SQL_FILTER_STRING_ANY;
} else if (StringUtils.equalsIgnoreCase(operation, ExpressionOperation.EW.toString())) {
formattedFilter = SQL_FILTER_STRING_ANY + attributeValue;
} else if (StringUtils.equalsIgnoreCase(operation, ExpressionOperation.CO.toString())) {
formattedFilter = SQL_FILTER_STRING_ANY + attributeValue + SQL_FILTER_STRING_ANY;
} else if (StringUtils.equalsIgnoreCase(operation, ExpressionOperation.EQ.toString())) {
formattedFilter = attributeValue;
}
return formattedFilter;
}

private List<Tenant> populateTenantList(ResultSet resultSet)
throws SQLException, UserStoreException {

Expand Down
2 changes: 2 additions & 0 deletions ...wso2.carbon.user.core/src/main/java/org/wso2/carbon/user/core/tenant/TenantConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ public class TenantConstants {
"UM_ORG_UUID IN (SELECT UM_ID FROM UM_ORG WHERE UM_PARENT_ID IS NULL) ) WHERE rn BETWEEN ? AND ?";
public static final String LIST_TENANTS_MSSQL_TAIL = "ORDER BY %s OFFSET ? ROWS FETCH NEXT ? ROWS ONLY";
public static final String LIST_TENANTS_ORACLE_TAIL = "ORDER BY %s) WHERE rownum <= ?) WHERE rnum > ?";
public static final String LIST_TENANTS_DOMAIN_FILTER_LIKE = "%s UM_DOMAIN_NAME LIKE ? ";
public static final String LIST_TENANTS_DOMAIN_FILTER_EQUAL = "%s UM_DOMAIN_NAME=? ";
public static final String GET_DOMAIN_SQL = "SELECT UM_DOMAIN_NAME FROM UM_TENANT WHERE UM_ID=?";
public static final String GET_TENANT_ID_SQL = "SELECT UM_ID FROM UM_TENANT WHERE UM_DOMAIN_NAME=?";
public static final String ACTIVATE_SQL = "UPDATE UM_TENANT SET UM_ACTIVE='1' WHERE UM_ID=?";
Expand Down