org.apache.juneau.rest.converters.Traversable Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.rest.converters;
import org.apache.juneau.*;
import org.apache.juneau.rest.*;
import org.apache.juneau.rest.exception.*;
import org.apache.juneau.transform.*;
import org.apache.juneau.utils.*;
/**
* Converter for enabling of {@link PojoRest} support on response objects returned by a @RestMethod method.
*
*
* When enabled, objects in a POJO tree returned by the REST method can be addressed through additional URL path
* information.
*
*
* // Resource method on resource "http://localhost:8080/sample/addressBook"
* @RestMethod (name=GET , converters=Traversable.class )
* public void doGet(RestRequest req, RestResponse res) {
* return new AddressBook();
* }
*
* // Sample usage
* public static void main(String[] args) {
* // Get the zip code of the 2nd address of the first person in the address book.
* RestCall r = new RestClient().doGet("http://localhost:8080/sample/addressBook/0/addresses/1/zip" );
* int zip = r.getResponse(Integer.class );
* }
*
*
* See Also:
*
* - {@link PojoRest} - Additional information on addressing elements in a POJO tree using URL notation.
*
- {@link RestContext#REST_converters} - Registering converters with REST resources.
*
- {@doc juneau-rest-server.Converters}
*
*/
public final class Traversable implements RestConverter {
@Override /* RestConverter */
@SuppressWarnings({"rawtypes", "unchecked"})
public Object convert(RestRequest req, Object o) throws RestException, InternalServerError {
if (o == null)
return null;
String pathRemainder = req.getPathMatch().getRemainder();
if (pathRemainder != null) {
try {
BeanSession bs = req.getBeanSession();
PojoSwap swap = bs.getClassMetaForObject(o).getPojoSwap(bs);
if (swap != null)
o = swap.swap(bs, o);
PojoRest p = new PojoRest(o, req.getBody().getReaderParser());
o = p.get(pathRemainder);
} catch (PojoRestException e) {
throw new RestException(e, e.getStatus());
} catch (Exception e) {
throw new InternalServerError(e);
}
}
return o;
}
}