Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
* Copyright (c) 2026, WSO2 LLC. (http://www.wso2.com) All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -386,4 +386,14 @@ default void deleteResourcesByType(String resourceType) throws ConfigurationMana

throw new NotImplementedException("This functionality is not implemented.");
}

/**
* Retrieves the default configuration for the given resource type and resource name, if it exists.
* @param resourceTypeName
* @param resourceName
* @return the resource object corresponding to the resource with default configurations.
* @throws ConfigurationManagementException
*/
Resource getDefaultResource(String resourceTypeName, String resourceName)
throws ConfigurationManagementException;
}
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
.ERROR_CODE_ATTRIBUTE_IDENTIFIERS_REQUIRED;
import static org.wso2.carbon.identity.configuration.mgt.core.constant.ConfigurationConstants.ErrorMessages
.ERROR_CODE_ATTRIBUTE_REQUIRED;
import static org.wso2.carbon.identity.configuration.mgt.core.constant.ConfigurationConstants.ErrorMessages.ERROR_CODE_DEFAULT_RESOLVER_DOES_NOT_EXISTS;
import static org.wso2.carbon.identity.configuration.mgt.core.constant.ConfigurationConstants.ErrorMessages
.ERROR_CODE_FILES_DOES_NOT_EXISTS;
import static org.wso2.carbon.identity.configuration.mgt.core.constant.ConfigurationConstants.ErrorMessages
Expand Down Expand Up @@ -598,6 +599,28 @@ public Attribute replaceAttribute(String resourceTypeName, String resourceName,
return attribute;
}

/**
* Resolve the default configurations for the given resource from the registered default config resolvers.
*
* @param resourceType Resource type name.
* @param resourceName Resource name.
* @return Default configurations for the given resource.
* @throws ConfigurationManagementException if no default resolver is found.
*/
@Override
public Resource getDefaultResource(String resourceType, String resourceName)
throws ConfigurationManagementException {

DefaultConfigResolver resolver = ConfigurationManagerComponentDataHolder.getInstance()
.getDefaultConfigResolver(resourceType, resourceName);

if (resolver == null) {
throw handleServerException(ERROR_CODE_DEFAULT_RESOLVER_DOES_NOT_EXISTS, resourceType);
}

return resolver.getDefaultConfigs(resourceType, resourceName);
}

