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

Add custom attributes to extensions management API #492

Merged
merged 5 commits into from
Oct 23, 2023
Merged

Add custom attributes to extensions management API #492

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
9aff4bf
add custom attributes to extensions service
asha15 Sep 21, 2023
257fdd9
add custom attributes to extension list item
asha15 Sep 21, 2023
555f6c2
add constants for key and value
asha15 Oct 18, 2023
1f974fe
refactor the code
asha15 Oct 22, 2023
b76adc4
bump framework version
asha15 Oct 23, 2023
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
4 changes: 4 additions & 0 deletions ...2/carbon/identity/api/server/extension/management/common/utils/ExtensionMgtConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ public class ExtensionMgtConstants {

public static final String EXTENSION_MANAGEMENT_PREFIX = "EXT-";

public static final String KEY = "key";

public static final String VALUE = "value";

/**
* Enum for error messages.
*/
Expand Down
33 changes: 32 additions & 1 deletion .../org/wso2/carbon/identity/api/server/extension/management/v1/model/ExtensionListItem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.validation.constraints.*;


Expand All @@ -41,6 +42,8 @@ public class ExtensionListItem {
private Integer displayOrder;
private List<String> tags = null;

private List<Map<String, Object>> customAttributes = null;

private String category;
private String type;
private String self;
Expand Down Expand Up @@ -163,6 +166,32 @@ public ExtensionListItem addTagsItem(String tagsItem) {

/**
**/
public ExtensionListItem customAttributes(List<Map<String, Object>> customAttributes) {

this.customAttributes = customAttributes;
return this;
}

@ApiModelProperty(value = "")
@JsonProperty("customAttributes")
@Valid
public List<Map<String, Object>> getCustomAttributes() {
return customAttributes;
}
public void setCustomAttributes(List<Map<String, Object>> customAttributes) {
this.customAttributes = customAttributes;
}

public ExtensionListItem addCustomAttributesItem(Map<String, Object> customAttributesItem) {
if (this.customAttributes == null) {
this.customAttributes = new ArrayList<>();
}
this.customAttributes.add(customAttributesItem);
return this;
}

/**
**/
public ExtensionListItem category(String category) {

this.category = category;
Expand Down Expand Up @@ -233,14 +262,15 @@ public boolean equals(java.lang.Object o) {
Objects.equals(this.image, extensionListItem.image) &&
Objects.equals(this.displayOrder, extensionListItem.displayOrder) &&
Objects.equals(this.tags, extensionListItem.tags) &&
Objects.equals(this.customAttributes, extensionListItem.customAttributes) &&
Objects.equals(this.category, extensionListItem.category) &&
Objects.equals(this.type, extensionListItem.type) &&
Objects.equals(this.self, extensionListItem.self);
}

@Override
public int hashCode() {
return Objects.hash(id, name, description, image, displayOrder, tags, category, type, self);
return Objects.hash(id, name, description, image, displayOrder, tags, customAttributes, category, type, self);
}

@Override
Expand All @@ -255,6 +285,7 @@ public String toString() {
sb.append(" image: ").append(toIndentedString(image)).append("\n");
sb.append(" displayOrder: ").append(toIndentedString(displayOrder)).append("\n");
sb.append(" tags: ").append(toIndentedString(tags)).append("\n");
sb.append(" customAttributes: ").append(toIndentedString(customAttributes)).append("\n");
sb.append(" category: ").append(toIndentedString(category)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" self: ").append(toIndentedString(self)).append("\n");
Expand Down
7 changes: 7 additions & 0 deletions ...carbon/identity/api/server/extension/management/v1/function/ExtensionListItemBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

package org.wso2.carbon.identity.api.server.extension.management.v1.function;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.identity.api.server.extension.management.common.utils.ExtensionMgtUtils;
import org.wso2.carbon.identity.api.server.extension.management.v1.model.ExtensionListItem;
import org.wso2.carbon.identity.extension.mgt.model.ExtensionInfo;
Expand All @@ -29,6 +31,8 @@
*/
public class ExtensionListItemBuilder implements Function<ExtensionInfo, ExtensionListItem> {

private static final Log log = LogFactory.getLog(ExtensionListItemBuilder.class);

@Override
public ExtensionListItem apply(ExtensionInfo extensionInfo) {

Expand All @@ -43,6 +47,9 @@ public ExtensionListItem apply(ExtensionInfo extensionInfo) {
extensionListItem.setType(extensionInfo.getType());
extensionListItem.setSelf(ExtensionMgtUtils.getExtensionInfoLocation(extensionInfo.getType(),
extensionInfo.getId()));
if (extensionInfo.getCustomAttributes() != null) {
extensionListItem.setCustomAttributes(extensionInfo.getCustomAttributes());
}
return extensionListItem;
}
}
5 changes: 5 additions & 0 deletions ....identity.api.server.extension.management.v1/src/main/resources/extension-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,11 @@ components:
items:
type: string
example: 'OIDC'
customAttributes:
type: array
items:
type: object
additionalProperties: { }
category:
type: string
example: 'DEFAULT'
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@
<maven.buildnumber.plugin.version>1.4</maven.buildnumber.plugin.version>
<org.apache.felix.annotations.version>1.2.4</org.apache.felix.annotations.version>
<identity.governance.version>1.8.62</identity.governance.version>
<carbon.identity.framework.version>5.25.416</carbon.identity.framework.version>
<carbon.identity.framework.version>5.25.424</carbon.identity.framework.version>
<maven.findbugsplugin.version>3.0.5</maven.findbugsplugin.version>
<identity.workflow.impl.bps.version>5.2.0</identity.workflow.impl.bps.version>
<maven.checkstyleplugin.excludes>**/gen/**/*</maven.checkstyleplugin.excludes>
Expand Down