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

Jump to bottom

Optimize cleanupTokenByTokenValue logic #2508

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Optimize cleanupTokenByTokenValue logic #2508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63f7f9f
Optimize cleanupTokenByTokenValue logic.
mpmadhavig Jun 27, 2024
80f91c3
Change the naming convention.
mpmadhavig Jun 28, 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
110 changes: 70 additions & 40 deletions ...n.identity.oauth/src/main/java/org/wso2/carbon/identity/oauth2/dao/OldTokensCleanDAO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,48 +64,57 @@ public void cleanupTokenByTokenId(String tokenId, Connection connection) throws
}
}

public void cleanupTokenByTokenValue(String token, Connection connection) throws SQLException {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it ok to remove public method here?

OldAccessTokenDO oldAccessTokenObject = new OldAccessTokenDO();

String sql;
if (OAuth2ServiceComponentHolder.isIDPIdColumnEnabled()) {
sql = SQLQueries.RETRIEVE_OLD_TOKEN_BY_TOKEN_HASH_WITH_IDP_NAME;
} else {
sql = SQLQueries.RETRIEVE_OLD_TOKEN_BY_TOKEN_HASH;
}
/**
* This method is used to clean-up old tokens by token hash value.
*
* @param tokenHash Token hash value.
* @param connection Database connection.
* @throws SQLException If an error occurs while cleaning up the token.
*/
public void cleanupTokenByTokenValue(String tokenHash, Connection connection) throws SQLException {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

name should be cleanupTokenByTokenHash ?


PreparedStatement prepStmt = connection.prepareStatement(sql);
prepStmt.setString(1, token);
ResultSet resultSet = prepStmt.executeQuery();
//iterate result set and insert to AccessTokenDO object.
if (resultSet.next()) {
oldAccessTokenObject.setTokenId(resultSet.getString(1));
oldAccessTokenObject.setAccessToken(resultSet.getString(2));
oldAccessTokenObject.setRefreshToken(resultSet.getString(3));
oldAccessTokenObject.setConsumerKeyId(resultSet.getInt(4));
oldAccessTokenObject.setAuthzUser(resultSet.getString(5));
oldAccessTokenObject.setTenantId(resultSet.getInt(6));
oldAccessTokenObject.setUserDomain(resultSet.getString(7));
oldAccessTokenObject.setUserType(resultSet.getString(8));
oldAccessTokenObject.setGrantType(resultSet.getString(9));
oldAccessTokenObject.setTimeCreated(resultSet.getTimestamp(10));
oldAccessTokenObject.setRefreshTokenTimeCreated(resultSet.getTimestamp(11));
oldAccessTokenObject.setValdityPeriod(resultSet.getLong(12));
oldAccessTokenObject.setRefreshTokenValidityPeriod(resultSet.getLong(13));
oldAccessTokenObject.setTokenScopeHash(resultSet.getString(14));
oldAccessTokenObject.setTokenState(resultSet.getString(15));
oldAccessTokenObject.setTokenStateId(resultSet.getString(16));
oldAccessTokenObject.setSubjectIdentifier(resultSet.getString(17));
oldAccessTokenObject.setAccessTokenHash(resultSet.getString(18));
oldAccessTokenObject.setRefreshTokenHash(resultSet.getString(19));
OldAccessTokenDO oldAccessTokenObject = new OldAccessTokenDO();
if (OAuthServerConfiguration.getInstance().useRetainOldAccessTokens()) {
String sql;
if (OAuth2ServiceComponentHolder.isIDPIdColumnEnabled()) {
oldAccessTokenObject.setIdpId(resultSet.getInt(20));
sql = SQLQueries.RETRIEVE_OLD_TOKEN_BY_TOKEN_HASH_WITH_IDP_NAME;
} else {
sql = SQLQueries.RETRIEVE_OLD_TOKEN_BY_TOKEN_HASH;
}

PreparedStatement prepStmt = connection.prepareStatement(sql);
prepStmt.setString(1, tokenHash);
ResultSet resultSet = prepStmt.executeQuery();
//iterate result set and insert to AccessTokenDO object.
if (resultSet.next()) {
oldAccessTokenObject.setTokenId(resultSet.getString(1));
oldAccessTokenObject.setAccessToken(resultSet.getString(2));
oldAccessTokenObject.setRefreshToken(resultSet.getString(3));
oldAccessTokenObject.setConsumerKeyId(resultSet.getInt(4));
oldAccessTokenObject.setAuthzUser(resultSet.getString(5));
oldAccessTokenObject.setTenantId(resultSet.getInt(6));
oldAccessTokenObject.setUserDomain(resultSet.getString(7));
oldAccessTokenObject.setUserType(resultSet.getString(8));
oldAccessTokenObject.setGrantType(resultSet.getString(9));
oldAccessTokenObject.setTimeCreated(resultSet.getTimestamp(10));
oldAccessTokenObject.setRefreshTokenTimeCreated(resultSet.getTimestamp(11));
oldAccessTokenObject.setValdityPeriod(resultSet.getLong(12));
oldAccessTokenObject.setRefreshTokenValidityPeriod(resultSet.getLong(13));
oldAccessTokenObject.setTokenScopeHash(resultSet.getString(14));
oldAccessTokenObject.setTokenState(resultSet.getString(15));
oldAccessTokenObject.setTokenStateId(resultSet.getString(16));
oldAccessTokenObject.setSubjectIdentifier(resultSet.getString(17));
oldAccessTokenObject.setAccessTokenHash(resultSet.getString(18));
oldAccessTokenObject.setRefreshTokenHash(resultSet.getString(19));
if (OAuth2ServiceComponentHolder.isIDPIdColumnEnabled()) {
oldAccessTokenObject.setIdpId(resultSet.getInt(20));
}
}
}
if (OAuthServerConfiguration.getInstance().useRetainOldAccessTokens()) {
saveTokenInAuditTable(oldAccessTokenObject, connection);
removeTokenFromMainTable(oldAccessTokenObject.getTokenId(), connection);
} else {
removeTokenFromMainTableByTokenHash(tokenHash, connection);
}
removeTokenFromMainTable(oldAccessTokenObject.getTokenId(), connection);
}

private void saveTokenInAuditTable(OldAccessTokenDO oldAccessTokenDAO, Connection connection) throws SQLException {
Expand Down Expand Up @@ -153,10 +162,10 @@ private void removeTokenFromMainTable(String oldAccessTokenID, Connection connec

connection.setAutoCommit(false);
try {
PreparedStatement deletefromaccesstokentable =
PreparedStatement deleteFromAccessTokenTable =
connection.prepareStatement(SQLQueries.DELETE_OLD_TOKEN_BY_ID);
deletefromaccesstokentable.setString(1, oldAccessTokenID);
deletefromaccesstokentable.executeUpdate();
deleteFromAccessTokenTable.setString(1, oldAccessTokenID);
deleteFromAccessTokenTable.executeUpdate();
if (log.isDebugEnabled()) {
log.debug(
"Successfully old access token deleted from access token table. Token ID: " + oldAccessTokenID);
Expand All @@ -168,6 +177,27 @@ private void removeTokenFromMainTable(String oldAccessTokenID, Connection connec
}
}

private void removeTokenFromMainTableByTokenHash(String accessTokenHash, Connection connection)
throws SQLException {

connection.setAutoCommit(false);
try {
PreparedStatement deleteFromAccessTokenTable =
connection.prepareStatement(SQLQueries.DELETE_OLD_TOKEN_BY_TOKEN_HASH);
deleteFromAccessTokenTable.setString(1, accessTokenHash);
deleteFromAccessTokenTable.executeUpdate();
if (log.isDebugEnabled()) {
log.debug(
"Successfully old access token deleted from access token table. Token Hash: " +
accessTokenHash);
}
connection.commit();
} catch (SQLException e) {
connection.rollback();
log.error("SQL error occurred while remove token from main table", e);
}
}

public void cleanupTokensInBatch(List<String> oldTokens, Connection connection) throws SQLException {
for (String token : oldTokens) {
cleanupTokenByTokenValue(token, connection);
Expand Down
3 changes: 3 additions & 0 deletions ...2.carbon.identity.oauth/src/main/java/org/wso2/carbon/identity/oauth2/dao/SQLQueries.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,6 +963,9 @@ public class SQLQueries {

public static final String DELETE_OLD_TOKEN_BY_ID = "DELETE FROM IDN_OAUTH2_ACCESS_TOKEN WHERE TOKEN_ID = ?";

public static final String DELETE_OLD_TOKEN_BY_TOKEN_HASH =
"DELETE FROM IDN_OAUTH2_ACCESS_TOKEN WHERE ACCESS_TOKEN_HASH = ?";

public static final String DELETE_ACCESS_TOKEN = "DELETE FROM IDN_OAUTH2_ACCESS_TOKEN WHERE ACCESS_TOKEN = ? ";

public static final String REVOKE_SAAS_TOKENS_OF_OTHER_TENANTS = "UPDATE IDN_OAUTH2_ACCESS_TOKEN " +
Expand Down
Loading