private void validateSearchRequest(Condition condition) throws ConfigurationManagementClientException {

if (condition == null) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Copyright (c) 2026, WSO2 LLC. (http://www.wso2.com).
*
* WSO2 LLC. 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.wso2.carbon.identity.configuration.mgt.core;

import org.wso2.carbon.identity.configuration.mgt.core.model.Resource;
import org.wso2.carbon.identity.configuration.mgt.core.model.ResourceIdentifier;

/**
* Interface for resolving default configurations for a given resource type and name.
*/
public interface DefaultConfigResolver {

/**
* Get the resource identifier that this resolver can handle.
* @return ResourceIdentifier of the default configuration.
*/
ResourceIdentifier getResourceIdentifier();

/**
* Get the default configurations for the given resource type and name.
*
* @param resourceTypeName Name of the resource type.
* @param resourceName Name of the resource.
* @return Resource containing the default configurations.
*/
Resource getDefaultConfigs(String resourceTypeName, String resourceName);
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018-2025, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
* Copyright (c) 2018-2026, WSO2 LLC. (http://www.wso2.com) All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -83,7 +83,9 @@ public enum InheritedResourceType {
COMPATIBILITY_SETTINGS("compatibility-settings", false),
FRAUD_DETECTION_CONFIG("fraud-detection", false),
// Resource Type for compatibility settings managed through /compatibility-settings endpoint.
COMPATIBILITY_SETTINGS_V2("compatibility-settings-v2", true);
COMPATIBILITY_SETTINGS_V2("compatibility-settings-v2", true),
// Resource Type for push device management settings management through /push-device-mgt endpoint
DEVICE_MANAGEMENT("DEVICE_MANAGEMENT", true);

private final String resourceTypeName;
private final boolean checkOrgVersionWhenInheriting;
Expand Down Expand Up @@ -190,7 +192,9 @@ public enum ErrorMessages {
ERROR_CODE_RESOLVING_TENANT_DOMAIN("CONFIGM_00050", "Error occurred while resolving the tenant domain " +
"for the organization id: %s."),
ERROR_CODE_RESOLVING_TENANT_ID("CONFIGM_00051", "Error occurred while resolving the tenant id " +
"for the organization id: %s.");
"for the organization id: %s."),
ERROR_CODE_DEFAULT_RESOLVER_DOES_NOT_EXISTS("CONFIGM_00052", "Default Config Resolver " +
"does not exists for the resource type : %s.");


private final String code;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018-2025, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
* Copyright (c) 2018-2026, WSO2 LLC. (http://www.wso2.com) All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -28,6 +28,7 @@
import org.wso2.carbon.database.utils.jdbc.exceptions.DataAccessException;
import org.wso2.carbon.identity.configuration.mgt.core.ConfigurationManager;
import org.wso2.carbon.identity.configuration.mgt.core.ConfigurationManagerImpl;
import org.wso2.carbon.identity.configuration.mgt.core.DefaultConfigResolver;
import org.wso2.carbon.identity.configuration.mgt.core.dao.ConfigurationDAO;
import org.wso2.carbon.identity.configuration.mgt.core.dao.impl.CachedBackedConfigurationDAO;
import org.wso2.carbon.identity.configuration.mgt.core.dao.impl.ConfigurationDAOImpl;
Expand Down Expand Up @@ -189,4 +190,27 @@ protected void unsetOrgResourceResolverService(OrgResourceResolverService orgRes

ConfigurationManagerComponentDataHolder.getInstance().setOrgResourceResolverService(null);
}

@Reference(
name = "default.config.resolver",
service = DefaultConfigResolver.class,
cardinality = ReferenceCardinality.MULTIPLE,
policy = ReferencePolicy.DYNAMIC,
unbind = "unsetDefaultConfigResolver"
)
protected void setDefaultConfigResolver(DefaultConfigResolver defaultConfigResolver) {

ConfigurationManagerComponentDataHolder.getInstance().addDefaultConfigResolver(defaultConfigResolver);
if (log.isDebugEnabled()) {
log.debug("DefaultConfigResolver registered: " + defaultConfigResolver.getClass().getName());
}
}

protected void unsetDefaultConfigResolver(DefaultConfigResolver defaultConfigResolver) {

ConfigurationManagerComponentDataHolder.getInstance().removeDefaultConfigResolver(defaultConfigResolver);
if (log.isDebugEnabled()) {
Comment thread
raviendalpatadu marked this conversation as resolved.
log.debug("DefaultConfigResolver unregistered: " + defaultConfigResolver.getClass().getName());
}
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2019-2025, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
* Copyright (c) 2019-2026, WSO2 LLC. (http://www.wso2.com) All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -16,22 +16,32 @@

Comment thread
raviendalpatadu marked this conversation as resolved.
package org.wso2.carbon.identity.configuration.mgt.core.internal;


import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.identity.configuration.mgt.core.DefaultConfigResolver;
import org.wso2.carbon.identity.configuration.mgt.core.model.ResourceIdentifier;
import org.wso2.carbon.identity.organization.management.service.OrganizationManager;
import org.wso2.carbon.identity.organization.resource.hierarchy.traverse.service.OrgResourceResolverService;
import org.wso2.carbon.user.core.service.RealmService;

import java.util.HashMap;
import java.util.Map;

/**
* A class to keep the data of the configuration manager component.
*/
public class ConfigurationManagerComponentDataHolder {

private static final Log LOG = LogFactory.getLog(ConfigurationManagerComponentDataHolder.class);
private static ConfigurationManagerComponentDataHolder instance = new ConfigurationManagerComponentDataHolder();
private static boolean useCreatedTime = false;

private boolean configurationManagementEnabled;
private RealmService realmService;
private OrganizationManager organizationManager;
private OrgResourceResolverService orgResourceResolverService;
private final Map<ResourceIdentifier, DefaultConfigResolver> defaultConfigResolvers = new HashMap<>();

public static ConfigurationManagerComponentDataHolder getInstance() {

Expand Down Expand Up @@ -107,4 +117,51 @@ public void setOrgResourceResolverService(OrgResourceResolverService orgResource

this.orgResourceResolverService = orgResourceResolverService;
}

/**
* Add a DefaultConfigResolver.
*
* @param resolver DefaultConfigResolver to add.
*/
public void addDefaultConfigResolver(DefaultConfigResolver resolver) {

ResourceIdentifier resourceIdentifier = resolver.getResourceIdentifier();
if (resourceIdentifier == null) {
if(LOG.isDebugEnabled()){
LOG.debug("Skipping registration of DefaultConfigResolver with a null resource identifier: "
+ resolver.getClass().getName());
}
return;
}
defaultConfigResolvers.put(resourceIdentifier, resolver);
}
Comment on lines +125 to +137

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Log Improvement Suggestion No: 5

Suggested change
*/
public void addDefaultConfigResolver(DefaultConfigResolver resolver) {
defaultConfigResolvers.add(resolver);
}
public void addDefaultConfigResolver(DefaultConfigResolver resolver) {
defaultConfigResolvers.add(resolver);
log.debug("DefaultConfigResolver added: " + resolver.getClass().getName());
}

Comment thread
coderabbitai[bot] marked this conversation as resolved.

/**
* Remove a DefaultConfigResolver.
*
* @param resolver DefaultConfigResolver to remove.
*/
public void removeDefaultConfigResolver(DefaultConfigResolver resolver) {

ResourceIdentifier resourceIdentifier = resolver.getResourceIdentifier();
if (resourceIdentifier == null) {
if(LOG.isDebugEnabled()) {
LOG.debug("Skipping removal of DefaultConfigResolver with a null resource identifier: "
+ resolver.getClass().getName());
}
return;
}
defaultConfigResolvers.remove(resourceIdentifier);
}

/**
* Get the DefaultConfigResolver for the given resource type and name.
* @param resourceType
* @param resourceName
* @return
*/
public DefaultConfigResolver getDefaultConfigResolver(String resourceType, String resourceName){

return defaultConfigResolvers.get(new ResourceIdentifier(resourceType, resourceName));
}
}
Comment on lines +144 to 167

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Log Improvement Suggestion No: 6

Suggested change
public void removeDefaultConfigResolver(DefaultConfigResolver resolver) {
defaultConfigResolvers.remove(resolver);
}
}
public void removeDefaultConfigResolver(DefaultConfigResolver resolver) {
defaultConfigResolvers.remove(resolver);
log.debug("DefaultConfigResolver removed: " + resolver.getClass().getName());
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/*
* Copyright (c) 2026, WSO2 LLC. (http://www.wso2.com).
*
* WSO2 LLC. 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.wso2.carbon.identity.configuration.mgt.core.model;

import java.util.Objects;

/**
* A model class to Identify a Configuration Resource uniquely by its type and name.
*/
public class ResourceIdentifier {

private String resourceType;
private String resourceName;

public ResourceIdentifier(String resourceType, String resourceName) {

this.resourceType = resourceType;
this.resourceName = resourceName;
}

public String getResourceType() {

return resourceType;
}

public String getResourceName() {

return resourceName;
}

@Override
public boolean equals(Object o) {

if (!(o instanceof ResourceIdentifier that)) {
return false;
}
return Objects.equals(resourceType, that.resourceType) &&
Comment thread
raviendalpatadu marked this conversation as resolved.
Objects.equals(resourceName, that.resourceName);
}

@Override
public int hashCode() {
Comment thread
raviendalpatadu marked this conversation as resolved.

return Objects.hash(resourceType, resourceName);
}
}
Loading
Loading