Add new DefinedBy property to authenticator config.

components/application-mgt/org.wso2.carbon.identity.application.common/src/main/java/org/wso2/carbon/identity/application/common/ApplicationAuthenticatorService.java

@@ -18,6 +18,8 @@
 
 package org.wso2.carbon.identity.application.common;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.wso2.carbon.identity.application.common.model.FederatedAuthenticatorConfig;
 import org.wso2.carbon.identity.application.common.model.LocalAuthenticatorConfig;
 import org.wso2.carbon.identity.application.common.model.RequestPathAuthenticatorConfig;
@@ -31,6 +33,7 @@
 public class ApplicationAuthenticatorService {
 
  private static volatile ApplicationAuthenticatorService instance;
+ private static final Log LOG = LogFactory.getLog(ApplicationAuthenticatorService.class);
 
  private List<LocalAuthenticatorConfig> localAuthenticators = new ArrayList<>();
  private List<FederatedAuthenticatorConfig> federatedAuthenticators = new ArrayList<>();
@@ -88,6 +91,9 @@
 
  public void addLocalAuthenticator(LocalAuthenticatorConfig authenticator) {
  if (authenticator != null) {
+ if (authenticator.getDefinedByType() == null) {
+ LOG.debug("The defined by type is not set for the : " + authenticator.getName());
+ }
  localAuthenticators.add(authenticator);
  }
  }
@@ -100,6 +106,9 @@
 
  public void addFederatedAuthenticator(FederatedAuthenticatorConfig authenticator) {
  if (authenticator != null) {
+ if (authenticator.getDefinedByType() == null) {
+ LOG.debug("The defined by type is not set for the : " + authenticator.getName());
+ }
  federatedAuthenticators.add(authenticator);
  }
  }

components/application-mgt/org.wso2.carbon.identity.application.common/src/main/java/org/wso2/carbon/identity/application/common/model/FederatedAuthenticatorConfig.java

@@ -22,6 +22,9 @@
 import org.apache.axiom.om.OMElement;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.lang.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.wso2.carbon.identity.base.IdentityConstants;
 
 import java.io.Serializable;
 import java.util.ArrayList;
@@ -46,6 +49,7 @@
 public class FederatedAuthenticatorConfig implements Serializable {
 
  private static final long serialVersionUID = -2361107623257323257L;
+ private static final Logger LOG = LoggerFactory.getLogger(LocalAuthenticatorConfig.class);
 
  @XmlElement(name = "Name")
  protected String name;
@@ -63,6 +67,9 @@
  @XmlElement(name = "Tags")
  protected String[] tags;
 
+ @XmlElement(name = "DefinedBy")
+ protected IdentityConstants.DefinedByType definedByType;
+
  public static FederatedAuthenticatorConfig build(OMElement federatedAuthenticatorConfigOM) {
 
  if (federatedAuthenticatorConfigOM == null) {
@@ -101,9 +108,18 @@
  Property[] propertiesArr = propertiesArrList.toArray(new Property[propertiesArrList.size()]);
  federatedAuthenticatorConfig.setProperties(propertiesArr);
  }
+ } else if ("DefinedBy".equals(elementName)) {
+ federatedAuthenticatorConfig.setDefinedByType(
+ IdentityConstants.DefinedByType.valueOf(element.getText()));
  }
  }
 
+ // TODO: Remove warn log, once feature is ready.
+ if (federatedAuthenticatorConfig.getDefinedByType() == null) {
+ federatedAuthenticatorConfig.setDefinedByType(IdentityConstants.DefinedByType.SYSTEM);
+ LOG.debug("The defined by type is not set for the : " + federatedAuthenticatorConfig.getName());
+ }
+
  return federatedAuthenticatorConfig;
  }
 
@@ -230,4 +246,24 @@
 
  tags = tagList;
  }
+
+ /**
+ * Get the tag list of the Local authenticator.
+ *
+ * @return String[]
+ */
+ public IdentityConstants.DefinedByType getDefinedByType() {
+
+ return definedByType;
+ }
+
+ /**
+ * Set the tag list for Local authenticator config.
+ *
+ * @param type authenticator.
+ */
+ public void setDefinedByType(IdentityConstants.DefinedByType type) {
+
+ definedByType = type;
+ }
 }

components/application-mgt/org.wso2.carbon.identity.application.common/src/main/java/org/wso2/carbon/identity/application/common/model/IdentityProvider.java

