use of org.wso2.carbon.apimgt.rest.api.util.exception.BadRequestException in project charon by wso2.
the class JSONEncoder method encodeSCIMException.
/*
* encode scim exceptions
* @param exception
* @return
*/
public String encodeSCIMException(AbstractCharonException exception) {
// outer most json object
JSONObject rootErrorObject = new JSONObject();
// JSON Object containing the error code and error message
JSONObject errorObject = new JSONObject();
try {
// construct error object with details in the exception
errorObject.put(ResponseCodeConstants.SCHEMAS, exception.getSchemas());
if (exception instanceof BadRequestException) {
errorObject.put(ResponseCodeConstants.SCIM_TYPE, ((BadRequestException) (exception)).getScimType());
}
errorObject.put(ResponseCodeConstants.DETAIL, String.valueOf(exception.getDetail()));
errorObject.put(ResponseCodeConstants.STATUS, String.valueOf(exception.getStatus()));
// construct the full json obj.
rootErrorObject = errorObject;
} catch (JSONException e) {
// usually errors occur rarely when encoding exceptions. and no need to pass them to clients.
// sufficient to log them in server side back end.
logger.error("SCIMException encoding error");
}
return rootErrorObject.toString();
}
use of org.wso2.carbon.apimgt.rest.api.util.exception.BadRequestException in project charon by wso2.
the class BulkResourceManager method processBulkData.
public SCIMResponse processBulkData(String data, UserManager userManager) {
BulkResponseData bulkResponseData;
try {
// Get encoder and decoder from AbstractResourceEndpoint
encoder = getEncoder();
decoder = getDecoder();
BulkRequestData bulkRequestDataObject;
// decode the request
bulkRequestDataObject = decoder.decodeBulkData(data);
bulkRequestProcessor.setFailOnError(bulkRequestDataObject.getFailOnErrors());
bulkRequestProcessor.setUserManager(userManager);
// Get bulk response data
bulkResponseData = bulkRequestProcessor.processBulkRequests(bulkRequestDataObject);
// encode the BulkResponseData object
String finalEncodedResponse = encoder.encodeBulkResponseData(bulkResponseData);
// careate SCIM response message
Map<String, String> responseHeaders = new HashMap<String, String>();
// add location header
responseHeaders.put(SCIMConstants.CONTENT_TYPE_HEADER, SCIMConstants.APPLICATION_JSON);
// create the final response
return new SCIMResponse(ResponseCodeConstants.CODE_OK, finalEncodedResponse, responseHeaders);
} catch (CharonException e) {
return AbstractResourceManager.encodeSCIMException(e);
} catch (BadRequestException e) {
return AbstractResourceManager.encodeSCIMException(e);
} catch (InternalErrorException e) {
return AbstractResourceManager.encodeSCIMException(e);
}
}
use of org.wso2.carbon.apimgt.rest.api.util.exception.BadRequestException in project charon by wso2.
the class GroupResourceManager method listWithPOST.
/*
* this facilitates the querying using HTTP POST
* @param resourceString
* @param usermanager
* @return
*/
@Override
public SCIMResponse listWithPOST(String resourceString, UserManager userManager) {
JSONEncoder encoder = null;
JSONDecoder decoder = null;
try {
// obtain the json encoder
encoder = getEncoder();
// obtain the json decoder
decoder = getDecoder();
// return core group schema
SCIMResourceTypeSchema schema = SCIMResourceSchemaManager.getInstance().getGroupResourceSchema();
// create the search request object
SearchRequest searchRequest = decoder.decodeSearchRequestBody(resourceString, schema);
searchRequest.setCount(ResourceManagerUtil.processCount(searchRequest.getCountStr()));
searchRequest.setStartIndex(ResourceManagerUtil.processCount(searchRequest.getStartIndexStr()));
if (searchRequest.getSchema() != null && !searchRequest.getSchema().equals(SCIMConstants.SEARCH_SCHEMA_URI)) {
throw new BadRequestException("Provided schema is invalid", ResponseCodeConstants.INVALID_VALUE);
}
// check whether provided sortOrder is valid or not
if (searchRequest.getSortOder() != null) {
if (!(searchRequest.getSortOder().equalsIgnoreCase(SCIMConstants.OperationalConstants.ASCENDING) || searchRequest.getSortOder().equalsIgnoreCase(SCIMConstants.OperationalConstants.DESCENDING))) {
String error = " Invalid sortOrder value is specified";
throw new BadRequestException(error, ResponseCodeConstants.INVALID_VALUE);
}
}
// ascending.
if (searchRequest.getSortOder() == null && searchRequest.getSortBy() != null) {
searchRequest.setSortOder(SCIMConstants.OperationalConstants.ASCENDING);
}
// get the URIs of required attributes which must be given a value
Map<String, Boolean> requiredAttributes = ResourceManagerUtil.getOnlyRequiredAttributesURIs((SCIMResourceTypeSchema) CopyUtil.deepCopy(schema), searchRequest.getAttributesAsString(), searchRequest.getExcludedAttributesAsString());
List<Object> returnedGroups;
int totalResults = 0;
// API user should pass a usermanager usermanager to UserResourceEndpoint.
if (userManager != null) {
List<Object> tempList = userManager.listGroupsWithPost(searchRequest, requiredAttributes);
totalResults = (int) tempList.get(0);
tempList.remove(0);
returnedGroups = tempList;
for (Object group : returnedGroups) {
// perform service provider side validation.
ServerSideValidator.validateRetrievedSCIMObjectInList((Group) group, schema, searchRequest.getAttributesAsString(), searchRequest.getExcludedAttributesAsString());
}
// create a listed resource object out of the returned users list.
ListedResource listedResource = createListedResource(returnedGroups, searchRequest.getStartIndex(), totalResults);
// convert the listed resource into specific format.
String encodedListedResource = encoder.encodeSCIMObject(listedResource);
// if there are any http headers to be added in the response header.
Map<String, String> responseHeaders = new HashMap<String, String>();
responseHeaders.put(SCIMConstants.CONTENT_TYPE_HEADER, SCIMConstants.APPLICATION_JSON);
return new SCIMResponse(ResponseCodeConstants.CODE_OK, encodedListedResource, responseHeaders);
} else {
String error = "Provided user manager handler is null.";
// throw internal server error.
throw new InternalErrorException(error);
}
} catch (CharonException e) {
return AbstractResourceManager.encodeSCIMException(e);
} catch (NotFoundException e) {
return AbstractResourceManager.encodeSCIMException(e);
} catch (InternalErrorException e) {
return AbstractResourceManager.encodeSCIMException(e);
} catch (BadRequestException e) {
return AbstractResourceManager.encodeSCIMException(e);
} catch (NotImplementedException e) {
return AbstractResourceManager.encodeSCIMException(e);
}
}
use of org.wso2.carbon.apimgt.rest.api.util.exception.BadRequestException in project charon by wso2.
the class GroupResourceManager method listWithGET.
/*
* Method to list the groups at the /Groups endpoint
*
* @param usermanager
* @param filter
* @param startIndex
* @param count
* @param sortBy
* @param sortOrder
* @param attributes
* @param excludeAttributes
* @return
*/
@Override
public SCIMResponse listWithGET(UserManager userManager, String filter, int startIndex, int count, String sortBy, String sortOrder, String attributes, String excludeAttributes) {
// According to SCIM 2.0 spec minus values will be considered as 0
if (count < 0) {
count = 0;
}
// According to SCIM 2.0 spec minus values will be considered as 1
if (startIndex < 1) {
startIndex = 1;
}
FilterTreeManager filterTreeManager = null;
Node rootNode = null;
JSONEncoder encoder = null;
try {
// check whether provided sortOrder is valid or not
if (sortOrder != null) {
if (!(sortOrder.equalsIgnoreCase(SCIMConstants.OperationalConstants.ASCENDING) || sortOrder.equalsIgnoreCase(SCIMConstants.OperationalConstants.DESCENDING))) {
String error = " Invalid sortOrder value is specified";
throw new BadRequestException(error, ResponseCodeConstants.INVALID_VALUE);
}
}
// ascending.
if (sortOrder == null && sortBy != null) {
sortOrder = SCIMConstants.OperationalConstants.ASCENDING;
}
// unless configured returns core-user schema or else returns extended user schema)
SCIMResourceTypeSchema schema = SCIMResourceSchemaManager.getInstance().getGroupResourceSchema();
if (filter != null) {
filterTreeManager = new FilterTreeManager(filter, schema);
rootNode = filterTreeManager.buildTree();
}
// obtain the json encoder
encoder = getEncoder();
// get the URIs of required attributes which must be given a value
Map<String, Boolean> requiredAttributes = ResourceManagerUtil.getOnlyRequiredAttributesURIs((SCIMResourceTypeSchema) CopyUtil.deepCopy(schema), attributes, excludeAttributes);
List<Object> returnedGroups;
int totalResults = 0;
// API group should pass a usermanager usermanager to GroupResourceEndpoint.
if (userManager != null) {
List<Object> tempList = userManager.listGroupsWithGET(rootNode, startIndex, count, sortBy, sortOrder, requiredAttributes);
totalResults = (int) tempList.get(0);
tempList.remove(0);
returnedGroups = tempList;
for (Object group : returnedGroups) {
// perform service provider side validation.
ServerSideValidator.validateRetrievedSCIMObjectInList((Group) group, SCIMSchemaDefinitions.SCIM_GROUP_SCHEMA, attributes, excludeAttributes);
}
// create a listed resource object out of the returned groups list.
ListedResource listedResource = createListedResource(returnedGroups, startIndex, totalResults);
// convert the listed resource into specific format.
String encodedListedResource = encoder.encodeSCIMObject(listedResource);
// if there are any http headers to be added in the response header.
Map<String, String> responseHeaders = new HashMap<String, String>();
responseHeaders.put(SCIMConstants.CONTENT_TYPE_HEADER, SCIMConstants.APPLICATION_JSON);
return new SCIMResponse(ResponseCodeConstants.CODE_OK, encodedListedResource, responseHeaders);
} else {
String error = "Provided user manager handler is null.";
// throw internal server error.
throw new InternalErrorException(error);
}
} catch (CharonException e) {
return encodeSCIMException(e);
} catch (NotFoundException e) {
return encodeSCIMException(e);
} catch (InternalErrorException e) {
return encodeSCIMException(e);
} catch (BadRequestException e) {
return encodeSCIMException(e);
} catch (NotImplementedException e) {
return encodeSCIMException(e);
} catch (IOException e) {
String error = "Error in tokenization of the input filter";
CharonException charonException = new CharonException(error);
return AbstractResourceManager.encodeSCIMException(charonException);
}
}
use of org.wso2.carbon.apimgt.rest.api.util.exception.BadRequestException in project charon by wso2.
the class MeResourceManager method updateWithPUT.
@Override
public SCIMResponse updateWithPUT(String userName, String scimObjectString, UserManager userManager, String attributes, String excludeAttributes) {
// needs to validate the incoming object. eg: id can not be set by the consumer.
JSONEncoder encoder = null;
JSONDecoder decoder = null;
try {
// obtain the json encoder
encoder = getEncoder();
// obtain the json decoder.
decoder = getDecoder();
SCIMResourceTypeSchema schema = SCIMResourceSchemaManager.getInstance().getUserResourceSchema();
// get the URIs of required attributes which must be given a value
Map<String, Boolean> requiredAttributes = ResourceManagerUtil.getOnlyRequiredAttributesURIs((SCIMResourceTypeSchema) CopyUtil.deepCopy(schema), attributes, excludeAttributes);
// decode the SCIM User object, encoded in the submitted payload.
User user = (User) decoder.decodeResource(scimObjectString, schema, new User());
User updatedUser = null;
if (userManager != null) {
// retrieve the old object
User oldUser = userManager.getMe(userName, ResourceManagerUtil.getAllAttributeURIs(schema));
if (oldUser != null) {
User validatedUser = (User) ServerSideValidator.validateUpdatedSCIMObject(oldUser, user, schema);
updatedUser = userManager.updateMe(validatedUser, requiredAttributes);
} else {
String error = "No user exists with the given userName: " + userName;
throw new NotFoundException(error);
}
} else {
String error = "Provided user manager handler is null.";
throw new InternalErrorException(error);
}
// encode the newly created SCIM user object and add id attribute to Location header.
String encodedUser;
Map<String, String> httpHeaders = new HashMap<String, String>();
if (updatedUser != null) {
// create a deep copy of the user object since we are going to change it.
User copiedUser = (User) CopyUtil.deepCopy(updatedUser);
// need to remove password before returning
ServerSideValidator.validateReturnedAttributes(copiedUser, attributes, excludeAttributes);
encodedUser = encoder.encodeSCIMObject(copiedUser);
// add location header
httpHeaders.put(SCIMConstants.LOCATION_HEADER, getResourceEndpointURL(SCIMConstants.USER_ENDPOINT) + "/" + updatedUser.getId());
httpHeaders.put(SCIMConstants.CONTENT_TYPE_HEADER, SCIMConstants.APPLICATION_JSON);
} else {
String error = "Updated User resource is null.";
throw new CharonException(error);
}
// put the uri of the User object in the response header parameter.
return new SCIMResponse(ResponseCodeConstants.CODE_OK, encodedUser, httpHeaders);
} catch (NotFoundException e) {
return encodeSCIMException(e);
} catch (BadRequestException e) {
return encodeSCIMException(e);
} catch (CharonException e) {
return encodeSCIMException(e);
} catch (InternalErrorException e) {
return encodeSCIMException(e);
} catch (NotImplementedException e) {
return encodeSCIMException(e);
}
}
Aggregations