Skip to content

Commit

Permalink
Fixing review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@HiranyaKavishani
HiranyaKavishani committed Oct 17, 2023
1 parent a39f2bd commit 9ff48c9
Show file tree
Hide file tree
Showing 6 changed files with 174 additions and 84 deletions.
1 change: 1 addition & 0 deletions ...t/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/ExceptionCodes.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ public enum ExceptionCodes implements ErrorHandler {
API_VERSION_ALREADY_EXISTS(900252, "The API version already exists.", 409, "An API with version '%s' already exists for API '%s'"),

API_PRODUCT_CONTEXT_ALREADY_EXISTS(900275, "The API Product context already exists.", 409, "An API Product with context '%s' already exists"),
API_PRODUCT_VERSION_ALREADY_EXISTS(900276, "The API Product version already exists.", 409, "An API Product with version '%s' already exists for API Product '%s'"),

API_CONTEXT_MALFORMED_EXCEPTION(900253, "The API context is malformed.", 400, "'%s'"),
API_ALREADY_EXISTS(900300, "The API already exists.", 409, "The API already exists"),
Expand Down
8 changes: 4 additions & 4 deletions ...org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/APIProduct.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ public class APIProduct implements Serializable {
* Used to set the workflow status in lifecycle state change workflow
*/
private String workflowStatus = null;
private boolean isDefaultVersion = false;
private Boolean isDefaultVersion = null;
private boolean isPublishedDefaultVersion = false;
public APIProduct(){}

Expand Down Expand Up @@ -196,17 +196,17 @@ public String getTechnicalOwnerEmail() {
public void setTechnicalOwnerEmail(String technicalOwnerEmail) {
this.technicalOwnerEmail = technicalOwnerEmail;
}
public void setDefaultVersion(boolean isDefaultVersion) {
public void setDefaultVersion(Boolean isDefaultVersion) {
this.isDefaultVersion = isDefaultVersion;
}
public void setAsPublishedDefaultVersion(boolean value) {
isPublishedDefaultVersion = value;
}
public boolean isDefaultVersion() {
public Boolean isDefaultVersion() {
return isDefaultVersion;
}

public boolean isPublishedDefaultVersion() {
public Boolean isPublishedDefaultVersion() {
return isPublishedDefaultVersion;
}

Expand Down
21 changes: 15 additions & 6 deletions ...rg.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIProviderImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1932,17 +1932,26 @@ public API createNewAPIVersion(String existingApiId, String newVersion, Boolean
public APIProduct createNewAPIProductVersion(String existingApiProductId, String newVersion,
Boolean isDefaultVersion, String organization) throws APIManagementException {

APIProduct existingAPIProduct = getAPIProductbyUUID(existingApiProductId, organization);
if (existingAPIProduct == null) {
throw new APIMgtResourceNotFoundException("API Product not found for id " + existingApiProductId,
ExceptionCodes.from(ExceptionCodes.API_PRODUCT_NOT_FOUND, existingApiProductId));
APIProductIdentifier apiProductIdentifier = APIUtil.getAPIProductIdentifierFromUUID(existingApiProductId);
if (apiProductIdentifier == null) {
throw new APIMgtResourceNotFoundException("Couldn't retrieve existing API Product with ID: "
+ existingApiProductId, ExceptionCodes.from(ExceptionCodes.API_PRODUCT_NOT_FOUND,
existingApiProductId));
}

if (newVersion.equals(existingAPIProduct.getId().getVersion())) {
//Get all existing versions of APIProducts
Set<String> apiProductVersions = getAPIVersions(apiProductIdentifier.getProviderName(),
apiProductIdentifier.getName(), organization);

if (apiProductVersions.contains(newVersion)) {
throw new APIMgtResourceAlreadyExistsException(
"Version " + newVersion + " exists for apiProduct " + existingAPIProduct.getId().getName());
"Version " + newVersion + " exists for API product " + apiProductIdentifier.getName(),
ExceptionCodes.from(ExceptionCodes.API_PRODUCT_VERSION_ALREADY_EXISTS, newVersion,
apiProductIdentifier.getName()));
}

APIProduct existingAPIProduct = getAPIProductbyUUID(existingApiProductId, organization);

APIProduct clonedAPIProduct = cloneExistingAPIProduct(existingAPIProduct);
clonedAPIProduct.setOrganization(organization);
APIProductIdentifier newApiProductId = new APIProductIdentifier(
Expand Down
218 changes: 147 additions & 71 deletions .../org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/dao/ApiMgtDAO.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5040,15 +5040,70 @@ public List<LifeCycleEvent> getLifeCycleEvents(String uuid) throws APIManagement
return events;
}

public List<SubscribedAPI> makeKeysForwardCompatible(ApiTypeWrapper apiTypeWrapper, List<API> oldAPIVersions,
List<APIProduct> oldAPIProductVersions)
/**
*
* This method is used to copy the subscription new for new API Version
*
* @param apiTypeWrapper apiTypeWrapper
* @param oldAPIVersions oldAPIVersions
* @return List<SubscribedAPI> list of Subscribed APIs
* @throws APIManagementException APIManagementException
*/
public List<SubscribedAPI> makeKeysForwardCompatibleForNewAPIVersion(ApiTypeWrapper apiTypeWrapper,
List<API> oldAPIVersions) throws APIManagementException {
int versionCount;
List<SubscribedAPI> subscribedAPISet = new ArrayList<>();

//if there are no previous versions, there is no need to copy subscriptions
versionCount = getNoOfVersionsToCopySubscription(apiTypeWrapper, oldAPIVersions, null);
if (versionCount == 0) {
return subscribedAPISet;
}

String getSubscriptionDataQuery = SQLConstants.GET_SUBSCRIPTION_DATA_SQL.replaceAll("_API_VERSION_LIST_",
String.join(",", Collections.nCopies(versionCount, "?")));

try {
// Retrieve all the existing subscription for the old version
try (Connection connection = APIMgtDBUtil.getConnection()) {
connection.setAutoCommit(false);
try (PreparedStatement prepStmt = connection.prepareStatement(getSubscriptionDataQuery)) {
prepStmt.setString(1,
APIUtil.replaceEmailDomainBack(apiTypeWrapper.getId().getProviderName()));
prepStmt.setString(2, apiTypeWrapper.getId().getName());
int index = 3;
for (API oldAPI : oldAPIVersions) {
prepStmt.setString(index++, oldAPI.getId().getVersion());
}
retrieveSubscriptionDataOfAPIs(apiTypeWrapper, oldAPIVersions, versionCount, subscribedAPISet,
connection, prepStmt);
connection.commit();
} catch (SQLException e) {
connection.rollback();
throw e;
}
}
} catch (SQLException e) {
handleException("Error when executing the SQL queries", e);
}
return subscribedAPISet;
}

/**
*
* @param apiTypeWrapper apiTypeWrapper
* @param oldAPIProductVersions oldAPIProductVersions
* @return List<SubscribedAPI> list of Subscribed APIProducts
* @throws APIManagementException APIManagementException
*/
public List<SubscribedAPI> makeKeysForwardCompatibleForNewAPIProductVersion
(ApiTypeWrapper apiTypeWrapper, List<APIProduct> oldAPIProductVersions)
throws APIManagementException {
int versionCount = 0;
List<SubscribedAPI> subscribedAPISet = new ArrayList<>();
ApiTypeWrapper oldApiTypeWrapperCopy;

//if there are no previous versions, there is no need to copy subscriptions
versionCount = getNoOfVersionsToCopySubscription(apiTypeWrapper, oldAPIVersions, oldAPIProductVersions);
versionCount = getNoOfVersionsToCopySubscription(apiTypeWrapper, null, oldAPIProductVersions);
if (versionCount == 0) {
return subscribedAPISet;
}
Expand All @@ -5065,17 +5120,10 @@ public List<SubscribedAPI> makeKeysForwardCompatible(ApiTypeWrapper apiTypeWrapp
APIUtil.replaceEmailDomainBack(apiTypeWrapper.getId().getProviderName()));
prepStmt.setString(2, apiTypeWrapper.getId().getName());
int index = 3;
if (!apiTypeWrapper.isAPIProduct()) {
for (API oldAPI : oldAPIVersions) {
prepStmt.setString(index++, oldAPI.getId().getVersion());
}
} else {
for (APIProduct oldAPIProduct : oldAPIProductVersions) {
for (APIProduct oldAPIProduct : oldAPIProductVersions) {
prepStmt.setString(index++, oldAPIProduct.getId().getVersion());
}
}

retrieveSubscriptionData(apiTypeWrapper, oldAPIVersions, oldAPIProductVersions, versionCount,
retrieveSubscriptionDataOfAPIProducts(apiTypeWrapper, oldAPIProductVersions, versionCount,
subscribedAPISet, connection, prepStmt);
connection.commit();
} catch (SQLException e) {
Expand All @@ -5089,7 +5137,34 @@ public List<SubscribedAPI> makeKeysForwardCompatible(ApiTypeWrapper apiTypeWrapp
return subscribedAPISet;
}

private void retrieveSubscriptionData(ApiTypeWrapper apiTypeWrapper, List<API> oldAPIVersions,
private void retrieveSubscriptionDataOfAPIs(ApiTypeWrapper apiTypeWrapper, List<API> oldAPIVersions,
int versionCount, List<SubscribedAPI> subscribedAPISet,
Connection connection, PreparedStatement prepStmt) throws SQLException, APIManagementException {
ApiTypeWrapper oldApiTypeWrapperCopy;
try (ResultSet rs = prepStmt.executeQuery()) {
List<SubscriptionInfo> subscriptionData = new ArrayList<SubscriptionInfo>();
while (rs.next() && !(APIConstants.SubscriptionStatus.ON_HOLD.equals(
rs.getString("SUB_STATUS")))) {
int subscriptionId = rs.getInt("SUBSCRIPTION_ID");
String tierId = rs.getString("TIER_ID");
int applicationId = rs.getInt("APPLICATION_ID");
String apiVersion = rs.getString("VERSION");
String subscriptionStatus = rs.getString("SUB_STATUS");
SubscriptionInfo info = new SubscriptionInfo(subscriptionId, tierId, applicationId,
apiVersion, subscriptionStatus);
subscriptionData.add(info);
}
// To keep track of already added subscriptions (apps)
List<Integer> addedApplications = new ArrayList<>();
for (int i = versionCount - 1; i >= 0; i--) {
oldApiTypeWrapperCopy = new ApiTypeWrapper(oldAPIVersions.get(i));
addSubscriptionData(apiTypeWrapper, subscribedAPISet, connection, oldApiTypeWrapperCopy,
subscriptionData, addedApplications);
}
}
}

private void retrieveSubscriptionDataOfAPIProducts(ApiTypeWrapper apiTypeWrapper,
List<APIProduct> oldAPIProductVersions, int versionCount, List<SubscribedAPI> subscribedAPISet,
Connection connection, PreparedStatement prepStmt) throws SQLException, APIManagementException {
ApiTypeWrapper oldApiTypeWrapperCopy;
Expand All @@ -5109,65 +5184,67 @@ private void retrieveSubscriptionData(ApiTypeWrapper apiTypeWrapper, List<API> o
// To keep track of already added subscriptions (apps)
List<Integer> addedApplications = new ArrayList<>();
for (int i = versionCount - 1; i >= 0; i--) {
if (!apiTypeWrapper.isAPIProduct()) {
oldApiTypeWrapperCopy = new ApiTypeWrapper(oldAPIVersions.get(i));
} else {
oldApiTypeWrapperCopy = new ApiTypeWrapper(oldAPIProductVersions.get(i));
}
oldApiTypeWrapperCopy = new ApiTypeWrapper(oldAPIProductVersions.get(i));
addSubscriptionData(apiTypeWrapper, subscribedAPISet, connection, oldApiTypeWrapperCopy,
subscriptionData, addedApplications);
}
}
}

for (SubscriptionInfo info : subscriptionData) {
try {
if (info.getApiVersion().equals(oldApiTypeWrapperCopy.getId()
.getVersion()) && !addedApplications.contains(info.getApplicationId())) {
String subscriptionStatus;
if (APIConstants.SubscriptionStatus.BLOCKED.equalsIgnoreCase(
info.getSubscriptionStatus())) {
subscriptionStatus = APIConstants.SubscriptionStatus.BLOCKED;
} else if (APIConstants.SubscriptionStatus.UNBLOCKED.equalsIgnoreCase(
info.getSubscriptionStatus())) {
subscriptionStatus = APIConstants.SubscriptionStatus.UNBLOCKED;
} else if (APIConstants.SubscriptionStatus.PROD_ONLY_BLOCKED.equalsIgnoreCase(
info.getSubscriptionStatus())) {
subscriptionStatus = APIConstants.SubscriptionStatus.PROD_ONLY_BLOCKED;
} else if (APIConstants.SubscriptionStatus.REJECTED.equalsIgnoreCase(
info.getSubscriptionStatus())) {
subscriptionStatus = APIConstants.SubscriptionStatus.REJECTED;
} else {
subscriptionStatus = APIConstants.SubscriptionStatus.ON_HOLD;
}
apiTypeWrapper.setTier(info.getTierId());
Application application = getLightweightApplicationById(connection,
info.getApplicationId());
String subscriptionUUID = UUID.randomUUID().toString();
int subscriptionId = addSubscription(connection, apiTypeWrapper, application,
subscriptionStatus, oldApiTypeWrapperCopy.getId().getProviderName(),
subscriptionUUID);
if (subscriptionId == -1) {
String msg = "Unable to add a new subscription for the API: "
+ oldApiTypeWrapperCopy.getName() + ":v" + oldApiTypeWrapperCopy.getId()
.getVersion();
log.error(msg);
throw new APIManagementException(msg);
}
SubscribedAPI subscribedAPI = new SubscribedAPI(subscriptionUUID);
subscribedAPI.setApplication(application);
subscribedAPI.setTier(new Tier(info.getTierId()));
subscribedAPI.setOrganization(apiTypeWrapper.getOrganization());
subscribedAPI.setIdentifier(apiTypeWrapper);
subscribedAPI.setSubStatus(subscriptionStatus);
subscribedAPI.setSubscriptionId(subscriptionId);
addedApplications.add(info.getApplicationId());
subscribedAPISet.add(subscribedAPI);
}
// catching the exception because when copy the api without the option "require
// re-subscription"
// need to go forward rather throwing the exception
} catch (SubscriptionAlreadyExistingException e) {
log.error("Error while adding subscription " + e.getMessage(), e);
} catch (SubscriptionBlockedException e) {
log.info("Subscription is blocked: " + e.getMessage());
private void addSubscriptionData(ApiTypeWrapper apiTypeWrapper, List<SubscribedAPI> subscribedAPISet,
Connection connection, ApiTypeWrapper oldApiTypeWrapperCopy, List<SubscriptionInfo> subscriptionData,
List<Integer> addedApplications) throws SQLException, APIManagementException {
for (SubscriptionInfo info : subscriptionData) {
try {
if (info.getApiVersion().equals(oldApiTypeWrapperCopy.getId()
.getVersion()) && !addedApplications.contains(info.getApplicationId())) {
String subscriptionStatus;
if (APIConstants.SubscriptionStatus.BLOCKED.equalsIgnoreCase(
info.getSubscriptionStatus())) {
subscriptionStatus = APIConstants.SubscriptionStatus.BLOCKED;
} else if (APIConstants.SubscriptionStatus.UNBLOCKED.equalsIgnoreCase(
info.getSubscriptionStatus())) {
subscriptionStatus = APIConstants.SubscriptionStatus.UNBLOCKED;
} else if (APIConstants.SubscriptionStatus.PROD_ONLY_BLOCKED.equalsIgnoreCase(
info.getSubscriptionStatus())) {
subscriptionStatus = APIConstants.SubscriptionStatus.PROD_ONLY_BLOCKED;
} else if (APIConstants.SubscriptionStatus.REJECTED.equalsIgnoreCase(
info.getSubscriptionStatus())) {
subscriptionStatus = APIConstants.SubscriptionStatus.REJECTED;
} else {
subscriptionStatus = APIConstants.SubscriptionStatus.ON_HOLD;
}
apiTypeWrapper.setTier(info.getTierId());
Application application = getLightweightApplicationById(connection,
info.getApplicationId());
String subscriptionUUID = UUID.randomUUID().toString();
int subscriptionId = addSubscription(connection, apiTypeWrapper, application,
subscriptionStatus, oldApiTypeWrapperCopy.getId().getProviderName(),
subscriptionUUID);
if (subscriptionId == -1) {
String msg = "Unable to add a new subscription for the API: "
+ oldApiTypeWrapperCopy.getName() + ":v" + oldApiTypeWrapperCopy.getId()
.getVersion();
log.error(msg);
throw new APIManagementException(msg);
}
SubscribedAPI subscribedAPI = new SubscribedAPI(subscriptionUUID);
subscribedAPI.setApplication(application);
subscribedAPI.setTier(new Tier(info.getTierId()));
subscribedAPI.setOrganization(apiTypeWrapper.getOrganization());
subscribedAPI.setIdentifier(apiTypeWrapper);
subscribedAPI.setSubStatus(subscriptionStatus);
subscribedAPI.setSubscriptionId(subscriptionId);
addedApplications.add(info.getApplicationId());
subscribedAPISet.add(subscribedAPI);
}
// catching the exception because when copy the api without the option "require
// re-subscription"
// need to go forward rather throwing the exception
} catch (SubscriptionAlreadyExistingException e) {
log.error("Error while adding subscription " + e.getMessage(), e);
} catch (SubscriptionBlockedException e) {
log.info("Subscription is blocked: " + e.getMessage());
}
}
}
Expand Down Expand Up @@ -9702,7 +9779,6 @@ public void setDefaultVersion(ApiTypeWrapper apiTypeWrapper) throws APIManagemen
}
}
}

} catch (SQLException e) {
throw new APIManagementException("Error while retrieving apimgt connection", e,
ExceptionCodes.INTERNAL_ERROR);
Expand Down
Loading

0 comments on commit 9ff48c9

Please sign in to comment.