@@ -58,6 +58,7 @@
 public class IdentityProvider implements Serializable {
 
  private static final long serialVersionUID = 2199048941051702943L;
+ private static final Log LOG = LogFactory.getLog(IdentityProvider.class);
 
  private static final Log log = LogFactory.getLog(IdentityProvider.class);
  private static final String FILE_ELEMENT_IDENTITY_PROVIDER_NAME = "IdentityProviderName";
@@ -419,6 +420,13 @@
  if (federatedAuthenticatorConfigs == null) {
  return;
  }
+
+ // TODO: Remove warn log, once feature is ready.
+ for (FederatedAuthenticatorConfig config: federatedAuthenticatorConfigs) {
+ if (config.getDefinedByType() == null) {
+ LOG.debug("The defined by type is not set for the : " + config.getName());
+ }
+ }
  Set<FederatedAuthenticatorConfig> propertySet =
  new HashSet<FederatedAuthenticatorConfig>(Arrays.asList(federatedAuthenticatorConfigs));
  this.federatedAuthenticatorConfigs = propertySet.toArray(new FederatedAuthenticatorConfig[propertySet.size()]);

components/application-mgt/org.wso2.carbon.identity.application.common/src/main/java/org/wso2/carbon/identity/application/common/model/LocalAuthenticatorConfig.java

@@ -22,6 +22,8 @@
 import org.apache.axiom.om.OMElement;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.lang.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.wso2.carbon.identity.base.IdentityConstants;
 
 import java.io.Serializable;
@@ -46,6 +48,7 @@
 public class LocalAuthenticatorConfig implements Serializable {
 
  private static final long serialVersionUID = 3363298518257599291L;
+ private static final Logger LOG = LoggerFactory.getLogger(LocalAuthenticatorConfig.class);
 
  @XmlElement(name = "Name")
  protected String name;
@@ -63,6 +66,9 @@
  @XmlElement(name = "Tags")
  protected String[] tags;
 
+ @XmlElement(name = "DefinedBy")
+ protected IdentityConstants.DefinedByType definedByType;
+
  /*
  * <LocalAuthenticatorConfig> <Name></Name> <DisplayName></DisplayName> <IsEnabled></IsEnabled>
  * <Properties></Properties> </LocalAuthenticatorConfig>
@@ -111,8 +117,16 @@
  Property[] propertiesArr = propertiesArrList.toArray(new Property[0]);
  localAuthenticatorConfig.setProperties(propertiesArr);
  }
+ } else if ("DefinedBy".equals(member.getLocalName())) {
+ localAuthenticatorConfig.setDefinedByType(IdentityConstants.DefinedByType.valueOf(member.getText()));
  }
  }
+
+ if (localAuthenticatorConfig.getDefinedByType() == null) {
+ localAuthenticatorConfig.setDefinedByType(IdentityConstants.DefinedByType.SYSTEM);
+ LOG.debug("The defined by type is not set for the : " + localAuthenticatorConfig.getName());
+ }
+
  return localAuthenticatorConfig;
  }
 
@@ -224,4 +238,24 @@
 
  tags = tagList;
  }
+
+ /**
+ * Get the tag list of the Local authenticator.
+ *
+ * @return String[]
+ */
+ public IdentityConstants.DefinedByType getDefinedByType() {
+
+ return definedByType;
+ }
+
+ /**
+ * Set the tag list for Local authenticator config.
+ *
+ * @param type authenticator.
+ */
+ public void setDefinedByType(IdentityConstants.DefinedByType type) {
+
+ definedByType = type;
+ }
 }

components/application-mgt/org.wso2.carbon.identity.application.mgt/src/main/java/org/wso2/carbon/identity/application/mgt/ApplicationConstants.java

@@ -50,6 +50,7 @@ private ApplicationConstants() {
  public static final String IDP_NAME = "idpName";
  public static final String IDP_AUTHENTICATOR_NAME = "authenticatorName";
  public static final String IDP_AUTHENTICATOR_DISPLAY_NAME = "authenticatorDisplayName";
+ public static final String IDP_AUTHENTICATOR_DEFINED_BY_TYPE = "definedByType";
  public static final String APPLICATION_DOMAIN = "Application";
  // Regex for validating application name.
  public static final String APP_NAME_VALIDATING_REGEX = "^[a-zA-Z0-9 ._-]*$";

components/application-mgt/org.wso2.carbon.identity.application.mgt/src/main/java/org/wso2/carbon/identity/application/mgt/dao/impl/ApplicationDAOImpl.java

@@ -77,6 +77,7 @@
 import org.wso2.carbon.identity.application.mgt.dao.PaginatableFilterableApplicationDAO;
 import org.wso2.carbon.identity.application.mgt.internal.ApplicationManagementServiceComponent;
 import org.wso2.carbon.identity.application.mgt.internal.ApplicationManagementServiceComponentHolder;
+import org.wso2.carbon.identity.base.IdentityConstants;
 import org.wso2.carbon.identity.base.IdentityException;
 import org.wso2.carbon.identity.base.IdentityRuntimeException;
 import org.wso2.carbon.identity.core.CertificateRetrievingException;
@@ -1566,6 +1567,15 @@
  ApplicationConstants.LOCAL_IDP_NAME,
  lclAuthenticator.getName(),
  lclAuthenticator.getDisplayName());
+ } else {
+ if (lclAuthenticator.getDefinedByType() == null) {
+ log.debug("Authenticator already exists. Updating the authenticator, but the " +
+ "defined by type is not set.");
+ } else {
+ log.debug("Authenticator already exists. Updating the authenticator.The defined "
+ + "by type is set to: " + lclAuthenticator.getDefinedByType().toString());
+ //TODO: Update database with defined by properties for local authenticators.
+ }
  }
  if (authenticatorId > 0) {
  // ID, TENANT_ID, AUTHENTICATOR_ID
@@ -3088,6 +3098,8 @@
  .get(ApplicationConstants.IDP_AUTHENTICATOR_NAME));
  localAuthenticator.setDisplayName(authenticatorInfo
  .get(ApplicationConstants.IDP_AUTHENTICATOR_DISPLAY_NAME));
