use of org.wso2.charon3.core.objects.SCIMObject in project charon by wso2.
the class JSONDecoder method decodeResource.
/**
* Decode the resource string sent in the SCIM request payload.
*
* @param scimResourceString - json encoded string of user info
* @param resourceSchema - SCIM defined user schema
* @param scimObject - a container holding the attributes and schema list
* @return SCIMObject
*/
public SCIMObject decodeResource(String scimResourceString, ResourceTypeSchema resourceSchema, AbstractSCIMObject scimObject) throws BadRequestException, CharonException, InternalErrorException {
try {
// decode the string into json representation
JSONObject decodedJsonObj = new JSONObject(new JSONTokener(scimResourceString));
// get the attribute schemas list from the schema that defines the given resource
List<AttributeSchema> attributeSchemas = resourceSchema.getAttributesList();
// set the schemas in scimobject
for (int i = 0; i < resourceSchema.getSchemasList().size(); i++) {
scimObject.setSchema(resourceSchema.getSchemasList().get(i));
}
// iterate through the schema and extract the attributes.
for (AttributeSchema attributeSchema : attributeSchemas) {
// obtain the user defined value for given key- attribute schema name
Object attributeValObj = decodedJsonObj.opt(attributeSchema.getName());
if (attributeValObj == null) {
// user may define the attribute by its fully qualified uri
attributeValObj = decodedJsonObj.opt(attributeSchema.getURI());
}
SCIMDefinitions.DataType attributeSchemaDataType = attributeSchema.getType();
if (attributeSchemaDataType.equals(STRING) || attributeSchemaDataType.equals(BINARY) || attributeSchemaDataType.equals(BOOLEAN) || attributeSchemaDataType.equals(DATE_TIME) || attributeSchemaDataType.equals(DECIMAL) || attributeSchemaDataType.equals(INTEGER) || attributeSchemaDataType.equals(REFERENCE)) {
if (!attributeSchema.getMultiValued()) {
if (attributeValObj instanceof String || attributeValObj instanceof Boolean || attributeValObj instanceof Integer || attributeValObj == null) {
// If an attribute is passed without a value, no need to save it.
if (attributeValObj == null) {
continue;
}
// if the corresponding schema data type is String/Boolean/Binary/Decimal/Integer/DataTime
// or Reference, it is a SimpleAttribute.
scimObject.setAttribute(buildSimpleAttribute(attributeSchema, attributeValObj), resourceSchema);
} else {
logger.error("Error decoding the simple attribute");
throw new BadRequestException(ResponseCodeConstants.INVALID_SYNTAX);
}
} else {
if (attributeValObj instanceof JSONArray || attributeValObj == null) {
// If an attribute is passed without a value, no need to save it.
if (attributeValObj == null) {
continue;
}
scimObject.setAttribute(buildPrimitiveMultiValuedAttribute(attributeSchema, (JSONArray) attributeValObj), resourceSchema);
} else {
logger.error("Error decoding the primitive multivalued attribute");
throw new BadRequestException(ResponseCodeConstants.INVALID_SYNTAX);
}
}
} else if (attributeSchemaDataType.equals(COMPLEX)) {
if (attributeSchema.getMultiValued() == true) {
if (attributeValObj instanceof JSONArray || attributeValObj == null) {
if (attributeValObj == null) {
continue;
}
// if the corresponding json value object is JSONArray, it is a MultiValuedAttribute.
scimObject.setAttribute(buildComplexMultiValuedAttribute(attributeSchema, (JSONArray) attributeValObj), resourceSchema);
} else {
logger.error("Error decoding the complex multivalued attribute");
throw new BadRequestException(ResponseCodeConstants.INVALID_SYNTAX);
}
} else if (attributeSchema.getMultiValued() == false) {
if (attributeValObj instanceof JSONObject || attributeValObj == null) {
if (attributeValObj == null) {
continue;
}
// if the corresponding json value object is JSONObject, it is a ComplexAttribute.
scimObject.setAttribute(buildComplexAttribute(attributeSchema, (JSONObject) attributeValObj), resourceSchema);
} else {
logger.error("Error decoding the complex attribute");
throw new BadRequestException(ResponseCodeConstants.INVALID_SYNTAX);
}
}
}
}
return scimObject;
} catch (JSONException e) {
logger.error("json error in decoding the resource");
throw new BadRequestException(ResponseCodeConstants.INVALID_SYNTAX);
}
}
use of org.wso2.charon3.core.objects.SCIMObject in project charon by wso2.
the class JSONDecoder method decode.
public AbstractSCIMObject decode(String scimResourceString, SCIMResourceTypeSchema schema) throws CharonException, BadRequestException {
try {
JSONObject decodedJsonObj = new JSONObject(new JSONTokener(scimResourceString));
AbstractSCIMObject scimObject = null;
if (schema.getSchemasList().contains(SCIMConstants.GROUP_CORE_SCHEMA_URI)) {
scimObject = (AbstractSCIMObject) decodeResource(decodedJsonObj.toString(), schema, new Group());
} else {
scimObject = (AbstractSCIMObject) decodeResource(decodedJsonObj.toString(), schema, new User());
}
return scimObject;
} catch (JSONException | InternalErrorException | CharonException e) {
throw new CharonException("Error in decoding the request", e);
} catch (BadRequestException e) {
throw new BadRequestException(ResponseCodeConstants.INVALID_SYNTAX);
}
}
use of org.wso2.charon3.core.objects.SCIMObject in project charon by wso2.
the class AbstractValidator method validateReturnedAttributes.
/*
* This method is to remove any defined and requested attributes and include
* requested attributes if not they have been removed.
*
* @param scimObject
* @param requestedAttributes
* @param requestedExcludingAttributes
*/
public static void validateReturnedAttributes(AbstractSCIMObject scimObject, String requestedAttributes, String requestedExcludingAttributes) throws CharonException {
List<String> requestedAttributesList = null;
List<String> requestedExcludingAttributesList = null;
if (requestedAttributes != null) {
// make a list from the comma separated requestedAttributes
requestedAttributesList = Arrays.asList(requestedAttributes.split(","));
}
if (requestedExcludingAttributes != null) {
// make a list from the comma separated requestedExcludingAttributes
requestedExcludingAttributesList = Arrays.asList(requestedExcludingAttributes.split(","));
}
Map<String, Attribute> attributeList = scimObject.getAttributeList();
ArrayList<Attribute> attributeTemporyList = new ArrayList<Attribute>();
for (Attribute attribute : attributeList.values()) {
attributeTemporyList.add(attribute);
}
for (Attribute attribute : attributeTemporyList) {
// check for never/request attributes.
if (attribute.getReturned().equals(SCIMDefinitions.Returned.NEVER)) {
scimObject.deleteAttribute(attribute.getName());
}
// If so return it.
if (requestedAttributes == null && requestedExcludingAttributes == null) {
if (attribute.getReturned().equals(SCIMDefinitions.Returned.REQUEST)) {
scimObject.deleteAttribute(attribute.getName());
}
} else {
// A request should only contains either attributes or exclude attribute params. Not both
if (requestedAttributes != null) {
// and add only the requested attributes
if ((attribute.getReturned().equals(SCIMDefinitions.Returned.DEFAULT) || attribute.getReturned().equals(SCIMDefinitions.Returned.REQUEST)) && (!requestedAttributesList.contains(attribute.getName()) && !isSubAttributeExistsInList(requestedAttributesList, attribute))) {
scimObject.deleteAttribute(attribute.getName());
}
} else if (requestedExcludingAttributes != null) {
// removing attributes which has returned as request. This is because no request is made
if (attribute.getReturned().equals(SCIMDefinitions.Returned.REQUEST)) {
scimObject.deleteAttribute(attribute.getName());
}
// removed from the default set of attributes
if ((attribute.getReturned().equals(SCIMDefinitions.Returned.DEFAULT)) && requestedExcludingAttributesList.contains(attribute.getName())) {
scimObject.deleteAttribute(attribute.getName());
}
}
}
// check the same for sub attributes
if (attribute.getType().equals(SCIMDefinitions.DataType.COMPLEX)) {
if (attribute.getMultiValued()) {
List<Attribute> valuesList = ((MultiValuedAttribute) attribute).getAttributeValues();
for (Attribute subAttribute : valuesList) {
Map<String, Attribute> valuesSubAttributeList = ((ComplexAttribute) subAttribute).getSubAttributesList();
ArrayList<Attribute> valuesSubAttributeTemporyList = new ArrayList<Attribute>();
// hence need to traverse on a copy
for (Attribute subSimpleAttribute : valuesSubAttributeList.values()) {
valuesSubAttributeTemporyList.add(subSimpleAttribute);
}
for (Attribute subSimpleAttribute : valuesSubAttributeTemporyList) {
removeValuesSubAttributeOnReturn(subSimpleAttribute, subAttribute, attribute, requestedAttributes, requestedExcludingAttributes, requestedAttributesList, requestedExcludingAttributesList, scimObject);
}
}
} else {
Map<String, Attribute> subAttributeList = ((ComplexAttribute) attribute).getSubAttributesList();
ArrayList<Attribute> subAttributeTemporyList = new ArrayList<Attribute>();
for (Attribute subAttribute : subAttributeList.values()) {
subAttributeTemporyList.add(subAttribute);
}
for (Attribute subAttribute : subAttributeTemporyList) {
if (subAttribute.getType().equals(SCIMDefinitions.DataType.COMPLEX)) {
// this applicable for extension schema only
if (subAttribute.getMultiValued()) {
List<Attribute> valuesList = ((MultiValuedAttribute) subAttribute).getAttributeValues();
for (Attribute subSubValue : valuesList) {
Map<String, Attribute> subValuesSubAttributeList = ((ComplexAttribute) subSubValue).getSubAttributesList();
ArrayList<Attribute> valuesSubSubAttributeTemporyList = new ArrayList<Attribute>();
// hence need to traverse on a copy
for (Attribute subSubSimpleAttribute : subValuesSubAttributeList.values()) {
valuesSubSubAttributeTemporyList.add(subSubSimpleAttribute);
}
for (Attribute subSubSimpleAttribute : valuesSubSubAttributeTemporyList) {
removeValuesSubSubAttributeOnReturn(attribute, subAttribute, subSubValue, subSubSimpleAttribute, requestedAttributes, requestedExcludingAttributes, requestedAttributesList, requestedExcludingAttributesList, scimObject);
}
}
} else {
ArrayList<Attribute> subSubAttributeTemporyList = new ArrayList<Attribute>();
Map<String, Attribute> subSubAttributeList = ((ComplexAttribute) subAttribute).getSubAttributesList();
for (Attribute subSubAttribute : subSubAttributeList.values()) {
subSubAttributeTemporyList.add(subSubAttribute);
}
for (Attribute subSubAttribute : subSubAttributeTemporyList) {
removeSubSubAttributesOnReturn(attribute, subAttribute, subSubAttribute, requestedAttributes, requestedExcludingAttributes, requestedAttributesList, requestedExcludingAttributesList, scimObject);
}
}
removeSubAttributesOnReturn(subAttribute, attribute, requestedAttributes, requestedExcludingAttributes, requestedAttributesList, requestedExcludingAttributesList, scimObject);
} else {
removeSubAttributesOnReturn(subAttribute, attribute, requestedAttributes, requestedExcludingAttributes, requestedAttributesList, requestedExcludingAttributesList, scimObject);
}
}
}
}
}
}
use of org.wso2.charon3.core.objects.SCIMObject in project charon by wso2.
the class AbstractValidator method validateSCIMObjectForRequiredSubAttributes.
/*
* Validate SCIMObject for required sub attributes given the object and the corresponding schema.
*
* @param attribute
* @param attributeSchema
* @throws CharonException
* @throws BadRequestException
*/
private static void validateSCIMObjectForRequiredSubAttributes(AbstractAttribute attribute, AttributeSchema attributeSchema) throws CharonException, BadRequestException {
if (attribute != null) {
List<SCIMAttributeSchema> subAttributesSchemaList = ((SCIMAttributeSchema) attributeSchema).getSubAttributeSchemas();
if (subAttributesSchemaList != null) {
for (SCIMAttributeSchema subAttributeSchema : subAttributesSchemaList) {
if (subAttributeSchema.getRequired()) {
if (attribute instanceof ComplexAttribute) {
if (attribute.getSubAttribute(subAttributeSchema.getName()) == null) {
String error = "Required sub attribute: " + subAttributeSchema.getName() + " is missing in the SCIM Attribute: " + attribute.getName();
throw new BadRequestException(error, ResponseCodeConstants.INVALID_VALUE);
}
} else if (attribute instanceof MultiValuedAttribute) {
List<Attribute> values = ((MultiValuedAttribute) attribute).getAttributeValues();
for (Attribute value : values) {
if (value instanceof ComplexAttribute) {
if (value.getSubAttribute(subAttributeSchema.getName()) == null) {
String error = "Required sub attribute: " + subAttributeSchema.getName() + ", is missing in the SCIM Attribute: " + attribute.getName();
throw new BadRequestException(error, ResponseCodeConstants.INVALID_VALUE);
}
}
}
}
}
// Following is only applicable for extension schema validation.
AbstractAttribute subAttribute = null;
if (attribute instanceof ComplexAttribute) {
subAttribute = (AbstractAttribute) ((ComplexAttribute) attribute).getSubAttribute(subAttributeSchema.getName());
} else if (attribute instanceof MultiValuedAttribute) {
List<Attribute> subAttributeList = ((MultiValuedAttribute) attribute).getAttributeValues();
for (Attribute subAttrbte : subAttributeList) {
if (subAttrbte.getName().equals(subAttributeSchema.getName())) {
subAttribute = (AbstractAttribute) subAttrbte;
}
}
}
List<SCIMAttributeSchema> subSubAttributesSchemaList = ((SCIMAttributeSchema) subAttributeSchema).getSubAttributeSchemas();
if (subSubAttributesSchemaList != null) {
validateSCIMObjectForRequiredSubAttributes(subAttribute, subAttributeSchema);
}
}
}
}
}
Aggregations