lmccay commented on a change in pull request #433: URL: https://github.com/apache/knox/pull/433#discussion_r616232824
########## File path: gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/JDBCTokenStateService.java ########## @@ -0,0 +1,180 @@ +/* + * 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 + * + * http://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. + */ +package org.apache.knox.gateway.services.token.impl; + +import java.sql.SQLException; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import org.apache.knox.gateway.config.GatewayConfig; +import org.apache.knox.gateway.services.ServiceLifecycleException; +import org.apache.knox.gateway.services.security.AliasService; +import org.apache.knox.gateway.services.security.token.TokenMetadata; +import org.apache.knox.gateway.services.security.token.UnknownTokenException; +import org.apache.knox.gateway.util.JDBCUtils; +import org.apache.knox.gateway.util.Tokens; + +public class JDBCTokenStateService extends DefaultTokenStateService { + private AliasService aliasService; // connection username/pw is stored here + private TokenStateDatabase tokenDatabase; + + public void setAliasService(AliasService aliasService) { + this.aliasService = aliasService; + } + + @Override + public void init(GatewayConfig config, Map<String, String> options) throws ServiceLifecycleException { + super.init(config, options); + if (aliasService == null) { + throw new ServiceLifecycleException("The required AliasService reference has not been set."); + } + try { + this.tokenDatabase = new TokenStateDatabase(JDBCUtils.getDataSource(config, aliasService)); + } catch (Exception e) { + throw new ServiceLifecycleException("Error while initiating JDBCTokenStateService: " + e, e); + } + } + + @Override + public void addToken(String tokenId, long issueTime, long expiration, long maxLifetimeDuration) { + super.addToken(tokenId, issueTime, expiration, maxLifetimeDuration); + try { + final boolean added = tokenDatabase.addToken(tokenId, issueTime, expiration, maxLifetimeDuration); + if (added) { + log.savedTokenInDatabase(Tokens.getTokenIDDisplayText(tokenId)); + } else { + log.failedToSaveTokenInDatabase(Tokens.getTokenIDDisplayText(tokenId)); + } + } catch (SQLException e) { + log.errorSavingTokenInDatabase(Tokens.getTokenIDDisplayText(tokenId), e.getMessage(), e); + } + } + + @Override + protected void removeTokens(Set<String> tokenIds) { + try { + boolean removed = tokenDatabase.removeTokens(tokenIds); + if (removed) { + log.removedTokensFromDatabase(tokenIds.size()); + } else { + log.failedToRemoveTokensFromDatabase(tokenIds.size()); + } + } catch (SQLException e) { + log.errorRemovingTokensFromDatabase(tokenIds.size(), e.getMessage(), e); + } + super.removeTokens(tokenIds); + } + + @Override + public long getTokenExpiration(String tokenId, boolean validate) throws UnknownTokenException { + try { + // check the in-memory cache, then + return super.getTokenExpiration(tokenId, validate); + } catch (UnknownTokenException e) { + // It's not in memory + } + + long expiration = 0; + try { + expiration = tokenDatabase.getTokenExpiration(tokenId); + log.fetchedExpirationFromDatabase(Tokens.getTokenIDDisplayText(tokenId), expiration); + } catch (SQLException e) { + log.errorFetchingExpirationFromDatabase(Tokens.getTokenIDDisplayText(tokenId), e.getMessage(), e); + } + return expiration; + } + + @Override + protected void updateExpiration(String tokenId, long expiration) { + // Update in-memory + super.updateExpiration(tokenId, expiration); + + try { + final boolean updated = tokenDatabase.updateExpiration(tokenId, expiration); + if (updated) { + log.updatedExpirationInDatabase(Tokens.getTokenIDDisplayText(tokenId), expiration); + } else { + log.failedToUpdateExpirationInDatabase(Tokens.getTokenIDDisplayText(tokenId), expiration); + } + } catch (SQLException e) { + log.errorUpdatingExpirationInDatabase(Tokens.getTokenIDDisplayText(tokenId), e.getMessage(), e); + } + } + + @Override + protected long getMaxLifetime(String tokenId) { + long maxLifetime = super.getMaxLifetime(tokenId); + + // If there is no result from the in-memory collection, proceed to check the Database + if (maxLifetime < 1L) { + try { + maxLifetime = tokenDatabase.getMaxLifetime(tokenId); + log.fetchedMaxLifetimeFromDatabase(Tokens.getTokenIDDisplayText(tokenId), maxLifetime); + } catch (SQLException e) { + log.errorFetchingMaxLifetimeFromDatabase(Tokens.getTokenIDDisplayText(tokenId), e.getMessage(), e); + } + } + return maxLifetime; + } + + @Override + protected boolean isUnknown(String tokenId) { + boolean isUnknown = super.isUnknown(tokenId); + + // If it's not in the cache, then check in the Database + if (isUnknown) { + try { + isUnknown = tokenDatabase.getMaxLifetime(tokenId) < 0; + } catch (SQLException e) { + log.errorFetchingMaxLifetimeFromDatabase(Tokens.getTokenIDDisplayText(tokenId), e.getMessage(), e); + } + } + return isUnknown; + } + + @Override + protected List<String> getTokenIds() { + List<String> tokenIds = new LinkedList<>(); + try { + tokenIds = tokenDatabase.getTokenIds(); + log.fetchedAllTokenIdsFromDatabase(tokenIds.size()); + } catch (SQLException e) { + log.errorFetchingAllTokenIdsFromDatabase(e.getMessage(), e); + } + return tokenIds; + } + + @Override + public void addMetadata(String tokenId, TokenMetadata metadata) { Review comment: It seems that the addMetadata is decoupled from the addToken. I can imagine this came about due to the alias service based approach but it seems sort of artificial for JDBC approach. Perhaps this can be refactored in the future to deprecate this method and include an addToken that accepts a TokenMetadata object as well? Should we actually do that now and leave the separate method for where it is currently used but deprecate it? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