+ localAuthenticator.setDefinedByType(IdentityConstants.DefinedByType.valueOf(
+ authenticatorInfo.get(ApplicationConstants.IDP_AUTHENTICATOR_DEFINED_BY_TYPE)));
  stepLocalAuth.get(step).add(localAuthenticator);
  } else {
  Map<String, List<FederatedAuthenticatorConfig>> stepFedIdps = stepFedIdPAuthenticators
@@ -3106,6 +3118,8 @@
  .get(ApplicationConstants.IDP_AUTHENTICATOR_NAME));
  fedAuthenticator.setDisplayName(authenticatorInfo
  .get(ApplicationConstants.IDP_AUTHENTICATOR_DISPLAY_NAME));
+ fedAuthenticator.setDefinedByType(IdentityConstants.DefinedByType.valueOf(
+ authenticatorInfo.get(ApplicationConstants.IDP_AUTHENTICATOR_DEFINED_BY_TYPE)));
  idpAuths.add(fedAuthenticator);
  }
 
@@ -5017,6 +5031,9 @@
  returnData
  .put(ApplicationConstants.IDP_AUTHENTICATOR_DISPLAY_NAME, rs.getString(3));
  }
+ // TODO: Read from database and set the DefinedBy property to the authenticator.
+ returnData.put(ApplicationConstants.IDP_AUTHENTICATOR_DEFINED_BY_TYPE,
+ IdentityConstants.DefinedByType.SYSTEM.toString());
  } finally {
  IdentityApplicationManagementUtil.closeStatement(prepStmt);
  }
@@ -5038,7 +5055,7 @@
  int authenticatorId = -1;
  PreparedStatement prepStmt = null;
  ResultSet rs = null;
- // TENANT_ID, IDP_ID, NAME,IS_ENABLED, DISPLAY_NAME
+ // TENANT_ID, IDP_ID, NAME,IS_ENABLED, DISPLAY_NAME, DEFINED_BY
  String sqlStmt = ApplicationMgtDBQueries.STORE_LOCAL_AUTHENTICATOR;
  try {
  String dbProductName = conn.getMetaData().getDatabaseProductName();
@@ -5050,6 +5067,7 @@
  prepStmt.setString(4, authenticatorName);
  prepStmt.setString(5, "1");
  prepStmt.setString(6, authenticatorDispalyName);
+ //TODO: prepStmt.setString(7, IdentityConstants.DefinedByType.SYSTEM.toString());
  prepStmt.execute();
  rs = prepStmt.getGeneratedKeys();
  if (rs.next()) {