org.wso2.charon3.core.encoder

Class JSONDecoder

java.lang.Object

org.wso2.charon3.core.encoder.JSONDecoder

public class JSONDecoder
extends Object

This decodes the json encoded resource string and create a SCIM object model according to the specification according to the info that the user has sent, and returns SCIMUser object.

Constructor Summary

Constructors

Constructor and Description
JSONDecoder()

Method Summary

Modifier and Type	Method and Description
ComplexAttribute	buildComplexAttribute(AttributeSchema complexAttributeSchema, org.json.JSONObject jsonObject)
MultiValuedAttribute	buildComplexMultiValuedAttribute(AttributeSchema attributeSchema, org.json.JSONArray attributeValues)
MultiValuedAttribute	buildPrimitiveMultiValuedAttribute(AttributeSchema attributeSchema, org.json.JSONArray attributeValues)
SimpleAttribute	buildSimpleAttribute(AttributeSchema attributeSchema, Object attributeValue)
AbstractSCIMObject	decode(String scimResourceString, SCIMResourceTypeSchema schema)
BulkRequestData	decodeBulkData(String bulkResourceString) Decode BulkRequestData Json Sting.
AbstractCharonException	decodeCharonException(String scimErrorString) this method can be used to decode a scim response with the error schema into an AbstractCharonException
<T extends AbstractCharonException> T	decodeCharonException(String scimErrorString, Class<T> exceptionType) this method can be used to decode a scim response with the error schema into an AbstractCharonException
<T extends AbstractSCIMObject> ListedResource	decodeListedResource(String scimResourceString, ResourceTypeSchema resourceSchema, Class<T> scimObjectType) decodes a string that should match the SCIMConstants.LISTED_RESOURCE_CORE_SCHEMA_URI scheme to ListedResource object that holds the parsed objects
ArrayList<PatchOperation>	decodeRequest(String scimResourceString)
<T extends AbstractSCIMObject> T	decodeResource(String scimResourceString, ResourceTypeSchema resourceSchema, T scimObject) Decode the resource string sent in the SCIM request payload.
SearchRequest	decodeSearchRequestBody(String scimResourceString, SCIMResourceTypeSchema schema)
List<String>	toList(org.json.JSONArray array) Converts a JSONArray to a List.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONDecoder

public JSONDecoder()

Method Detail

decodeListedResource

public <T extends AbstractSCIMObject> ListedResource decodeListedResource(String scimResourceString,
                                                                          ResourceTypeSchema resourceSchema,
                                                                          Class<T> scimObjectType)
                                                                   throws BadRequestException,
                                                                          CharonException

decodes a string that should match the SCIMConstants.LISTED_RESOURCE_CORE_SCHEMA_URI scheme to ListedResource object that holds the parsed objects

Type Parameters:

T - a AbstractSCIMObject type as Group or User

Parameters:

scimResourceString - the listed resource string

resourceSchema - the schema of the resource objects that should be present.

scimObjectType - the type of the scim resources

Returns:

the listed resource object

Throws:

BadRequestException - if the json could not be parsed

CharonException - if a value of the json contains data in an unexpected format or type

decodeCharonException

public AbstractCharonException decodeCharonException(String scimErrorString)
                                              throws BadRequestException,
                                                     CharonException

this method can be used to decode a scim response with the error schema into an AbstractCharonException

Returns:

the decoded exception

Throws:

BadRequestException

CharonException

decodeCharonException

public <T extends AbstractCharonException> T decodeCharonException(String scimErrorString,
                                                                   Class<T> exceptionType)
                                                            throws BadRequestException,
                                                                   CharonException

this method can be used to decode a scim response with the error schema into an AbstractCharonException

Returns:

the decoded exception

Throws:

BadRequestException

CharonException

decodeResource

public <T extends AbstractSCIMObject> T decodeResource(String scimResourceString,
                                                       ResourceTypeSchema resourceSchema,
                                                       T scimObject)
                                                throws BadRequestException,
                                                       CharonException,
                                                       InternalErrorException

Decode the resource string sent in the SCIM request payload.

Parameters:

scimResourceString - - json encoded string of user info

resourceSchema - - SCIM defined user schema

scimObject - - a container holding the attributes and schema list

Returns:

SCIMObject

Throws:

BadRequestException

CharonException

InternalErrorException

toList

public List<String> toList(org.json.JSONArray array)
                    throws org.json.JSONException

Converts a JSONArray to a List.

Parameters:

array - JSONArray object.

Returns:

List of the JSONArray object.

Throws:

org.json.JSONException - Error when creating List from JSONArray.

buildSimpleAttribute

public SimpleAttribute buildSimpleAttribute(AttributeSchema attributeSchema,
                                            Object attributeValue)
                                     throws CharonException,
                                            BadRequestException

Throws:

CharonException

BadRequestException

buildComplexMultiValuedAttribute

public MultiValuedAttribute buildComplexMultiValuedAttribute(AttributeSchema attributeSchema,
                                                             org.json.JSONArray attributeValues)
                                                      throws CharonException,
                                                             BadRequestException

Throws:

CharonException

BadRequestException

buildPrimitiveMultiValuedAttribute

public MultiValuedAttribute buildPrimitiveMultiValuedAttribute(AttributeSchema attributeSchema,
                                                               org.json.JSONArray attributeValues)
                                                        throws CharonException,
                                                               BadRequestException

Throws:

CharonException

BadRequestException

buildComplexAttribute

public ComplexAttribute buildComplexAttribute(AttributeSchema complexAttributeSchema,
                                              org.json.JSONObject jsonObject)
                                       throws BadRequestException,
                                              CharonException,
                                              InternalErrorException,
                                              org.json.JSONException

Throws:

BadRequestException

CharonException

InternalErrorException

org.json.JSONException

decodeRequest

public ArrayList<PatchOperation> decodeRequest(String scimResourceString)
                                        throws BadRequestException

Throws:

BadRequestException

decode

public AbstractSCIMObject decode(String scimResourceString,
                                 SCIMResourceTypeSchema schema)
                          throws CharonException,
                                 BadRequestException

Throws:

CharonException

BadRequestException

decodeSearchRequestBody

public SearchRequest decodeSearchRequestBody(String scimResourceString,
                                             SCIMResourceTypeSchema schema)
                                      throws BadRequestException

Throws:

BadRequestException

decodeBulkData

public BulkRequestData decodeBulkData(String bulkResourceString)
                               throws BadRequestException

Decode BulkRequestData Json Sting.

Parameters:

bulkResourceString -

Returns:

BulkRequestData Object

Throws:

BadRequestException