I am attempting to validate the input to a REST method using one or more specific validation groups, but so far I have been unable to figure out how to properly do it. I am using RESTeasy 3.X with Hibernate Validator 5.X.
I know that prior to the Bean Validation 1.1 spec, a RESTeasy method could be annotated with something like:
#ValidateRequest(groups=MyGroup.class)
However, this functionality no longer exists in Hibernate Validator 5.X.
Suppose I have an entity like:
#Entity
#Table(name = "example_table")
#XmlRootElement
public class ExampleEntity implements Mappable, Serializable
{
// ...
#Column(name = "title")
#NotEmpty(groups = Default.class, ExampleEntityGroup.class)
#Size(max = 255)
private String title;
#Column(name = "description")
#NotEmpty(groups = Default.class)
#Size(max = 255)
private String description;
// ...
}
Now I'd like to define a REST PUT method to update this entity, and I'd like the "description" field to allow an empty value. For this to happen I'd like to validate the entity using the ExampleEntityGroup group that I've defined (whereas the Default group would be used to validate POST requests that create new objects).
Right now my update method interface looks something like:
#Path("{id}")
#PUT
#Consumes(...)
#Produces(...)
ExampleEntity update(#PathParam("id"), ExampleEntity exampleEntity);
However, with this as written, it will always validate exampleEntity using the Default validation group. What would I do to force the update() method to use the other validation group?
The only documentation I could find that seems close to this is an example from the Bean Validation spec that uses an interceptor. Is there a better way?
RestEasy 3 with Bean Validation 1.1 will automatically validate constrained resource methods, i.e. it suffices to place a constraint annotation to a resource method parameter or return value and it will be validated. There is no way to validate a specific group, it will always be the default group. You could try and open a feature request for the RestEasy project for this.
Related
Spring MVC | Angularjs | Hibernate
I have a very simple web app that list all books from database.
Page looks something like this....
-------------------------------------------
Problem
1. My update method returns not only book object but also other information such as error message, error code...etc. This causes a problem in my view when I update.
-------------------------------------------
Angularjs $resource
Once the data is returned from the server the existing reference is populated with the actual data. This is a useful trick since usually the resource is assigned to a model which is then rendered by the view. Having an empty object results in no rendering, once the data arrives from the server then the object is populated with the data and the view automatically re-renders itself showing the new data. This means that in most cases one never has to write a callback function for the action methods.
Now this is actually very convenient as you don't have to re-render new data to the view. But for my case, I really want to return not only the object its self but also other necessary data if when an error occurs.
This is what my update method looks like in my controller
#RequestMapping(path="/booklist/{id}", method = RequestMethod.PUT, produces="application/json")
#ResponseBody
public ResponseBuilder<Book> save(#PathVariable("id") Integer id, #RequestBody #Valid Book book, BindingResult result){
if(result.hasErrors()){
/*...
* Some error process
*/
ResponseBuilder<Book> rrBuilder = new ResponseBuilder.Builder<Book>(book)
.httpStatus(HttpStatus.BAD_REQUEST)
.map(errorMap)
.message(result.getAllErrors().toString())
.build();
return rrBuilder;
}else{
bookDao.saveOrUpdate(book);
ResponseBuilder<Book> rrBuilder = new ResponseBuilder.Builder<Book>(
book)
.httpStatus(HttpStatus.ACCEPTED)
.build();
return rrBuilder;
}
};
Questions
What is a proper way of doing this? I could use ResponseEnitity but this doesn't allow me to pass error codes when needed.
Should I include Error Object with in my Book class?
Or should all Object implements an Error interface?
Look something like this..
#Entity
#Table(name="books")
#Component
public class Book implements Serializable{
#Id
#GeneratedValue
private int id;
#NotBlank
private String name;
/**
* other fields
*/
#Transient
private ErrorHandler errorHandler;
How do you usually handle errors?
thank you...
I'm using Objectify and wish to have its Key<> type passed around in my API. I've created an ApiTransformer, but my questions is where to declare it, since the serialized Key<> class is not available, hence I cannot declare its transformer as a class annotation. I tried declaring it in the #Api annotation, but it doesn't work, I still get the error:
There was a problem generating the API metadata for your Cloud Endpoints classes: java.lang.IllegalArgumentException: Parameterized type com.googlecode.objectify.Key<[my package].User> not supported.
The ApiTransformer looks like:
public class KeyTransformer implements Transformer<Key<?>, String> {
public String transformTo(Key<?> in) {
return in.getString();
}
public Key<?> transformFrom(String in) {
return Key.valueOf(in);
}
}
And in my #Api I have:
#Api(name = "users", version = "v1",transformers = {KeyTransformer.class})
Unfortunately you can't. As you said you need to declare it on the Key class, your only chances to make this work are either.
1) Recompile the Key class for objectify with the #transformer annotation.
2) Extend the Key class with your own implementation and define the transformer there.
I don't really like any of those options so the way i usually resolve this is to hide the key object getter (by using #ApiResourceProperty(ignored=AnnotationBoolean.TRUE)) and only expose the id from that key.
That way you get a Endpoints frendly object, the only downside is you'll have to reconstitute the key using Key.create(YourClass.class, longId) manually whenever you need it.
You can add transforms to 3rd party classes by listing the transform in #Api annotation. I'm not dead sure it'll work parameterized class, but I don't see why not.
https://cloud.google.com/appengine/docs/java/endpoints/javadoc/com/google/api/server/spi/config/Api#transformers()
I am using Objectify to manage GAE Datastore for my GWT app. The problem is that I am not using queries properly and I get UmbrellaExceptions as per below:
Caused by: java.lang.RuntimeException: Server Error: java.lang.String cannot be cast to java.lang.Number
at com.google.web.bindery.requestfactory.shared.Receiver.onFailure(Receiver.java:44)
Say that I have a class Box with a unique field String id. I want to get the Box object whose id == "cHVQP6zZiUjM"
This is how I do it now:
public Box getBox(String boxId)
{
Objectify ofy = ObjectifyService.begin();
Query<Box> q=ofy.query(Box.class).filter("id",boxId);
Box targetBox = q.get();
return targetBox;
}
#Entity
public class Box extends DatastoreObject{
private String id;
private String title;
}
I tried doing this with ofy.load() but that method is not defined in my class Objectify (I don't know why).
Your key is encoded. Try using:
Box targetBox = ofy.get(Box.class, KeyFactory.stringToKey(boxId));
To decode your key.
The short answer: You are missing the #Id annotation in your entity.
The long answer: Id fields are special in the datastore. The id is not a real property, but rather a part of the Key that identifies the entity. You can't really filter on id fields, but you can filter on a special field called __key__. Objectify is somewhat clever about letting you filter by the id field and converting this to a __key__ filter under the covers, but it can't do it if you don't annotate the entity properly!
Actually I'm a little confused because Objectify shouldn't let you register the entity without an #Id field.
By the way, there are two sections of the documentation: Objectify4 (release coming soon) and Objectify3. Since you're using Ofy3, there is no load() method.
Another thing: Get-by-key operations are strongly preferred to queries when the operations are equivalent (as they are in your example).
I have a requirement to design a RESTful Service using RESTEasy. Clients can call this common service with any number of Query Parameters they would want to. My REST code should be able to read these Query Params in some way. For example if I have a book search service, clients can make the following calls.
http://domain.com/context/rest/books/searchBook?bookName=someBookName
http://domain.com/context/rest/books/searchBook?authorName=someAuthor& pubName=somePublisher
http://domain.com/context/rest/books/searchBook?isbn=213243
http://domain.com/context/rest/books/searchBook?authorName=someAuthor
I have to write a service class like below to handle this.
#Path("/books")
public class BookRestService{
// this is what I currently have, I want to change this method to in-take all the
// dynamic parameters that can come
#GET
#Path("/searchBook")
public Response searchBook(#QueryParam("bookName") String bookName,#QueryParam("isbn") String isbn) {
// fetch all such params
// create a search array and pass to backend
}
#POST
#Path("/addBook")
public Response addBook(......) {
//....
}
}
Sorry for the bad format (I couldn't get how code formatting works in this editor!). As you can see, I need to change the method searchBook() so that it will take any number of query parameters.
I saw a similar post here, but couldn't find the right solution.
How to design a RESTful URL for search with optional parameters?
Could any one throw some light on this please?
The best thing to do in this case would be using a DTO containing all the fields of your search criteria. For example, you mentioned 4 distinct parameters.
Book Name (bookName)
Author Name (authorName)
Publisher Name (pubName)
ISBN (isbn)
Create a DTO containing the fields having the following annotations for every property you want to map the parameters to:
public class CriteriaDTO{
#QueryParam("isbn")
private String isbn;
.
.
Other getter and setters of other properties
}
Here is a method doing that for your reference:
#GET
#Produces("application/json")
#Path("/searchBooks")
public ResultDTO search(#Form CriteriaDTO dto){
}
using following URL will populate the CriteriaDTO's property isbn automatically:
your.server.ip:port/URL/Mapping/searchBooks?isbn=123456789&pubName=testing
A similar question was asked here: How do you map multiple query parameters to the fields of a bean on Jersey GET request?
I went with kensen john's answer (UriInfo) instead. It allowed to just iterate through a set to check which parameters were passed.
Trying to implement a domain service in a SL app and getting the following error:
Parameter 'spFolderCreate' of domain method 'CreateSharePointFolder' must be an entity type exposed by the DomainService.
[EnableClientAccess()]
public class FileUploadService : DomainService
{
public void CreateSharePointFolder(SharePointFolderCreate spFolderCreate)
{
SharePointFolder spf = new SharePointFolder();
spf.CreateFolder_ClientOM(spFolderCreate.listName, spFolderCreate.fileName);
}
[OperationContract]
void CreateSharePointFolder(SharePointFolderCreate spFolderCreate);
[DataContract]
public class SharePointFolderCreate
{
private string m_listName;
private string m_fileName;
[DataMember]
public string listName
{
get { return m_listName; }
set { m_listName = value; }
}
[DataMember]
public string fileName
{
get { return m_fileName; }
set { m_fileName = value; }
}
}
So am I missing something simple here to make this all work?
It may be that the framework is inferring the intended operation because you have the word "Create" prefixing the function name (CreateSharePointFolder). Details of this behaviour can be found here
Although that is all fine for DomainServices and EntityFramework, following the information in that article, it can be inferred that methods beginning "Delete" will be performing a delete of an entity, so must accept an entity as a parameter. The same is true for "Create" or "Insert" prefixed methods. Only "Get" or "Select" methods can take non-entity parameters, making it possible to pass a numeric id (for example) to a "Get" method.
Try changing your method name temporarily to "BlahSharePointFolder" to see if it is this convention of inferrance that's causing your problem.
Also, as there is no metadata defined for your SharePointFolderCreate DC, you might need to decorate the class (in addition to the [DataContract] attribute) with the [MetadataType] attribute. You will see how to implement this if you used the DomainServiceClass wizard and point to an EF model. There is a checkbox at the bottom for generating metadata. Somewhere in your solution.Web project you should find a domainservice.metadata.cs file. In this file, you will find examples of how to use the [MetadataType] attribute.
For the RIA WCF service to work correctly with your own methods, you need to ensure that all entities existing on the parameter list have at least one member with a [Key] attribute defined in their metadata class, and that the entity is returned somewhere on your DomainService in a "Get" method.
HTH
Lee