The core packages of Juneau contains serializers and parsers for converting POJOs to and from a wide variety of content types.
It uses a common API for defining serializers and parsers.
One of the goals of Juneau was to make serialization as simple as possible.
In a single line of code, you should be able to serialize and parse most POJOs.
Despite this simplicity, Juneau provides lots of extensibility and configuration properties for tailoring how POJOs are serialized and parsed.
2.1 - Serializers
The built-in serializers in Juneau are fast, efficient, and highly configurable.
They work by serializing POJOs directly to streams instead of using intermediate Document Object Model objects.
In most cases, you can serialize objects in one line of code by using one of the default serializers:
// A simple bean
public class Person {
public String name = "John Smith";
public int age = 21;
}
// Serialize to JSON, XML, or HTML
Person p = new Person();
// Produces:
// "{name:'John Smith',age:21}"
String json = JsonSerializer.DEFAULT.serialize(p);
// Produces:
// <object>
// <name>John Smith</name>
// <age>21</age>
// </object>
String xml = XmlSerializer.DEFAULT.serialize(p);
// Produces:
// <table>
// <tr><th>key</th><th>value</th></tr>
// <tr><td>name</td><td>John Smith</td></tr>
// <tr><td>age</td><td>21</td></tr>
// </table>
String html = HtmlSerializer.DEFAULT.serialize(p);
// Produces:
// "(name='John Smith',age=21)"
String uon = UonSerializer.DEFAULT.serialize(p);
// Produces:
// "name='John+Smith'&age=21"
String urlencoding = UrlEncodingSerializer.DEFAULT.serialize(p);
// Produces:
// 82 A4 6E 61 6D 65 AA 4A 6F 68 6E 20 53 6D 69 74 68 A3 61 67 65 15
byte[] b = MsgPackSerializer.DEFAULT.serialize(p);
In addition to the default serializers, customized serializers can be created using various built-in options:
// Use one of the default serializers to serialize a POJO
String json = JsonSerializer.DEFAULT.serialize(someObject);
// Create a custom serializer for lax syntax using single quote characters
JsonSerializer serializer = new JsonSerializer()
.setSimpleMode(true)
.setQuoteChar('\'');
// Clone an existing serializer and modify it to use single-quotes
JsonSerializer serializer = JsonSerializer.DEFAULT.clone()
.setQuoteChar('\'');
// Serialize a POJO to JSON
String json = serializer.serialize(someObject);
Default serialization support is provided for Java primitives, Maps
, Collections
, beans, and arrays.
Extensible support for other data types such as Calendars
, Dates
, Iterators
is available through the use of POJO swaps (described later).
Additional Information
2.2 - Parsers
Parsers work by parsing input directly into POJOs instead of having to create intermediate Document Object Models.
This allows them to parse input with minimal object creation.
Like the serializers, you can often parse objects in one line of code by using one of the default parsers:
// Use one of the predefined parsers.
Parser parser = JsonParser.DEFAULT;
// Parse a JSON object as a bean.
String json = "{name:'John Smith',age:21}";
Person p = parser.parse(json, Person.class);
// Or parse it into a generic Map.
Map m1 = parser.parse(json, Map.class);
// Parse a JSON string.
json = "'foobar'";
String s2 = parser.parse(json, String.class);
// Parse a JSON number as a Long or Float.
json = "123";
Long l3 = parser.parse(json, Long.class);
Float f3 = parser.parse(json, Float.class);
// Parse a JSON object as a HashMap<String,Person>.
json = "{a:{name:'John Smith',age:21},b:{name:'Joe Smith',age:42}}";
Map<String,Person> m4 = parser.parse(json, HashMap.class, String.class, Person.class)
// Parse a JSON object as a HashMap<String,LinkedList<Person>>.
json = "{a:[{name:'John Smith',age:21},{name:'Joe Smith',age:42}]}";
Map<String,List<Person>> m5 = parser.parse(json, HashMap.class, String.class, LinkedList.class, Person.class)
// Parse a JSON array of integers as a Collection of Integers or int[] array.
json = "[1,2,3]";
List<Integer> l6 = parser.parse(json, LinkedList.class, Integer.class);
int[] i7 = parser.parse(json, int[].class);
The parsers can also be used to populating existing bean and collection objects:
// Use one of the predefined parsers.
Parser parser = JsonParser.DEFAULT;
// Populate the properties on an existing bean from a JSON object.
String json = "{name:'John Smith',age:21}";
Person p = new Person();
parser.parseIntoBean(json, p);
// Populate an existing list from a JSON array of numbers.
json = "[1,2,3]";
List<Integer> l2 = new LinkedList<Integer>();
parser.parseIntoCollection(json, l2, Integer.class);
// Populate an existing map from a JSON object containing beans.
json = "{a:{name:'John Smith',age:21},b:{name:'Joe Smith',age:42}}";
Map<String,Person> m3 = new TreeMap<String,Person>();
parser.parseIntoMap(json, m3, String.class, Person.class);
In the example above, we're parsing "lax" JSON (single quotes, unquoted attributes).
The JSON parser can handle any valid JSON syntax (such as quoted or unquoted attributes, single or double quotes).
It can also handle JSON fragements and embedded Javascript comments.
Many of the JSON examples provided will use lax syntax which is easier to read since we don't have to deal with escapes.
Additional Information
2.3 - SerializerGroups and ParserGroups
Above the serializers and parsers are the {@link org.apache.juneau.serializer.SerializerGroup} and {@link org.apache.juneau.parser.ParserGroup} classes.
These classes allow serializers and parsers to be retrieved by W3C-compliant HTTP Accept
and Content-Type
values...
// Construct a new serializer group with configuration parameters that get applied to all serializers.
SerializerGroup sg = new SerializerGroup()
.append(JsonSerializer.class, UrlEncodingSerializer.class);
.setUseIndentation(true)
.addPojoSwaps(CalendarSwap.ISO8601DT.class);
// Find the appropriate serializer by Accept type and serialize our POJO to the specified writer.
sg.getSerializer("text/invalid, text/json;q=0.8, text/*;q:0.6, *\/*;q=0.0")
.serialize(myPersonObject, myWriter);
// Construct a new parser group with configuration parameters that get applied to all parsers.
ParserGroup pg = new ParserGroup()
.append(JsonSerializer.class, UrlEncodingSerializer.class);
.addTransforms(CalendarSwap.ISO8601DT.class);
Person p = pg.getParser("text/json").parse(myReader, Person.class);
The REST servlet API builds upon the SerializerGroup
and ParserGroup
classes
to provide annotated REST servlets that automatically negotiate the HTTP media types and allow the developer
to work with requests and responses as POJOs.
Additional Information
- {@link org.apache.juneau.serializer.SerializerGroup}
- {@link org.apache.juneau.parser.ParserGroup}
2.4 - ObjectMap and ObjectList
The {@link org.apache.juneau.ObjectMap} and {@link org.apache.juneau.ObjectList} classes are generic Java representations of JSON objects and arrays.
These classes can be used to create "unstructured" models for serialization (as opposed to "structured" models consisting of beans).
If you want to quickly generate JSON/XML/HTML from generic maps/collections, or parse JSON/XML/HTML into generic maps/collections, these classes work well.
These classes extend directly from the following JCF classes:
- {@link java.util.LinkedHashMap java.util.LinkedHashMap}
- {@link org.apache.juneau.ObjectMap org.apache.juneau.ObjectMap}
- {@link java.util.LinkedList java.util.LinkedList}
- {@link org.apache.juneau.ObjectMap org.apache.juneau.ObjectList}
The ObjectMap and ObjectList classes are very similar to the JSONObject and JSONArray
classes found in other libraries. However, the names were chosen
because the concepts of Maps and Lists are already familiar to
Java programmers, and these classes can be used with any of the serializers or parsers.
These object can be serialized in one of two ways:
- Using the provided {@link org.apache.juneau.ObjectMap#serializeTo(java.io.Writer)} or {@link org.apache.juneau.ObjectList#serializeTo(java.io.Writer)} methods.
- Passing them to one of the {@link org.apache.juneau.serializer.Serializer} serialize methods.
Any valid JSON can be parsed into an unstructured model consisting of generic {@link org.apache.juneau.ObjectMap} and {@link org.apache.juneau.ObjectList} objects.
// Parse an arbitrary JSON document into an unstructered data model
// consisting of ObjectMaps, ObjectLists, and java primitive objects.
Parser parser = JsonParser.DEFAULT;
String json = "{a:{name:'John Smith',age:21},b:{name:'Joe Smith',age:42}}";
ObjectMap m = parser.parse(json, ObjectMap.class);
// Use ObjectMap API to extract data from the unstructured model.
int johnSmithAge = m.getObjectMap("a").getInt("age");
// Convert it back into JSON.
json = JsonSerializer.DEFAULT.serialize(m);
// Or convert it to XML.
String xml = XmlSerializer.DEFAULT.serialize(m);
As a general rule, if you do not specify a target type during parsing, or if the target type cannot be determined
through reflection, the parsers automatically generate ObjectMaps and ObjectLists.
Additional Information
- {@link org.apache.juneau.ObjectMap}
- {@link org.apache.juneau.ObjectList}
2.5 - Configurable Properties
Serializers and parsers have a wide variety of configurable properties.
For example, the following code shows how to configure a JSON serializer:
JsonSerializer s = new JsonSerializer()
.setUseIndentation(true)
.setUseWhitespace(true)
.setSimpleMode(true)
.setQuoteChar('\'');
However, each of the serializers and parsers already contain reusable instances with common configurations.
For example, JSON has the following predefined reusable serializers and parsers:
- {@link org.apache.juneau.json.JsonSerializer}
- {@link org.apache.juneau.json.JsonSerializer#DEFAULT DEFAULT}
- {@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX DEFAULT_LAX}
- {@link org.apache.juneau.json.JsonSerializer#DEFAULT_READABLE DEFAULT_READABLE}
- {@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX_READABLE DEFAULT_LAX_READABLE}
- {@link org.apache.juneau.json.JsonParser}
- {@link org.apache.juneau.json.JsonParser#DEFAULT DEFAULT}
- {@link org.apache.juneau.json.JsonParser#DEFAULT_STRICT DEFAULT_STRICT}
These can be used directly, as follows:
// Serialize a POJO to LAX JSON.
String json = JsonSerializer.DEFAULT_LAX.serialize(myPojo);
Serializers and parsers can be locked to prevent further modification to the properties.
They can also be cloned to copy the configuration of other serializers and parsers.
// Clone and customize an existing serializer.
JsonSerializer s = JsonSerializer.DEFAULT_LAX
.clone()
.setQuoteChar('"');
// Lock it so that the configuration cannot be changed.
s.lock();
Additional Information
The following is a list of all configurable properties across all serializers and parsers.
- BeanContext - Properties associated with handling beans on serializers and parsers.
- RestServletContext - Configurable properties on the REST servlet.
2.6 - Transforms
By default, the Juneau framework can serialize and parse a wide variety of POJOs out-of-the-box.
However, two special classes are provided tailor how certain Java objects are handled by the framework.
These classes are:
- {@link org.apache.juneau.transform.PojoSwap} - Tailor how specific non-bean classes are handled by the framework.
- {@link org.apache.juneau.transform.BeanFilter} - Tailor how specific bean classes are handled by the framework.
Annotations are also provided that allow you to use transformations directly on class definitions:
- {@link org.apache.juneau.annotation.Pojo @Pojo} - Used to tailor how non-bean POJOs get interpreted by the framework.
- {@link org.apache.juneau.annotation.Bean @Bean} - Used to tailor how beans get interpreted by the framework.
- {@link org.apache.juneau.annotation.BeanConstructor @BeanConstructor} - Maps constructor arguments to property names on beans with read-only properties.
- {@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore} - Ignore classes, fields, and methods from being interpreted as bean or bean components.
- {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} - Used to tailor how bean properties get interpreted by the framework.
- {@link org.apache.juneau.annotation.NameProperty @NameProperty} - Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
- {@link org.apache.juneau.annotation.ParentProperty @ParentProperty} - Identifies a setter as a method for adding a parent reference to a child object.
- {@link org.apache.juneau.annotation.URI @URI} - Used to identify a class or bean property as a URI.
2.6.1 - PojoSwaps
{@link org.apache.juneau.transform.PojoSwap PojoSwaps} are a critical component of Juneau.
They allow the serializers and parsers to handle Java objects that wouldn't normally be serializable.
Swaps are very easy to understand.
Simply put, they can be thought of as 'object swappers' that swap in serializable objects for non-serializable ones during serialization, and vis-versa during parsing.
Some examples of non-serializable POJOs are File
, Reader
, Iterable
, etc...
These are classes that aren't beans and cannot be represented as simple maps, collections, or primitives.
In the following example, we introduce a PojoSwap
that will swap in ISO8601 strings for Date
objects:
// Sample swap for converting Dates to ISO8601 strings.
public class MyDateSwap extends PojoSwap<Date,String> {
// ISO8601 formatter.
private DateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ");
/** Converts a Date object to an ISO8601 string. */
@Override
public String swap(BeanSession session, Date o) {
return format.format(o);
}
/** Converts an ISO8601 string to a Date object. */
@Override
public Date unswap(BeanSession session, String o, ClassMeta hint) throws ParseException {
try {
return format.parse(o);
} catch (java.text.ParseException e) {
throw new ParseException(e);
}
}
}
The swap can then be associated with serializers and parsers like so:
// Sample bean with a Date field.
public class MyBean {
public Date date = new Date(112, 2, 3, 4, 5, 6);
}
// Create a new JSON serializer, associate our date swap with it, and serialize a sample bean.
Serializer serializer = new JsonSerializer().addPojoSwaps(MyDateSwap.class);
String json = serializer.serialize(new MyBean()); // == "{date:'2012-03-03T04:05:06-0500'}"
// Create a JSON parser, associate our date swap with it, and reconstruct our bean (including the date).
ReaderParser parser = new JsonParser().addPojoSwaps(MyDateSwap.class);
MyBean bean = parser.parse(json, MyBean.class);
int day = bean.date.getDay(); // == 3
Several PojoSwaps
are already provided for common Java objects:
- {@link org.apache.juneau.transforms}
- {@link org.apache.juneau.transforms.ByteArrayBase64Swap}
- {@link org.apache.juneau.transforms.CalendarSwap}
- {@link org.apache.juneau.transforms.DateSwap}
- {@link org.apache.juneau.transforms.EnumerationSwap}
- {@link org.apache.juneau.transforms.IteratorSwap}
- {@link org.apache.juneau.transforms.ReaderSwap}
- {@link org.apache.juneau.transforms.XMLGregorianCalendarSwap}
In particular, the {@link org.apache.juneau.transforms.CalendarSwap} and {@link org.apache.juneau.transforms.DateSwap} tramsforms
provide a large number of customized swaps to ISO, RFC, or localized strings.
The 'swapped' class type must be a serializable type.
See the definition for Category 4 objects in POJO Categories.
2.6.2 - Swap methods
Various methods can be defined on a class directly to affect how it gets serialized.
This can often be simpler than using PojoSwaps
.
Objects serialized as Strings
can be parsed back into their original objects by implementing
one of the following methods on the class:
public static T fromString(String)
method.
Any of the following method names also work:
valueOf(String)
parse(String)
parseString(String)
forName(String)
forString(String)
public T(String)
constructor.
Note that these methods cover conversion from several built-in Java types, meaning the parsers can automatically construct these objects from strings:
fromString(String)
- {@link java.util.UUID}
valueOf(String)
- {@link java.lang.Boolean}, {@link java.lang.Byte}, {@link java.lang.Double}, {@link java.lang.Float},
{@link java.lang.Integer}, {@link java.lang.Long}, {@link java.lang.Short}, {@link java.sql.Date}, {@link java.sql.Time}, {@link java.sql.Timestamp}
parse(String)
- {@link java.text.DateFormat}, {@link java.text.MessageFormat}, {@link java.text.NumberFormat}, {@link java.util.Date}, {@link java.util.logging.Level}
parseString(String)
- {@link javax.xml.bind.DatatypeConverter}
forName(String)
- {@link java.lang.Class}
If you want to force a bean-like class to be serialized as a string, you can use the {@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore}
annotation on the class to force it to be serialized to a string using the toString()
method.
Serializing to other intermediate objects can be accomplished by defining a swap method directly on the class:
public X swap(BeanSession)
method, where X
is any serializable object.
The BeanSession
parameter allows you access to various information about the current serialization session.
For example, you could provide customized results based on the media type being produced ({@link org.apache.juneau.BeanSession#getMediaType()}).
The following example shows how an HTML5 form template object can be created that gets serialized as a populated HTML5 {@link org.apache.juneau.dto.html5.Form} bean.
import static org.apache.juneau.dto.html5.HtmlBuilder.*;
/**
* A simple HTML form template whose serialized form is an HTML5 Form object.
*/
public class FormTemplate {
private String action;
private int value1;
private boolean value2;
// Some constructor that initializes our fields.
public FormTemplate(String action, int value1, boolean value2) {
this.action = action;
this.value1 = value1;
this.value2 = value2;
}
// Special swap method that converts this template to a serializable bean
public Form swap(BeanSession session) {
return form(action,
input("text").name("v1").value(value1),
input("text").name("v2").value(value2)
);
}
}
Swapped objects can be converted back into their original form by the parsers by specifying one of the following methods:
public static T unswap(BeanSession, X)
method where X
is the swap class type.
public T(X)
constructor where X
is the swap class type.
The following shows how our form template class can be modified to allow the parsers to reconstruct our original object:
import static org.apache.juneau.dto.html5.HtmlBuilder.*;
/**
* A simple HTML form template whose serialized form is an HTML5 Form object.
* This time with parsing support.
*/
@Bean(beanDictionary=HtmlBeanDictionary.class)
public class FormTemplate {
private String action;
private int value1;
private boolean value2;
// Our 'unswap' constructor
public FormTemplate(Form f) {
this.action = f.getAttr("action");
this.value1 = f.getChild(Input.class, 0).getAttr(int.class, "value");
this.value2 = f.getChild(Input.class, 1).getAttr(boolean.class, "value");
}
public FormTemplate(String action, int value1, boolean value2) {
this.action = action;
this.value1 = value1;
this.value2 = value2;
}
public Form swap(BeanSession session) {
return form(action,
input("text").name("v1").value(value1),
input("text").name("v2").value(value2)
);
}
}
2.6.3 - BeanFilters and @Bean annotations
{@link org.apache.juneau.transform.BeanFilter BeanFilters} are used to control aspects of how beans are handled during serialization and parsing.
They allow you to control various aspects of beans, such as...
- Which properties to include or exclude.
- Property order.
- Property naming conventions.
- Overriding reading and writing of properties.
In practice, however, it's simpler to use the {@link org.apache.juneau.annotation.Bean @Bean} and {@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
annotations on your bean classes.
The annotations are functionally equivalent to the bean filter class.
// Address class with only street/city/state properties (in that order).
// All other properties are ignored.
@Bean(properties="street,city,state")
public class Address {
...
Bean filters are defined through {@link org.apache.juneau.transform.BeanFilterBuilder BeanFilterBuilders}.
The programmatic equivalent to the the annotation above would be:
public class MyAddressBeanFilter extends BeanFilterBuilder {
// Must provide a no-arg constructor!
public MyAddressBeanFilter() {
super(Address.class); // The bean class that this filter applies to.
setIncludeProperties("street,city,state"); // The properties we want exposed.
}
}
Bean filters are added to serializers and parsers using the addBeanFilters(Class...)
method.
For example:
// Create a new JSON serializer and associate a bean filter with it.
Serializer serializer = new JsonSerializer().addBeanFilters(MyAddressBeanFilter.class);
Note that if you use the annotation, you do NOT need to set anything on the serializers/parsers.
The annotations will be detected and bean filters will automatically be created for them.
The addBeanFilter(Class...)
method also allows you to pass in interfaces.
Any class that's not a subclass of {@link org.apache.juneau.transform.BeanFilterBuilder} get interpreted
as bean interface classes.
These cause bean implementations of those interfaces to only expose the properties defined on the interface.
// An interface with the 3 properties we want serialized.
public interface AddressInterface {
public String getStreet();
public String getCity();
public String getState();
}
// Our bean implementation.
public class Address implements AddressInterface {
...
}
// Create a new JSON serializer that only exposes street,city,state on Address bean.
Serializer serializer = new JsonSerializer().addBeanFilters(AddressInterface.class);
Additional Information
- {@link org.apache.juneau.transform}
2.7 - Bean Names and Dictionaries
While parsing into beans, Juneau attempts to determine the class types of bean properties through reflection on the bean property getter or setter.
Often this is insufficient if the property type is an interface or abstract class that cannot be instantiated.
This is where bean names and dictionaries come into play.
Bean names and dictionary are used for identifying class types when they cannot be inferred through reflection.
Bean classes are given names through the {@link org.apache.juneau.annotation.Bean#typeName() @Bean.typeName()} annotation.
These names are then added to the serialized output as virtual "_type" properties (or element names in XML).
On the parsing side, these type names are resolved to classes through the use of bean dictionaries.
For example, if a bean property is of type Object
, then the serializer will add "_type" attributes so that the class can be determined during parsing.
@Bean(typeName="foo")
public class Foo {
// A bean property where the object types cannot be inferred since it's an Object[].
@BeanProperty(typeDictionary={Bar.class,Baz.class})
public Object[] x = new Object[]{new Bar(), new Baz()};
}
@Bean(typeName="bar")
public class Bar {}
@Bean(typeName="baz")
public class Baz {}
When serialized as JSON, "_type" attributes would be added when needed to infer the type during parsing:
{
x: [
{_type:'bar'},
{_type:'baz'}
]
}
Type names can be represented slightly differently in different languages.
For example, the dictionary name is used as element names when serialized to XML.
This allows the typeName
annotation to be used as a shortcut for defining element names for beans.
When serialized as XML, the bean is rendered as:
<foo>
<x>
<bar/>
<baz/>
</x>
</foo>
Bean dictionaries are defined at two levels:
- On individual bean properties through the {@link org.apache.juneau.annotation.BeanProperty#beanDictionary() @BeanProperty.beanDictionary()} annotation.
- Globally for a parser using the {@link org.apache.juneau.parser.Parser#addToBeanDictionary(Class...)} method.
Type names do not need to be universally unique.
However, they must be unique within a dictionary.
The following reserved words cannot be used as type names: object, array, number, boolean, null
.
Serialized type names are DISABLED by default.
They must be enabled on the serializer using the {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_addBeanTypeProperties} configuration property.
The "_type" property name can be overridden using the {@link org.apache.juneau.BeanContext#BEAN_beanTypePropertyName} configuration property.
2.7.1 - Bean Subtypes
In addition to the bean type name support described above, simplified support is provided
for bean subtypes.
Bean subtypes are similar in concept to bean type names, except for the following differences:
- You specify the list of possible subclasses through an annotation on a parent bean class.
- You do not need to register the subtype classes on the bean dictionary of the parser.
In the following example, the abstract class has two subclasses:
// Abstract superclass
@Bean(
beanDictionary={A1.class, A2.class}
)
public abstract class A {
public String f0 = "f0";
}
// Subclass 1
@Bean(typeName="A1")
public class A1 extends A {
public String f1;
}
// Subclass 2
@Bean(typeName="A2")
public class A2 extends A {
public String f2;
}
When serialized, the subtype is serialized as a virtual "_type" property:
JsonSerializer s = JsonSerializer.DEFAULT_LAX;
A1 a1 = new A1();
a1.f1 = "f1";
String r = s.serialize(a1);
assertEquals("{_type:'A1',f1:'f1',f0:'f0'}", r);
The following shows what happens when parsing back into the original object.
JsonParser p = JsonParser.DEFAULT;
A a = p.parse(r, A.class);
assertTrue(a instanceof A1);
2.8 - POJO Categories
The following chart shows POJOs categorized into groups and whether they can be serialized or parsed:
Group | Description | Examples | Can serialize? | Can parse? |
1 |
Java primitive objects |
- {@code String}
- {@code Integer}
- {@code Float}
- {@code Boolean}
|
yes |
yes |
2 |
Java Collections Framework objects and Java arrays |
|
|
|
2a |
With standard keys/values
Map keys are group [1, 4a, 5] objects.
Map, Collection, and array values are group [1, 2, 3a, 4a, 5] objects.
|
HashSet<String,Integer>
TreeMap<Integer,Bean>
List<int[][]>
Bean[]
|
yes |
yes |
2b |
With non-standard keys/values
Map keys are group [2, 3, 4b, 5, 6] objects.
Map, Collection, and array values are group [3b, 4, 5, 6] objects.
|
HashSet<Bean,Integer>
TreeMap<Integer,Reader>
|
yes |
no |
3 |
Java Beans |
|
|
|
3a |
With standard properties
These are beans that have no-arg constructors and one or more properties defined by public getter and setter methods or public fields.
Property values are group [1, 2, 3a, 4a, 5] objects.
|
|
yes |
yes |
3b |
With non-standard properties or not true beans
These include true beans that have no-arg constructors and one or more properties defined by getter and setter methods or properties,
but property types include group [3b, 4b, 5, 6] objects.
This also includes classes that look like beans but aren't true beans.
For example, classes that have getters but not setters, or classes without no-arg constructors.
|
|
yes |
no |
4 |
Swapped objects
These are objects that are not directly serializable, but have {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated with them.
The purpose of a POJO swap is to convert an object to another object that is easier to serialize and parse.
For example, the {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} class can be used to serialize {@link java.util.Date} objects
to ISO8601 strings, and parse them back into {@link java.util.Date} objects.
|
|
|
|
4a |
2-way swapped to group [1, 2a, 3a] objects
For example, a swap that converts a {@code Date} to a {@code String}.
|
|
yes |
yes |
4b |
1-way swapped to group [1, 2, 3] objects
For example, a swap that converts an {@code Iterator} to a {@code List}.
This would be one way, since you cannot reconstruct an {@code Iterator}.
|
|
yes |
no |
5 |
Objects with standardized static methods and/or constructors for converting to another POJO that's serializable.
|
|
|
|
5a |
Objects with standardized static T valueOf(String) /static T fromString(String) methods, or constructors with a String argument.
During serialization, objects are converted to strings using the toString() method.
During parsing, strings are converted to objects using one of these static methods or constructors.
|
java.util.UUID |
yes |
yes |
5b |
Objects with standardized Object swap(BeanSession) /static T unswap(BeanSession,Object) methods, or constructors with an Object argument
where the objects are any object on this list.
During serialization, normal objects are converted to swapped objects using the swap() method.
During parsing, swapped objects are converted to normal objects using the static method or constructor.
|
|
yes |
yes |
6 |
All other objects
Anything that doesn't fall into one of the groups above are simply converted to {@code Strings} using the {@code toString()} method.
|
|
yes |
no |
Serializers are designed to work on tree-shaped POJO models.
These are models where there are no referential loops (e.g. leaves with references to nodes, or nodes in one branch referencing nodes in another branch).
There is a serializer setting {@code detectRecursions} to look for and handle these kinds of loops (by setting these references to null),
but it is not enabled by default since it introduces a moderate performance penalty.
2.9 - Simple Variable Language
The {@link org.apache.juneau.svl} package defines an API for a language called "Simple Variable Language".
In a nutshell, Simple Variable Language (or SVL) is text that contains variables of the form "$varName{varKey}".
Variables can be recursively nested within the varKey (e.g. "$FOO{$BAR{xxx},$BAZ{xxx}}").
Variables can also return values that themselves contain more variables.
// Use the default variable resolver to resolve a string that contains $S (system property) variables
String myProperty = VarResolver.DEFAULT.resolve("The Java home directory is $S{java.home}");
The following shows how variables can be arbitrarily nested...
// Look up a property in the following order:
// 1) MYPROPERTY environment variable.
// 2) 'my.property' system property if environment variable not found.
// 3) 'not found' string if system property not found.
String myproperty = VarResolver.DEFAULT.resolve("$E{MYPROPERTY,$S{my.property,not found}}");
SVL is a large topic on it's own.
It is used extensively in the ConfigFile, REST and Microservice APIs.
Additional Information
2.10 - Configuration Files
The {@link org.apache.juneau.ini} package contains a powerful API for creating and using INI-style config files.
An example of an INI file:
# Default section
key1 = 1
key2 = true
key3 = 1,2,3
key4 = http://foo
# Section 1
[Section1]
key1 = 2
key2 = false
key3 = 4,5,6
key4 = http://bar
This class can be used to easily access contents of the file:
int key1;
boolean key2;
int[] key3;
URL key4;
// Load our config file
ConfigFile f = ConfigMgr.DEFAULT.get("MyIniFile.cfg");
// Read values from default section
key1 = f.getInt("key1");
key2 = f.getBoolean("key2");
key3 = f.getObject(int[].class, "key3");
key4 = f.getObject(URL.class, "key4");
// Read values from section #1
key1 = f.getInt("Section1/key1");
key2 = f.getBoolean("Section1/key2");
key3 = f.getObject(int[].class, "Section1/key3");
key4 = f.getObject(URL.class, "Section1/key4");
The interface also allows a config file to be easily constructed programmatically:
// Construct the sample INI file programmatically
ConfigFile cf = ConfigMgr.DEFAULT.create("MyIniFile.cfg")
.addLines(null,
"# Default section",
"key1 = 1",
"key2 = true",
"key3 = 1,2,3",
"key4 = http://foo",
"")
.addHeaderComments("Section1",
"# Section 1")
.addLines("Section1",
"key1 = 2",
"key2 = false",
"key3 = 4,5,6",
"key4 = http://bar")
.save();
The following is equivalent, except that it uses {@link org.apache.juneau.ini.ConfigFile#put(String, Object)} to set values:
// Construct the sample INI file programmatically
ConfigFile cf = ConfigMgr.DEFAULT.create("MyIniFile.cfg")
.addLines(null,
"# Default section")
.addHeaderComments("section1",
"# Section 1");
cf.put("key1", 1);
cf.put("key2", true);
cf.put("key3", new int[]{1,2,3});
cf.put("key4", new URL("http://foo"));
cf.put("Section1/key1", 2);
cf.put("Section1/key2", false);
cf.put("Section1/key3", new int[]{4,5,6});
cf.put("Section1/key4", new URL("http://bar"));
cf.save();
The config file looks deceptively simple, the config file API is a very powerful feature with many capabilities, including:
- The ability to use variables to reference environment variables, system properties, other config file entries, and a host of other types.
- The ability to store and retrieve POJOs as JSON.
- APIs for updating, modifying, and saving configuration files without losing comments or formatting.
- Extensive listener APIs.
Example:
#--------------------------
# My section
#--------------------------
[MySection]
# An integer
anInt = 1
# A boolean
aBoolean = true
# An int array
anIntArray = 1,2,3
# A POJO that can be converted from a String
aURL = http://foo
# A POJO that can be converted from JSON
aBean = {foo:'bar',baz:123}
# A system property
locale = $S{java.locale, en_US}
# An environment variable
path = $E{PATH, unknown}
# A manifest file entry
mainClass = $MF{Main-Class}
# Another value in this config file
sameAsAnInt = $C{MySection/anInt}
# A command-line argument in the form "myarg=foo"
myArg = $ARG{myarg}
# The first command-line argument
firstArg = $ARG{0}
# Look for system property, or env var if that doesn't exist, or command-line arg if that doesn't exist.
nested = $S{mySystemProperty,$E{MY_ENV_VAR,$ARG{0}}}
# A POJO with embedded variables
aBean2 = {foo:'$ARG{0}',baz:$C{MySection/anInt}}
// Java code for accessing config entries above.
ConfigFile cf = Microservice.getConfig();
int anInt = cf.getInt("MySection/anInt");
boolean aBoolean = cf.getBoolean("MySection/aBoolean");
int[] anIntArray = cf.getObject(int[].class, "MySection/anIntArray");
URL aURL = cf.getObject(URL.class, "MySection/aURL");
MyBean aBean = cf.getObject(MyBean.class, "MySection/aBean");
Locale locale = cf.getObject(Locale.class, "MySection/locale");
String path = cf.getString("MySection/path");
String mainClass = cf.getString("MySection/mainClass");
int sameAsAnInt = cf.getInt("MySection/sameAsAnInt");
String myArg = cf.getString("MySection/myArg");
String firstArg = cf.getString("MySection/firstArg");
Additional Information
2.11 - Supported Languages
Extensive javadocs exist for individual language support.
Refer to these docs for language-specific information.
Additional Information
The Juneau REST Server API provides servlet-based REST resources on top of existing POJOs.
The API automatically detects Accept header of requests and converts POJOs to any of the supported languages.
The toolkit is extensible and also allows for support of user-defined content types.
Automatic built-in support is provided for negotiation of response charsets and gzip encoding.
The following is an example of a REST API used to view and set JVM system properties.
@RestResource(
path="/systemProperties",
title="System properties resource",
description="REST interface for performing CRUD operations on system properties.",
properties={
@Property(name=SERIALIZER_quoteChar, value="'"),
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'$R{servletURI}?method=OPTIONS'}"),
},
stylesheet="styles/devops.css",
encoders=GzipEncoder.class,
contact="{name:'John Smith',email:'john@smith.com'}",
license="{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}",
version="2.0",
termsOfService="You're on your own.",
tags="[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]",
externalDocs="{description:'Home page',url:'http://juneau.apache.org'}"
)
public class SystemPropertiesResource extends RestServletDefault {
@RestMethod(
name="GET", path="/",
summary="Show all system properties",
description="Returns all system properties defined in the JVM.",
parameters={
@Parameter(in="query", name="sort", description="Sort results alphabetically.", _default="false")
},
responses={
@Response(value=200, description="Returns a map of key/value pairs.")
}
)
public Map getSystemProperties(@Query("sort") boolean sort) throws Throwable {
if (sort)
return new TreeMap(System.getProperties());
return System.getProperties();
}
@RestMethod(
name="GET", path="/{propertyName}",
summary="Get system property",
description="Returns the value of the specified system property.",
parameters={
@Parameter(in="path", name="propertyName", description="The system property name.")
},
responses={
@Response(value=200, description="The system property value, or null if not found.")
}
)
public String getSystemProperty(@Path String propertyName) throws Throwable {
return System.getProperty(propertyName);
}
@RestMethod(
name="PUT", path="/{propertyName}",
summary="Replace system property",
description="Sets a new value for the specified system property.",
guards=AdminGuard.class,
parameters={
@Parameter(in="path", name="propertyName", description="The system property name."),
@Parameter(in="body", description="The new system property value."),
},
responses={
@Response(value=302,
headers={
@Parameter(name="Location", description="The root URL of this resource.")
}
),
@Response(value=403, description="User is not an admin.")
}
)
public Redirect setSystemProperty(@Path String propertyName, @Body String value) {
System.setProperty(propertyName, value);
return new Redirect();
}
@RestMethod(
name="POST", path="/",
summary="Add an entire set of system properties",
description="Takes in a map of key/value pairs and creates a set of new system properties.",
guards=AdminGuard.class,
parameters={
@Parameter(in="path", name="propertyName", description="The system property key."),
@Parameter(in="body", description="The new system property values.", schema="{example:{key1:'val1',key2:123}}"),
},
responses={
@Response(value=302,
headers={
@Parameter(name="Location", description="The root URL of this resource.")
}
),
@Response(value=403, description="Unauthorized: User is not an admin.")
}
)
public Redirect setSystemProperties(@Body java.util.Properties newProperties) {
System.setProperties(newProperties);
return new Redirect();
}
@RestMethod(
name="DELETE", path="/{propertyName}",
summary="Delete system property",
description="Deletes the specified system property.",
guards=AdminGuard.class,
parameters={
@Parameter(in="path", name="propertyName", description="The system property name."),
},
responses={
@Response(value=302,
headers={
@Parameter(name="Location", description="The root URL of this resource.")
}
),
@Response(value=403, description="Unauthorized: User is not an admin")
}
)
public Redirect deleteSystemProperty(@Path String propertyName) {
System.clearProperty(propertyName);
return new Redirect();
}
@RestMethod(
name="OPTIONS", path="/*",
summary="Show resource options",
description="Show resource options as a Swagger doc"
)
public Swagger getOptions(RestRequest req) {
return req.getSwagger();
}
}
The resource above is deployed like any other servlet, in this way:
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.3">
<servlet>
<servlet-name>SystemPropertiesService</servlet-name>
<servlet-class>org.apache.juneau.examples.rest.SystemPropertiesService</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>SystemPropertiesService</servlet-name>
<url-pattern>/systemProperties</url-pattern>
</servlet-mapping>
</web-app>
Pointing your browser to the resource renders the POJOs as HTML (since that's what the browser specifies in the Accept
header).
One of the most useful aspects of using this API is the self-discovering, self-documenting OPTIONS pages.
These are constructed automatically using reflection, augmented with information pulled from annotations (as shown above), resource bundles, or Swagger JSON files:
Arbitrarily complex POJO models can be serialized using any of the supported serializers, and content can be parsed using any of the supported parsers.
The juneau-examples-rest project contains various REST resource examples in an easy-to-use REST microservice.
One of these is AddressBookResource which serializes AddressBook objects defined below (some code omitted):
/** package-info.java */
@XmlSchema(
prefix="ab",
xmlNs={
@XmlNs(prefix="ab", namespaceURI="http://www.apache.org/addressBook/"),
@XmlNs(prefix="per", namespaceURI="http://www.apache.org/person/"),
@XmlNs(prefix="addr", namespaceURI="http://www.apache.org/address/"),
@XmlNs(prefix="mail", namespaceURI="http://www.apache.org/mail/")
}
)
package org.apache.juneau.examples.addressBook;
import org.apache.juneau.xml.annotation.*;
/** Address book bean */
@Bean(typeName="addressBook")
public class AddressBook extends LinkedList<Person> {}
/** Person bean */
@Xml(prefix="per")
@Bean(typeName="person")
public class Person {
// Bean properties
@Rdf(beanUri=true) public URI uri;
public URI addressBookUri;
public int id;
public String name;
@BeanProperty(swap=CalendarSwap.Medium.class) public Calendar birthDate;
public LinkedList<Address> addresses;
}
/** Address bean */
@Xml(prefix="addr")
@Bean(typeName="address")
public class Address {
// Bean properties
@Rdf(beanUri=true) public URI uri;
public URI personUri;
public int id;
@Xml(prefix="mail") public String street, city, state;
@Xml(prefix="mail") public int zip;
public boolean isCurrent;
}
The framework allows you to override header values through GET parameters, so that you can specify the ACCEPT header to see each type.
Adding &plainText=true forces the response Content-Type to be text/plain.
Also, localization can be tested by passing in an Accept-Language header.
The Server API is an exhaustive topic on its own.
Refer to the additional information for an in-depth examination of the API.
Additional Information
The microservice-samples-project.zip file is a zipped eclipse project that includes everything you
need to start the Samples REST microservice in an Eclipse workspace.
This project is packaged as a Juneau Microservice project that allows REST resources to be started
using embedded Jetty.
8.1 - Installing in Eclipse
Follow these instructions to create the Samples project in Eclipse:
- Download the latest microservice-samples-project .zip file (e.g. microservice-samples-project-5.2.zip).
- In your Eclipse workspace, go to File->Import->General->Existing Projects into Workspace and click Next.
- Select the .zip file and click Finish.
- In your workspace, you can now see the following project:
The important elements in this project are:
- META-INF/MANIFEST.MF - The manifest file.
This defines the entry point, classpath, top-level REST resources, and location of external configuration file.
Manifest-Version: 1.0
Main-Class: org.apache.juneau.microservice.RestMicroservice
Rest-Resources: org.apache.juneau.examples.rest.RootResources
Main-ConfigFile: examples.cfg
Class-Path:
lib/commons-codec-1.9.jar
lib/commons-io-1.2.jar
lib/commons-logging-1.1.1.jar
lib/httpclient-4.5.jar
lib/httpcore-4.4.1.jar
lib/httpmime-4.5.jar
lib/javax.servlet-api-3.0.jar
lib/jetty-all-8.1.0.jar
lib/juneau-all-5.2.jar
lib/org.apache.commons.fileupload_1.3.1.jar
lib/derby.jar
lib/jena-core-2.7.1.jar
lib/jena-iri-0.9.2.jar
lib/log4j-1.2.16.jar
lib/slf4j-api-1.6.4.jar
lib/slf4j-log4j12-1.6.4.jar
- RestMicroservice.java - The application class.
This is a specialized microservice in Juneau for exposing REST servlets.
Allows REST servlets to be registered in the manifest or configuration file.
- RootResources.java - The top-level REST resource.
This class serves as a "router" page to child resources:
- examples.cfg - The external configuration file.
A deceptively simple yet powerful INI-style configuration file:
#================================================================================
# Basic configuration file for SaaS microservices
# Subprojects can use this as a starting point.
#================================================================================
#================================================================================
# REST settings
#================================================================================
[REST]
# The HTTP port number to use.
# Default is Rest-Port setting in manifest file, or 8000.
port = 10000
...
At this point you're ready to start the microservice from your workspace.
8.2 - Running in Eclipse
The microservice-samples-project.launch file is already provided to allow you to quickly start
the Samples microservice.
Go to Run->Run Configurations->Java Application->microservice-samples.project and click Run.
In your console view, you can see the following output:
Now open your browser and point to http://localhost:10000.
You can see the following:
You have now started a REST interface on port 10000.
8.3 - Building and Running from Command-Line
The build.xml file is a very basic ANT script for building the Samples microservice
into an executable jar.
To build the Samples microservice, right-click build.xml and select Run As->Ant Build.
Once complete (which takes approximately 1 second), if you refresh the project, you can see the following new directory:
If you open up a command prompt in the build/microservice folder, you can start your microservice as follows:
If you get an error message saying java.net.BindException: Address already in use
, this means that the microservice
is already running elsewhere, so it cannot bind to port 10000.
8.4 - MANIFEST.MF
The META-INF/MANIFEST.MF file is used to describe the microservice.
If you open it, you'll see the following:
Manifest-Version: 1.0
Main-Class: org.apache.juneau.microservice.RestMicroservice
Rest-Resources: org.apache.juneau.examples.rest.RootResources
Main-ConfigFile: examples.cfg
Class-Path:
lib/commons-codec-1.9.jar
lib/commons-io-1.2.jar
lib/commons-logging-1.1.1.jar
lib/httpclient-4.5.jar
lib/httpcore-4.4.1.jar
lib/httpmime-4.5.jar
lib/javax.servlet-api-3.0.jar
lib/jetty-all-8.1.0.jar
lib/juneau-all-5.2.jar
lib/org.apache.commons.fileupload_1.3.1.jar
lib/derby.jar
lib/jena-core-2.7.1.jar
lib/jena-iri-0.9.2.jar
lib/log4j-1.2.16.jar
lib/slf4j-api-1.6.4.jar
lib/slf4j-log4j12-1.6.4.jar
Notes
- The Main-Class entry is just the standard manifest entry describing the entry point for the executable jar.
The org.apache.juneau.microservice.RestMicroservice class is the standard microservice class for REST microservices.
Other kinds of microservices can be created by extending the {@link org.apache.juneau.microservice.Microservice} class.
- The Rest-Resources entry is a comma-delimited list of REST resources.
These are classes that subclass from {@link org.apache.juneau.rest.RestServlet}.
This is a specialized entry used by org.apache.juneau.microservice.RestMicroservice.
In this case, you're pointing to a resource defined in our project, org.apache.juneau.examples.rest.RootResources, which serves
as a "grouping" page for several other REST resources.
- The Main-ConfigFile entry points to the location of an external configuration file for our microservice.
- The Class-Path entry again is just the standard manifest file entry.
However, if you need to add extra libraries to your microservice, you'll need to copy them into your lib
directory and add them to the classpath here.
If you modify the manifest file and get NoClassDefFoundErrors, ensure that the classpath entries contain trailing spaces.
8.5 - RootResources
The RootResources class is the main page for the REST microservice.
It serves as the jumping-off point for the other resources.
The class hierarchy for this class is:
- {@link org.apache.juneau.rest.RestServlet org.apache.juneau.rest.RestServlet}
Contains all the REST servlet logic.
- {@link org.apache.juneau.rest.RestServletDefault org.apache.juneau.rest.RestServletDefault}
Defines default serializers and parsers, and OPTIONs page logic.
- {@link org.apache.juneau.rest.RestServletGroupDefault org.apache.juneau.rest.RestServletGroupDefault}
Specialized subclass for grouping other resources
- {@link org.apache.juneau.microservice.ResourceGroup org.apache.juneau.microservice.ResourceGroup}
Specialized subclass when using the Microservice API.
org.apache.juneau.rest.samples.RootResources
Pointing a browser to the resource shows the following:
The RootResources class can also be defined as a servlet in a web.xml file:
<web-app version='2.3'>
<servlet>
<servlet-name>RootResources</servlet-name>
<servlet-class>org.apache.juneau.rest.samples.RootResources</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>RootResources</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
The RootResources class consists entirely of annotations:
/**
* Sample REST resource showing how to implement a "router" resource page.
*/
@RestResource(
path="/",
messages="nls/RootResources",
properties={
@Property(name=HTMLDOC_links, value="{options:'$R{servletURI}?method=OPTIONS',source:'$R{servletURI}/source?classes=(org.apache.juneau.rest.samples.RootResources)'}")
},
children={
HelloWorldResource.class,
MethodExampleResource.class,
RequestEchoResource.class,
TempDirResource.class,
AddressBookResource.class,
SampleRemoteableServlet.class,
PhotosResource.class,
AtomFeedResource.class,
JsonSchemaResource.class,
SqlQueryResource.class,
TumblrParserResource.class,
CodeFormatterResource.class,
UrlEncodedFormResource.class,
SourceResource.class,
ConfigResource.class,
LogsResource.class,
DockerRegistryResource.class,
ShutdownResource.class
}
)
public class RootResources extends ResourceGroup {
private static final long serialVersionUID = 1L;
}
The resource bundle contains the localized strings for the resource:
#--------------------------------------------------------------------------------
# RootResources labels
#--------------------------------------------------------------------------------
title = Root resources
description = This is an example of a router resource that is used to access other resources.
The title and description keys identify the localized values
return by the {@link org.apache.juneau.rest.RestServlet#getTitle(RestRequest)} and {@link org.apache.juneau.rest.RestServlet#getDescription(RestRequest)} methods.
The children annotation defines the child resources of this router resource.
These are resources whose paths are relative to the parent resource.
Child resources must also be subclasses of {@link org.apache.juneau.rest.RestServlet}, and
must specify a {@link org.apache.juneau.rest.annotation.RestResource#path()} annotation to
identify the subpath of the child.
For example, the HelloWorldResource class is annotated as follows:
@RestResource(messages="nls/HelloWorldResource", path="/helloWorld")
public class HelloWorldResource extends Resource {
It should be noted that child resources do not need to be defined this way.
They could also be defined as servlets in the same way as the root resource.
The children annotation approach simply makes it easier to define them without having to touch the web.xml file again.
Child resources can also be defined programmatically by overriding the {@link org.apache.juneau.rest.RestServlet#createChildren()} method.
Note that these router pages can be arbitrarily nested deep.
You can define many levels of router pages for arbitrarily hierarchical REST interfaces.
Let's step back and describe what's going on here:
During servlet initialization of the RootResources object, the toolkit looks for the @RestResource.children() annotation.
If it finds it, it instantiates instances of each class and recursively performs servlet initialization on them.
It then associates the child resource with the parent by the name specified by the @RestResource.path() annotation on the child class.
When a request for the child URL (/helloWorld) is received, the RootResources servlet gets the request and sees that the URL remainder matches one of its child resources.
It then forwards the request to the child resource for processing.
The request passed to the child resource is the same as if the child resource had been deployed independently (e.g. path-info, resource-URI, and so forth).
8.6 - HelloWorldResource
The HelloWorldResource class is a simple resource that prints a "Hello world!" message.
/**
* Sample REST resource that prints out a simple "Hello world!" message.
*/
@RestResource(
messages="nls/HelloWorldResource",
path="/helloWorld",
properties={
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'?method=OPTIONS'}")
}
)
public class HelloWorldResource extends Resource {
private static final long serialVersionUID = 1L;
/** GET request handler */
@RestMethod(name="GET", path="/*")
public String sayHello() {
return "Hello world!";
}
}
#--------------------------------------------------------------------------------
# HelloWorldResource labels
#--------------------------------------------------------------------------------
title = Hello World sample resource
description = Simplest possible resource
sayHello.summary = Responds with "Hello world!"
The class hierarchy for this class is:
- {@link org.apache.juneau.rest.RestServlet org.apache.juneau.rest.RestServlet}
Contains all the REST servlet logic.
- {@link org.apache.juneau.rest.RestServletDefault org.apache.juneau.rest.RestServletDefault}
Defines default serializers and parsers, and OPTIONs page logic.
- {@link org.apache.juneau.microservice.Resource org.apache.juneau.microservice.Resource}
Specialized subclass when using the Microservice API.
org.apache.juneau.rest.samples.HelloWorldResource
Pointing a browser to the resource shows the following:
Using the special &Accept=text/json and &plainText=true parameters
allows us to see this page rendered as JSON:
8.7 - MethodExampleResource
The MethodExampleResource class provides examples of the following:
- Using the {@link org.apache.juneau.rest.Redirect} object to perform redirections.
- Using the various Java method parameter annotations to retrieve request attributes, parameters, etc.
- Using the annotation programmatic equivalents on the {@link org.apache.juneau.rest.RestRequest} object.
- Setting response POJOs by either returning them or using the {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} method.
The resource is provided to show how various HTTP entities (e.g. parameters, headers) can be accessed
as either annotated Java parameters, or through methods on the RestRequest object.
/**
* Sample REST resource that shows how to define REST methods and OPTIONS pages
*/
@RestResource(
path="/methodExample",
messages="nls/MethodExampleResource",
properties={
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.MethodExampleResource)'}")
}
)
public class MethodExampleResource extends Resource {
private static final long serialVersionUID = 1L;
/** Example GET request that redirects to our example method */
@RestMethod(name="GET", path="/")
public Redirect doGetExample() throws Exception {
return new Redirect("example1/xxx/123/{0}/xRemainder?p1=123&p2=yyy", UUID.randomUUID());
}
/** Example GET request using annotated attributes */
@RestMethod(name="GET", path="/example1/{a1}/{a2}/{a3}/*", rc={200})
public String doGetExample1(
@Method String method,
@Path String a1,
@Path int a2,
@Path UUID a3,
@Query("p1") int p1,
@Query("p2") String p2,
@Query("p3") UUID p3,
@PathRemainder String remainder,
@Header("Accept-Language") String lang,
@Header("Accept") String accept,
@Header("DNT") int doNotTrack
) {
String output = String.format(
"method=%s, a1=%s, a2=%d, a3=%s, remainder=%s, p1=%d, p2=%s, p3=%s, lang=%s, accept=%s, dnt=%d",
method, a1, a2, a3, remainder, p1, p2, p3, lang, accept, doNotTrack);
return output;
}
/** Example GET request using methods on RestRequest and RestResponse */
@RestMethod(name="GET", path="/example2/{a1}/{a2}/{a3}/*", rc={200})
public void doGetExample2(RestRequest req, RestResponse res) throws Exception {
String method = req.getMethod();
// Attributes (from URL pattern variables)
String a1 = req.getPathParameter("a1", String.class);
int a2 = req.getPathParameter("a2", int.class);
UUID a3 = req.getPathParameter("a3", UUID.class);
// Optional GET parameters
int p1 = req.getQueryParameter("p1", int.class, 0);
String p2 = req.getQueryParameter("p2", String.class);
UUID p3 = req.getQueryParameter("p3", UUID.class);
// URL pattern post-match
String remainder = req.getPathRemainder();
// Headers
String lang = req.getHeader("Accept-Language");
int doNotTrack = req.getHeader("DNT", int.class);
// Send back a simple String response
String output = String.format(
"method=%s, a1=%s, a2=%d, a3=%s, remainder=%s, p1=%d, p2=%s, p3=%s, lang=%s, dnt=%d",
method, a1, a2, a3, remainder, p1, p2, p3, lang, doNotTrack);
res.setOutput(output);
}
}
The class consists of 3 methods:
- doGetExample()
The root page.
Performs a simple redirection to the doGetExample1() method using a {@link org.apache.juneau.rest.Redirect} object.
- doGetExample1()
Shows how to use the following annotations:
- {@link org.apache.juneau.rest.annotation.Path @Path}
- {@link org.apache.juneau.rest.annotation.Query @Query}
- {@link org.apache.juneau.rest.annotation.Header @Header}
- {@link org.apache.juneau.rest.annotation.Method @Method}
- {@link org.apache.juneau.rest.annotation.PathRemainder @PathRemainder}
Method returns a POJO to be serialized as the output.
- doGetExample2()
Identical to doGetExample1() but shows how to use the {@link org.apache.juneau.rest.RestRequest} and {@link org.apache.juneau.rest.RestResponse} objects:
- {@link org.apache.juneau.rest.RestRequest#getPathParameter(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getHeader(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getMethod()}
- {@link org.apache.juneau.rest.RestRequest#getPathRemainder()}
Method sets the POJO to be serialized using the {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} method.
There's a lot going on in this method. Notice how you're able to access URL attributes, parameters, headers, and content
as parsed POJOs. All the input parsing is already done by the toolkit. You simply work with the resulting POJOs.
As you might notice, using annotations typically results in fewer lines of code and are therefore usually preferred over the API approach, but both are equally valid.
When you visit this page through the router page, you can see the following (after the automatic redirection occurs):
Notice how the conversion to POJOs is automatically done for us, even for non-standard POJOs such as UUID.
Self-documenting design through Swagger OPTIONS pages
One of the main features of Juneau is that it produces OPTIONS pages for self-documenting design (i.e. REST interfaces that document themselves).
Much of the information populated on the OPTIONS page is determined through reflection.
This basic information can be augmented with information defined through:
- Annotations - An example of this was shown in the
SystemPropertiesResource
example above.
Localized strings can be pulled from resource bundles using the $L
localization variable.
- Resource bundle properties - Described in detail in this section.
- Swagger JSON files with the same name and location as the resource class (e.g.
MethodExampleResource.json
).
Localized versions are defined by appending the locale to the file name (e.g. MethodExampleResource_ja_JP.json
);
OPTIONS pages are simply serialized {@link org.apache.juneau.dto.swagger.Swagger} DTO beans.
Localized versions of these beans are retrieved using the {@link org.apache.juneau.rest.RestRequest#getSwagger()} method.
To define an OPTIONS request handler, the {@link org.apache.juneau.rest.RestServletDefault} class defines the following Java method:
/** OPTIONS request handler */
@RestMethod(name="OPTIONS", path="/*")
public Swagger getOptions(RestRequest req) {
return req.getSwagger();
}
The OPTIONS link that you see on the HTML version of the page is created
through a property defined by the {@link org.apache.juneau.html.HtmlDocSerializer} class
and specified on the resource class annotation:
@RestResource(
properties={
@Property(name=HTMLDOC_links, value="{options:'?method=OPTIONS'}")
}
)
This simply creates a link that's the same URL as the resource URL appended with "?method=OPTIONS",
which is a shorthand way that the framework provides of defining overloaded GET requests.
Links using relative or absolute URLs can be defined this way.
Metadata about the servlet class is combined with localized strings from a properties file associated
through a @RestResource(messages="nls/MethodExampleResources")
annotation.
The properties file contains localized descriptions for the resource, resource methods, and method
parameters.
#--------------------------------------------------------------------------------
# MethodExampleResource labels
#--------------------------------------------------------------------------------
title = A simple REST method example resource
doGetExample.summary = Sample GET method
doGetExample1.summary = Sample GET using annotations
doGetExample1.req.path.a1.description = Sample variable
doGetExample1.req.path.a2.description = Sample variable
doGetExample1.req.path.a3.description = Sample variable
doGetExample1.req.query.p1.description = Sample parameter
doGetExample1.req.query.p2.description = Sample parameter
doGetExample1.req.query.p3.description = Sample parameter
doGetExample1.req.header.Accept-Language.description = Sample header
doGetExample1.req.header.DNT.description = Sample header
doGetExample2.summary = Sample GET using Java APIs
doGetExample2.req.path.a1.description = Sample variable
doGetExample2.req.path.a2.description = Sample variable
doGetExample2.req.path.a3.description = Sample variable
doGetExample2.req.query.p1.description = Sample parameter
doGetExample2.req.query.p2.description = Sample parameter
doGetExample2.req.query.p3.description = Sample parameter
doGetExample2.req.header.Accept-Language.description = Sample header
doGetExample2.req.header.DNT.description = Sample header
getOptions.summary = View these options
Clicking the options link on the page presents you with information about how to use this resource:
This page (like any other) can also be rendered in JSON or XML by using the &Accept URL parameter.
8.8 - UrlEncodedFormResource
The UrlEncodedFormResource class provides examples of the following:
- How to use form entry beans to process form POSTs.
- How to use the {@link org.apache.juneau.rest.RestRequest#getReaderResource(String)} method to
serve up static files with embedded string variables.
The class is shown below:
/**
* Sample REST resource for loading URL-Encoded form posts into POJOs.
*/
@RestResource(
path="/urlEncodedForm",
messages="nls/UrlEncodedFormResource"
)
public class UrlEncodedFormResource extends Resource {
private static final long serialVersionUID = 1L;
/** GET request handler */
@RestMethod(name="GET", path="/")
public ReaderResource doGet(RestRequest req) throws IOException {
return req.getReaderResource("UrlEncodedForm.html", true);
}
/** POST request handler */
@RestMethod(name="POST", path="/")
public Object doPost(@Body FormInputBean input) throws Exception {
// Just mirror back the request
return input;
}
public static class FormInputBean {
public String aString;
public int aNumber;
@BeanProperty(pojoSwaps=CalendarSwap.ISO8601DT.class)
public Calendar aDate;
}
}
The {@link org.apache.juneau.rest.RestRequest#getReaderResource(String,boolean)} method pulls in the following
file located in the same package as the class:
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<style type='text/css'>
@import '$R{servletURI}/style.css';
</style>
<script type="text/javascript">
// Load results from IFrame into this document.
function loadResults(buff) {
var doc = buff.contentDocument || buff.contentWindow.document;
var buffBody = doc.getElementById('data');
document.getElementById('results').innerHTML = buffBody.innerHTML;
}
</script>
</head>
<body>
<h3 class='title'>$R{servletTitle}</h3>
<h5 class="description">$R{servletDescription}</h5>
<div class='data'>
<form id='form' action='$R{servletURI}' method='POST' target='buff'>
<table>
<tr>
<th>$L{aString}</th>
<td><input name="aString" type="text"></td>
</tr>
<tr>
<th>$L{aNumber}</th>
<td><input name="aNumber" type="number"></td>
</tr>
<tr>
<th>$L{aDate}</th>
<td><input name="aDate" type="datetime"> (ISO8601, e.g. "<code>2001-07-04T15:30:45Z</code>")</td>
</tr>
<tr>
<td colspan='2' align='right'><button type="submit">$L{submit}</button></td>
</tr>
</table>
</form>
<br>
<div id='results'>
</div>
</div>
<iframe name='buff' style='display:none' onload="parent.loadResults(this)"></iframe>
</body>
</html>
The $L variables are string variable that pull in localized values from the resource bundle:
#--------------------------------------------------------------------------------
# UrlEncodedFormResource labels
#--------------------------------------------------------------------------------
title = URL-Encoded Form Post Example
description = Shows how URL-Encoded form input can be loaded into POJOs. POJO is simply echoed back.
aString = A String:
aNumber = A Number:
aDate = A Date:
submit = submit
The $R variables are request string variables.
In this case, $R{servletTitle} and $R{servletDescription} resolve to the values returned by
{@link org.apache.juneau.rest.RestRequest#getServletTitle()} and {@link org.apache.juneau.rest.RestRequest#getServletDescription()}.
Pointing a browser to the resource shows the following:
Entering some values and clicking submit causes the form bean to be populated
and returned back as a POJO response:
Additional Information
- {@link org.apache.juneau.rest.RestServlet#createVarResolver()} - Servlet and request variables.
- {@link org.apache.juneau.rest.RestServlet#getSessionObjects(RestRequest)} - Var resolver session objects.
8.9 - RequestEchoResource
The RequestEchoResource class shows how existing complex POJOs can be serialized to a variety of content types.
The example simply takes the incoming HttpServletRequest object and serializes it.
It provides examples of the following:
- Using the {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties()}
annotation to set serializer properties.
- Using the {@link org.apache.juneau.rest.annotation.RestResource#beanFilters() @RestResource.beanFilters()} and {@link org.apache.juneau.rest.annotation.RestResource#pojoSwaps() @RestResource.pojoSwaps()}
annotations to set serializer transforms.
- Using the {@link org.apache.juneau.rest.annotation.Properties @Properties} annotation to set serializers properties
programmatically on a request.
The class is shown below:
/**
* Sample REST resource for echoing HttpServletRequests back to the browser
*/
@RestResource(
path="/echo",
messages="nls/RequestEchoResource",
properties={
@Property(name=SERIALIZER_maxDepth, value="10"),
@Property(name=SERIALIZER_detectRecursions, value="true"),
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.RequestEchoResource)'}")
},
beanFilters={
// Interpret these as their parent classes, not subclasses
HttpServletRequest.class, HttpSession.class, ServletContext.class,
},
pojoSwaps={
// Add a special POJO swap for Enumerations
EnumerationSwap.class
}
)
public class RequestEchoResource extends Resource {
/** GET request handler */
@RestMethod(name="GET", path="/*", converters={Queryable.class,Traversable.class})
public HttpServletRequest doGet(RestRequest req, @Properties ObjectMap properties) {
// Set the HtmlDocSerializer title programmatically.
// This sets the value for this request only.
properties.put(HTMLDOC_title, "Contents of HttpServletRequest object");
// Just echo the request back as the response.
return req;
}
}
Again, there's a lot going on here that's new that requires some explanation.
The HttpServletRequest object is not a tree-shaped POJO model.
Instead, it contains lots of loops that can cause stack overflow errors if you were to try
to serialize it as-is.
Also, you want to look only at the properties defined on the HttpServletRequest class,
not implementation-specific (i.e. WAS or Jetty) fields which can get messy.
The {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties()},
{@link org.apache.juneau.rest.annotation.RestResource#beanFilters() @RestResopurce.beanFilters()}, and
{@link org.apache.juneau.rest.annotation.RestResource#pojoSwaps() @RestResopurce.pojoSwaps()} annotations are used
to set behavior properties on the resource's underlying bean context, serializers, and parsers.
You're using them here to modify the behavior of serialization for all content types.
The annotations are functionally equivalent to overriding the {@link org.apache.juneau.rest.RestServlet#createSerializers(ObjectMap,Class[],Class[])} method, as follows:
/** Override the default rest serializers to add some transforms */
@Override
protected SerializerGroup createSerializers(ObjectMap properties, Class[] beanFilters, Class[] pojoSwaps) {
// You'll just reuse the parent serializer group
SerializerGroup serializerGroup = super.createSerializers(properties, beanFilters, pojoSwaps);
// Add bean filters for the HttpServletRequest, HttpSession, and ServletContext objects
// so that you don't show vendor-specific properties on subclasses.
// Add Enumeration POJO swap to be able to render the contents of Enumeration properties.
// The max depth and detect recursion options prevent any possible runaway serializations.
// This shouldn't happen, but future JEE APIs may introduce deep hierarchies or loops.
serializerGroup
.addBeanFilters(HttpServletRequest.class, HttpSession.class, ServletContext.class)
.addPojoSwaps(EnumerationSwap.class)
.setMaxDepth(10)
.setDetectRecursions(true);
.setProperty(HTMLDOC_links, "{...}");
// Return the updated group
return serializerGroup;
}
Note how the annotations generally require fewer lines of code.
Pointing a browser to the resource shows the following:
This gives you an idea of what kinds of POJO models can be serialized, since you are serializing a regular old HttpServletRequest object.
8.10 - AddressBookResource
The AddressBookResource class is a proof-of-concept class that shows a true RESTful API using the Juneau REST toolkit.
It provides examples of the following:
- How to create RESTful interfaces using only POJOs.
- How to use the {@link org.apache.juneau.xml.annotation.Xml @Xml} and
{@link org.apache.juneau.xml.annotation.XmlSchema @XmlSchema} annotations to provide XML namespaces
and alter how beans are handled by the XML serializer.
- How to use the {@link org.apache.juneau.jena.annotation.Rdf @Rdf} and
{@link org.apache.juneau.xml.annotation.XmlSchema @RdfSchema} annotations to provide XML namespaces
and alter how beans are handled by the Jena serializers.
- How to use the {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotation
to alter how bean properties are handled by the serializers.
- How to use the {@link org.apache.juneau.rest.annotation.RestMethod#name() RestMethod.name()} annotation
to create overloaded methods beyond the standard GET/PUT/POST/DELETE.
- How to augment data in the OPTIONS page.
- How to use the {@link org.apache.juneau.rest.client.RestClient} API to interact with the REST resource using
the same POJOs used to create the server-side API.
- How to interact with the REST resource using only a browser.
- Using the {@link org.apache.juneau.rest.converters.Traversable} converter to drill down into POJO models.
- Using the {@link org.apache.juneau.rest.converters.Queryable} converter to provide search/view/sort functionality against POJOs.
- Using the {@link org.apache.juneau.rest.converters.Introspectable} converter to invoke methods on POJOs.
- Using proxy interfaces.
Pointing a browser to the resource shows the following:
8.10.1 - Classes
The code is straightforward, consisting of the following classes:
- package-info.java - Used to define XML namespaces for POJOs in this package.
- IAddressBook - An interface describing the address book.
- AddressBook - A data structure consisting of a list of
Persons
.
- Person, Address - In-memory representations of people and addresses.
- CreatePerson, CreateAddress - POJOs for creating and updating people and address through the REST interface.
- AddressBookResource - The REST resource class.
For the sake of brevity, bean properties are defined as public fields instead of the normal getters/setters.
Also, the examples are not the most efficient design and are not thread safe.
The package-info.java file is used to define XML and RDF namespaces on beans and properties in this package.
Here you define a default XML and RDF namespaces and URL mappings for namespace shortnames used throughout this package.
It should be noted that these features are entirely optional, and there are often several ways of defining these namespaces.
// XML and RDF namespaces used in this package
@Xml(ns="ab",
namespaces={
@XmlNs(name="ab", uri="http://www.apache.org/addressBook/"),
@XmlNs(name="per", uri="http://www.apache.org/person/"),
@XmlNs(name="addr", uri="http://www.apache.org/address/"),
@XmlNs(name="mail", uri="http://www.apache.org/mail/")
}
)
@Rdf(ns="ab",
namespaces={
@RdfNs(name="ab", uri="http://www.apache.org/addressBook/"),
@RdfNs(name="per", uri="http://www.apache.org/person/"),
@RdfNs(name="addr", uri="http://www.apache.org/address/"),
@RdfNs(name="mail", uri="http://www.apache.org/mail/")
}
)
package org.apache.juneau.examples.addressBook;
import org.apache.juneau.xml.annotation.*;
Our address book uses the following interface:
/**
* Interface used to help illustrate proxy interfaces.
* See {@link SampleRemoteableServlet}.
*/
public interface IAddressBook {
/** Return all people in the address book */
List<Person> getPeople();
/** Return all addresses in the address book */
List<Address> getAddresses();
/** Create a person in this address book */
Person createPerson(CreatePerson cp) throws Exception;
/** Find a person by id */
Person findPerson(int id);
/** Find an address by id */
Address findAddress(int id);
/** Find a person by address id */
Person findPersonWithAddress(int id);
/** Remove a person by id */
Person removePerson(int id);
}
Notes
- You interface an interface for our address book so that you can later
use it to demonstrate the proxy interface support.
The AddressBook class is our address book.
It maintains a list of Person objects with some additional convenience methods:
/** Address book bean */
public class AddressBook extends LinkedList<Person> implements IAddressBook {
// The URL of this resource
private URI uri;
/** Bean constructor - Needed for instantiating on client side */
public AddressBook () {}
/** Normal constructor - Needed for instantiating on server side */
public AddressBook (URI uri) {...}
@Override /* IAddressBook */
public List<Person> getPeople() {
return this;
}
@Override /* IAddressBook */
public Person createPerson(CreatePerson cp) throws Exception {
Person p = new Person(uri, cp);
add(p);
return p;
}
@Override /* IAddressBook */
public Person findPerson(int id) {
for (Person p : this)
if (p.id == id)
return p;
return null;
}
@Override /* IAddressBook */
public Address findAddress(int id) {
for (Person p : this)
for (Address a : p.addresses)
if (a.id == id)
return a;
return null;
}
@Override /* IAddressBook */
public Person findPersonWithAddress(int id) {
for (Person p : this)
for (Address a : p.addresses)
if (a.id == id)
return p;
return null;
}
@Override /* IAddressBook */
public List<Address> getAddresses() {
Set<Address> s = new LinkedHashSet<Address>();
for (Person p : this)
for (Address a : p.addresses)
s.add(a);
return new ArrayList<Address>(s);
}
@Override /* IAddressBook */
public Person removePerson(int id) {
Person p = findPerson(id);
if (p != null)
remove(p);
return p;
}
/** Utility method */
public static Calendar toCalendar(String birthDate) throws Exception {
Calendar c = new GregorianCalendar();
c.setTime(DateFormat.getDateInstance(DateFormat.MEDIUM, Locale.US).parse(birthDate));
return c;
}
}
Notes
- The
@Xml(elementName="addressBook")
annotation tells the toolkit that
when serialized as XML, the element name is <addressBook>.
Without this annotation, the element would revert to the generalized <array> tag.
- The separate constructors are implementation specific and are needed because you're going to be using this class in two ways,
since you'll be demonstrating the client code as well as the server code, and it eliminates having to define separate client-side and server-side POJOs:
- The normal constructor is used to programmatically create this object in the REST servlet code.
- The no-arg constructor is used by the Juneau parsers to construct this object in our client side code.
The Person bean is defined as follows:
/** Person bean */
@Xml(ns="per")
@Rdf(prefix="per")
@Bean(typeName="person")
public class Person {
private static int nextPersonId = 1;
// Bean properties.
@Rdf(beanUri=true) public URI uri;
public URI addressBookUri;
public String id;
public String name;
@BeanProperty(swap=CalendarSwap.Medium.class) public Calendar birthDate;
public LinkedList<Address> addresses = new LinkedList<Address>();
/** Bean constructor - Needed for instantiating on server side */
public Person() {}
/** Normal constructor - Needed for instantiating on client side */
public Person(URI addressBookUri, CreatePerson cp) throws Exception {
this.id = nextPersonId++;
this.addressBookUri = addressBookUri;
if (addressBookUri != null)
this.uri = addressBookUri.resolve("people/" + id);
this.name = cp.name;
this.birthDate = cp.birthDate;
for (CreateAddress ca : cp.addresses)
this.addresses.add(new Address(addressBookUri, uri, ca));
}
/** Extra read-only bean property */
public int getAge() {
return new GregorianCalendar().get(Calendar.YEAR) - birthDate.get(Calendar.YEAR);
}
/** Convenience method - Add an address for this person */
public Address createAddress(CreateAddress ca) throws Exception {
Address a = new Address(addressBookUri, uri, ca);
addresses.add(a);
return a;
}
/** Extra method (for method invocation example) */
public String sayHello(String toPerson, int age) {
return name + " says hello to " + toPerson + " who is " + age + " years old";
}
}
Notes
- The ns="per" annotations override the default "ab" namespace defined on the package.
It applies to this class and all properties of this class.
- The
@Rdf(beanUri=true)
annotation identifies the uri property as the resource URI for this resource.
This property has special meaning for the RDF serializer.
The RDF serializer uses this property for the value of the rdf:resource attribute.
- The
@BeanProperty(swap=CalendarSwap.Medium.class)
annotation causes the date field to
be serialized in the format "MM dd, yyyy".
This could have also been specified globally on the resource level through the {@link org.apache.juneau.rest.annotation.RestResource#properties} annotation.
The Address bean is defined as follows:
/**
* Address bean
*/
@Xml(prefix="addr")
@Rdf(prefix="addr")
@Bean(typeName="address")
public class Address {
private static int nextAddressId = 1;
// Bean properties
@Rdf(beanUri=true) public URI uri;
public URI personUri;
public int id;
@Xml(prefix="mail") @Rdf(prefix="mail") public String street, city, state;
@Xml(prefix="mail") @Rdf(prefix="mail") public int zip;
public boolean isCurrent;
/** Bean constructor - Needed for instantiating on client side */
public Address() {}
/** Normal constructor - Needed for instantiating on server side */
public Address(URI addressBookUri, URI personUri, CreateAddress ca) throws Exception {
this.id = nextAddressId++;
if (addressBookUri != null)
this.uri = addressBookUri.resolve("addresses/" + id);
this.personUri = personUri;
this.street = ca.street;
this.city = ca.city;
this.state = ca.state;
this.zip = ca.zip;
this.isCurrent = ca.isCurrent;
}
}
Notes
- This class shows how the namespace can be overridden at the property level through the
@Xml(ns="mail")
annotation.
The CreatePerson bean is used as the input data for creating a person.
/** Bean for creating a new person */
@Xml(ns="per")
@Rdf(ns="addr")
@Bean(typeName="person")
public class CreatePerson {
// Bean properties
public String name;
@BeanProperty(swap=CalendarSwap.Medium.class) public Calendar birthDate;
public LinkedList<CreateAddress> addresses;
/** Bean constructor - Needed for instantiating on server side */
public CreatePerson() {}
/** Normal constructor - Needed for instantiating on client side */
public CreatePerson(String name, Calendar birthDate, CreateAddress...addresses) {...}
}
The CreateAddress bean is used as the input data for creating an address.
/** Bean for creating a new address */
@Xml(ns="addr")
@Rdf(ns="addr")
@Bean(typeName="address")
public class CreateAddress {
// Bean properties
@Xml(ns="mail") @Rdf(ns="mail") public String street, city, state;
@Xml(ns="mail") @Rdf(ns="mail") public int zip;
public boolean isCurrent;
/** Bean constructor -Needed for instantiating on server side */
public CreateAddress() {}
/** Normal constructor - Needed for instantiating on client side */
public CreateAddress(String street, String city, String state, int zip, boolean isCurrent) {...}
}
The AddressBookResource class is our REST resource class.
/**
* Proof-of-concept resource that shows off the capabilities of working with POJO resources.
* Consists of an in-memory address book repository.
*/
@RestResource(
path="/addressBook",
messages="nls/AddressBookResource",
properties={
@Property(name=REST_allowMethodParam, value="*"),
@Property(name=HTML_uriAnchorText, value=TO_STRING),
@Property(name=SERIALIZER_quoteChar, value="'"),
@Property(name=RDF_rdfxml_tab, value="5"),
@Property(name=RDF_addRootProperty, value="true"),
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'$R{servletURI}?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.addressbook.AddressBookResource,org.apache.juneau.examples.addressbook.Address,org.apache.juneau.examples.addressbook.AddressBook,org.apache.juneau.examples.addressbook.CreateAddress,org.apache.juneau.examples.addressbook.CreatePerson,org.apache.juneau.examples.addressbook.IAddressBook,org.apache.juneau.examples.addressbook.Person)'}"),
// Resolve all relative URIs so that they're relative to this servlet!
@Property(name=SERIALIZER_relativeUriBase, value="$R{servletURI}"),
},
stylesheet="styles/devops.css",
encoders=GzipEncoder.class,
contact="{name:'John Smith',email:'john@smith.com'}",
license="{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}",
version="2.0",
termsOfService="You're on your own.",
tags="[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]",
externalDocs="{description:'Home page',url:'http://juneau.apache.org'}"
)
public class AddressBookResource extends ResourceJena {
private static final long serialVersionUID = 1L;
// The in-memory address book
private AddressBook addressBook;
@Override /* Servlet */
public void init() {
try {
// Create the address book
addressBook = new AddressBook(java.net.URI.create(""));
// Add some people to our address book by default
addressBook.createPerson(
new CreatePerson(
"Barack Obama",
toCalendar("Aug 4, 1961"),
new CreateAddress("1600 Pennsylvania Ave", "Washington", "DC", 20500, true),
new CreateAddress("5046 S Greenwood Ave", "Chicago", "IL", 60615, false)
)
);
addressBook.createPerson(
new CreatePerson(
"George Walker Bush",
toCalendar("Jul 6, 1946"),
new CreateAddress("43 Prairie Chapel Rd", "Crawford", "TX", 76638, true),
new CreateAddress("1600 Pennsylvania Ave", "Washington", "DC", 20500, false)
)
);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
* [GET /]
* Get root page.
*/
@RestMethod(name="GET", path="/",
converters=Queryable.class
)
public Link[] getRoot() throws Exception {
return new Link[] {
new Link("people", "people"),
new Link("addresses", "addresses")
};
}
/**
* [GET /people/*]
* Get all people in the address book.
* Traversable transforming enabled to allow nodes in returned POJO tree to be addressed.
* Introspectable transforming enabled to allow public methods on the returned object to be invoked.
*/
@RestMethod(name="GET", path="/people/*",
converters={Traversable.class,Queryable.class,Introspectable.class}
)
public AddressBook getAllPeople() throws Exception {
return addressBook;
}
/**
* [GET /people/{id}/*]
* Get a single person by ID.
* Traversable transforming enabled to allow nodes in returned POJO tree to be addressed.
* Introspectable transforming enabled to allow public methods on the returned object to be invoked.
*/
@RestMethod(name="GET", path="/people/{id}/*",
converters={Traversable.class,Queryable.class,Introspectable.class}
)
public Person getPerson(@Path int id) throws Exception {
return findPerson(id);
}
/**
* [GET /addresses/*]
* Get all addresses in the address book.
*/
@RestMethod(name="GET", path="/addresses/*",
converters={Traversable.class,Queryable.class}
)
public List<Address> getAllAddresses() throws Exception {
return addressBook.getAddresses();
}
/**
* [GET /addresses/{id}/*]
* Get a single address by ID.
*/
@RestMethod(name="GET", path="/addresses/{id}/*",
converters={Traversable.class,Queryable.class}
)
public Address getAddress(@Path int id) throws Exception {
return findAddress(id);
}
/**
* [POST /people]
* Create a new Person bean.
*/
@RestMethod(name="POST", path="/people",
guards=AdminGuard.class
)
public Redirect createPerson(@Body CreatePerson cp) throws Exception {
Person p = addressBook.createPerson(cp);
return new Redirect("people/{0}", p.id);
}
/**
* [POST /people/{id}/addresses]
* Create a new Address bean.
*/
@RestMethod(name="POST", path="/people/{id}/addresses",
guards=AdminGuard.class
)
public Redirect createAddress(@Path int id, @Body CreateAddress ca) throws Exception {
Person p = findPerson(id);
Address a = p.createAddress(ca);
return new Redirect("addresses/{0}", a.id);
}
/**
* [DELETE /people/{id}]
* Delete a Person bean.
*/
@RestMethod(name="DELETE", path="/people/{id}",
guards=AdminGuard.class,
)
public String deletePerson(@Path int id) throws Exception {
addressBook.removePerson(id);
return "DELETE successful";
}
/**
* [DELETE /addresses/{id}]
* Delete an Address bean.
*/
@RestMethod(name="DELETE", path="/addresses/{id}",
guards=AdminGuard.class
)
public String deleteAddress(@Path int addressId) throws Exception {
Person p = addressBook.findPersonWithAddress(addressId);
if (p == null)
throw new RestException(SC_NOT_FOUND, "Person not found");
Address a = findAddress(addressId);
p.addresses.remove(a);
return "DELETE successful";
}
/**
* [PUT /people/{id}/*]
* Change property on Person bean.
*/
@RestMethod(name="PUT", path="/people/{id}/*",
guards=AdminGuard.class
)
public String updatePerson(RestRequest req, @Path int id) throws Exception {
try {
Person p = findPerson(id);
String pathRemainder = req.getPathRemainder();
PojoRest r = new PojoRest(p);
ClassMeta<?> cm = r.getClassMeta(pathRemainder);
Object in = req.getBody(cm);
r.put(pathRemainder, in);
return "PUT successful";
} catch (Exception e) {
throw new RestException(SC_BAD_REQUEST, "PUT unsuccessful").initCause(e);
}
}
/**
* [PUT /addresses/{id}/*]
* Change property on Address bean.
*/
@RestMethod(name="PUT", path="/addresses/{id}/*",
guards=AdminGuard.class
)
public String updateAddress(RestRequest req, @Path int id) throws Exception {
try {
Address a = findAddress(id);
String pathInfo = req.getPathInfo();
PojoRest r = new PojoRest(a);
ClassMeta<?> cm = r.getClassMeta(pathInfo);
Object in = req.getBody(cm);
r.put(pathInfo, in);
return "PUT successful";
} catch (Exception e) {
throw new RestException(SC_BAD_REQUEST, "PUT unsuccessful").initCause(e);
}
}
/**
* [INIT /]
* Reinitialize this resource.
*/
@RestMethod(name="INIT", path="/",
guards=AdminGuard.class
)
public String doInit() throws Exception {
init();
return "OK";
}
/**
* [GET /cognos]
* Get data in Cognos/XML format
*/
@RestMethod(name="GET", path="/cognos")
public DataSet getCognosData() throws Exception {
// The Cognos metadata
Column[] items = {
new Column("name", "xs:String", 255),
new Column("age", "xs:int"),
new Column("numAddresses", "xs:int")
.addPojoSwap(
new PojoSwap<Person,Integer>() {
@Override /* PojoSwap */
public Integer swap(BeanSession session, Person p) {
return p.addresses.size();
}
}
)
};
return new DataSet(items, addressBook, this.getBeanContext());
}
/**
* [OPTIONS /*]
* View resource options
*/
@Override /* RestServletJenaDefault */
@RestMethod(name="OPTIONS", path="/*")
public Swagger getOptions(RestRequest req) {
return req.getSwagger();
}
/** Convenience method - Find a person by ID */
private Person findPerson(int id) throws RestException {
Person p = addressBook.findPerson(id);
if (p == null)
throw new RestException(SC_NOT_FOUND, "Person not found");
return p;
}
/** Convenience method - Find an address by ID */
private Address findAddress(int id) throws RestException {
Address a = addressBook.findAddress(id);
if (a == null)
throw new RestException(SC_NOT_FOUND, "Address not found");
return a;
}
}
Notes
- The @RestResource.messages() annotation identifies org/apache/juneau/samples/addressbook/nls/AddressBookResource.properties as the resource bundle for localized message for this class.
- You are setting XML_enableNamespaces to true to enable XML namespaces.
By default, XML namespace support is disabled per {@link org.apache.juneau.xml.XmlSerializerContext#XML_enableNamespaces},
so you have to explicitly enable it on our serializers.
- The XML_autoDetectNamespaces setting is needed to get the XML serializer to add xmlns attributes to the root elements.
This causes the XML serializer to scan the POJO objects for namespaces in order to populate the root element.
There are other ways to do this, such as explicitely specifying the XML_defaultNamespaceUris setting at either the resource or method level, which might be preferred in high-performance environments.
However, XML_autoDetectNamespaces produces the simplest code for our example.
- The updatePerson() and updateAddress() methods use a guard to only allow administrators access.
For the sample code, the guard does nothing. It's up to the implementer to decide how to restrict access.
- The updatePerson() and updateAddress() methods use the {@link org.apache.juneau.utils.PojoRest} class
to locate and update individual nodes in a POJO tree using the path remainder on the request.
- The doInit() method shows an example of an overloaded method using the @RestMethod(name="INIT") annotation.
- The getOptions() method shows the default OPTIONS page augmented with some additional information.
The OPTIONS page uses the servlet resource bundle to specify the labels so that they're globalizable.
title = AddressBook sample resource
description = Proof-of-concept resource that shows off the capabilities of working with POJO resources
getRoot.summary = Get root page
getRoot.description = Jumping off page for top-level Person and Address beans.
doInit.summary = Reinitialize this resource
doInit.description = Resets the address book to the original contents.
doInit.res.200.description = Returns the string "OK"
getAllPeople.summary = Get all people in the address book
getAllPeople.res.200.description = Returns a serialized List<Person>
getAllPeople.res.200.examples = {'text/json':"[\n\t{\n\t\turi:'http://hostname/addressBook/person/1',\n\t\taddressBookUri:'http://localhost/addressBook',\n\t\tid:1,\n\t\tname:'John Smith',\n\t\tbirthDate:'Jan 1, 2000',\n\t\taddresses:[\n\t\t\t{\n\t\t\t\turi:'http://localhost/addressBook/addresses/1',\n\t\t\t\tpersonUri:'http://localhost/addressBook/people/1',\n\t\t\t\tid:1,\n\t\t\t\tstreet:'101 Main St',\n\t\t\t\tcity:'Anywhere',\n\t\t\t\tstate:'NY',\n\t\t\t\tzip:12345,\n\t\t\t\tisCurrent:true\n\t\t\t}\n\t\t]\n\t}\n]"}
getPerson.summary = Get a single person by ID
getPerson.req.path.id.description = Person ID
getPerson.req.path.id.type = integer
getPerson.res.200.description = Returns a serialized Person bean
getPerson.res.200.examples = {'text/json':"{\n\turi:'http://hostname/addressBook/person/1',\n\taddressBookUri:'http://localhost/addressBook',\n\tid:1,\n\tname:'John Smith',\n\tbirthDate:'Jan 1, 2000',\n\taddresses:[\n\t\t{\n\t\t\turi:'http://localhost/addressBook/addresses/1',\n\t\t\tpersonUri:'http://localhost/addressBook/people/1',\n\t\t\tid:1,\n\t\t\tstreet:'101 Main St',\n\t\t\tcity:'Anywhere',\n\t\t\tstate:'NY',\n\t\t\tzip:12345,\n\t\t\tisCurrent:true\n\t\t}\n\t]\n\}"}
getPerson.res.404.description = Person ID not found
getAllAddresses.summary = Get all addresses in the address book
getAllAddresses.res.200.description = Returns a serialized List<Address>
getAllAddresses.res.200.examples = {'text/json':"[\n\t{\n\t\turi:'http://localhost/addressBook/addresses/1',\n\t\tpersonUri:'http://localhost/addressBook/people/1',\n\t\tid:1,\n\t\tstreet:'101 Main St',\n\t\tcity:'Anywhere',\n\t\tstate:'NY',\n\t\tzip:12345,\n\t\tisCurrent:true\n\t}\n]"}
getAddress.summary = Get a single address by ID
getAddress.req.path.id.description = Address ID
getAddress.req.path.id.type = integer
getAddress.res.200.description = Returns a serialized Address bean
getAddress.res.200.examples = {'text/json':"{\n\turi:'http://localhost/addressBook/addresses/1',\n\tpersonUri:'http://localhost/addressBook/people/1',\n\tid:1,\n\tstreet:'101 Main St',\n\tcity:'Anywhere',\n\tstate:'NY',\n\tzip:12345,\n\tisCurrent:true\n}"}
getAddress.res.404.description = Address ID not found
createPerson.summary = Create a new Person bean
createPerson.req.body.description = Serialized CreatePerson bean
createPerson.req.body.schema = {example:"{\n\tname:'John Smith',\n\tbirthDate:'Jan 1, 2000',\n\taddresses:[\n\t\t{\n\t\t\tstreet:'101 Main St',\n\t\t\tcity:'Anywhere',\n\t\t\tstate:'NY',\n\t\t\tzip:12345,\n\t\t\tisCurrent:true\n\t\t}\n\t]\n\}"}
createPerson.res.307.header.Location.description = URL of new person
createAddress.summary = Create a new Address bean
createAddress.req.path.id.description = Person ID
createAddress.req.path.id.type = integer
createAddress.req.body.schema = {example:"{\n\tstreet:'101 Main St',\n\tcity:'Anywhere',\n\tstate:'NY',\n\tzip:12345,\n\tisCurrent:true\n}"}
createAddress.res.307.header.Location.description = URL of new address
deletePerson.summary = Delete a Person bean
deletePerson.req.path.id.description = Person ID
deletePerson.req.path.id.type = integer
deletePerson.res.200.description = Returns the string "DELETE successful"
deletePerson.res.404.description = Person ID not found
deleteAddress.summary = Delete an Address bean
deleteAddress.req.path.id.description = Address ID
deleteAddress.res.200.description = Returns the string "DELETE successful"
deleteAddress.res.404.description = Address ID not found
updatePerson.summary = Change property on Person bean
updatePerson.req.path.id.description = Person ID
updatePerson.req.path.id.type = integer
updatePerson.req.body.description = Any object matching the field
updatePerson.res.200.description = Returns the string "PUT successful"
updatePerson.res.400.description = Invalid object type used
updatePerson.res.404.description = Person ID not found
updateAddress.summary = Change property on Address bean
updateAddress.req.path.id.description = Address ID
updateAddress.req.path.id.type = integer
updateAddress.req.body.description = Any object matching the field
updateAddress.res.200.description = Returns the string "PUT successful"
updateAddress.res.400.description = Invalid object type used
updateAddress.res.404.description = Address ID not foundv
getOptions.summary = View resource options
getCognosData.summary = Get data in Cognos/XML format
getCognosData.res.200.description = Returns a serialized DataSet
otherNotes = GZip support enabled. Public methods can be invoked by using the &Method URL parameter. 'text/cognos+xml' support available under root resource only
8.10.2 - Demo
Pointing a browser to the resource shows the results of running the getRoot() method:
Clicking the people link shows you the result of running the getAllPeople() method:
Notice how the URI properties automatically became hyperlinks.
Also notice how the dates are formatted as readable strings.
This was from the transform you added to the Calendar property.
Let's see what the output looks like in other formats:
Notice how our XML_enableNamespaces and XML_autoDetectNamespaces settings result
in namespaces being used.
Also notice how the @BeanProperty(uri=true)
annotations caused the uri properties
to become XML attributes instead of elements.
Notice how the @BeanProperty(uri=true)
annotations are used to identify values for
rdf:about values.
Also notice how URI properties are serialized as rdf:resource attributes.
Now lets look at the schema outputs that can be rendered that show information about the POJO classes themselves.
Now let's see what else you can do.
Clicking on the first personUri link executes the getPerson() method, which renders a serialized Person object:
Clicking on the OPTIONS link on the page shows you the Swagger doc generated from our annotations and resource bundle properties:
8.10.3 - Traversable
Because you added the Traversable converter to the getPerson method, you can also address child nodes in the POJO model
through path remainders:
8.10.4 - Queryable
8.10.5 - Introspectable
The Introspectable converter on the getPerson method allows us to invoke public methods on the addressed POJO (in this case, public methods on the String class):
8.10.6 - ClientTest
The ClientTest class is provided to demonstrate how POJOs can be serialized and parsed
through the REST interface using the RestClient class.
You'll notice that the class is a standalone executable that can be invoked as a plain Java process.
/**
* Sample client code for interacting with AddressBookResource
*/
public class ClientTest {
public static void main(String[] args) {
try {
System.out.println("Running client test...");
// Create a client to handle XML requests and responses.
RestClient client = new RestClient(JsonSerializer.DEFAULT, JsonParser.DEFAULT);
RestClient xmlClient = new RestClient(XmlSerializer.DEFAULT, XmlParser.DEFAULT);
String root = "http://localhost:10000/addressBook";
// Get the current contents of the address book
AddressBook ab = client.doGet(root + "/people").getResponse(AddressBook.class);
System.out.println("Number of entries = " + ab.getPeople().size());
// Same, but use XML as the protocol both ways
ab = xmlClient.doGet(root + "/people").getResponse(AddressBook.class);
System.out.println("Number of entries = " + ab.getPeople().size());
// Delete the existing entries
for (Person p : ab.getPeople()) {
String r = client.doDelete(p.uri).getResponse(String.class);
System.out.println("Deleted person " + p.name + ", response = " + r);
}
// Make sure they're gone
ab = client.doGet(root + "/people").getResponse(AddressBook.class);
System.out.println("Number of entries = " + ab.getPeople().size());
// Add 1st person again
CreatePerson cp = new CreatePerson(
"Barack Obama",
toCalendar("Aug 4, 1961"),
new CreateAddress("1600 Pennsylvania Ave", "Washington", "DC", 20500, true),
new CreateAddress("5046 S Greenwood Ave", "Chicago", "IL", 60615, false)
);
Person p = client.doPost(root + "/people", cp).getResponse(Person.class);
System.out.println("Created person " + p.name + ", uri = " + p.uri);
// Add 2nd person again, but add addresses separately
cp = new CreatePerson(
"George Walker Bush",
toCalendar("Jul 6, 1946")
);
p = client.doPost(root + "/people", cp).getResponse(Person.class);
System.out.println("Created person " + p.name + ", uri = " + p.uri);
// Add addresses to 2nd person
CreateAddress ca = new CreateAddress("43 Prairie Chapel Rd", "Crawford", "TX", 76638, true);
Address a = client.doPost(p.uri + "/addresses", ca).getResponse(Address.class);
System.out.println("Created address " + a.uri);
ca = new CreateAddress("1600 Pennsylvania Ave", "Washington", "DC", 20500, false);
a = client.doPost(p.uri + "/addresses", ca).getResponse(Address.class);
System.out.println("Created address " + a.uri);
// Find 1st person, and change name
Person[] pp = client.doGet(root + "/people?q=(name='Barack+Obama')").getResponse(Person[].class);
String r = client.doPut(pp[0].uri + "/name", "Barack Hussein Obama").getResponse(String.class);
System.out.println("Changed name, response = " + r);
p = client.doGet(pp[0].uri).getResponse(Person.class);
System.out.println("New name = " + p.name);
} catch (Exception e) {
e.printStackTrace();
}
}
// Utility method
public static Calendar toCalendar(String birthDate) throws Exception {
Calendar c = new GregorianCalendar();
c.setTime(DateFormat.getDateInstance(DateFormat.MEDIUM).parse(birthDate));
return c;
}
}
The output from running this code is the following:
Running client test...
Number of entries = 2
Deleted person Barack Obama, response = DELETE successful
Deleted person George Walker Bush, response = DELETE successful
Number of entries = 0
Created person Barack Obama, uri = http://localhost:9081/sample/addressBook/people/3
Created person George Walker Bush, uri = http://localhost:9081/sample/addressBook/people/4
Created address http://localhost:9081/sample/addressBook/addresses/7
Created address http://localhost:9081/sample/addressBook/addresses/8
Changed name, response = PUT successful
New name = Barack Hussein Obama
8.10.7 - Browser Tips
The Juneau architecture is designed to make it easy to debug REST resources using nothing more than a browser.
The same actions done programmatically in the last section can also be done using URLs.
By default, you can override the HTTP Method and Content through GET parameters, as shown below:
// Delete the existing entries
http://localhost:10000/addressBook/people/1?method=DELETE
http://localhost:10000/addressBook/people/2?method=DELETE
// Add 1st person again
http://localhost:10000/addressBook/people?method=POST&content={name:'Barack Obama',birthDate:'Aug 4, 1961',addresses:[{street:'1600 Pennsylvania Ave',city:'Washington',state:'DC',zip:20500,isCurrent:true},{street:'5046 S Greenwood Ave',city:'Chicago',state:'IL',zip:60615,isCurrent:false}]}
// Add 2nd person again
http://localhost:10000/addressBook/people?method=POST&content={name:'George Walker Bush',birthDate:'Jul 6, 1946'}
http://localhost:10000/addressBook/people/4/addresses?method=POST&content={street:'43 Prairie Chapel Rd',city:'Crawford',state:'TX',zip:76638,isCurrent:true}
http://localhost:10000/addressBook/people/4/addresses?method=POST&content={street:'1600 Pennsylvania Ave',city:'Washington',state:'DC',zip:20500,isCurrent:false}
// Change name of 1st person
http://localhost:10000/addressBook/people/3/name?method=PUT&content="'Barack Hussein Obama'"
The ability to overload methods is enabled through the {@link org.apache.juneau.rest.RestServletContext#REST_allowMethodParam} property.
8.11 - SampleRemoteableServlet
The SampleRemoteableServlet class shows examples of the following:
- Extending the {@link org.apache.juneau.rest.remoteable.RemoteableServlet} class to create a proxy service.
- Using the {@link org.apache.juneau.rest.client.RestClient} class to create remoteable proxy interfaces.
The RemoteableServlet class has a single abstract method, {@link org.apache.juneau.rest.remoteable.RemoteableServlet#getServiceMap()},
that defines interface keys and POJO values.
The SampleRemoteableServlet exposes the AddressBook bean from the previous example as a service.
@RestResource(
path="/remoteable",
messages="nls/SampleRemoteableServlet",
properties={
@Property(name=HTMLDOC_title, value="Remoteable Service Proxy API"),
@Property(name=HTMLDOC_description, value="Sample class showing how to use remoteable proxies. The list below are exposed services that can be retrieved using RestClient.getProxyInterface(Class)."),
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'$R{servletURI}?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.SampleRemoteableServlet)'}"),
// Allow us to use method=POST from a browser.
@Property(name=REST_allowMethodParam, value="*")
}
)
public class SampleRemoteableServlet extends RemoteableServlet {
AddressBook addressBook = new AddressBook();
@Override /* RemoteableServlet */
protected Map<Class<?>,Object> getServiceMap() throws Exception {
Map<Class<?>,Object> m = new LinkedHashMap<Class<?>,Object>();
// In this simplified example, you expose the same POJO service under two different interfaces.
// One is IAddressBook which only exposes methods defined on that interface, and
// the other is AddressBook itself which exposes all methods defined on the class itself.
m.put(IAddressBook.class, addressBook);
m.put(AddressBook.class, addressBook);
return m;
}
}
Pointing a browser to the resource shows the following:
Clicking the hyperlinks on each shows you the list of methods that can be invoked on that service.
Note that the IAddressBook link shows that you can only invoke methods defined on that
interface, whereas the AddressBook link shows ALL public methods defined on that class.
Since AddressBook extends from LinkedList, you may notice familiar collections
framework methods listed.
As good practice, you'll want to use interfaces to prevent all public methods from being exposed.
The {@link org.apache.juneau.rest.client.RestClient#setRemoteableServletUri(String)} method is used to specify the location
of the remoteable services servlet running on the server.
Proxy interfaces are then retrieved using the {@link org.apache.juneau.rest.client.RestClient#getRemoteableProxy(Class)} method.
The client side code for invoking this method is shown below:
// Create a RestClient using JSON for serialization, and point to the server-side remoteable servlet.
RestClient client = new RestClient(JsonSerializer.class,JsonParser.class)
.setRemoteableServletUri("http://localhost:10000/remoteable");
// Create a proxy interface.
IAddressBook ab = client.getRemoteableProxy(IAddressBook.class);
// Invoke a method on the server side and get the returned result.
Person p = ab.createPerson(
new CreatePerson("Test Person",
AddressBook.toCalendar("Aug 1, 1999"),
new CreateAddress("Test street", "Test city", "Test state", 12345, true))
);
Additional Information
- org.apache.juneau.rest.remoteable - Remoteable API Javadoc
- {@link org.apache.juneau.rest.remoteable.RemoteableServlet}
- {@link org.apache.juneau.rest.client.RestClient}
- {@link org.apache.juneau.rest.client.RestClient#setRemoteableServletUri(String) setRemoteableServletUri(String)}
- {@link org.apache.juneau.rest.client.RestClient#getRemoteableProxy(Class) getRemoteableProxy(Class)}
8.12 - TempDirResource
The TempDirResource class shows examples of the following:
- Extending the {@link org.apache.juneau.microservice.resources.DirectoryResource} class.
- Using the Apache ServletFileUpload class to handle multi-part form posts.
- Using a system property string variable.
- Using {@link org.apache.juneau.rest.RestMatcher RestMatchers}.
Pointing a browser to the resource shows the following:
Pointing a browser to the upload link shows a form entry page:
/**
* Sample resource that extends DirectoryResource to open up the temp directory as a REST resource.
*/
@RestResource(
path="/tempDir",
messages="nls/TempDirResource",
properties={
@Property(name="DirectoryResource.rootDir", value="$S{java.io.tmpdir}"),
@Property(name="DirectoryResource.allowViews", value="true"),
@Property(name="DirectoryResource.allowDeletes", value="true"),
@Property(name="DirectoryResource.allowPuts", value="false"),
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'$R{servletURI}?method=OPTIONS',upload:'upload',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.TempDirResource,org.apache.juneau.rest.samples.DirectoryResource)'}"),
},
stylesheet="styles/devops.css"
)
public class TempDirResource extends DirectoryResource {
private static final long serialVersionUID = 1L;
/**
* [GET /upload] - Display the form entry page for uploading a file to the temp directory.
*/
@RestMethod(name="GET", path="/upload")
public ReaderResource getUploadPage(RestRequest req) throws IOException {
return req.getReaderResource("TempDirUploadPage.html", true);
}
/**
* [POST /upload] - Upload a file as a multipart form post.
* Shows how to use the Apache Commons ServletFileUpload class for handling multi-part form posts.
*/
@RestMethod(name="POST", path="/upload", matchers=TempDirResource.MultipartFormDataMatcher.class)
public Redirect uploadFile(RestRequest req) throws Exception {
ServletFileUpload upload = new ServletFileUpload();
FileItemIterator iter = upload.getItemIterator(req);
while (iter.hasNext()) {
FileItemStream item = iter.next();
if (item.getFieldName().equals("contents")) {
File f = new File(getRootDir(), item.getName());
IOPipe.create(item.openStream(), new FileOutputStream(f)).closeOut().run();
}
}
return new Redirect(); // Redirect to the servlet root.
}
/** Causes a 404 if POST isn't multipart/form-data */
public static class MultipartFormDataMatcher extends RestMatcher {
@Override /* RestMatcher */
public boolean matches(RestRequest req) {
String contentType = req.getContentType();
return contentType != null && contentType.startsWith("multipart/form-data");
}
}
}
#--------------------------------------------------------------------------------
# TempDirResource labels
#--------------------------------------------------------------------------------
title = Temp Directory View Service
description = View and download files in the '$S{java.io.tmpdir}' directory.
Note how a system property variable can be defined in the properties file.
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<style type='text/css'>
@import '$R{servletURI}/style.css';
</style>
</head>
<body>
<h3 class='title'>$R{servletTitle}</h3>
<h5 class="description">$R{servletDescription}</h5>
<div class='data'>
<form id='form' action='$R{servletURI}/upload' method='POST' target='buff' enctype="multipart/form-data">
<input name="contents" type="file"><button type="submit">Submit</button>
</form>
</div>
</body>
</html>
Note how the HTML file contains localized variables for the servlet label and description.
Additional Information
- {@link org.apache.juneau.microservice.resources.DirectoryResource}
8.13 - AtomFeedResource
The AtomFeedResource class shows examples of the following:
Pointing a browser to the resource shows the following:
True ATOM feeds require using an Accept:text/xml header:
Other languages, such as JSON are also supported:
/**
* Sample resource that shows how to generate ATOM feeds.
*/
@RestResource(
path="/atom",
messages="nls/AtomFeedResource",
properties={
@Property(name=SERIALIZER_quoteChar, value="'"),
@Property(name=RDF_rdfxml_tab, value="5"),
@Property(name=RDF_addRootProperty, value="true"),
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.AtomFeedResource)'}")
},
encoders=GzipEncoder.class
)
public class AtomFeedResource extends ResourceJena {
private static final long serialVersionUID = 1L;
private Feed feed; // The root resource object
@Override /* Servlet */
public void init() {
try {
feed = new Feed()
.setTitle(new Text("text", "Juneau ATOM specification"))
.setSubTitle(new Text("html", "Decribes <em>stuff</em> about Juneau"))
.setUpdated(parseDateTime("2016-01-02T03:04:05Z"))
.setId(new Id("tag:juneau.apache.org"))
.addLinks(
new Link("alternate", "text/html", "http://juneau.apache.org/").setHreflang("en"),
new Link("self", "application/atom+xml", "http://juneau.apache.org/feed.atom")
)
.setRights(new Text("Copyright (c) 2016, Apache Foundation"))
.setGenerator(new Generator("Juneau").setUri(new URI("http://juneau.apache.org/")).setVersion("1.0"))
.addEntries(
new Entry()
.setTitle(new Text("Juneau ATOM specification snapshot"))
.addLinks(
new Link("alternate", "text/html", "http://juneau.apache.org/juneau.atom"),
new Link("enclosure", "audio/mpeg", "http://juneau.apache.org/audio/juneau_podcast.mp3").setLength(12345)
)
.setId(new Id("tag:juneau.apache.org"))
.setUpdated(parseDateTime("2016-01-02T03:04:05Z"))
.setPublished(parseDateTime("2016-01-02T03:04:05Z"))
.addAuthors(new Person("James Bognar").setUri(new URI("http://juneau.apache.org/")).setEmail("james.bognar@apache.org"))
.addContributors(
new Person("Barry M. Caceres")
)
.setContent(
new Content()
.setLang("en")
.setBase(new URI("http://www.apache.org/"))
.setType("xhtml")
.setText("<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><i>[Update: Juneau supports ATOM.]</i></p></div>")
)
);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
* GET request handler
*/
@RestMethod(name="GET", path="/")
public Feed getFeed() throws Exception {
return feed;
}
/**
* PUT request handler.
* Replaces the feed with the specified content, and then mirrors it as the response.
*/
@RestMethod(name="PUT", path="/")
public Feed setFeed(@org.apache.juneau.rest.annotation.Content Feed feed) throws Exception {
this.feed = feed;
return feed;
}
}
Additional Information
8.14 - DockerRegistryResource
The DockerRegistryResource class shows examples of the following:
- Accessing a docker registry REST API as POJOs using {@link org.apache.juneau.rest.client.RestClient}.
- Using the {@link org.apache.juneau.rest.labels.ResourceDescription} class to implement a top-level 'router' page.
- Using the {@link org.apache.juneau.rest.RestServlet#getConfig()} method to access external configuration file values.
Pointing a browser to the resource shows the following:
Clicking the search link provides you with the search results against the Docker registry:
/**
* Sample resource that shows how to mirror query results from a Docker registry.
*/
@RestResource(
path="/docker",
title="Sample Docker resource",
properties={
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.AtomFeedResource)'}")
}
)
public class DockerRegistryResource extends Resource {
private static final long serialVersionUID = 1L;
// Get registry URL from examples.cfg file.
private String registryUrl = getConfig().getString("DockerRegistry/url");
RestClient rc = new RestClient(JsonSerializer.DEFAULT, JsonParser.DEFAULT);
/** [GET /] - Show child resources. */
@SuppressWarnings("nls")
@RestMethod(name="GET", path="/")
public ResourceDescription[] getChildren(RestRequest req) {
return new ResourceDescription[] {
new ResourceDescription(req, "search", "Search Registry")
};
}
/**
* PUT request handler.
* Replaces the feed with the specified content, and then mirrors it as the response.
*/
@RestMethod(name="GET", path="/search")
public QueryResults query(@Query("q") String q) throws Exception {
String url = registryUrl + "/search" + (q == null ? "" : "?q=" + q);
return rc.doGet(url).getResponse(QueryResults.class);
}
public static class QueryResults {
public int num_results;
public String query;
public List<DockerImage> results;
}
public static class DockerImage {
public String name, description;
}
}
The Docker registry URL is specified in the examples.cfg file:
#================================================================================
# DockerRegistryResource properties
#================================================================================
[DockerRegistry]
url = http://clmdocker02.ratl.swg.usma.apache.org:5000/v1
Additional Information
- {@link org.apache.juneau.rest.labels.ResourceDescription}
- {@link org.apache.juneau.rest.RestServlet#getConfig()}
8.15 - TumblrParserResource
The TumblrParserResource class shows examples of the following:
- Using {@link org.apache.juneau.rest.client.RestClient} to retrieve information from other REST resources.
- Using {@link org.apache.juneau.ObjectMap} and {@link org.apache.juneau.ObjectList} to produce
generalized POJO models.
Pointing a browser at a Tumblr blog name, such as ibmblr causes a REST call to be make to the Tumblr
blog and the results to be parsed:
@RestResource(
path="/tumblrParser",
messages="nls/TumblrParserResource",
properties={
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.TumblrParserResource)'}"),
@Property(name=HTMLDOC_title, value="Tumblr parser service"),
@Property(name=HTMLDOC_description, value="Specify a URL to a Tumblr blog and parse the results.")
}
)
public class TumblrParserResource extends Resource {
private static final long serialVersionUID = 1L;
@RestMethod(name="GET", path="/")
public String getInstructions() throws Exception {
return "Append the Tumblr blog name to the URL above (e.g. /tumblrParser/mytumblrblog)";
}
@RestMethod(name="GET", path="/{blogName}")
public ObjectList parseBlog(@Path String blogName) throws Exception {
ObjectList l = new ObjectList();
RestClient rc = new RestClient(JsonSerializer.class, JsonParser.class);
String site = "http://" + blogName + ".tumblr.com/api/read/json";
ObjectMap m = rc.doGet(site).getResponse(ObjectMap.class);
int postsTotal = m.getInt("posts-total");
for (int i = 0; i < postsTotal; i += 20) {
m = rc.doGet(site + "?start=" + i + "&num=20&transform=text").getResponse(ObjectMap.class);
ObjectList ol = m.getObjectList("posts");
for (int j = 0; j < ol.size(); j++) {
ObjectMap om = ol.getObjectMap(j);
String type = om.getString("type");
Entry e = new Entry();
e.date = om.getString("date");
if (type.equals("link"))
e.entry = new Link(om.getString("link-text"), om.getString("link-url"));
else if (type.equals("audio"))
e.entry = new ObjectMap().append("type","audio").append("audio-caption", om.getString("audio-caption"));
else if (type.equals("video"))
e.entry = new ObjectMap().append("type","video").append("video-caption", om.getString("video-caption"));
else if (type.equals("quote"))
e.entry = new ObjectMap().append("type","quote").append("quote-source", om.getString("quote-source")).append("quote-text", om.getString("quote-text"));
else if (type.equals("regular"))
e.entry = om.getString("regular-body");
else if (type.equals("photo"))
e.entry = new Img(om.getString("photo-url-250"));
else
e.entry = new ObjectMap().append("type", type);
l.add(e);
}
}
return l;
}
public static class Entry {
public String date;
public Object entry;
}
}
8.16 - PhotosResource
The PhotosResource class shows examples of the following:
- How to define custom serializers and parsers at the method level.
In this case, you define a serializer and parser to handle images.
The resource consists of a simple registry of images with integer IDs.
It is initialized with a single entry, which can be accessed through a GET request.
/**
* Sample resource that allows images to be uploaded and retrieved.
*/
@RestResource(
path="/photos",
messages="nls/PhotosResource",
properties={
@Property(name=HtmlDocSerializerContext.HTMLDOC_links, value="{options:'?method=OPTIONS'}"),
@Property(name=HtmlDocSerializerContext.HTMLDOC_title, value="Photo REST service"),
@Property(name=HtmlDocSerializerContext.HTMLDOC_description, value="Use a tool like Poster to upload and retrieve jpeg and png images.")
}
)
public class PhotosResource extends RestServletDefault {
// Our cache of photos
private Map<Integer,Photo> photos = new TreeMap<Integer,Photo>();
@Override /* Servlet */
public void init() {
try {
// Preload an image.
InputStream is = getClass().getResourceAsStream("averycutedog.jpg");
BufferedImage image = ImageIO.read(is);
Photo photo = new Photo(0, image);
photos.put(photo.id, photo);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
/** Bean class for storing photos */
public static class Photo {
private int id;
BufferedImage image;
Photo(int id, BufferedImage image) {
this.id = id;
this.image = image;
}
public URI getURI() throws URISyntaxException {
return new URI("photos/"+id);
}
public int getID() {
return id;
}
}
/** GET request handler for list of all photos */
@RestMethod(name="GET", path="/")
public Collection<Photo> getAllPhotos(RestRequest req, RestResponse res) throws Exception {
res.setProperty(HtmlDocSerializerContext.HTMLDOC_title, "Photo REST service");
res.setProperty(HtmlDocSerializerContext.HTMLDOC_description, "Use a tool like Poster to upload and retrieve jpeg and png images.");
return photos.values();
}
/** GET request handler for single photo */
@RestMethod(name="GET", path="/{id}", serializers=ImageSerializer.class)
public BufferedImage getPhoto(RestRequest req, @Path int id) throws Exception {
Photo p = photos.get(id);
if (p == null)
throw new RestException(SC_NOT_FOUND, "Photo not found");
return p.image;
}
/** PUT request handler */
@RestMethod(name="PUT", path="/{id}", parsers=ImageParser.class)
public String addPhoto(RestRequest req, @Path int id, @Body BufferedImage image) throws Exception {
photos.put(id, new Photo(id, image));
return "OK";
}
/** POST request handler */
@RestMethod(name="POST", path="/", parsers=ImageParser.class)
public Photo setPhoto(RestRequest req, @Body BufferedImage image) throws Exception {
int id = photos.size();
Photo p = new Photo(id, image);
photos.put(id, p);
return p;
}
/** DELETE request handler */
@RestMethod(name="DELETE", path="/{id}")
public String deletePhoto(RestRequest req, @Path int id) throws Exception {
Photo p = photos.remove(id);
if (p == null)
throw new RestException(SC_NOT_FOUND, "Photo not found");
return "OK";
}
/** OPTIONS request handler */
@RestMethod(name="OPTIONS", path="/*")
public Swagger getOptions(RestRequest req) {
return req.getSwagger();
}
/** Serializer for converting images to byte streams */
@Produces("image/png,image/jpeg")
public static class ImageSerializer extends OutputStreamSerializer {
@Override
public void serialize(Object o, OutputStream out, SerializerSession session) throws IOException, SerializeException {
RenderedImage image = (RenderedImage)o;
String mediaType = ctx.getMediaType();
ImageIO.write(image, mediaType.substring(mediaType.indexOf('/')+1), out);
}
}
/** Parser for converting byte streams to images */
@Consumes("image/png,image/jpeg")
public static class ImageParser extends InputStreamParser {
@Override
public <T> T parse(InputStream in, ClassMeta<T> type, ParserSession session) throws ParseException, IOException {
BufferedImage image = ImageIO.read(in);
return (T)image;
}
}
}
8.17 - JsonSchemaResource
The JsonSchemaResource class shows examples of the following:
The resource consists of a pre-initialized {@link org.apache.juneau.dto.jsonschema.Schema} object.
Pointing a browser to the resource shows the following:
For true JSON-Schema, you need to specify the header Accept: text/json:
/**
* Sample resource that shows how to serialize JSON-Schema documents.
*/
@RestResource(
path="/jsonSchema",
messages="nls/JsonSchemaResource",
properties={
@Property(name=HTMLDOC_title, value="Sample JSON-Schema document"),
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.JsonSchemaResource)'}")
}
)
public class JsonSchemaResource extends ResourceJena {
private static final long serialVersionUID = 1L;
private Schema schema; // The schema document
@Override /* Servlet */
public void init() {
try {
schema = new Schema()
.setId("http://example.com/sample-schema#")
.setSchemaVersionUri("http://json-schema.org/draft-04/schema#")
.setTitle("Example Schema")
.setType(JsonType.OBJECT)
.addProperties(
new SchemaProperty("firstName", JsonType.STRING),
new SchemaProperty("lastName", JsonType.STRING),
new SchemaProperty("age", JsonType.INTEGER)
.setDescription("Age in years")
.setMinimum(0)
)
.addRequired("firstName", "lastName");
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/** GET request handler */
@RestMethod(name="GET", path="/")
public Schema getSchema() throws Exception {
return schema;
}
/**
* PUT request handler.
* Replaces the schema document with the specified content, and then mirrors it as the response.
*/
@RestMethod(name="PUT", path="/")
public Schema setSchema(@Body Schema schema) throws Exception {
this.schema = schema;
return schema;
}
}
8.18 - SqlQueryResource
The SqlQueryResource class shows examples of the following:
- Using the {@link org.apache.juneau.dto.ResultSetList} to serialize database result sets.
- Using {@link org.apache.juneau.rest.RestServlet#getConfig()} to access config properties.
- Using form entry beans.
The example uses embedded Derby to create a database whose name is defined in the external configuration files.
Pointing a browser to the resource shows the following:
Running a query results in the following output:
/**
* Sample resource that shows how Juneau can serialize ResultSets.
*/
@RestResource(
path="/sqlQuery",
messages="nls/SqlQueryResource",
properties={
@Property(name=HTMLDOC_title, value="SQL query service"),
@Property(name=HTMLDOC_description, value="Executes queries against the local derby '$C{SqlQueryResource/connectionUrl}' database"),
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'$R{servletURI}?method=OPTIONS',source:'$R{servletParentURI}/source?classes=(org.apache.juneau.rest.samples.SqlQueryResource)'}"),
}
)
public class SqlQueryResource extends Resource {
private static final long serialVersionUID = 1L;
private ConfigFile cf = getConfig();
private String driver = cf.getString("SqlQueryResource/driver");
private String connectionUrl = cf.getString("SqlQueryResource/connectionUrl");
private boolean
allowUpdates = cf.getBoolean("SqlQueryResource/allowUpdates", false),
allowTempUpdates = cf.getBoolean("SqlQueryResource/allowTempUpdates", false),
includeRowNums = cf.getBoolean("SqlQueryResource/includeRowNums", false);
@Override /* Servlet */
public void init() {
try {
Class.forName(driver).newInstance();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/** GET request handler - Display the query entry page. */
@RestMethod(name="GET", path="/")
public ReaderResource doGet(RestRequest req) throws IOException {
return req.getReaderResource("SqlQueryResource.html", true);
}
/** POST request handler - Execute the query. */
@RestMethod(name="POST", path="/")
public List<Object> doPost(@Body PostInput in) throws Exception {
List<Object> results = new LinkedList<Object>();
// Don't try to submit empty input.
if (StringUtils.isEmpty(in.sql))
return results;
if (in.pos < 1 || in.pos > 10000)
throw new RestException(SC_BAD_REQUEST, "Invalid value for position. Must be between 1-10000");
if (in.limit < 1 || in.limit > 10000)
throw new RestException(SC_BAD_REQUEST, "Invalid value for limit. Must be between 1-10000");
// Create a connection and statement.
// If these fails, let the exception transform up as a 500 error.
Connection c = DriverManager.getConnection(connectionUrl);
c.setAutoCommit(false);
Statement st = c.createStatement();
String sql = null;
try {
for (String s : in.sql.split(";")) {
sql = s.trim();
if (! sql.isEmpty()) {
Object o = null;
if (allowUpdates || (allowTempUpdates && ! sql.matches("(?:i)commit.*"))) {
if (st.execute(sql)) {
ResultSet rs = st.getResultSet();
o = new ResultSetList(rs, in.pos, in.limit, includeRowNums);
} else {
o = st.getUpdateCount();
}
} else {
ResultSet rs = st.executeQuery(sql);
o = new ResultSetList(rs, in.pos, in.limit, includeRowNums);
}
results.add(o);
}
}
if (allowUpdates)
c.commit();
else if (allowTempUpdates)
c.rollback();
} catch (SQLException e) {
c.rollback();
throw new RestException(SC_BAD_REQUEST, "Invalid query: {0}", sql).initCause(e);
} finally {
c.close();
}
return results;
}
/** The parsed form post */
public static class PostInput {
public String sql;
public int pos = 1, limit = 100;
}
}
<html>
<head>
<style type='text/css'>
@import '$R{servletURI}/style.css';
</style>
<script>
// Quick and dirty function to allow tabs in textarea.
function checkTab(e) {
if (e.keyCode == 9) {
var t = e.target;
var ss = t.selectionStart, se = t.selectionEnd;
t.value = t.value.slice(0,ss).concat('\t').concat(t.value.slice(ss,t.value.length));
e.preventDefault();
}
}
// Load results from IFrame into this document.
function loadResults(b) {
var doc = b.contentDocument || b.contentWindow.document;
var data = doc.getElementById('data') || doc.getElementsByTagName('body')[0];
document.getElementById('results').innerHTML = data.innerHTML;
}
</script>
</head>
<body>
<h3 class='title'>SQL Query API</h3>
<div class='data'>
<form action='sqlQuery' method='POST' target='buf'>
<table>
<tr>
<th>Position (1-10000):</th>
<td><input name='pos' type='number' value='1'></td>
<th>Limit (1-10000):</th>
<td><input name='limit' type='number' value='100'></td>
<td><button type='submit'>Submit</button><button type='reset'>Reset</button></td>
</tr>
<tr>
<td colspan="5">
<textarea name='sql' style='width:100%;height:200px;font-family:Courier;font-size:9pt;' onkeydown='checkTab(event)'></textarea>
</td>
</tr>
</table>
</form>
<br>
<div id='results'>
</div>
</div>
<iframe name='buf' style='display:none' onload="parent.loadResults(this)"></iframe>
</body>
</html>
#================================================================================
# SqlQueryResource properties
#================================================================================
[SqlQueryResource]
driver = org.apache.derby.jdbc.EmbeddedDriver
connectionUrl = jdbc:derby:C:/testDB;create=true
allowTempUpdates = true
includeRowNums = true
8.19 - ConfigResource
The {@link org.apache.juneau.microservice.resources.ConfigResource} class is a reusable resource
defined in the {@link org.apache.juneau.microservice} API.
It provides a REST interface for reading and altering the microservice config file.
Pointing a browser to the resource shows the following:
An edit page is provided for altering the raw config file:
The {@link org.apache.juneau.ini.ConfigFile} class is a serializable POJO, which makes the resource
relatively straighforward to implement.
/**
* Shows contents of the microservice configuration file.
*/
@RestResource(
path="/config",
title="Configuration",
description="Contents of configuration file.",
properties={
@Property(name=HTMLDOC_links, value="{up:'$R{requestParentURI}',options:'$R{servletURI}?method=OPTIONS',edit:'$R{servletURI}/edit'}"),
}
)
public class ConfigResource extends Resource {
private static final long serialVersionUID = 1L;
/**
* [GET /] - Show contents of config file.
*
* @return The config file.
* @throws Exception
*/
@RestMethod(name="GET", path="/", description="Show contents of config file.")
public ConfigFile getConfigContents() throws Exception {
return getConfig();
}
/**
* [GET /edit] - Show config file edit page.
*
* @param req The HTTP request.
* @return The config file as a reader resource.
* @throws Exception
*/
@RestMethod(name="GET", path="/edit", description="Show config file edit page.")
public ReaderResource getConfigEditPage(RestRequest req) throws Exception {
// Note that you don't want variables in the config file to be resolved,
// so you need to escape any $ characters that you see.
req.setAttribute("contents", getConfig().toString().replaceAll("\\$", "\\\\\\$"));
return req.getReaderResource("ConfigEdit.html", true);
}
/**
* [GET /{section}] - Show config file section.
*
* @param section The section name.
* @return The config file section.
* @throws Exception
*/
@RestMethod(name="GET", path="/{section}",
description="Show config file section.",
parameters={
@Parameter(in="path", name="section", description="Section name.")
}
)
public ObjectMap getConfigSection(@Path("section") String section) throws Exception {
return getSection(section);
}
/**
* [GET /{section}/{key}] - Show config file entry.
*
* @param section The section name.
* @param key The section key.
* @return The value of the config file entry.
* @throws Exception
*/
@RestMethod(name="GET", path="/{section}/{key}",
description="Show config file entry.",
parameters={
@Parameter(in="path", name="section", description="Section name."),
@Parameter(in="path", name="key", description="Entry name.")
}
)
public String getConfigEntry(@Path("section") String section, @Path("key") String key) throws Exception {
return getSection(section).getString(key);
}
/**
* [POST /] - Sets contents of config file from a FORM post.
*
* @param contents The new contents of the config file.
* @return The new config file contents.
* @throws Exception
*/
@RestMethod(name="POST", path="/",
description="Sets contents of config file from a FORM post.",
parameters={
@Parameter(in="formData", name="contents", description="New contents in INI file format.")
}
)
public ConfigFile setConfigContentsFormPost(@FormData("contents") String contents) throws Exception {
return setConfigContents(new StringReader(contents));
}
/**
* [PUT /] - Sets contents of config file.
*
* @param contents The new contents of the config file.
* @return The new config file contents.
* @throws Exception
*/
@RestMethod(name="PUT", path="/",
description="Sets contents of config file.",
parameters={
@Parameter(in="body", description="New contents in INI file format.")
}
)
public ConfigFile setConfigContents(@Body Reader contents) throws Exception {
ConfigFile cf2 = ConfigMgr.DEFAULT.create().load(contents);
return getConfig().merge(cf2).save();
}
/**
* [PUT /{section}] - Add or overwrite a config file section.
*
* @param section The section name.
* @param contents The new contents of the config file section.
* @return The new section.
* @throws Exception
*/
@RestMethod(name="PUT", path="/{section}",
description="Add or overwrite a config file section.",
parameters={
@Parameter(in="path", name="section", description="Section name."),
@Parameter(in="body", description="New contents for section as a simple map with string keys and values.")
}
)
public ObjectMap setConfigSection(@Path("section") String section, @Body Map<String,String> contents) throws Exception {
getConfig().setSection(section, contents);
return getSection(section);
}
/**
* [PUT /{section}/{key}] - Add or overwrite a config file entry.
*
* @param section The section name.
* @param key The section key.
* @param value The new value.
* @return The new value.
* @throws Exception
*/
@RestMethod(name="PUT", path="/{section}/{key}",
description="Add or overwrite a config file entry.",
parameters={
@Parameter(in="path", name="section", description="Section name."),
@Parameter(in="path", name="key", description="Entry name."),
@Parameter(in="body", description="New value as a string.")
}
)
public String setConfigSection(@Path("section") String section, @Path("key") String key, @Body String value) throws Exception {
getConfig().put(section, key, value, false);
return getSection(section).getString(key);
}
private ObjectMap getSection(String name) {
ObjectMap m = getConfig().getSectionMap(name);
if (m == null)
throw new RestException(SC_NOT_FOUND, "Section not found.");
return m;
}
}
<html>
<head>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'>
<style type='text/css'>
@import '$R{servletURI}/style.css';
</style>
</head>
<body>
<h3 class='title'>$R{servletTitle}</h3>
<h5 class='description'>Edit config file</h5>
<p class='links'><a href='$R{requestParentURI}'>up</a> - <a href='$R{servletURI}?method=OPTIONS'>options</a></p>
<form id='form' action='$R{servletURI}' method='POST' enctype='application/x-www-form-urlencoded'>
<div class='data'>
<table>
<tr><td colspan='2' align='right'><button type='submit'>Submit</button><button type='reset'>Reset</button></td></tr>
<tr><th colspan='2'>Contents</th></tr>
<tr><td colspan='2'><textarea name='contents' rows='40' cols='120' style='white-space: pre; word-wrap: normal; overflow-x: scroll;'>$SA{contents}</textarea></td></tr>
</table>
</div>
</form>
</body>
</html>
8.20 - LogsResource
The {@link org.apache.juneau.microservice.resources.LogsResource} class is a reusable resource
defined in the {@link org.apache.juneau.microservice} API.
It provides a REST interface for the log files generated by the microservice.
Pointing a browser to the resource shows the following:
The highlighted links show the contents of the log file with color highlighting:
The parsed links parse the log file and return the entries as serialized POJOs:
What's new in each release
6.1.0 (TBD)
6.0.1 (Jan 3, 2017)
6.0.0 (Oct 3, 2016)
5.2.0.1 (Mar 23, 2016)
5.2.0.0 (Dec 30, 2015)
5.1.0.20 (Sept 5, 2015)
5.1.0.19 (Aug 15, 2015)
5.1.0.18 (Aug 5, 2015)
5.1.0.17 (Aug 3, 2015)
5.1.0.16 (June 28, 2015)
5.1.0.15 (May 24, 2015)
5.1.0.14 (May 10, 2015)
5.1.0.13 (Apr 24, 2015)
5.1.0.12 (Mar 28, 2015)
5.1.0.11 (Feb 14, 2015)
5.1.0.10 (Dec 23, 2014)
5.1.0.9 (Dec 1, 2014)
5.1.0.8 (Oct 25, 2014)
5.1.0.7 (Oct 5, 2014)
5.1.0.6 (Sept 21, 2014)
5.1.0.5 (Sept 1, 2014)
5.1.0.4 (Aug 25, 2014)
5.1.0.3 (Jun 28, 2014)
5.1.0.2 (Apr 27, 2014)
5.1.0.1 (Jan 25, 2014)
5.1.0.0 (Jan 18, 2014)
5.0.0.36 (Dec 18, 2013)
5.0.0.35 (Nov 26, 2013)
5.0.0.34 (Nov 10, 2013)
5.0.0.33 (Oct 20, 2013)
5.0.0.32 (Oct 5, 2013)
5.0.0.31 (Aug 9, 2013)
5.0.0.30 (Aug 8, 2013)
5.0.0.29 (Aug 2, 2013)
5.0.0.28 (July 9, 2013)
5.0.0.27 (July 7, 2013)
5.0.0.26 (Jun 5, 2013)
5.0.0.25 (May 11, 2013)
5.0.0.24 (May 9, 2013)
5.0.0.23 (Apr 14, 2013)
5.0.0.22 (Apr 12, 2013)
5.0.0.21 (Apr 9, 2013)
5.0.0.20 (Apr 7, 2013)
5.0.0.19 (Apr 1, 2013)
5.0.0.18 (Mar 27, 2013)
5.0.0.17 (Mar 25, 2013)
5.0.0.16 (Mar 25, 2013)
5.0.0.15 (Mar 24, 2013)
5.0.0.14 (Mar 23, 2013)
5.0.0.13 (Mar 14, 2013)
5.0.0.12 (Mar 10, 2013)
5.0.0.11 (Mar 8, 2013)
5.0.0.10 (Mar 7, 2013)
5.0.0.9 (Feb 26, 2013)
5.0.0.8 (Jan 30, 2013)
5.0.0.7 (Jan 20, 2013)
5.0.0.6 (Oct 30, 2012)
5.0.0.5 (Oct 29, 2012)
5.0.0.4 (Oct 7, 2012)
5.0.0.3 (Oct 3, 2012)
5.0.0.2 (Sept 28, 2012)
5.0.0.1 (Jun 14, 2012)
5.0.0.0 (Jun 11, 2012)
6.1.0 (TBD)
Juneau 6.1.0 is a major update.
In particular, this release cleans up the {@link org.apache.juneau.BeanContext} API to match
the {@link org.apache.juneau.ContextFactory}/{@link org.apache.juneau.Context}/{@link org.apache.juneau.Session} paradigm
previously used in the serializer and parser APIs.
It also makes several improvements to the HTML and XML serialization support and introduces HTML5 DTO beans.
org.apache.juneau
- Improvements to XML serialization support.
- New supported XML formats:
- {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format can now be applied to bean classes to have all bean properties serialized
as attributes instead of elements by default.
- {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENT} format can now be applied to bean properties to override the {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS}
setting above on specific bean properties.
- New {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENTS} format can be applied to a bean property of type array/Collection to represent the child elements.
- New {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED} format can be applied to a bean property of type array/Collection to represent mixed content (text + child elements).
- New {@link org.apache.juneau.xml.annotation.XmlFormat#MIXED_PWS} format. Identical to MIXED except preserves whitespace.
- New {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT} format can be applied to a bean property of a single object to represent a text node as a child.
- New {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT_PWS} format. Identical to TEXT except preserves whitespace.
- New {@link org.apache.juneau.xml.annotation.XmlFormat#XMLTEXT} format that's identical to {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT} except
XML content is not escaped and serialized directly as the child content. The parser will reconvert this to the original XML text during parsing.
- New support methodology and other improvements to {@link org.apache.juneau.xml} documentation.
- Eliminated unnecessary <string> elements.
- Eliminated
XmlContentHandler
class.
- Parser efficiency improvements through reuse of string builders.
- Reworked and simplified the default XML serializers. The {@link org.apache.juneau.xml.XmlSerializer#DEFAULT} serializer now has namespaces disabled,
and {@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS} has namespaces enabled. The 'XML-JSON' serializers have been eliminated.
- Eliminated the
addJsonTypeAttrs
and addJsonStringTypeAttrs
settings.
- Namespace support is now disabled by default.
- Significant modifications and improvements to HTML serialization support.
- Parser converted from
XMLEventReader
-based to XMLStreamReader
.
- Eliminated many unnecessary type tags and <string> elements and improved the readable layout.
The new format is much leaner.
- New exhaustive support methodology section added to {@link org.apache.juneau.html} documentation.
- New HTML5 DTO support: {@link org.apache.juneau.dto.html5}.
- {@link org.apache.juneau.BeanContext} class split into separate {@link org.apache.juneau.BeanContext} and {@link org.apache.juneau.BeanSession} classes.
- Session object meant to be single-use that can be discarded after use and contains session-level object cache and overridable Locale and TimeZone.
- {@link org.apache.juneau.serializer.SerializerContext} and {@link org.apache.juneau.parser.ParserContext}
now extend directly from {@link org.apache.juneau.BeanContext}.
- {@link org.apache.juneau.serializer.SerializerSession} and {@link org.apache.juneau.parser.ParserSession}
now extend directly from {@link org.apache.juneau.BeanSession}.
- New settings in {@link org.apache.juneau.BeanContext}:
- {@link org.apache.juneau.BeanContext#BEAN_debug} - Debug setting. Replaces individual debug properties in the serializer and parser contexts.
- {@link org.apache.juneau.BeanContext#BEAN_locale} - Specifies a default locale at the context level.
- {@link org.apache.juneau.BeanContext#BEAN_timeZone} - Specifies a default timezone at the context level.
- {@link org.apache.juneau.BeanContext#BEAN_mediaType} - Specifies a default media type at the context level.
- Improvements to Parser class:
- Simplified the parse methods (e.g.
parseMap()
, parseCollection()
)
by replacing them with two simple methods:
- {@link org.apache.juneau.parser.Parser#parse(Object,Class)} - Normal method.
- {@link org.apache.juneau.parser.Parser#parse(Object,Type,Type...)} - Method for parsing into parameterized maps and collections.
Using these methods, you can construct arbitrarily complex objects consisting of maps and collections.
You could do this before, but it required constructing a ClassMeta
object.
For example:
// Old way:
ClassMeta<?> cm = parser.getMapClassMeta(
HashMap.class,
String.class,
parser.getCollectionClassMeta(
LinkedList.class,
MyBean.class
)
);
Map<String,List<MyBean>> map = (Map<String,List<MyBean>>)parser.parse(input, cm);
// New way:
Map<String,List<MyBean>> map = parser.parse(input, HashMap.class, String.class, LinkedList.class, MyBean.class);
- Arbitrarily-complex parameterized maps and collections can now be parsed without the need for creating intermediate
ClassMeta
objects.
- No need for casting anymore if you were using the old
parseMap()
and parseCollection()
methods!
- Changes allow me to eliminate
BeanContext.normalizeClassMeta()
method.
- Convenience methods added for setting parser properties:
// Old way:
new JsonParser().setProperty(PARSER_strict, true).setProperty(BEAN_locale, mylocale);
// New way:
new JsonParser().setStrict(true).setLocale(mylocale);
- Improvements to Serializer class:
- Simplified {@link org.apache.juneau.transform.PojoSwap} class. Now just two methods:
- {@link org.apache.juneau.transform.PojoSwap#swap(BeanSession,Object)}
- {@link org.apache.juneau.transform.PojoSwap#unswap(BeanSession,Object,ClassMeta)}
- General code improvements made to {@link org.apache.juneau.ClassMeta} class.
- All fields are now final which should improve overall performance.
- Replaced support for
toObjectMap()
and fromObjectMap()/T(ObjectMap)
methods with
generalized swap(BeanSession)
/unswap(BeanSession,X)
/T(BeanSession,X)
methods.
See new section Swap methods for information.
- Session-level media type now available through {@link org.apache.juneau.BeanSession#getMediaType()} method.
Allows for swaps and serializer/parser behavior to be tailored to individual media types.
- Several new {@link java.util.Calendar} and {@link java.util.Date} swaps:
- {@link org.apache.juneau.transforms.CalendarSwap.ToString},{@link org.apache.juneau.transforms.DateSwap.ToString} - To {@link java.lang.String Strings} using the {@code Date.toString()} method.
- {@link org.apache.juneau.transforms.CalendarSwap.ISO8601DT},{@link org.apache.juneau.transforms.DateSwap.ISO8601DT} - To ISO8601 date-time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.ISO8601DTZ},{@link org.apache.juneau.transforms.DateSwap.ISO8601DTZ} - Same as ISO8601DT, except always serializes in GMT.
- {@link org.apache.juneau.transforms.CalendarSwap.ISO8601DTP},{@link org.apache.juneau.transforms.DateSwap.ISO8601DTP} - Same as ISO8601DT except with millisecond precision.
- {@link org.apache.juneau.transforms.CalendarSwap.ISO8601DTPZ},{@link org.apache.juneau.transforms.DateSwap.ISO8601DTPZ} - Same as ISO8601DTZ except with millisecond precision.
- {@link org.apache.juneau.transforms.CalendarSwap.RFC2822DT},{@link org.apache.juneau.transforms.DateSwap.RFC2822DT} - To RFC2822 date-time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.RFC2822DTZ},{@link org.apache.juneau.transforms.DateSwap.RFC2822DTZ} - Same as RFC2822DT, except always serializes in GMT.
- {@link org.apache.juneau.transforms.CalendarSwap.RFC2822D},{@link org.apache.juneau.transforms.DateSwap.RFC2822D} - To RFC2822 date strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateTimeSimple},{@link org.apache.juneau.transforms.DateSwap.DateTimeSimple} - To simple "yyyy/MM/dd HH:mm:ss" date-time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateSimple},{@link org.apache.juneau.transforms.DateSwap.DateSimple} - To simple "yyyy/MM/dd" date strings.
- {@link org.apache.juneau.transforms.CalendarSwap.TimeSimple},{@link org.apache.juneau.transforms.DateSwap.TimeSimple} - To simple "HH:mm:ss" time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateFull},{@link org.apache.juneau.transforms.DateSwap.DateFull} - To {@link java.text.DateFormat#FULL} date strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateLong},{@link org.apache.juneau.transforms.DateSwap.DateLong} - To {@link java.text.DateFormat#LONG} date strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateMedium},{@link org.apache.juneau.transforms.DateSwap.DateMedium} - To {@link java.text.DateFormat#MEDIUM} date strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateShort},{@link org.apache.juneau.transforms.DateSwap.DateShort} - To {@link java.text.DateFormat#SHORT} date strings.
- {@link org.apache.juneau.transforms.CalendarSwap.TimeFull},{@link org.apache.juneau.transforms.DateSwap.TimeFull} - To {@link java.text.DateFormat#FULL} time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.TimeLong},{@link org.apache.juneau.transforms.DateSwap.TimeLong} - To {@link java.text.DateFormat#LONG} time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.TimeMedium},{@link org.apache.juneau.transforms.DateSwap.TimeMedium} - To {@link java.text.DateFormat#MEDIUM} time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.TimeShort},{@link org.apache.juneau.transforms.DateSwap.TimeShort} - To {@link java.text.DateFormat#SHORT} time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateTimeFull},{@link org.apache.juneau.transforms.DateSwap.DateTimeFull} - To {@link java.text.DateFormat#FULL} date-time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateTimeLong},{@link org.apache.juneau.transforms.DateSwap.DateTimeLong} - To {@link java.text.DateFormat#LONG} date-time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateTimeMedium},{@link org.apache.juneau.transforms.DateSwap.DateTimeMedium} - To {@link java.text.DateFormat#MEDIUM} date-time strings.
- {@link org.apache.juneau.transforms.CalendarSwap.DateTimeShort},{@link org.apache.juneau.transforms.DateSwap.DateTimeShort} - To {@link java.text.DateFormat#SHORT} date-time strings.
- New method {@link org.apache.juneau.serializer.SerializerGroup#getSerializerMatch(String)} that returns the matched serializer and media type.
- New method {@link org.apache.juneau.parser.ParserGroup#getParserMatch(String)} that returns the matched parser and media type.
- New method {@link org.apache.juneau.encoders.EncoderGroup#getEncoderMatch(String)} that returns the matched encoder and encoding.
- General improvements to Bean Dictionary support.
- New {@link org.apache.juneau.BeanDictionaryList} class can be used for defining reusable sets of bean dictionaries consisting
of classes annotated with {@link org.apache.juneau.annotation.Bean#typeName()}.
- New {@link org.apache.juneau.BeanDictionaryMap} class can be used for defining reusable sets of bean dictionaries consisting
of classes not annotated with {@link org.apache.juneau.annotation.Bean#typeName()}.
- New {@link org.apache.juneau.annotation.Bean#beanDictionary()} annotation.
- Removed restriction on getters and setters to be prefixed with "getX/setX/isX" if a {@link org.apache.juneau.annotation.BeanProperty#name()} annotation is used.
- Improvements to ATOM DTO:
- New {@link org.apache.juneau.dto.atom.AtomBuilder} class.
- New setter method names for a better fluent design.
- Updated {@link org.apache.juneau.dto.atom} documentation.
- New {@link org.apache.juneau.transform.MapSwap} and {@link org.apache.juneau.transform.StringSwap} classes.
- New {@link org.apache.juneau.serializer.WriterSerializer#println(Object)} method. Useful for debugging purposes.
- New {@link org.apache.juneau.BeanContext#getClassMeta(Type,Type...)} and {@link org.apache.juneau.BeanSession#getClassMeta(Type,Type...)}
methods for retrieving Map and Collection class metas.
Replaces the various
getMapClassMeta()
/getCollectionClassMeta()
methods.
- New section added to this document: Juneau Data Transfer Objects (org.apache.juneau.dto)
- Modified the UON specification to work with mixed content.
- The new specification is considerably cleaner and eliminates the need for separate normal/simple modes.
It also allows for arbitrary whitespace to be added to the output without any confusion.
- Eliminated the
UonParser.DEFAULT_WS_AWARE
and UrlEncodingParser.DEFAULT_WS_AWARE
parsers.
The normal {@link org.apache.juneau.urlencoding.UonParser#DEFAULT} and {@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT} parsers will now handle whitespace.
- Eliminated the
UonParserContext.UON_whitespaceAware
configuration setting.
- Eliminated the
UonSerializer.DEFAULT_SIMPLE
, UonSerializer.DEFAULT_SIMPLE_ENCODING
and UrlEncodingSerializer.DEFAULT_SIMPLE
serializers since there is no separate simple mode anymore.
- Eliminated the
UonParserContext.UON_simpleMode
configuration setting.
- Added new {@link org.apache.juneau.serializer.OutputStreamSerializer#serializeToHex(Object)} method.
Useful mostly for testing purposes.
Equivalently, the {@link org.apache.juneau.parser.InputStreamParser#parse(Object,Class)} method can now
read the output from this method.
- Eliminated the
@Bean(subTypeProperty)
and @Bean(subTypes)
annotations
and replaced them with the ability to define subtypes using the existing {@link org.apache.juneau.annotation.Bean#beanDictionary() @Bean.beanDictionary()}
annotation on parent classes and interfaces.
This has the added benefit of simplifying the overall code.
- The {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_addBeanTypeProperties} setting is now enabled by default.
- Combined the
SERIALIZER_addIndentation
/JSON_addWhitespace
/UON_addWhitespace
properties into a single {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_useWhitespace} setting.
org.apache.juneau.rest
- {@link org.apache.juneau.rest.RestRequest} now passes locale and timezone to serializers/parsers/transforms.
- New {@link org.apache.juneau.rest.RestRequest#getTimeZone()} method.
- Standardized the following methods in {@link org.apache.juneau.rest.RestRequest} to remove dependency on
ClassMeta
objects and eliminate the need for casts:
- {@link org.apache.juneau.rest.RestRequest#getHeader(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getHeader(String,Object,Class)}
- {@link org.apache.juneau.rest.RestRequest#getHeader(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Object,Class)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Object,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameters(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameters(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameter(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameter(String,Object,Class)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameters(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameter(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameters(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getPathParameter(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getPathParameter(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getBody(Class)}
- {@link org.apache.juneau.rest.RestRequest#getBody(Type,Type...)}
- Fixed issue where whitespace was not added to UON/URL-Encoding output when
&plainText=true
specified.
6.0.1 (Jan 3, 2017)
Juneau 6.0.1 is a minor update.
org.apache.juneau
- General improvements to JSON parser.
- Several fixes to handle obscure edge cases.
- New properties in {@link org.apache.juneau.parser.ParserContext}.
- {@link org.apache.juneau.parser.ParserContext#PARSER_strict}
- {@link org.apache.juneau.parser.ParserContext#PARSER_inputStreamCharset}
- {@link org.apache.juneau.parser.ParserContext#PARSER_fileCharset}
- Removed
JsonParserContext.JSON_strictMode
. Replaced by PARSER_strict
.
byte[]
arrays can now be passed to {@link org.apache.juneau.parser.Parser#parse(Object,Class)} for reader-based parsers.
6.0.0 (Oct 3, 2016)
Juneau 6.0.0 is a major update.
The major change is rebranding from "Juno" to "Juneau" in preparation for donation to the Apache Foundation.
org.apache.juneau
- Major changes around how serializer and parser class properties are defined to improve performance
and concurrency.
- New {@link org.apache.juneau.ContextFactory} class - Used for creating context objects.
- New {@link org.apache.juneau.Context} class - Read-only configurations for serializers and parsers.
- New {@link org.apache.juneau.Session} class - One-time use objects used by serializers and parsers.
- All context context properties can now also be specified via system properties.
- Refactored serializer and parser APIs for more consistency between stream-based and character-based serializers
and parsers.
- More consistent handling of exceptions.
- More consistent method declarations.
- Refactored var resolver API and added them to a new package - {@link org.apache.juneau.svl}.
- Support for stream-based variables - {@link org.apache.juneau.svl.StreamedVar}.
- Added support for context and session objects.
- Eliminated "_class" properties and replaced them with "_type" properties.
The class properties were a little-used feature where we would serialize fully-qualified class names when the class type could not be inferred through reflection.
It's been replaced with bean type names and bean dictionaries.
Instead of class names, we serialize "_type" properties whose name is the type name defined on the bean being serialized.
The parsers use a 'dictionary' of bean classes to resolve those names to actual bean classes.
The following features were added to enable this support:
- {@link org.apache.juneau.annotation.Bean#typeName() @Bean.typeName()} - Annotation that defines an identifying name for a bean class.
- {@link org.apache.juneau.transform.BeanFilterBuilder#setTypeName(String)} - Programmatic equivalent to annotation above.
- {@link org.apache.juneau.BeanContext#BEAN_beanDictionary} - List of bean classes that make up the bean dictionary for lookup
during parsing.
- {@link org.apache.juneau.BeanContext#BEAN_beanTypePropertyName} - The overridable type property name. Default is "_type".
- {@link org.apache.juneau.annotation.BeanProperty#beanDictionary() @BeanProperty.beanDictionary()} - Define a type dictionary
for a particular bean property value. This overrides the value specified using {@link org.apache.juneau.BeanContext#BEAN_beanDictionary}.
- {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_addBeanTypeProperties} - Controls whether type properties are serialized.
In addition, the {@link org.apache.juneau.annotation.Bean#typeName() @Bean.typeName()} value replaces the @Xml.name()
annotation, and the
"type" and "_class" attributes in the XML and HTML serializers have been standardized on a single "_type" attribute.
- Refactor bean filter support to use {@link org.apache.juneau.transform.BeanFilterBuilder} class.
Allows the
BeanFilter
class to use final fields.
- {@link org.apache.juneau.msgpack MessagePack} support.
- Serializers can now serialize directly to {@link java.io.File Files}.
See {@link org.apache.juneau.serializer.Serializer#serialize(Object,Object)}
- Parsers can now parse directly from {@link java.io.File Files} and other types.
See {@link org.apache.juneau.parser.Parser#parse(Object,ClassMeta)}
- Parsers will automatically covert numeric input to POJOs that have numeric constructors (e.g.
java.util.Date
).
- Renamed 'Filters' to 'BeanFilters' and 'PojoSwaps'. Filters is just too overloaded a term.
- Internal utility classes moved to a new
org.apache.juneau.internal
package.
These internal utility classes are not meant for consumption outside the Juneau codebase.
- New methods on {@link org.apache.juneau.parser.Parser}:
org.apache.juneau.parser.Parser.createSession(ObjectMap,Method,Object)
Parser.getMediaRanges()
- New methods on {@link org.apache.juneau.serializer.Serializer}:
org.apache.juneau.serializer.Serializer.createSession(ObjectMap,Method)
Serializer.getMediaRanges()
- New {@link org.apache.juneau.annotation.Bean#sort() @Bean.sort()} annotation.
- Added @Bean.properties annotations on various DTO beans to make the ordering consistent
between IBM and Oracle JVMs.
IBM JVMs maintain the order of methods in a class, whereas Oracle JVMs do not.
- Serializers and parsers now automatically convert {@link java.lang.Class} objects to readable names via {@link org.apache.juneau.internal.ClassUtils#getReadableClassName(Class)}.
- Eliminated the
ClassFilter
class since it's no longer needed.
- Code and concurrency improvements to {@link org.apache.juneau.serializer.SerializerGroup} and {@link org.apache.juneau.parser.ParserGroup}.
- Various enhancements to
BeanContext.convertToType(Object,Class)
.
- New properties on {@link org.apache.juneau.html.HtmlSerializer}:
- {@link org.apache.juneau.html.HtmlSerializerContext#HTML_detectLinksInStrings} - Automatically detect hyperlinks in strings.
- {@link org.apache.juneau.html.HtmlSerializerContext#HTML_lookForLabelParameters} - Specify anchor text by appending
&label=MyLabel
to URL.
- {@link org.apache.juneau.html.HtmlSerializerContext#HTML_labelParameter} - Specify what URL parameter to use as the anchor text label.
- New {@link org.apache.juneau.html.HtmlSerializerContext#URI_ANCHOR} option for {@link org.apache.juneau.html.HtmlSerializerContext#HTML_uriAnchorText}.
- Removed generics from {@link org.apache.juneau.BeanPropertyMeta}.
- Introduced new classes to eliminate the references to language-specific metadata in the core metadata classes:
- {@link org.apache.juneau.ClassMetaExtended} / {@link org.apache.juneau.ClassMeta#getExtendedMeta(Class)}
- {@link org.apache.juneau.BeanMetaExtended} / {@link org.apache.juneau.BeanMeta#getExtendedMeta(Class)}
- {@link org.apache.juneau.BeanPropertyMetaExtended} / {@link org.apache.juneau.BeanPropertyMeta#getExtendedMeta(Class)}
- Renamed
@Transform
annotation to {@link org.apache.juneau.annotation.Pojo @Pojo} so that it can be used for various POJO-related behavior, not just associating transforms.
- Introduced {@link org.apache.juneau.dto.swagger Swagger DTOs}.
org.apache.juneau.rest
- OPTIONS pages replaced with Swagger documents.
Lots of changes related to supporting Swagger.
- Annotation name changes to conform to Swagger specs: @Attr->@Path, @QParam->@Query, @Param->@FormData, @Content->@Body
- Eliminated
ResourceOptions
and related code.
- New annotations and related methods:
- {@link org.apache.juneau.rest.annotation.RestResource#title() @RestResource.title()} / {@link org.apache.juneau.rest.RestServlet#getTitle(RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestResource#description() @RestResource.description()} / {@link org.apache.juneau.rest.RestServlet#getDescription(RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestResource#termsOfService() @RestResource.termsOfService()} / {@link org.apache.juneau.rest.RestServlet#getTermsOfService(RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestResource#contact() @RestResource.contact()} / {@link org.apache.juneau.rest.RestServlet#getContact(RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestResource#license() @RestResource.license()} / {@link org.apache.juneau.rest.RestServlet#getLicense(RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestResource#version() @RestResource.version()} / {@link org.apache.juneau.rest.RestServlet#getVersion(RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestResource#tags() @RestResource.tags()} / {@link org.apache.juneau.rest.RestServlet#getTags(RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestResource#externalDocs() @RestResource.externalDocs()} / {@link org.apache.juneau.rest.RestServlet#getExternalDocs(RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestMethod#summary() @RestMethod.summary()} / {@link org.apache.juneau.rest.RestServlet#getMethodSummary(String,RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestMethod#description() @RestMethod.description()} / {@link org.apache.juneau.rest.RestServlet#getMethodDescription(String,RestRequest)}
- {@link org.apache.juneau.rest.annotation.RestMethod#externalDocs() @RestMethod.externalDocs()}
- {@link org.apache.juneau.rest.annotation.RestMethod#tags() @RestMethod.tags()}
- {@link org.apache.juneau.rest.annotation.RestMethod#deprecated() @RestMethod.deprecated()}
- {@link org.apache.juneau.rest.annotation.RestMethod#parameters() @RestMethod.parameters()}
- {@link org.apache.juneau.rest.annotation.RestMethod#responses() @RestMethod.responses()}
- New {@link org.apache.juneau.rest.RestServletContext#paramFormat} context property.
- New/updated methods on {@link org.apache.juneau.rest.RestServlet}:
- {@link org.apache.juneau.rest.RestServlet#createProperties()}
- {@link org.apache.juneau.rest.RestServlet#createBeanContext(ObjectMap,Class[],Class[])}
- {@link org.apache.juneau.rest.RestServlet#createBeanFilters()}
- {@link org.apache.juneau.rest.RestServlet#createPojoSwaps()}
- {@link org.apache.juneau.rest.RestServlet#createParsers(ObjectMap,Class[],Class[])}
- {@link org.apache.juneau.rest.RestServlet#createUrlEncodingSerializer(ObjectMap,Class[],Class[])}
- {@link org.apache.juneau.rest.RestServlet#createUrlEncodingParser(ObjectMap,Class[],Class[])}
- {@link org.apache.juneau.rest.RestServlet#createConverters(ObjectMap)}
- {@link org.apache.juneau.rest.RestServlet#createDefaultRequestHeaders(ObjectMap)}
- {@link org.apache.juneau.rest.RestServlet#createDefaultResponseHeaders(ObjectMap)}
- {@link org.apache.juneau.rest.RestServlet#createEncoders(ObjectMap)}
- {@link org.apache.juneau.rest.RestServlet#createGuards(ObjectMap)}
- {@link org.apache.juneau.rest.RestServlet#createMimetypesFileTypeMap(ObjectMap)}
- {@link org.apache.juneau.rest.RestServlet#createResponseHandlers(ObjectMap)}
- New client-version annotations:
- {@link org.apache.juneau.rest.annotation.RestResource#clientVersionHeader} - The name of the header used to identify the client version.
- {@link org.apache.juneau.rest.annotation.RestMethod#clientVersion} - The client version range applied to a Java method.
org.apache.juneau.rest.client
- Removed the
JazzRestClient
class.
- New method {@link org.apache.juneau.rest.client.RestClient#setClientVersion(String)}.
5.2.0.1 (Mar 23, 2016)
Juno 5.2.0.1 is a moderate update.
com.ibm.team.juno
- Improved support for multi-line values in config files.
Any line that begins with whitespace is interpreted as a continuation of the previous line.
- Support for '\uXXXX' character sequences in config files.
- Fixed issue in {@link org.apache.juneau.xml.XmlSerializer} where '\r' and '\n' characters were not being handled per XML specs.
- New methods on {@link org.apache.juneau.ObjectList}:
- {@link org.apache.juneau.ObjectList#getAt(Class,String)}
- {@link org.apache.juneau.ObjectList#putAt(String,Object)}
- {@link org.apache.juneau.ObjectList#postAt(String,Object)}
- {@link org.apache.juneau.ObjectList#deleteAt(String)}
- New methods on {@link org.apache.juneau.ObjectMap}:
- {@link org.apache.juneau.ObjectMap#getAt(Class,String)}
- {@link org.apache.juneau.ObjectMap#putAt(String,Object)}
- {@link org.apache.juneau.ObjectMap#postAt(String,Object)}
- {@link org.apache.juneau.ObjectMap#deleteAt(String)}
- New {@link org.apache.juneau.annotation.ThreadSafe @ThreadSafe} annotation.
- New
ClassFilter
class.
ConfigFile.getResolving(StringVarResolver,boolean)
method.
ConfigFile.getStringVar()
method.
- New {@link org.apache.juneau.parser.ParserContext#PARSER_trimStrings} property.
- New {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_trimStrings} property.
Args.getStringVar()}
method.
- New {@link org.apache.juneau.utils.ManifestFile} class
- New {@link org.apache.juneau.utils.MessageBundle} class. Replaces SafeResourceBundle/SafeResourceMultiBundle/RestNls.
- New
StringMapVar
class.
- New
StringVars
class with reusable common StringVar
instances.
- New {@link org.apache.juneau.internal.JuneauLogger} class.
- Default value for
XmlParserContext.XML_trimWhitespace
changed to true.
Server
- New methods on {@link org.apache.juneau.rest.RestServlet}:
- {@link org.apache.juneau.rest.RestServlet#getMessages()}
- {@link org.apache.juneau.rest.RestServlet#getMessages(Locale)}
Client
- Fixed potential issue in {@link org.apache.juneau.rest.client.RestClient} where the HTTP connection pool could end up exhausted if an error occurred.
- Improved thread safety on {@link org.apache.juneau.rest.client.RestClient}.
- New warning message is logged if a {@link org.apache.juneau.rest.client.RestClient} is garbage collected without being closed:
"WARNING: RestClient garbage collected before it was finalized."
5.2.0.0 (Dec 30, 2015)
Juno 5.2.0.0 is a major update.
Major changes have been made to the microservice architecture and config INI file APIs.
Core
- Significant changes and enhancements to the {@link org.apache.juneau.ini} API.
- More consistent handling of comma-delimited lists of objects.
- New methods in {@link org.apache.juneau.ini.ConfigFile}:
- {@link org.apache.juneau.ini.ConfigFile#getStringArray(String)},{@link org.apache.juneau.ini.ConfigFile#getStringArray(String,String[])}
- {@link org.apache.juneau.ini.ConfigFile#getSectionAsBean(String,Class)} - Instantiate a new bean with property values in the specfied section..
- {@link org.apache.juneau.ini.ConfigFile#writeProperties(String,Object,boolean,Class[])} - Copy the properties in a config file section into properties on an existing bean or POJO.
- {@link org.apache.juneau.ini.ConfigFile#getSectionMap(String)} - Get all the resolved values in a section.
- {@link org.apache.juneau.ini.ConfigFile#containsNonEmptyValue(String)}
- {@link org.apache.juneau.ini.ConfigFile#isEncoded(String)}
- {@link org.apache.juneau.ini.ConfigFile#addListener(ConfigFileListener)} - Listen for modification events on the config file.
- {@link org.apache.juneau.ini.ConfigFile#merge(ConfigFile)} - Merge the contents of another config file into this config file.
- {@link org.apache.juneau.ini.ConfigFile#getResolving()},
ConfigFile.getResolving(StringVarResolver)
- Return an instance of the config file that resolves string variables.
Much more efficient than the previous design since the same underlying config file object is shared.
- {@link org.apache.juneau.ini.ConfigFile#toWritable()} - Wraps the config file in a {@link org.apache.juneau.Writable} interface so that it can be serialized by the REST interface as a plain-text INI file instead of as a serialized POJO.
- {@link org.apache.juneau.ini.ConfigFile#getInt(String)} - Now supports "M" and "K" to identify millions and thousands.
- New methods in {@link org.apache.juneau.ini.ConfigMgr}:
- {@link org.apache.juneau.ini.ConfigMgr#create()}, {@link org.apache.juneau.ini.ConfigMgr#create(Reader)}, {@link org.apache.juneau.ini.ConfigMgr#create(File)}
- {@link org.apache.juneau.ini.ConfigMgr#deleteAll()}
- New methods in {@link org.apache.juneau.ini.Section}:
- {@link org.apache.juneau.ini.Section#setParent(ConfigFileImpl)} - Used by parsers to set the config file for this section.
- {@link org.apache.juneau.ini.Section#setName(String)} - Used by parsers to set the name for this section.
- New interfaces:
- {@link org.apache.juneau.ini.ConfigFileListener}
- {@link org.apache.juneau.ini.SectionListener}
- {@link org.apache.juneau.ini.EntryListener}
- {@link org.apache.juneau.ini.Encoder} methods have access to field names to use them as salt values.
- The name of the default section is now "default". Before it was just null.
- {@link org.apache.juneau.ini.XorEncoder} XOR key can be overridden through the "org.apache.juneau.ini.XorEncoder.key" system property.
- Support for converting Strings to POJOs if the POJO class has any of the following static methods:
fromString(String)
valueOf(String)
(e.g. enums)
parse(String)
(e.g. logging Level
class)
parseString(String)
forName(String)
(e.g. Class
and Charset
classes)
- Support for parsing into objects with unbound type variables.
For example, if you have a class
Pair<S,T>
and you try to parse into this
class (e.g. parser.parse(in, Pair.class)
), the unbound type variables
is interpreted as Object
instead of throwing an exception.
- Support for serializing/parsing the following new types:
AtomicInteger
AtomicLong
BigInteger
BigDecimal
- Parsers have been enhanced to allow parent POJOs and field names to be passed into child POJOs.
New {@link org.apache.juneau.annotation.NameProperty @NameProperty} and {@link org.apache.juneau.annotation.ParentProperty @ParentProperty}
annotations are provided for identifying methods for setting names and parent POJOs on child POJOs.
For example, the config file {@link org.apache.juneau.ini.Section} class represents a section
in a config file. It needs to know it's own name and have a link to the {@link org.apache.juneau.ini.ConfigFile}
that it belongs to. With these new annotations, config files can be reconstructed using any of the parsers.
- New classes and interfaces:
- {@link org.apache.juneau.Streamable} interface for identifying objects that can be serialized directly to an output stream.
- {@link org.apache.juneau.Writable} interface for identifying objects that can be serialized directly to a writer.
- {@link org.apache.juneau.serializer.StringObject} class that can be used for delayed object serialization.
- {@link org.apache.juneau.internal.ByteArrayCache}
- {@link org.apache.juneau.internal.ByteArrayInOutStream}
- {@link org.apache.juneau.internal.FileUtils}
- {@link org.apache.juneau.internal.ThrowableUtils}
StringVarMultipart
StringVarWithDefault
- New fields on {@link org.apache.juneau.ObjectList}:
- {@link org.apache.juneau.ObjectList#EMPTY_LIST}
- New fields and methods on {@link org.apache.juneau.ObjectMap}:
- {@link org.apache.juneau.ObjectMap#EMPTY_MAP}
- {@link org.apache.juneau.ObjectMap#getStringArray(String)}
- {@link org.apache.juneau.ObjectMap#getStringArray(String,String[])}
- {@link org.apache.juneau.ObjectMap#putIfNull(String,Object)}
- {@link org.apache.juneau.ObjectMap#putIfEmpty(String,Object)}
- New methods in {@link org.apache.juneau.internal.ArrayUtils}:
- {@link org.apache.juneau.internal.ArrayUtils#contains(Object,Object[])}
- {@link org.apache.juneau.internal.ArrayUtils#indexOf(Object,Object[])}
- {@link org.apache.juneau.internal.ArrayUtils#toPrimitiveArray(Object)}
- New methods in {@link org.apache.juneau.internal.IOUtils}:
- {@link org.apache.juneau.internal.IOUtils#pipe(Reader,Writer)}
- {@link org.apache.juneau.internal.IOUtils#read(File)}
- {@link org.apache.juneau.internal.IOUtils#readFile(String)}
- {@link org.apache.juneau.internal.IOUtils#write(File,Reader)}
- New methods on {@link org.apache.juneau.utils.PojoRest}:
- {@link org.apache.juneau.utils.PojoRest#get(Class,String,Object)}
- {@link org.apache.juneau.utils.PojoRest#getString(String)}
- {@link org.apache.juneau.utils.PojoRest#getString(String,String)}
- {@link org.apache.juneau.utils.PojoRest#getInt(String)}
- {@link org.apache.juneau.utils.PojoRest#getInt(String,Integer)}
- {@link org.apache.juneau.utils.PojoRest#getLong(String)}
- {@link org.apache.juneau.utils.PojoRest#getLong(String,Long)}
- {@link org.apache.juneau.utils.PojoRest#getBoolean(String)}
- {@link org.apache.juneau.utils.PojoRest#getBoolean(String,Boolean)}
- {@link org.apache.juneau.utils.PojoRest#getMap(String)}
- {@link org.apache.juneau.utils.PojoRest#getMap(String,Map)}
- {@link org.apache.juneau.utils.PojoRest#getList(String)}
- {@link org.apache.juneau.utils.PojoRest#getList(String,List)}
- {@link org.apache.juneau.utils.PojoRest#getObjectMap(String)}
- {@link org.apache.juneau.utils.PojoRest#getObjectMap(String,ObjectMap)}
- {@link org.apache.juneau.utils.PojoRest#getObjectList(String)}
- {@link org.apache.juneau.utils.PojoRest#getObjectList(String,ObjectList)}
- New methods on {@link org.apache.juneau.utils.ProcBuilder}:
- {@link org.apache.juneau.utils.ProcBuilder#pipeTo(Writer,boolean)}
- {@link org.apache.juneau.utils.ProcBuilder#pipeTo(Writer)}
- {@link org.apache.juneau.utils.ProcBuilder#logTo(Writer,boolean)}
- {@link org.apache.juneau.utils.ProcBuilder#logTo(Writer)}
- {@link org.apache.juneau.utils.ProcBuilder#logTo(Level,Logger)}
- {@link org.apache.juneau.utils.ProcBuilder#maxExitStatus(int)}
- New methods on {@link org.apache.juneau.internal.StringUtils}:
- {@link org.apache.juneau.internal.StringUtils#isEmpty(Object)}
- {@link org.apache.juneau.internal.StringUtils#nullIfEmpty(String)}
- {@link org.apache.juneau.internal.StringUtils#base64EncodeToString(String)}
- {@link org.apache.juneau.internal.StringUtils#base64Encode(byte[])}
- {@link org.apache.juneau.internal.StringUtils#base64DecodeToString(String)}
- {@link org.apache.juneau.internal.StringUtils#base64Decode(String)}
- {@link org.apache.juneau.internal.StringUtils#generateUUID(int)}
- {@link org.apache.juneau.internal.StringUtils#trim(String)}
- {@link org.apache.juneau.internal.StringUtils#parseISO8601Date(String)}
- {@link org.apache.juneau.internal.StringUtils#replaceVars(String,Map)}
- {@link org.apache.juneau.internal.StringUtils#pathStartsWith(String,String)}
- {@link org.apache.juneau.internal.StringUtils#pathStartsWith(String,String[])}
- New
StringVar.doResolve(String)
method.
- New
StringVarResolver.DEFAULT
field.
- Eliminated dependency on
javax.mail.internet.MimeUtility
by implementing our own {@link org.apache.juneau.internal.StringUtils#base64Encode(byte[])} method.
- {@link org.apache.juneau.transforms.CalendarSwap} and {@link org.apache.juneau.transforms.DateSwap} classes now handle blank input better. Returns null instead of throwing an exception.
- {@link org.apache.juneau.html.HtmlDocSerializer} specifies the default CSS location as
/servletPath/style.css
instead of /servletPath/htdocs/juneau.css
.
This coincides with enhancements made in the server code for specifying styles.
- {@link org.apache.juneau.html.HtmlDocSerializer} wraps output in two div tags instead of one (e.g.
<div class='outerdata'><div class='data' id='data'>...</div></div>
).
Needed for supporting the new devops look-and-feel.
- Fixed indentation inconsistencies in {@link org.apache.juneau.html.HtmlDocSerializer}.
- Renamed
HtmlSchemaSerializer to {@link org.apache.juneau.html.HtmlSchemaDocSerializer}.
- RDF serializers and parsers now support
RdfProperties.RDF_looseCollection
loose collections.
- RDF parser handles case where resources point to themselves (an unfortunate behavior in JFS RDF documents).
- JSON parser with throw an exception in strict mode if it encounters numbers that are valid in Java but invalid in JSON (e.g. octal, hexadecimal numbers).
- {@link org.apache.juneau.parser.Parser} methods now check for null input.
- {@link org.apache.juneau.serializer.SerializerGroup} and {@link org.apache.juneau.parser.ParserGroup} ignores serializers and parsers if they throw
NoClassDefFoundErrors
.
- {@link org.apache.juneau.urlencoding.UrlEncodingParser} creates lists if the same attribute name is encountered more than once. Before it would just replace the previous value with the new value.
- New
UrlEncodingSerializer.DEFAULT_SIMPLE_EXPANDED
serializer.
- Changes to {@link org.apache.juneau.utils.Args}:
getMainArg(int)
changed to {@link org.apache.juneau.utils.Args#getArg(int)}.
Non-existent arguments are returned as null instead of blank strings.
This is more inline with the behavior of the rest of the library.
- New {@link org.apache.juneau.utils.Args#hasArg(int)} method.
- Removed
org.apache.juneau.utils.CharsetUtils
class.
- Removed
org.apache.juneau.utils.ConcurrentIdentityList
class.
- Fixed bug in {@link org.apache.juneau.internal.MultiIterable} class.
- {@link org.apache.juneau.utils.PojoIntrospector} must now be instantiated with a
ReaderParser
.
Simplifies the API on the class.
- {@link org.apache.juneau.utils.PojoRest} must now be instantiated with a
ReaderParser
.
Simplifies the API on the class.
- {@link org.apache.juneau.utils.MessageBundle} and
SafeResourceMultiBundle
moved from server component.
- Several bug fixes and performance improvements in
StringVarResolver
.
- Various enhancements to {@link org.apache.juneau.internal.TeeWriter} and {@link org.apache.juneau.internal.TeeOutputStream}.
- Renamed
CharSet to {@link org.apache.juneau.internal.AsciiSet}.
- {@link org.apache.juneau.serializer.SerializerGroup} and {@link org.apache.juneau.parser.ParserGroup} now ignores
NoClassDefFoundErrors
so that resources that include Jena support can continue to operate even if the Jena libraries are not present.
- New {@link org.apache.juneau.internal.FileUtils#createTempFile(String)} method.
- New {@link org.apache.juneau.utils.PojoQuery} modified to handle bean getters that throw exceptions.
Client
- Upgraded to use Apache HttpClient 4.5.
- New classes:
- {@link org.apache.juneau.rest.client.AllowAllRedirects}
- {@link org.apache.juneau.rest.client.HttpMethod}
- {@link org.apache.juneau.rest.client.ResponsePattern}
- {@link org.apache.juneau.rest.client.SimpleX509TrustManager}
- {@link org.apache.juneau.rest.client.SSLOpts}
- Removed
org.apache.juneau.rest.client.LaxRedirectStrategy
. Use HTTP Client equivalent.
- New methods on {@link org.apache.juneau.rest.client.RestCall}:
- {@link org.apache.juneau.rest.client.RestCall#addInterceptor(RestCallInterceptor)}
- {@link org.apache.juneau.rest.client.RestCall#pipeTo(Writer)}
- {@link org.apache.juneau.rest.client.RestCall#pipeTo(Writer,boolean)}
- {@link org.apache.juneau.rest.client.RestCall#pipeTo(String,Writer,boolean)}
- {@link org.apache.juneau.rest.client.RestCall#getWriter(String)}
- {@link org.apache.juneau.rest.client.RestCall#pipeTo(OutputStream)}
- {@link org.apache.juneau.rest.client.RestCall#pipeTo(OutputStream,boolean)}
- {@link org.apache.juneau.rest.client.RestCall#pipeTo(String,OutputStream,boolean)}
- {@link org.apache.juneau.rest.client.RestCall#getOutputStream(String)}
- {@link org.apache.juneau.rest.client.RestCall#byLines()}
- {@link org.apache.juneau.rest.client.RestCall#captureResponse()}
- {@link org.apache.juneau.rest.client.RestCall#successPattern(String)}
- {@link org.apache.juneau.rest.client.RestCall#failurePattern(String)}
- {@link org.apache.juneau.rest.client.RestCall#addResponsePattern(ResponsePattern)}
- {@link org.apache.juneau.rest.client.RestCall#run()} - Renamed from
execute()
.
- {@link org.apache.juneau.rest.client.RestCall#getCapturedResponse()}
- {@link org.apache.juneau.rest.client.RestCall#getResponsePojoRest(Class)}
- {@link org.apache.juneau.rest.client.RestCall#getResponsePojoRest()}
- {@link org.apache.juneau.rest.client.RestCall#logTo(Level,Logger)}
- {@link org.apache.juneau.rest.client.RestCall#setConfig(RequestConfig)}
- New lifecycle listener methods on {@link org.apache.juneau.rest.client.RestCallInterceptor}:
- {@link org.apache.juneau.rest.client.RestCallInterceptor#onInit(RestCall)}
- {@link org.apache.juneau.rest.client.RestCallInterceptor#onClose(RestCall)}
- New methods on {@link org.apache.juneau.rest.client.RestClient}:
- {@link org.apache.juneau.rest.client.RestClient#setBasicAuth(String,int,String,String)}
- {@link org.apache.juneau.rest.client.RestClient#logTo(Level,Logger)}
- {@link org.apache.juneau.rest.client.RestClient#setRootUrl(String)}
- {@link org.apache.juneau.rest.client.RestClient#enableSSL(SSLOpts)}
- {@link org.apache.juneau.rest.client.RestClient#enableLaxSSL()}
- {@link org.apache.juneau.rest.client.RestClient#doCall(HttpMethod,Object,Object)}
- {@link org.apache.juneau.rest.client.RestClient#createHttpClientBuilder()}
- New passthrough methods on {@link org.apache.juneau.rest.client.RestClient} defined on
HttpClientBuilder
:
- {@link org.apache.juneau.rest.client.RestClient#setRedirectStrategy(RedirectStrategy)}
- {@link org.apache.juneau.rest.client.RestClient#setDefaultCookieSpecRegistry(Lookup)}
- {@link org.apache.juneau.rest.client.RestClient#setRequestExecutor(HttpRequestExecutor)}
- {@link org.apache.juneau.rest.client.RestClient#setSSLHostnameVerifier(HostnameVerifier)}
- {@link org.apache.juneau.rest.client.RestClient#setPublicSuffixMatcher(PublicSuffixMatcher)}
- {@link org.apache.juneau.rest.client.RestClient#setSSLContext(SSLContext)}
- {@link org.apache.juneau.rest.client.RestClient#setSSLSocketFactory(LayeredConnectionSocketFactory)}
- {@link org.apache.juneau.rest.client.RestClient#setMaxConnTotal(int)}
- {@link org.apache.juneau.rest.client.RestClient#setMaxConnPerRoute(int)}
- {@link org.apache.juneau.rest.client.RestClient#setDefaultSocketConfig(SocketConfig)}
- {@link org.apache.juneau.rest.client.RestClient#setDefaultConnectionConfig(ConnectionConfig)}
- {@link org.apache.juneau.rest.client.RestClient#setConnectionTimeToLive(long,TimeUnit)}
- {@link org.apache.juneau.rest.client.RestClient#setConnectionManager(HttpClientConnectionManager)}
- {@link org.apache.juneau.rest.client.RestClient#setConnectionManagerShared(boolean)}
- {@link org.apache.juneau.rest.client.RestClient#setConnectionReuseStrategy(ConnectionReuseStrategy)}
- {@link org.apache.juneau.rest.client.RestClient#setKeepAliveStrategy(ConnectionKeepAliveStrategy)}
- {@link org.apache.juneau.rest.client.RestClient#setTargetAuthenticationStrategy(AuthenticationStrategy)}
- {@link org.apache.juneau.rest.client.RestClient#setProxyAuthenticationStrategy(AuthenticationStrategy)}
- {@link org.apache.juneau.rest.client.RestClient#setUserTokenHandler(UserTokenHandler)}
- {@link org.apache.juneau.rest.client.RestClient#disableConnectionState()}
- {@link org.apache.juneau.rest.client.RestClient#setSchemePortResolver(SchemePortResolver)}
- {@link org.apache.juneau.rest.client.RestClient#setUserAgent(String userAgent)}
- {@link org.apache.juneau.rest.client.RestClient#setDefaultHeaders(Collection)}
- {@link org.apache.juneau.rest.client.RestClient#addInterceptorFirst(HttpResponseInterceptor)}
- {@link org.apache.juneau.rest.client.RestClient#addInterceptorLast(HttpResponseInterceptor)}
- {@link org.apache.juneau.rest.client.RestClient#addInterceptorFirst(HttpRequestInterceptor)}
- {@link org.apache.juneau.rest.client.RestClient#addInterceptorLast(HttpRequestInterceptor)}
- {@link org.apache.juneau.rest.client.RestClient#disableCookieManagement()}
- {@link org.apache.juneau.rest.client.RestClient#disableContentCompression()}
- {@link org.apache.juneau.rest.client.RestClient#disableAuthCaching()}
- {@link org.apache.juneau.rest.client.RestClient#setHttpProcessor(HttpProcessor)}
- {@link org.apache.juneau.rest.client.RestClient#setRetryHandler(HttpRequestRetryHandler)}
- {@link org.apache.juneau.rest.client.RestClient#disableAutomaticRetries()}
- {@link org.apache.juneau.rest.client.RestClient#setProxy(HttpHost)}
- {@link org.apache.juneau.rest.client.RestClient#setRoutePlanner(HttpRoutePlanner)}
- {@link org.apache.juneau.rest.client.RestClient#disableRedirectHandling()}
- {@link org.apache.juneau.rest.client.RestClient#setConnectionBackoffStrategy(ConnectionBackoffStrategy)}
- {@link org.apache.juneau.rest.client.RestClient#setBackoffManager(BackoffManager)}
- {@link org.apache.juneau.rest.client.RestClient#setServiceUnavailableRetryStrategy(ServiceUnavailableRetryStrategy)}
- {@link org.apache.juneau.rest.client.RestClient#setDefaultCookieStore(CookieStore)}
- {@link org.apache.juneau.rest.client.RestClient#setDefaultCredentialsProvider(CredentialsProvider)}
- {@link org.apache.juneau.rest.client.RestClient#setDefaultAuthSchemeRegistry(Lookup)}
- {@link org.apache.juneau.rest.client.RestClient#setContentDecoderRegistry(Map)}
- {@link org.apache.juneau.rest.client.RestClient#setDefaultRequestConfig(RequestConfig)}
- {@link org.apache.juneau.rest.client.RestClient#useSystemProperties()}
- {@link org.apache.juneau.rest.client.RestClient#evictExpiredConnections()}
- {@link org.apache.juneau.rest.client.RestClient#evictIdleConnections(long,TimeUnit)}
JazzRestClient
now supports OIDC authentication.
- These classes are now deprecated and will be removed in a future release:
org.apache.juneau.rest.client.jazz.CertificateStore
org.apache.juneau.rest.client.jazz.ICertificateValidator
org.apache.juneau.rest.client.jazz.ITrustStoreProvider
org.apache.juneau.rest.client.jazz.LenientCertificateValidator
org.apache.juneau.rest.client.jazz.SharedTrustStoreProvider
org.apache.juneau.rest.client.jazz.ValidatingX509TrustManager
Server
- New {@link org.apache.juneau.rest.ReaderResource} class.
Represents the contents of a text file with convenience methods for resolving
StringVar
variables and adding HTTP response headers.
REST Java methods can return instances of these to serialize Readers
containing text with StringVarResolver
variables in them.
- New {@link org.apache.juneau.rest.StreamResource} class.
REST Java methods can return instances of these to serialize
OutputStreams
.
- Fixed a bug in the stack trace hash algorithm in {@link org.apache.juneau.rest.RestException}.
- New methods in {@link org.apache.juneau.rest.RestRequest}:
- {@link org.apache.juneau.rest.RestRequest#getReaderResource(String)} - Replaces
getVarResource(String)
.
- {@link org.apache.juneau.rest.RestRequest#getReaderResource(String,boolean)}
RestRequest.getReaderResource(String,boolean,String)
- Changes in {@link org.apache.juneau.rest.RestResponse}:
- Don't set
Content-Encoding: identity
when no encoding is used. Some clients don't interpret it correctly.
- New methods in {@link org.apache.juneau.rest.RestServlet}:
- {@link org.apache.juneau.rest.RestServlet#getChildClasses()} - Programmatic equivalent to {@link org.apache.juneau.rest.annotation.RestResource#children()} annotation.
- {@link org.apache.juneau.rest.RestServlet#shouldLog(HttpServletRequest,HttpServletResponse,RestException)}
- {@link org.apache.juneau.rest.RestServlet#shouldLogStackTrace(HttpServletRequest,HttpServletResponse,RestException)}
- {@link org.apache.juneau.rest.RestServlet#logObjects(Level,String,Object[])}
- {@link org.apache.juneau.rest.RestServlet#resolveStaticFile(String)}
- {@link org.apache.juneau.rest.RestServlet#createStyleSheet()}
- {@link org.apache.juneau.rest.RestServlet#createFavIcon()}
- {@link org.apache.juneau.rest.RestServlet#createStaticFilesMap()}
- {@link org.apache.juneau.rest.RestServlet#getConfigMgr()}
- Removed {@link org.apache.juneau.jso.JavaSerializedObjectParser}
from {@link org.apache.juneau.rest.RestServletDefault} and {@link org.apache.juneau.rest.jena.RestServletJenaDefault}.
These may represent a security risk if not handled correctly, so removed
them as a precaution.
- Removed
RestServletProperties.REST_htDocsFolder
. Replaced with {@link org.apache.juneau.rest.annotation.RestResource#staticFiles()}.
- New annotations on {@link org.apache.juneau.rest.annotation.RestResource}.
- {@link org.apache.juneau.rest.annotation.RestResource#stylesheet()}
- {@link org.apache.juneau.rest.annotation.RestResource#favicon()}
- {@link org.apache.juneau.rest.annotation.RestResource#staticFiles()}
- Eliminated
org.apache.juneau.rest.jaxrs.JsonProvider
class.
Some JAX-RS implementations use code scanning to find providers, so if you were using DefaultJenaProvider
, it would
pick up JsonProvider
as well. It's easy enough to create your own implementation if needed.
- OPTIONS pages now specify
consumes
and produces
fields instead of accept
and contentType
which was confusing.
- Eliminated
properties
from OPTIONS pages.
- New {@link org.apache.juneau.rest.labels.ResourceLink#ResourceLink(String,RestRequest,String,Object[])} constructor.
- New response handlers:
- {@link org.apache.juneau.rest.response.StreamableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Streamable}.
- {@link org.apache.juneau.rest.response.WritableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Writable}.
- New DevOps stylesheet.
- Servlet initialization and HTTP requests are now logged at FINE level.
- Added abstract modifier on various RestServlet subclasses to indicate that they're meant to be subclassed.
- New {@link org.apache.juneau.rest.RestUtils#trimPathInfo(StringBuffer,String,String)} method.
Microservice
- Completely revamped API.
- New {@link org.apache.juneau.microservice.Microservice} class that serves as a generic
interface for microservices and their lifecycles.
- New {@link org.apache.juneau.microservice.RestMicroservice} class that implements a microservice
consisting of a REST interface.
- REST resources and configuration settings can be defined through either manifest files
or config files.
- Enhanced logging support.
- Easy-to-configure SSL support.
- BASIC auth support.
- Automatic restartability if the config file changes.
- Eliminated
org.apache.juneau.microservice.Main
class. This is replaced by
the microservice classes defined above.
- {@link org.apache.juneau.microservice.Resource} and {@link org.apache.juneau.microservice.ResourceGroup}
classes now support the following new string variables:
- "$ARG{key,default}"" - Command line arguments.
- "$MF{key,default}"" - Manifest file entries.
- CSS stylesheet now configurable through config file entry "REST/stylesheet".
- New {@link org.apache.juneau.microservice.ResourceJena} class if you want your REST interface to support RDF.
- Eliminated the following classes:
org.apache.juneau.microservice.RootResource
org.apache.juneau.microservice.SampleResource
- New predefined reusable resources:
- {@link org.apache.juneau.microservice.resources.ConfigResource} - REST resource for viewing and editing microservice config file.
- {@link org.apache.juneau.microservice.resources.LogsResource} - REST resource for viewing log files.
- {@link org.apache.juneau.microservice.resources.SampleRootResource} - Sample REST resource that contains the config and logs resource as children.
- {@link org.apache.juneau.microservice.resources.ShutdownResource} - REST resource for stopping the microservice JVM. Useful for testing purposes.
Samples
- Converted to a REST microservice.
- Look-and-feel changed to IBM DevOps.
Documentation Updates
5.1.0.20 (Sept 5, 2015)
Juno 5.1.0.20 is a moderate update.
The biggest improvement is the ability to associate external INI config files with REST servlets using the {@link org.apache.juneau.ini.ConfigFile} functionality.
Core
- Significant API changes to {@link org.apache.juneau.ini} API.
- {@link org.apache.juneau.ini.ConfigFile} is now thread safe and can be shared across multiple threads.
- New {@link org.apache.juneau.ini.ConfigMgr} class for managing configuration files.
- Serializers and parsers can be associated with config files for storing and retrieving POJOs.
Default support provided for JSON.
- New {@link org.apache.juneau.html.SimpleHtmlWriter} class.
Can be used for simple HTML DOM construction.
- New {@link org.apache.juneau.utils.ProcBuilder} class for calling external processes.
- New {@link org.apache.juneau.ObjectMap#remove(Class,String,Object)} method.
- "class='link'" added to links generated by {@link org.apache.juneau.html.HtmlDocSerializer}.
- New {@link org.apache.juneau.encoders.EncoderGroup#append(EncoderGroup)} method.
- New
HtmlDocSerializerContext.HTMLDOC_addLinks
configuration property.
- Modified the
Parser.createContext(ObjectMap,Method,Object)
method.
Outer context objects can be passed in to create instances of non-static inner classes.
- Fixed bug in {@link org.apache.juneau.html.HtmlStrippedDocSerializer} where exception was thrown when trying to serialize primitive arrays.
- {@link org.apache.juneau.json.JsonParser} now handles parsing JSON boolean/numeric values as strings to bean properties of type boolean or number.
- {@link org.apache.juneau.urlencoding.UrlEncodingSerializer} and {@link org.apache.juneau.urlencoding.UrlEncodingParser} now
represent arrays and collections as key-value pairs where the keys are numbers (e.g. "?0=foo&1=bar").
- Various internal improvements to {@link org.apache.juneau.utils.IOPipe}.
- New {@link org.apache.juneau.internal.ReflectionUtils#getResource(Class,String)} method.
- {@link org.apache.juneau.internal.StringUtils#parseNumber(String,Class)} now returns zero for empty strings.
This affects the way most parsers handle blank values.
Server
- You can now parse into non-static inner classes of a servlet for parameters/attributes/content.
Useful if you like to define your marshaller beans inside your servlet.
- Changes to {@link org.apache.juneau.rest.RestServlet}:
- New methods for accessing external INI config files:
{@link org.apache.juneau.rest.RestServlet#getConfig()}
{@link org.apache.juneau.rest.RestServlet#createConfigFile()}
- New "$C{...}" variable that resolve to INI config file values.
- New "$UE{...}" variable that URL-encodes the value inside the variable.
- New convenience methods for retrieving classpath resource files:
RestServlet.getResource(String)
RestServlet.getResourceAsString(String)
RestServlet.getResource(Class,String,String)
.
Useful if you want to load predefined POJOs from JSON files in your classpath.
- New {@link org.apache.juneau.rest.RestServlet#handleNotFound(int,RestRequest,RestResponse)} method for customized handling
of when a resource or method was not found.
- {@link org.apache.juneau.rest.RestServletDefault} now automatically processes "/favicon.ico" requests by
overriding the new {@link org.apache.juneau.rest.RestServlet#handleNotFound(int,RestRequest,RestResponse)} method.
- New {@link org.apache.juneau.rest.RestRequest} methods:
- {@link org.apache.juneau.rest.RestRequest#resolveVars(String)}
RestRequest.getVarResource(String)
- {@link org.apache.juneau.rest.RestRequest#getConfig()}
- New {@link org.apache.juneau.rest.RestResponse} methods:
- {@link org.apache.juneau.rest.RestResponse#getDirectWriter(String)}.
- {@link org.apache.juneau.rest.RestResponse#getNegotiatedWriter()}.
getWriter()
now returns an unnegotiated writer.
getUnbufferedWriter()
has been removed.
- New {@link org.apache.juneau.rest.annotation.RestMethod#encoders() @RestMethod.encoders()} and
{@link org.apache.juneau.rest.annotation.RestMethod#inheritEncoders() @RestMethod.inheritEncoders} annotations.
Allows encoders to be fine-tuned at the method level.
- New {@link org.apache.juneau.rest.annotation.RestResource#config() @RestResource.config()} annotation for associating external {@link org.apache.juneau.ini.ConfigFile} config files with servlets.
- Fixed bugs in {@link org.apache.juneau.rest.labels.ResourceLink}.
- New {@link org.apache.juneau.rest.matchers} package for commonly-used {@link org.apache.juneau.rest.RestMatcher RestMatchers}:
- {@link org.apache.juneau.rest.matchers#MultipartFormDataMatcher}
- {@link org.apache.juneau.rest.matchers#UrlEncodedFormMatcher}
Microservice
- New juneau-microservice.jar file that encapsulates all 3 juneau jars with code necessary for creating fast and efficent jetty-powered REST microservices.
Contains the following:
- Jetty 8.0
- Apache HttpClient 4.3.5
- Apache Commons FileUpload 1.3.1
- Microservice now supports Java 6 (previously required Java 7)
5.1.0.19 (Aug 15, 2015)
Juno 5.1.0.19 is a minor update in terms of core functionality.
But it introduces a Microservices project for building REST microservices and docker containers.
Core
- Beans can now be serialized to and parsed from {@link org.apache.juneau.ObjectMap ObjectMaps}.
See Serializing to ObjectMaps for details.
- New {@link org.apache.juneau.ObjectMap#include(String[])} and {@link org.apache.juneau.ObjectMap#exclude(String[])} methods.
- {@link org.apache.juneau.html.annotation.Html @Html} annotations can now be applied to bean properties.
- New {@link org.apache.juneau.utils.IOPipe} utility class.
- Behavior change on
StringVarResolver
. null input now results in blank strings instead of null.
Client
- New {@link org.apache.juneau.rest.client.RestClient#doCallback(String)} method.
Server
- New {@link org.apache.juneau.rest.RestRequest#getHeaders()} method.
- New
RestResponse.getUnbufferedWriter()
method.
- Fixed bug that was preventing
x-response-headers
parameter from working correctly.
- Added {@link org.apache.juneau.annotation.Bean#properties() @Bean.properties} annotations to the various
classes in {@link org.apache.juneau.rest.labels} so that the order of the bean properties are consistent
on all JVMs. On IBM JVMs this is unnecessary because the order of the properties as defined in the class
are stored in the bytecode. Other JVMs such as OpenJRE do not implement this feature causing the bean
properties to be in random order.
- New {@link org.apache.juneau.rest.labels.ResourceDescription#ResourceDescription(RestRequest,String,String)} constructor.
5.1.0.18 (Aug 5, 2015)
Juno 5.1.0.18 is a minor update affecting the server component only.
Server
- Fixed bug where localized strings weren't resolving when using chained resource bundles.
- Servlet and method labels and descriptions can now contain embedded string variables.
- New
RestMethod.input()
and org.apache.juneau.rest.annotation.RestMethod#responses()}
annotations.
These replace the various description
annotations added 2 days ago with a simpler design.
- New methods on {@link org.apache.juneau.rest.RestServlet}:
- {@link org.apache.juneau.rest.RestServlet#getMethodDescription(String,RestRequest)} so that subclasses
can override the method description in the OPTIONS page.
RestServlet.createRequestVarResolver(RestRequest)
so that subclasses
can override and augment the variable resolver.
- {@link org.apache.juneau.rest.RestServlet#resolveChild(Class)} and {@link org.apache.juneau.rest.RestServlet#replaceChild(RestServlet)}
classes that allows customized resolution of servlet instances (e.g. if services are defined in OSGi).
- Reverted the
MethodDescription
back to 5.1.0.16 since it was being used by someone.
5.1.0.17 (Aug 3, 2015)
Juno 5.1.0.17 is a major update.
Core
- {@link org.apache.juneau.BeanMap#get(Object)} and {@link org.apache.juneau.BeanMap#put(String,Object)} now
automatically performs filtering if filters are defined on the bean property or bean property class.
- Deleted the following methods which are now unnecessary:
BeanMap.getFiltered(String)
BeanMap.putFiltered(String,Object)
BeanMapEntry.getFiltered(String)
BeanMapEntry.putFiltered(String,Object)
BeanMapEntry.putFiltered(String,Object)
BeanPropertyMeta.getFiltered()
BeanPropertyMeta.setFiltered(Object)
BeanPropertyMeta.getTransformedClassMeta()
- {@link org.apache.juneau.BeanPropertyMeta#getClassMeta()} now returns the filtered type of the property.
StringVarResolver
now has support for chained resolvers.
StringVarResolver
now resolves variables inside resolved values.
i.e. if a resolved variable value itself contains a variable, it now resolves that variable too.
- Fixed bug where inner interface classes being used in
RestResource.filters()
were being
interpreted as surrogate classes because they have hidden 1-arg constructors due to being inner classes.
- Fixed bug in {@link org.apache.juneau.internal.MultiSet} where exception was being thrown if last set was empty.
- New {@link org.apache.juneau.utils.ZipFileList} class for providing efficiently zipped directories through the REST interface.
- New
RdfProperties.RDF_useXmlNamespaces
property.
- New {@link org.apache.juneau.xml.XmlParserContext#XML_preserveRootElement} property.
- Worked around bug in Sun VM on OS/X where XML parser was throwing an exception when trying to set a reporter.
Server
- New {@link org.apache.juneau.rest.response.ZipFileListResponseHandler} class.
- Simplified lables in servlet resource bundles:
"[ClassName].ResourceDescription"
is now "[ClassName].label"
.
"[ClassName].MethodDescription.[methodName]"
is now "[ClassName].[methodName]"
.
- Several changes to {@link org.apache.juneau.rest.RestRequest}:
- Added new methods:
- {@link org.apache.juneau.rest.RestRequest#getQueryParameterMap()}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameterNames()}
- {@link org.apache.juneau.rest.RestRequest#getPathInfoUndecoded()}
- {@link org.apache.juneau.rest.RestRequest#getPathRemainderUndecoded()}
- {@link org.apache.juneau.rest.RestRequest#getTrimmedRequestURI()}
- {@link org.apache.juneau.rest.RestRequest#getTrimmedRequestURL()}
- {@link org.apache.juneau.rest.RestRequest#getServletTitle()}
- {@link org.apache.juneau.rest.RestRequest#getServletDescription()}
- {@link org.apache.juneau.rest.RestRequest#getMethodDescription()}
- Behavior changes to {@link org.apache.juneau.rest.RestRequest#getPathInfo()} to follow Servlet specs.
Returns null instead of blank for no path info.
- {@link org.apache.juneau.rest.RestRequest#getPathRemainder()} now automatically decodes the path remainder.
Use {@link org.apache.juneau.rest.RestRequest#getPathRemainderUndecoded()} to get the unencoded path remainder.
- Bug fixes in {@link org.apache.juneau.rest.RestRequest#getRequestParentURI()} when servlet is mapped to "/*".
- Bug fixes in {@link org.apache.juneau.rest.RestRequest#getServletURI()} when servlet is mapped to "/*".
- New string replacement variables:
$R{contextPath}
- Returns value from {@link org.apache.juneau.rest.RestRequest#getContextPath()}
$R{methodDescription}
- Returns value from {@link org.apache.juneau.rest.RestRequest#getMethodDescription()}
$R{servletTitle}
- Returns value from {@link org.apache.juneau.rest.RestRequest#getServletTitle()}
$R{servletDescription}
- Returns value from {@link org.apache.juneau.rest.RestRequest#getServletDescription()}
$R{trimmedRequestURI}
- Returns value from {@link org.apache.juneau.rest.RestRequest#getTrimmedRequestURI()}
$E{var}
- Environment variables.
- Added methods {@link org.apache.juneau.rest.RestServlet#getDescription(RestRequest)} and
RestServlet.getLabel(RestRequest)
.
- {@link org.apache.juneau.rest.RestServletDefault} and {@link org.apache.juneau.rest.jena.RestServletJenaDefault} now provide default HTML titles
and descriptions:
@Property(name=HTMLDOC_title, value="$R{servletTitle}"),
@Property(name=HTMLDOC_description, value="$R{servletDescription}")
- Options pages on {@link org.apache.juneau.rest.RestServletDefault} and {@link org.apache.juneau.rest.jena.RestServletJenaDefault} now provide default descriptions and back links:
and descriptions:
@Property(name=HTMLDOC_links, value="{back:'$R{servletURI}"),
@Property(name=HTMLDOC_description, value="Resource options")
- New {@link org.apache.juneau.rest.RestServletGroupDefault} class.
- Removed
RestServletProperties.REST_trimTrailingUriSlashes
and RestServletProperties.REST_pathInfoBlankForNull
.
- New annotations for providing labels and descriptions. Useful if you don't plan on having to support other languages, so you don't
want to provide labels in resource bundles.
RestResource.label()
- {@link org.apache.juneau.rest.annotation.RestResource#description()}
- {@link org.apache.juneau.rest.annotation.RestMethod#description()}
- {@link org.apache.juneau.rest.annotation.RestMethod#responses()}
Attr.description()
Content.description()
HasParam.description()
HasQParam.description()
Header.description()
Param.description()
QParam.description()
- Support for sorting resources by name in {@link org.apache.juneau.rest.labels.ChildResourceDescriptions}.
Samples
- Added
/tempDir/upload
showing how to use ServletFileUpload
with multipart form posts.
5.1.0.16 (June 28, 2015)
Juno 5.1.0.16 is a moderate update.
Core
- New methods on {@link org.apache.juneau.ClassMeta} that eliminates language-specific code in
the general class metadata.
ClassMeta.getXmlMeta()
ClassMeta.getJsonMeta()
ClassMeta.getHtmlMeta()
ClassMeta.getUrlEncodingMeta()
ClassMeta.getRdfMeta()
- New {@link org.apache.juneau.dto.jsonschema.JsonType#ANY} enum.
- New {@link org.apache.juneau.html.annotation.Html#asPlainText @Html.asPlainText()} annotation.
- New {@link org.apache.juneau.html.HtmlDocSerializerContext#HTMLDOC_cssImports} property.
- Signifant changes to RDF support.
- New {@link org.apache.juneau.jena.annotation.Rdf @Rdf} and {@link org.apache.juneau.jena.annotation.RdfSchema @RdfSchema}
annotations. These replace the use of defining namespaced through the XML annotations, and allows XML and RDF to be
serialized using different namespaces.
- Support for serializing arrays/collections as RDF bags, RDF lists, and multi-valued properties.
- Fixed warning message about "tab" setting when using the N3/Turtle serializers.
- New {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_sortCollections} and
{@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_sortMaps} properties.
-
- FindBug fixes.
Server
- New {@link org.apache.juneau.rest.RestRequest#getServletParentURI()} method.
- New
$R{servletParentURI}
variable.
- Removed final modifier from {@link org.apache.juneau.rest.labels.ChildResourceDescriptions}.
Samples
- Added source code links to examples.
5.1.0.15 (May 24, 2015)
Juno 5.1.0.15 is a minor update.
Core
- New properties in {@link org.apache.juneau.serializer.SerializerContext}:
- {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_relativeUriBase}
- {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_absolutePathUriBase}
These replace the SERIALIZER_uriAuthority
and SERIALIZER_uriContext
properties.
- Improvements in {@link org.apache.juneau.csv.CsvSerializer}.
Server
- New properties in
RestServletProperties
:
REST_defaultCharset
REST_servletURI
REST_relativeServletURI
- Improvements involving path calculations when servlets deployed outside of a war file with a context root.
Client
- New methods in {@link org.apache.juneau.rest.client.RestCall}:
- {@link org.apache.juneau.rest.RestRequest#getHeader(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getHeader(String,Object,Class)}
- {@link org.apache.juneau.rest.RestRequest#getHeader(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Object,Class)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String,Object,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameters(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getQueryParameters(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameter(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameter(String,Object,Class)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameters(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameter(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getFormDataParameters(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getPathParameter(String,Class)}
- {@link org.apache.juneau.rest.RestRequest#getPathParameter(String,Type,Type...)}
- {@link org.apache.juneau.rest.RestRequest#getBody(Class)}
- {@link org.apache.juneau.rest.RestRequest#getBody(Type,Type...)}
5.1.0.14 (May 10, 2015)
Juno 5.1.0.14 is a moderate update.
The major addition is support for {@link org.apache.juneau.rest.remoteable Remoteable Services}, the ability
to invoke server-side POJO methods through client-side proxy interfaces.
Core
- Simplified {@link org.apache.juneau.utils.PojoIntrospector} class.
- New {@link org.apache.juneau.internal.ClassUtils#getMethodSignature(Method)} method.
Client
- New methods in {@link org.apache.juneau.rest.client.RestClient} for working with remoteable services:
- {@link org.apache.juneau.rest.client.RestClient#setRemoteableServletUri(String)}
- {@link org.apache.juneau.rest.client.RestClient#getRemoteableProxy(Class)}
Server
- Added a default OPTIONS page to {@link org.apache.juneau.rest.RestServletDefault} and {@link org.apache.juneau.rest.jena.RestServletJenaDefault}.
RestServletProperties.REST_allowMethodParam
has been enhanced to allow you to
explicitely specify which HTTP methods can be used in the &method
parameter.
- New methods added to {@link org.apache.juneau.rest.RestRequest}:
- {@link org.apache.juneau.rest.RestRequest#getParser()}
- {@link org.apache.juneau.rest.RestRequest#getReaderParser()}
5.1.0.13 (Apr 24, 2015)
Juno 5.1.0.13 is a minor update.
Core
- {@link org.apache.juneau.ClassMeta#newInstance()} method can now create new instances of arrays.
- Arguments passed to {@link org.apache.juneau.dto.Link} are now serialized using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer}, so arbitrary POJOs can now be passed as arguments.
- New date filters:
org.apache.juneau.transforms.Datefilter.ISO8601DTZP
and org.apache.juneau.transforms.Datefilter.SimpleP
.
- New {@link org.apache.juneau.html.HtmlDocSerializerContext#HTMLDOC_nowrap} setting for {@link org.apache.juneau.html.HtmlDocSerializer} class.
Adds "* {white-space:nowrap}" to the style header to prevent word wrapping.
- Fixed bug in {@link org.apache.juneau.urlencoding.UonParser} where passing in a blank value on an array or collection type in a form post would cause a
ClassCastException
.
New behavior creates an empty array or Collection
.
- Improved implementation of {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializeUrlPart(Object)} method.
Server
- {@link org.apache.juneau.rest.RestConverter} API fixed to handle the existence of POJO filters.
{@link org.apache.juneau.rest.converters.Introspectable}/{@link org.apache.juneau.rest.converters.Queryable}/{@link org.apache.juneau.rest.converters.Traversable} classes can now work with filtered POJOs.
- {@link org.apache.juneau.rest.annotation.RestResource#messages()} annotation can now be defined on super and subclasses so that NLS messages can be defined in multiple resource bundles.
- Performance improvements in
RestServletNls
class.
- Fixed bug where two REST java methods mapped to the same path pattern wasn't triggering an exception when it was supposed to.
Client
- New {@link org.apache.juneau.rest.client.RestCall#setRedirectMaxAttempts(int)} method to prevent endless redirection loops.
- New {@link org.apache.juneau.rest.client.RestCall#setRetryable(int,long,RetryOn)} method to automatically retry on failed connection attempts.
- New
RestCallInterceptor.onRetry(RestCall,int,HttpRequest,HttpResponse)
method for listening in on retry attempts.
5.1.0.12 (Mar 28, 2015)
Juno 5.1.0.12 is a minor update.
Core
- Fixed {@link org.apache.juneau.ini.ConfigFile#isEmpty()} method.
- Changed behavior on {@link org.apache.juneau.urlencoding.UonParser} to not treat '~' characters as escapes
unless followed by one of the following characters:
( ) , $ = ~
.
Client
- New class {@link org.apache.juneau.rest.client.RestCallInterceptor}.
Allows responses to be inspected and modified before being processed.
Replaces
RestClientListener
class.
- Minor connection cleanup fixes.
5.1.0.11 (Feb 14, 2015)
Juno 5.1.0.11 is a moderate update.
Core
- Additions to {@link org.apache.juneau.html.annotation.Html @Html} bean annotation.
- New {@link org.apache.juneau.html.annotation.Html#noTables() @Html.noTables()} annotation that prevents
arrays/Collections from being serialized as tables.
- New {@link org.apache.juneau.html.annotation.Html#noTableHeaders() @Html.noTableHeaders()} annotation that prevents
HTML tables from having header rows.
- Several improvements to URL-Encoding support.
- Improved whitespace handling in {@link org.apache.juneau.urlencoding.UonParser}.
- New
UonParserContext.UON_whitespaceAware
property for controlling whether whitespace is ignored.
- New {@link org.apache.juneau.urlencoding.UrlEncodingContext#URLENC_expandedParams} property for controlling whether arrays/Collections
should be serialized/parsed as multi-part parameters.
- New {@link org.apache.juneau.urlencoding.annotation.UrlEncoding#expandedParams() @UrlEncoding.expandedParams()}
annotation that specifies that bean properties of type array/Collection be serialized as multi-part parameters (e.g.
&key=val1&key=val2
).
- New {@link org.apache.juneau.json.JsonSerializerContext#JSON_escapeSolidus} property for controlling whether slash characters should be escaped.
- New {@link org.apache.juneau.internal.TeeOutputStream} and {@link org.apache.juneau.internal.TeeWriter} classes.
- New {@link org.apache.juneau.ClassMeta#isInstance(Object)} method.
- Performance improvements when using the {@link org.apache.juneau.BeanMap#add(String,Object)} method.
Array properties are stored in a temporary list cache until {@link org.apache.juneau.BeanMap#getBean()} is called.
- New {@link org.apache.juneau.BeanPropertyMeta#add(BeanMap,Object)} method for adding values to Collection and array properties.
- Config INI files now support keys with name "*".
Server
- REST method parameters can now be generic types (e.g.
@Param("foo") Map<String,Integer> foo).
This applies to headers, attributes, and parameters.
- New
@Param.multipart()
and @Query.multipart()
annotations
for handling multi-part GET and POST parameters.
- GET parameters are now CASE-SENSITIVE per W3C standards.
-
&Content
must now be specified as &content
.
&Method
must now be specified as &method
.
&debug
must now be specified as &debug=true
.
&plainText
must now be specified as &plainText=true
.
¬race
must now be specified as &noTrace=true
.
- Performance improvements around query parameters.
- New methods on {@link org.apache.juneau.rest.RestRequest} for handling multi-part parameters:
RestRequest.getParameters(String,Class)
- {@link org.apache.juneau.rest.RestRequest#getQueryParameters(String,Class)}
- Fixed Jetty issue in {@link org.apache.juneau.rest.RestResponse#setHeader(String,String)} where setting
the
Content-Type
through this method was inconsistent with the behavior in WAS/Tomcat.
&noTrace=true
now prevents any errors from being logged in log file.
- Workaround for Jetty issue where
ServletContext.getContextPath()
always ends with "null".
RestServletProperties.REST_allowMethodParam
is now true by default on all subclasses
of {@link org.apache.juneau.rest.RestServletDefault} and {@link org.apache.juneau.rest.jena.RestServletJenaDefault}.
Client
- New method {@link org.apache.juneau.rest.client.RestCall#allowRedirectsOnPosts(boolean)}.
- New method
RestCall.peekInputStream()
allows you to read response bodies without interrupting execution flow.
- New method {@link org.apache.juneau.rest.client.RestCall#toString()} now useful for debugging purposes.
Shows all request/response headers and bodies.
- {@link org.apache.juneau.rest.client.RestCallException} now includes
HttpResponse
object for easier debugging.
- New method
RestClient.addListener(RestClientListener)
for registering request/response listeners.
- New {@link org.apache.juneau.rest.client.RestClient#setClassLoader(ClassLoader)} method.
- TLS support in
JazzRestClient
.
Other changes
samples.ear
and samples.war
projects
have been replaced with an OSGi bundle with activated servlets in juno.samples
.
5.1.0.10 (Dec 23, 2014)
Juno 5.1.0.10 is a moderate update.
Core
- Major changes to URL-Encoded serializer and parser.
- Logic for serializing and parsing URL-Encoded key-value pairs moved to {@link org.apache.juneau.urlencoding.UrlEncodingSerializer} and {@link org.apache.juneau.urlencoding.UrlEncodingParser} classes.
- Logic for serializing and parsing URL-Encoded values moved to new {@link org.apache.juneau.urlencoding.UonSerializer} and {@link org.apache.juneau.urlencoding.UonParser} classes.
- Fix bug where
BeanRuntimeExceptions
weren't being thrown on subsequent calls to {@link org.apache.juneau.BeanContext#getClassMeta(Class)}.
- Moved logic for
BeanContext.getPrimitiveDefault(Class)
to new {@link org.apache.juneau.ClassMeta#getPrimitiveDefault()} method for performance reasons.
- Fixed bug in
BeanContext.addTransforms(Class[])
that would cause filter order to get messed up.
- {@link org.apache.juneau.ClassMeta#newInstance()} can now create array instances.
- Fixed indentation bugs in {@link org.apache.juneau.html.HtmlSerializer}.
- Fixed issue in {@link org.apache.juneau.html.HtmlSerializer} where newlines were not being converted into line breaks.
- New {@link org.apache.juneau.serializer.WriterSerializer#toString(Object)} method that's identical to the serialize method but throws
RuntimeExceptions
to make the serializer easier to use for debugging.
Server
- Fixed major issue that prevented parsing URL-Encoded form posts into POJOs.
Calling
HttpServlet.getParameter(String)
was forcing the underlying servlet code to process the HTTP body itself, preventing the UrlEncodingSerializer
class from being able to parse the content. Updated code no longer inadvertantly calls this method.
- New {@link org.apache.juneau.rest.RestRequest#getQueryParameter(String)}, {@link org.apache.juneau.rest.RestRequest#hasQueryParameter(String)}, and {@link org.apache.juneau.rest.RestRequest#hasAnyQueryParameters(String[])}
methods that only look for parameters in the URL query string to prevent loading and parsing of URL-Encoded form posts.
- New
@QParam
and @HasQParam
annotations for accessing query parameters from the URL query string.
&plainText
parameter can now specify a false value.
- Removed properties parameters from {@link org.apache.juneau.rest.RestServlet#onPreCall(RestRequest)} and {@link org.apache.juneau.rest.RestServlet#onPostCall(RestRequest,RestResponse)} methods
since the properties are already accessible through
RestRequest.getProperties()
.
- Added {@link org.apache.juneau.urlencoding.UonSerializer} and {@link org.apache.juneau.urlencoding.UonParser} to serializer and parser lists on
{@link org.apache.juneau.rest.RestServletDefault} and {@link org.apache.juneau.rest.jena.RestServletJenaDefault}.
Client
- Moved to Apache HttpClient 4.3 to match Jazz 6.0.
- Renamed
RestResponseEntity
to {@link org.apache.juneau.rest.client.RestRequestEntity}.
- Improved performance on URL-Encoded form posts by serializing directly to output stream instead of serialized to string first.
- New methods on {@link org.apache.juneau.rest.client.RestClient} class that makes it easier to associate serializer and parser attributes with registered serializer and parser:
- {@link org.apache.juneau.rest.client.RestClient#setProperty(String,Object)}
- {@link org.apache.juneau.rest.client.RestClient#setProperties(ObjectMap)}
- {@link org.apache.juneau.rest.client.RestClient#addNotBeanClasses(Class[])}
RestClient.addTransforms(Class[])
- {@link org.apache.juneau.rest.client.RestClient#addImplClass(Class,Class)}
- Renamed
RestClient.shutdown()
to {@link org.apache.juneau.rest.client.RestClient#close()} to mirror change in Apache API.
Samples
- New
CodeFormatterResource
for quickly formatting Java and XML code samples in Javadocs.
- New
UrlEncodedFormResource
for showing how to work with URL-Encoded form posts.
5.1.0.9 (Dec 1, 2014)
Juno 5.1.0.9 is a major update.
There weren't very many code changes, but the source has been made a part of Jazz Foundation.
This required some restructuring of the project.
The project on Jazz Hub will eventually be discontinued.
However, the libraries on IBM Community Source will continue to be updated regularly.
- Project split up into 3 separate bundles:
org.apache.juneau
- Core serializers and parsers.
org.apache.juneau.rest
- REST server component.
org.apache.juneau.rest.client
- REST client component.
- Code changes to facilitate breaking up bundles:
org.apache.juneau.rest.labels.Link
class moved to {@link org.apache.juneau.dto.Link}.
- References to
org.apache.juneau.rest.RestException
in {@link org.apache.juneau.encoders.Encoder} class changed to IOException
.
- Changed configuration names for consistency with Jazz Framework.
- New {@link org.apache.juneau.rest.client.RestClient#execute(HttpUriRequest)} method that allows subclasses to handle their own HTTP request execution.
- Changes in
JazzRestClient
to handle introduction of SSO support in v6.
&plainText
debug feature was broken.
- Removed double-buffering in
RestRequest
.
- Metadata cleanup, Find Bug fixes.
5.1.0.8 (Oct 25, 2014)
Juno 5.1.0.8 is a moderate update, focused primarily on performance improvements.
- Improved performance on JSON and URL-Encoding parsers by approximately 50% on large data sets.
- Rewrote {@link org.apache.juneau.parser.ParserReader} class to handle it's own buffering.
The change allowed several optimizations to be made when dealing with JSON and URL-Encoding
text by avoiding char array copies.
- Added a
estimatedSize
parameter to the {@link org.apache.juneau.parser.Parser} parse methods to
optimize buffering when the input size is known beforehand.
- Revamped the {@link org.apache.juneau.BeanContext} API to perform better in multi-threaded environments.
- Introduced a new
BeanContextFactory
class that handles creation of {@link org.apache.juneau.BeanContext} objects.
This allows BeanContext
objects to be considered immutable, and therefore cacheable/reusable by the framework.
While this was technically possible to cache these objects beforehand, it relied on a locking mechanism to prevent bean contexts
from being modified after being created. The new mechanism is much more straightforward.
- Modifications to the {@link org.apache.juneau.rest.client} APIs to make it easier to work with custom Apache HTTP clients.
- Added overridable {@link org.apache.juneau.rest.client.RestClient#createHttpClient()} to allow customized subclasses to construct customized HTTP clients.
- Removed the
DefaultRestClient
class since it's now fully redundant with RestClient
.
- Added
RestClient.shutdown()
method for cleaning up the internal HTTP client when you're done using a REST client.
5.1.0.7 (Oct 5, 2014)
Juno 5.1.0.7 is a moderate update.
- Improved error handling.
- New
ParserContext.PARSER_debug
and SerializerContext.SERIALIZER_debug
.
settings for logging additional information for debugging problems.
- New {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_ignoreRecursions} setting for explicitely ignoring recursions when
serializing models. Previously, the SERIALIZER_detectRecursions setting did this, but now it simply looks for recursions
and throws exceptions when they occur.
- Improved handling of
StackOverflowErrors
. When SERIALIZER_detectRecursions is enabled, a useful error message
is displayed showing the exact chain of objects that resulted in the stack overflow.
- Bug fixes in {@link org.apache.juneau.dto.ResultSetList} for Oracle and SQL Server.
- Serializers and parsers can now access HTTP request attributes, parameters, and headers through
SerializerContext.getProperties()
and
ParserContext.getProperties()
.
- Removed media-type and encoding attributes from {@link org.apache.juneau.serializer.SerializerContext} and {@link org.apache.juneau.parser.ParserContext}
since these are now available through context properties, and are typically not used.
- {@link org.apache.juneau.xml.XmlParser} now accepts
application/xml
.
- Improved handling of bean property serialization when multiple matching pojo filters for the bean property class exist.
- Improved concurrency on BeanContext class.
- Fixed bug in {@link org.apache.juneau.rest.converters.Traversable} that was causing it to be executed even if the servlet extra path info was empty.
- Fixed bug in {@link org.apache.juneau.rest.converters.Traversable} where it was not picking up filters and properties defined on REST Java methods.
5.1.0.6 (Sept 21, 2014)
Juno 5.1.0.6 is a moderate update.
- Simplified API for {@link org.apache.juneau.transform.PojoSwap}.
Since it's rarely used, the
beanContext
parameter was replaced with a PojoSwap#getBeanContext()
method on
the class.
- New simplified way of defining POJO filters without needing to extend {@link org.apache.juneau.transform.PojoSwap}.
See {@link org.apache.juneau.transform.SurrogateSwap} for details.
- New {@link org.apache.juneau.html.annotation.Html @Html} annotation.
Will allow the definition of standard XHTML DTOs in future releases.
For now,
Img
is an example of defining an XHTML element using Juno DTOs.
- {@link org.apache.juneau.json.JsonParser} now ignores trailing
';'
characters in input so that it can
parse strings of the form "var x = {'foo':'bar'};".
- New
TumblrParserResource
in the samples war file showing how to combine the REST client and server APIs into a single
resource in order to download Tumblr blogs and convert the response into any supported response content type.
5.1.0.5 (Sept 1, 2014)
Juno 5.1.0.5 is a moderate update.
- New {@link org.apache.juneau.rest.Redirect} class that simplifies performing redirections in REST methods.
- New pluggable {@link org.apache.juneau.rest.ResponseHandler} class and {@link org.apache.juneau.rest.annotation.RestResource#responseHandlers()} annotation
for defining customer response handlers for special kinds of POJOs.
- New method {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializeUrlPart(Object)} method.
- New method {@link org.apache.juneau.rest.RestRequest#getServletURIBuilder()} for construcing servlet-based URLs more efficiently.
- New method {@link org.apache.juneau.rest.RestResponse#getNegotiatedOutputStream()} that uses encoders if a match is found,
and {@link org.apache.juneau.rest.RestResponse#getOutputStream()} that just return the underlying output stream without any modifications.
- Fixed bug where some properties were not being propagated correctly when using {@link org.apache.juneau.CoreApi#setProperties(ObjectMap)}
on serializer and parser subclasses.
- Fixed bug in {@link org.apache.juneau.html.HtmlSerializer} where URL keys in Maps were not being serialized as hyperlinks.
- Fixed bug in {@link org.apache.juneau.json.JsonSerializer} where "_class" and "items" attributes were not quoted in strict mode when using SERIALIZER_addClassAttrs feature.
- Fixed bug where
Content-Encoding
andCharacter-Encoding
headers were being set when calling {@link org.apache.juneau.rest.RestResponse#getOutputStream()}.
These should not be set if interacting with the output streams at a low level.
- Eliminated various convenience
RestResponse.sendRedirect(...)
methods due to the introduction of the {@link org.apache.juneau.rest.Redirect} class.
5.1.0.4 (Aug 25, 2014)
Juno 5.1.0.4 is a minor update.
- New {@link org.apache.juneau.rest.RestServlet#getPath()} method.
- New
SerializerContext.getJavaMethod()
and ParserContext.getJavaMethod()
to allow access to REST methods that invoked the serializers or parsers.
For example, can be used to access additional annotations on REST methods to perform special handing
during serialization or parsing.
- Better behavior on overriding of filters in
BeanContext.addTransforms(Class[])
.
Previously, adding multiple conflicting filters resulted in random behavior.
Now filters are overridden when multiple matching filters are applied.
- Allow {@link org.apache.juneau.html.HtmlDocSerializerContext} properties to be set via {@link org.apache.juneau.serializer.Serializer#setProperty(String,Object)}.
Previously, these could only be defined through override properties (e.g. through REST class and method annotations).
- Fixed memory leak in XML parser.
5.1.0.3 (Jun 28, 2014)
Juno 5.1.0.3 is a moderate update.
Core API updates
- Ability to detect and use non-public bean classes, getters/setters, and fields using the following new properties:
- {@link org.apache.juneau.BeanContext#BEAN_beanConstructorVisibility} - Control which bean constructors are visible to Juno.
- {@link org.apache.juneau.BeanContext#BEAN_beanClassVisibility} - Control which bean classes are interpreted as beans to Juno.
- {@link org.apache.juneau.BeanContext#BEAN_beanFieldVisibility} - Control which fields are visible to Juno as bean properties.
- {@link org.apache.juneau.BeanContext#BEAN_methodVisibility} - Control which getters/setters are visible to Juno as bean properties.
Removed BeanContext.INCLUDE_BEAN_FIELD_PROPERTIES
and BeanContext.INCLUDE_BEAN_METHOD_PROPERTIES
properties, since ignoring fields and methods
can be accomplished by setting the appropriate properties above to {@link org.apache.juneau.Visibility#NONE NONE}.
Also, the {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotation can now be used on non-public fields/getters/setters to override
the default behavior defined by the VISIBILITY
properties identified above. This is a convenient way of identifying protected or
private fields or methods as bean properties. Previously, you could only identify public fields/getters/setters using this annotation.
- New {@link org.apache.juneau.BeanContext#BEAN_useJavaBeanIntrospector} property that lets Juno use the Java bean
Introspector
class to determine bean properties. In the previous release, the method for determining bean properties was a mixture of Juno-based and Introspector-based.
Now it's either pure Juno-based or pure Introspector-based. The result is considerably cleaner code and consistent behavior.
- New {@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore} annotation. Replaces the previous
@BeanProperty(hidden=true)
annotation
for ignoring bean properties. Can also be used on classes that look like beans so that they're not treated as beans.
- Support for parsing into non-static member classes. This applies to all parsers.
- New {@link org.apache.juneau.json.annotation.Json#wrapperAttr() @Json.wrapperAttr()} annotation that automatically wraps beans and objects in a wrapper
attribute when serializing to or parsing from JSON.
- Changed the default ordering of bean properties to be in parent-to-child class order.
- New {@link org.apache.juneau.transform.BeanFilter#readProperty(Object,String,Object) readProperty()} and {@link org.apache.juneau.transform.BeanFilter#writeProperty(Object,String,Object) writeProperty()}
methods added to {@link org.apache.juneau.transform.BeanFilter} class to allow individualized serialization and parsing behavior on a class-by-class basis.
- Eliminated previous restriction where bean subtype attributes had to be listed first in JSON objects when using the
Bean.subTypeProperty()
annotation.
The previous behavior was not strictly JSON-compliant since JSON objects are supposed to consist of unordered lists of key/value pairs.
While targeted for JSON, the restriction is also lifted for all other parsers.
- New fluent-style {@link org.apache.juneau.BeanMap#load(String) BeanMap.load()} methods for initializing bean maps.
- {@link org.apache.juneau.html.HtmlDocSerializer} will now embed the data portion of the output in a
<div id='data'>
element to make it easier to extract the data portion of the page in Javascript in browsers.
REST Server API updates
- New {@link org.apache.juneau.rest.RestRequest#getJavaMethod()} method for getting access to the method used to handle a request.
Useful for accessing the method name or annotations during requests, such as in calls to {@link org.apache.juneau.rest.RestGuard#guard(RestRequest,RestResponse)}.
- Fixed bug when using Jetty where you tried to read text input after a header was written.
- Added new string variables
$A{...}
(request attributes) and $P{...}
(request parameters) to RestServlet.createRequestVarResolver(RestRequest)
.
5.1.0.2 (Apr 27, 2014)
Juno 5.1.0.2 is a minor update.
- Fixed issue preventing
&Accept-Language
from being used as a GET parameter.
- Minor XSS vulnerability fix.
- Empty results on HTML pages now shows "no results" instead of a blank page.
- Fixed issues preventing REST pages from rendering HTML in newer versions of Internet Explorer.
- Changed
RestServletProperties.REST_allowMethodParam
to be disabled by default.
5.1.0.1 (Jan 25, 2014)
Juno 5.1.0.1 is a minor update.
- Addressed some behavioral differences between Tomcat and WAS.
- Query parameter lookup is now always case-insensitive (per WAS behavior).
- Consistent handling of redirect requests (Tomcat and WAS handle relative redirect paths differently).
- Fixed bug involving incorrect resolution of overlapping URL match patterns.
- Overall improvements in HTTP request parameter and header value resolution.
- Made workspace changes so as not to be dependent on the WAS test environment being loaded.
- Renamed @Remainder annotation to {@link org.apache.juneau.rest.annotation.PathRemainder @PathRemainder}.
- Fixed bug involving incorrect calculation of
pathInfo
on child resources.
5.1.0.0 (Jan 18, 2014)
Juno 5.1.0.0 is a major update.
Major changes
- Brand new REST client API that uses Apache HttpClient for HTTP communication.
The new client API is simply a thin layer on top of HttpClient
that performs
serialization and parsing using Juno parsers, but leaves all the details of the HTTP connection
to the Apache code.
See the {@link org.apache.juneau.rest.client} package for details.
- New
org.apache.juneau.rest.client.jazz
package and org.apache.juneau.rest.client.jazz.JazzRestClient
class
for performing REST operations against Jazz servers.
Includes improved support for FORM authentication, and better SSL certificate validation.
- Completely redesigned URL-Encoding support.
See {@link org.apache.juneau.urlencoding} package for details.
- Changes to Parser API.
- Removal of
ExtendedReaderParser
abstract class and moved methods into
{@link org.apache.juneau.parser.ReaderParser} class.
- Removal of
DataFormat
class from API since it was no longer necessary
due to API change above.
- Removal of
ParserStringReader
class.
This was a reader optimized to work with String
input.
However, it could interfere with garbage collection of the original string object.
Instead, the existing {@link org.apache.juneau.parser.ParserReader} was enhanced to work
well with String
input, and tests show no significant performance differences.
- New
org.apache.juneau.parser.Parser.parse(Object,int,ClassMeta)
convenience method added.
Other changes
- Various new methods added to {@link org.apache.juneau.internal.StringUtils} and {@link org.apache.juneau.internal.ClassUtils}.
- Improved support on
BeanContext.getClassMetaFromString(String)
.
Now supports resolving "long[]"
, and so forth.
- {@link org.apache.juneau.rest.labels.ResourceDescription} name parameter is now automatically URL-encoded in links.
- {@link org.apache.juneau.rest.RestRequest} now correctly handles cases involving URL-encoded characters in the
path info portion of URLs (e.g.
http://host/contextRoot/foo%2Fbar
).
- Removed lazy-initialization that required locking in {@link org.apache.juneau.ClassMeta}.
- New
BeanContext.setDefaultParser(ReaderParser)
method added for specifying
a default parser to use in a bean context (used when converting beans to Strings
using
BeanContext.convertToType(Object,Class)
.
Old behavior simply used the default JSON serializer in these cases.
- More consistent handling of exceptions across all parsers.
- Minor changes to {@link org.apache.juneau.rest.RestRequest} class.
- Changed the order of parameters on
RestRequest#getParameter(String,Class)
.
- Added
RestRequest.getMapParameter(String,Class,Class,Class)
and
RestRequest.getCollectionParameter(String,Class,Class)}
methods.
5.0.0.36 (Dec 18, 2013)
Juno 5.0.0.36 is a minor update.
- Implemented
org.apache.juneau.urlencoding.UrlEncodingParser.parseArgs(Reader,int,ClassMeta[])
.
name
parameter of {@link org.apache.juneau.rest.labels.ResourceDescription#ResourceDescription(String,String,String)}
is now automatically URL-encoded so that the name can contain special characters (e.g. "foo/bar(baz)").
- Support for URL-matching and path info containing encoded characters (e.g. '/') now supported.
- Removed some lazy-initialization of bean information in {@link org.apache.juneau.ClassMeta} that allowed the removal of
some synchronized blocks.
- Improved support of
BeanContext.getClassMetaFromString(String)
.
Now supports primitive arrays such as "long[]" in addition to the previous support for the equivalent "[J".
- Various new convenience methods added to {@link org.apache.juneau.internal.StringUtils} and {@link org.apache.juneau.internal.ClassUtils}.
5.0.0.35 (Nov 26, 2013)
Juno 5.0.0.35 is a minor update.
- {@link org.apache.juneau.rest.RestGuard#guard(RestRequest,RestResponse)} now returns a boolean to allow redirects to login pages.
- Fixed bug in RestServlet where occasional false positive "duplicate method with same name and path" errors were occurring.
5.0.0.34 (Nov 10, 2013)
Juno 5.0.0.34 is a moderate update.
-
New support for runtime-replaced variables in REST resource properties:
@RestResource(
messages="nls/Messages",
properties={
@Property(name="label",value="$L{servletTitle}"), // Localized variable in Messages.properties
@Property(name="javaVendor",value="$S{java.vendor}"), // System property
@Property(name="foo",value="bar"),
@Property(name="bar",value="baz"),
@Property(name="v1",value="$R{foo}"), // Request variable. value="bar"
@Property(name="v2",value="$R{$R{foo}}") // Nested request variable. value="baz"
}
)
See RestServlet.createRequestVarResolver(RestRequest)
for more information.
-
Eliminated @Property.type annotation which was the old way of specifying NLS variables that got resolved at runtime.
-
New methods on {@link org.apache.juneau.rest.RestRequest}:
RestRequest.getVarResolver()
- {@link org.apache.juneau.rest.RestRequest#getServletURI()}
- {@link org.apache.juneau.rest.RestRequest#getRequestParentURI()}
-
New methods on {@link org.apache.juneau.rest.RestResponse}:
RestResponse.sendRedirect(CharSequence)
-
New methods on {@link org.apache.juneau.rest.RestServlet} that allow easier customization by subclasses:
RestServlet.createConfigFactory()
RestServlet.createConverters()
RestServlet.createDefaultRequestHeaders()
RestServlet.createDefaultResponseHeaders()
RestServlet.createEncoders()
RestServlet.createFilters()
RestServlet.createGuards()
RestServlet.createMimetypesFileTypeMap()
RestServlet.createParsers()
- {@link org.apache.juneau.rest.RestServlet#createProperties()}
- {@link org.apache.juneau.rest.RestServlet#createRequestProperties(ObjectMap,RestRequest)}
RestServlet.createRequestVarResolver(RestRequest)
RestServlet.createSerializers()
RestServlet.createUrlEncodingParser()
-
Changed
RestServletNls
to use ResourceDescription/MethodDescription
instead of RestResource/RestMethod
-
New property
RestServletProperties.REST_htDocsFolder
.
New support for serving up static documents from classpath through REST interface.
-
Exception APIs now use {@link java.text.MessageFormat} (e.g. "{0}") for message variables instead of "%s".
-
New {@link org.apache.juneau.annotation.Bean#stopClass @Bean.stopClass} annotation for specifying stop classes for bean properties.
-
New
BeanFilter.setStopClass(Class)
which is the program equivalent to the annotation above.
-
New methods on {@link org.apache.juneau.dto.ResultSetList}:
ResultSetList.handleBlob(Blob)
ResultSetList.handleClob(Clob)
5.0.0.33 (Oct 20, 2013)
Juno 5.0.0.33 is a moderate update.
-
Removed generic parameter from {@link org.apache.juneau.serializer.WriterSerializer} class.
-
Many of the examples in the documentation were written as follows, which resulted in "unchecked" compile warnings:
WriterSerializer s = new JsonSerializer();
These compile warnings will now go away.
-
New settings in BeanContext. These can be applied to all serializers/parsers.
- {@link org.apache.juneau.BeanContext#BEAN_ignoreInvocationExceptionsOnGetters}
- {@link org.apache.juneau.BeanContext#BEAN_ignoreInvocationExceptionsOnSetters}
- {@link org.apache.juneau.BeanContext#BEAN_notBeanPackages_add}
- {@link org.apache.juneau.BeanContext#BEAN_notBeanPackages_remove}
-
Eliminated
addNotBeanClassPatterns(String...)
methods throughout API since these are now controlled by {@link org.apache.juneau.BeanContext#BEAN_notBeanPackages_add} / {@link org.apache.juneau.BeanContext#BEAN_notBeanPackages_remove} properties.
-
New settings in
RestServletProperties
.
RestServletProperties.REST_trimTrailingUriSlashes
Also removed RestRequest.getRequestURI(boolean trimTrailingSlashes)
method which is now redundant with this property.
RestServletProperties.REST_pathInfoBlankForNull
Also removed RestRequest.getPathInfo(boolean returnBlankForNull)
method which is now redundant with this property.
-
New JSON-Schema {@link org.apache.juneau.dto.jsonschema.SchemaMap} class for supporting linked schemas.
-
Serializers will no longer throw an exception when
maxDepth
setting is reached, and will instead simply ignore content below the specified depth.
While the old behavior was as-designed, the new behavior is more in-line with expected behavior.
-
Added support for HTTP header "X-Response-Headers" to {@link org.apache.juneau.rest.RestServlet}.
Allows you to specify one or more headers that should be returned on the response from the servlet.
For example, to get a page to automatically refresh every 1 second, you can append the following to a URL: ?x-response-headers={Refresh=1}
-
Removed
HtmlDocSerializerContext.HTML_REFRESH
setting that added a Refresh meta tag to HTML documents, since this can now be controlled through X-Response-Headers
.
-
Small improvements to samples.
PhotosResource
now includes a default entry.
5.0.0.32 (Oct 5, 2013)
Juno 5.0.0.32 is a moderate update.
-
New support for generating and consuming fully-compliant JSON-Schema documents.
See {@link org.apache.juneau.dto.jsonschema} for information.
-
New methods added to {@link org.apache.juneau.parser.Parser}:
org.apache.juneau.parser.Parser.parseMap(Object,int,Class,Class,Class)
org.apache.juneau.parser.Parser.parseCollection(Object,int,Class,Class)
-
{@link org.apache.juneau.annotation.Bean @Bean} annotation can now be defined on interfaces and inherited by subclasses.
-
Support for customizing serialized values for
Enums
through overriding toString()
and fromString()
on the enum class.
Previously used Enum.valueOf()
to convert strings back into Enums
.
Used for JSON-Schema support to allow {@link org.apache.juneau.dto.jsonschema.JsonType} enum to be serialized to lowercase per the specification (e.g. "string" instead of "STRING").
-
{@link org.apache.juneau.dto.cognos Cognos} DTOs now have fluent-style bean setters.
-
Support for generic bean objects whose type was erased at compile time.
Previous behavior gave you an error message that the type could not be determined.
New behavior assumes a type of Object
when the type is erased.
-
Bug fixes:
-
When duplicate fluent-style setters were defined with different parameter types (e.g.
setFoo(Foo f)
, setFoo(Bar b)
), the {@link org.apache.juneau.BeanMap} API would sometime choose the wrong setter as the bean property setter.
Now validates that the setter being chosen is the one whose return type matches the property getter.
-
Passing in
Accept
GET parameters with '+' (e.g. &Accept=text/json+simple
) wasn't working anymore.
The Accept
parameter is supposed to interpret spaces as '+' to allow you to not have to write &Accept=text/json%2Bsimple
.
-
Parsers would not set bean properties of abstract type {@link java.lang.Number}.
Now it detects the numeric type based on input and sets the value accordingly.
5.0.0.31 (Aug 9, 2013)
Juno 5.0.0.31 is a moderate update.
-
Simplified the {@link org.apache.juneau.serializer.Serializer} and {@link org.apache.juneau.parser.Parser} class hierarchies.
This reverses a previous change that added a bunch of interfaces in these APIs (and subsequently required compiling with Java 7 to get around a compiler bug).
The new class hierarchy is much simpler to understand.
-
Added {@link org.apache.juneau.transforms.XMLGregorianCalendarSwap} to convert these to ISO8601 strings during serialization, and vice versa during parsing.
-
Added a strict mode to {@link org.apache.juneau.json.JsonParser}.
-
Added default {@link org.apache.juneau.json.JsonParser#DEFAULT_STRICT} parser.
5.0.0.30 (Aug 8, 2013)
Juno 5.0.0.30 is a minor update.
-
Fixed bug involving beans using
Bean.subTypes()
annotation in addition to subTypes
property.
-
Modified the JSON parser to handle non-existent JSON values to get around an issue where Cognos was generating invalid JSON.
5.0.0.29 (Aug 2, 2013)
Juno 5.0.0.29 is a moderate update.
-
Revamped the API for filter support:
- Updated {@link org.apache.juneau.transform.BeanFilter} class to mirror the {@link org.apache.juneau.annotation.Bean @Bean} annotation.
- Introduced support for bean
Bean.subTypeProperty() subtypes
.
- Replaced
@Bean(filter=xxx)
with new @Transform
annotation.
-
Revamped URL-Encoding support.
The old URL-Encoding serializer and parser simply used the JSON serializer/parser with a thin URL-encoding top layer.
The new URL-Encoding serialize and parser was written from scratch and is considerably more consistent in design and output.
-
Improved number parsing.
The new number parser should handle any valid numeric syntax for decimals and floats that Java itself supports.
-
{@link org.apache.juneau.json.JsonSerializer} LAX mode now quotes reserved word attributes.
-
New predefined DateFilters with millisecond precision:
org.apache.juneau.transforms.DateSwap.ISO8601DTP
org.apache.juneau.transforms.DateSwap.ISO8601DTZP
5.0.0.28 (July 9, 2013)
Juno 5.0.0.28 is a moderate update.
-
Fixes an
OutOfMemoryError
and performance issue caused by incorrect caching of class metadata.
-
Added
WriterSerializer.serialize(Object,Writer)
convenience method for serializing directly to a writer.
Applies to all serializers.
5.0.0.27 (July 7, 2013)
Juno 5.0.0.27 is a moderate update.
-
Fixed some HTML formatting issues in {@link org.apache.juneau.html.HtmlSerializer}.
-
{@link org.apache.juneau.rest.RestServletDefault} now includes {@link org.apache.juneau.plaintext.PlainTextSerializer} and {@link org.apache.juneau.plaintext.PlainTextParser} for plain-text support.
-
Child resources now render on default
OPTIONS
pages through new method ResourceOptions.getChildren()
.
-
Changes to {@link org.apache.juneau.urlencoding.UrlEncodingSerializer}/{@link org.apache.juneau.urlencoding.UrlEncodingParser} to reduce the need for quoted string values.
More changes are likely in this area of the code to support multipart form posts.
-
FindBugs fixes.
5.0.0.26 (Jun 5, 2013)
Juno 5.0.0.26 is a minor update.
-
FindBug fixes.
-
Changed the way child REST resources are defined.
Eliminated the @RestChild annotation on getter methods and replaced it with {@link org.apache.juneau.rest.annotation.RestResource#children() @RestResource.children()} defined on the resource class itself.
Child resource paths are specified through {@link org.apache.juneau.rest.annotation.RestResource#path() @RestResource.path()}.
-
New {@link org.apache.juneau.rest.labels.ChildResourceDescriptions} bean for automatically generating the contents of router resource pages.
-
Changed
@RestMethod.pattern()
to {@link org.apache.juneau.rest.annotation.RestMethod#path() @RestMethod.path()} for naming consistency.
5.0.0.25 (May 11, 2013)
Juno 5.0.0.25 is a minor update.
Core API updates
-
New {@link org.apache.juneau.dto.ResultSetList} DTO for serializing SQL result sets to JSON/XML/HTML and so forth.
-
New
SqlQueryResource
class in the sample war for demonstrating the ResultSetList
DTO.
Server API updates
-
Fixed issue with media type for CSS files being reported as "text/plain" instead of "text/css".
-
Moved initialization of class properties to before the call to
Servlet.init()
so that getProperties()
can be called during servlet initialization.
-
New
@Property.type
annotation with support for using system properties as resource properties.
5.0.0.24 (May 9, 2013)
Juno 5.0.0.24 is a major update.
Core API updates
-
New support for {@link org.apache.juneau.dto.atom ATOM}.
- New
AtomFeedResource
class added to sample war.
-
New
XmlFormat.CONTENT
enum value.
Allows bean properties to be persisted as XML element text.
-
New
XmlContentHandler
class and @Xml.contentHandler
annotation.
Allows customized serialization and parsing of beans to XML element text.
Added for support of ATOM text content that must support both plain text and embedded XHTML.
-
New {@link org.apache.juneau.xml.annotation.XmlSchema @XmlSchema} and updated {@link org.apache.juneau.xml.annotation.XmlNs @XmlNs} annotations to better mimic JAXB.
-
Removed
@Xml.valAttr
annotation since it's now redundant with @Xml(format=CONTENT)
.
-
Fixed timezone bug in {@link org.apache.juneau.transforms.CalendarSwap}.
-
Simplified
Serializer.serialize(Object,Object,SerializerContext)
method.
-
Fixed bug where lists returned by {@link org.apache.juneau.ObjectMap#getObjectList(String)} were not updatable.
-
Eliminated old RDF/XML serializer.
Documentation updates
- New {@link org.apache.juneau.json JSON Support Overview} document.
- New {@link org.apache.juneau.xml XML Support Overview} document.
- New {@link org.apache.juneau.jena RDF Languages Support Overview} document.
- New {@link org.apache.juneau.dto.atom ATOM Support Overview} document.
5.0.0.23 (Apr 14, 2013)
Juno 5.0.0.23 is a minor update.
-
Simplified {@link org.apache.juneau.dto.cognos Cognos} support.
-
Fixed bug where
@Xml
annotation was not being inherited by inner classes.
-
Javadoc stylesheet improvements.
5.0.0.22 (Apr 12, 2013)
Juno 5.0.0.22 is a minor update.
Core API changes
-
New
@Property.nls()
annotation for specifying localized property values.
For example, allows you to set the HTMLDOC_title and HTMLDOC_description properties to localized values pulled from a resource bundle.
See the AddressBookResource
class for an example.
REST Servlet API changes
- Fix a bug where the
&Content
query parameter was not always parsed correctly.
5.0.0.21 (Apr 9, 2013)
Juno 5.0.0.21 is a minor update.
Core API changes
-
New {@link org.apache.juneau.html.HtmlDocSerializerContext#HTMLDOC_links} annotation for addint links to HTML page views.
-
Renamed the properties in {@link org.apache.juneau.html.HtmlDocSerializerContext} for clarity.
Servlet API changes
-
Added new
RestServlet.addDefaultProperties(ObjectMap,RestRequest)
method for programatically adding properties to the property map per request.
-
Added the following new properties in the properties map to make them easily available to serializers and parsers (since they don't have access to the HTTP request object).
Note that the SerializerContext.SERIALIZER_uriAuthority
and SerializerContext.SERIALIZER_uriContext
properties were previously available.
RestServletProperties.REST_servletPath
RestServletProperties.REST_pathInfo
RestServletProperties.REST_method
-
Path variables annotated with
@Attr
are now automatically URL-decoded.
5.0.0.20 (Apr 7, 2013)
Juno 5.0.0.20 is a major update.
Core API changes
-
New Jena-based {@link org.apache.juneau.jena.RdfSerializer} for serializing POJOs to RDF/XML, RDF/XML-ABBREV, N-Triple, Turtle, and N3.
Serializes ANY POJOs to RDF, even simple objects and primitives.
-
New Jena-based {@link org.apache.juneau.jena.RdfParser} for parsing RDF/XML, RDF/XML-ABBREV, N3, Turtle, and N-Triple back into POJOs.
-
{@link org.apache.juneau.xml.XmlSerializerContext#XML_autoDetectNamespaces} default changed to true.
The old default value would cause XML with unmapped namespaces if you didn't manually specify them via the {@link org.apache.juneau.xml.XmlSerializerContext#XML_namespaces} annotation.
While setting the default to true is somewhat slower (since the serializer must crawl the POJO tree to find namespaces), the benefits of having it work out-of-the-box outweighs the performance concerns.
For developers concerned about performance, they can always change it back to false and specify the namespaces themselves.
REST server API changes
-
Allow inheritance of {@link org.apache.juneau.rest.annotation.RestResource @RestResource} annotation.
Serializers, parsers, filters, properties , guards, and converters definitions are automatically inherited from parent classes and interfaces.
-
Enhancements to {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod} annotation:
-
New
RestMethod.filters()
annotation for defining POJO filters at the method level.
-
New {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit()} and {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit()} annotations for controlling how serializers and parsers (and associated filters and properties) are inherited from the class.
This replaces the previous addSerializers
and addParsers
annotations.
-
New {@link org.apache.juneau.rest.jena.RestServletJenaDefault} servlet that includes serialization/parsing support for all Jena-based serializers and parsers.
-
New {@link org.apache.juneau.rest.jaxrs.rdf.DefaultJenaProvider} JAX-RS provider that includes serialization/parsing support for all Jena-based serializers and parsers.
-
Eliminated
RestServletChild
class.
It's redundant with the introduction of inheritable annotations.
-
New methods on {@link org.apache.juneau.rest.RestServlet}:
RestServlet.createConfigFactory()
RestServlet.createSerializers()
RestServlet.createParsers()
These augment the existing getBeanContext()
/ getSerializers()
/ getParsers()
methods.
REST client API changes
-
New
RestCall.setDateHeader(String,Object)
method for setting ISO8601 datetime headers.
5.0.0.19 (Apr 1, 2013)
Juno 5.0.0.19 is a minor update.
-
New methods on {@link org.apache.juneau.rest.RestServlet}:
- {@link org.apache.juneau.rest.RestServlet#onPreCall(RestRequest)}
- {@link org.apache.juneau.rest.RestServlet#onPostCall(RestRequest,RestResponse)}
-
TRIM_NULLS setting changed to {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_trimNullProperties}.
New property default is true.
Only applies to bean properties, not map or collection entries.
5.0.0.18 (Mar 27, 2013)
Juno 5.0.0.18 is a moderate update.
The biggest change is the introduction of the {@link org.apache.juneau.jena.RdfSerializer} class that uses Jena to generate RDF/XML, RDF/XML-ABBREV, N-Tuple, N3, and Turtle output.
This code should be considered prototype-quality, and subject to change in the future.
There are plans of adding an equivalent RdfParser
class in the future, so the serializer logic may need to be tweaked to allow POJOs to be reconstituted correctly in the parser.
The RdfXmlSerializer
class should be considered deprecated for now.
However, I'm keeping it around, since it's considerably faster and uses far less memory than the Jena-based serializer since it serializes directly from POJOs to RDF/XML.
It may or may not be removed in the future depending on demand.
Other changes
-
New {@link org.apache.juneau.jso.JavaSerializedObjectParser} class.
5.0.0.17 (Mar 25, 2013)
Juno 5.0.0.17 is a minor update.
-
Charset now passed as a parameter to
IOutputStreamSerializer.serialize()
and IInputStreamParser.parse()
.
5.0.0.16 (Mar 25, 2013)
Juno 5.0.0.16 is a minor update.
-
New {@link org.apache.juneau.rest.annotation.Properties @Properties} REST method parameter annotation that can be used to get the runtime properties map through a parameter instead of through {@link org.apache.juneau.rest.RestResponse}.
5.0.0.15 (Mar 24, 2013)
Juno 5.0.0.15 is a moderate update.
-
Juno-Wink integration components that have been requested my many for a long time!
Refer to {@link org.apache.juneau.rest.jaxrs} for information.
-
New {@link org.apache.juneau.annotation.Produces @Produces} annotation in place of
ISerializer.getMediaTypes()
for specifying what media types a serializer produces.
Available when subclassing from {@link org.apache.juneau.serializer.Serializer}.
-
New {@link org.apache.juneau.annotation.Consumes @Consumes} annotation in place of
IParser.getMediaTypes()
for specifying what media types a parser consumes.
Available when subclassing from {@link org.apache.juneau.parser.Parser}.
5.0.0.14 (Mar 23, 2013)
Juno 5.0.0.14 is a major update.
The biggest change is that the RestSerializer
, RestParser
, RestSerializerGroup
, and RestParserGroup
classes have been eliminated entirely.
Instead, the existing {@link org.apache.juneau.serializer.Serializer}, {@link org.apache.juneau.parser.Parser}, {@link org.apache.juneau.serializer.SerializerGroup}, and {@link org.apache.juneau.parser.ParserGroup} classes of the core API have been augmented to replace them.
Adoptions will be required if you have previously used these classes.
Core API changes
-
New {@link org.apache.juneau.serializer} package.
- Entirely reworked class hierarchy to make it easier to define new serializers.
- New {@link org.apache.juneau.serializer.WriterSerializer} base class for defining character-based serializers.
- New {@link org.apache.juneau.serializer.OutputStreamSerializer} base class for defining byte-based serializers.
- Updated {@link org.apache.juneau.serializer.SerializerGroup} class with full support for RFC2616
Accept-Content
headers.
- Improved cloning support on serializers and serializer groups.
-
New {@link org.apache.juneau.parser} package.
- Entirely reworked class hierarchy to make it easier to define new parsers.
- New {@link org.apache.juneau.parser.ReaderParser} base class for defining character-based parsers.
- New {@link org.apache.juneau.parser.InputStreamParser} base class for defining byte-based parsers.
- Improved cloning support on parsers and parser groups.
-
New {@link org.apache.juneau.transform} package.
- Cleaner class structure.
- Improved {@link org.apache.juneau.transform.BeanFilter} class for defining property filters on beans.
- Improved {@link org.apache.juneau.utils.PojoQuery} class for defining filters on objects (previously called
ObjectFilter
).
-
New {@link org.apache.juneau.encoders} package.
- Defines API for {@link org.apache.juneau.encoders.Encoder Encoders} for enabling compression in REST servlets and clients.
- Previously, gzip compression was enabled by default. This new API allows you to plug in your own compression algorithms.
- New {@link org.apache.juneau.encoders.GzipEncoder} class for enabling gzip compression.
- New {@link org.apache.juneau.encoders.EncoderGroup} class for managing multiple encoders and finding them based on RFC2616
Accept-Encoding
header values.
-
New {@link org.apache.juneau.plaintext} package.
- New {@link org.apache.juneau.plaintext.PlainTextSerializer} and {@link org.apache.juneau.plaintext.PlainTextParser} classes for serializing/parsing text/plain content.
-
New {@link org.apache.juneau.jso} package.
- New {@link org.apache.juneau.jso.JavaSerializedObjectSerializer} class for serializing
application/x-java-serialized-object
content.
-
New {@link org.apache.juneau.soap} package.
- New {@link org.apache.juneau.soap.SoapXmlSerializer} class for serializing
text/xml+soap
content.
-
Improved cloning support on the {@link org.apache.juneau.BeanContext} class.
- Better caching. Improved caching performance.
-
JsonMap
and JsonList
changed to {@link org.apache.juneau.ObjectMap} and {@link org.apache.juneau.ObjectList} to better reflect that they're not limited to just JSON support.
-
Renamed
PojoSwap
to {@link org.apache.juneau.utils.PojoQuery} to not confuse it with the new Filter API.
REST server API changes
-
Eliminated
org.apache.juneau.rest.serializers
and org.apache.juneau.rest.parsers
packages.
- All existing REST serializers and parsers merged into the core API.
REST client API changes
-
Simplified {@link org.apache.juneau.rest.client.RestClient} API.
- You can now only specify a single serializer or parser per client. This significantly simplifies the code.
- Support for {@link org.apache.juneau.encoders.Encoder Encoders}.
-
Eliminated
RestCmdLine
(since it's essentially redundant with CURL).
5.0.0.13 (Mar 14, 2013)
Juno 5.0.0.13 is a minor update.
Core API changes
-
New support for relative URIs.
- URIs of the form "foo/bar" are interpreted as relative to the context root of the web application.
- URIs of the form "/foo/bar" are interpreted as relative to the HTTP authority (e.g. "http://myhost:9080").
-
New
SerializerContext.SERIALIZER_uriContext
and SerializerContext.SERIALIZER_uriAuthority
serializer properties for specifying values for relative URIs.
-
New {@link org.apache.juneau.annotation.URI @URI} annotation that allows you to specify classes and bean properties as URLs that aren't
java.net.URI
or java.net.URL
.
-
New {@link org.apache.juneau.html.HtmlSerializerContext#HTML_uriAnchorText} HTML serializer property for tailoring how anchor text is rendered.
-
Renamed
BeanProperty#uri
annotation to BeanProperty#beanUri
to make it clear that this property represents the URI of the bean itself instead of an arbitrary property containing a URI.
-
Removed
BeanProperty#id
annotation.
REST server API changes
-
Improvements to {@link org.apache.juneau.rest.RestServlet} to automatically handle relative URIs in POJOs.
SerializerContext.SERIALIZER_uriContext
property set by default to web app context root.
SerializerContext.SERIALIZER_uriAuthority
property set by default to the request scheme+hostname+port.
-
Fixed bug involving
Accept-Charset
header in Chrome that prevented HTML output from rendering correctly in that browser.
Accept-Charset
handling should now be fully W3C compliant.
5.0.0.12 (Mar 10, 2013)
Juno 5.0.0.12 is a minor update.
Core API changes
-
Relaxed method naming conventions when using {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotation.
Methods with zero parameters are interpreted as getters, and methods with one parameter are interpreted as setters.
Eliminated the BeanProperty.method
annotation, since it's now unnecessary.
REST server API changes
-
Significantly improved response error messages.
Older messages were rather cryptic. Error conditions should be much easier to debug now.
-
New
PlainTextRestSerializer
class for serializing "plain/text" requests.
Useful for debugging purposes.
-
Readers
and InputStreams
can now be passed in as @Content
parameters if you need direct access to the HTTP body content without involving the parsers.
Equivalent to previously calling {@link org.apache.juneau.rest.RestRequest#getInputStream()} and {@link org.apache.juneau.rest.RestRequest#getReader()}.
-
Improved support for the
?debug
parameter.
Dumps better information to the log file, such as all header parameters.
5.0.0.11 (Mar 8, 2013)
Juno 5.0.0.11 is a moderate update.
REST server API changes
-
New
UrlEncodingRestSerializer
and UrlEncodingRestParser
classes.
Allows parsing form posts directly to POJOs.
-
Support for
Accept
and Content-Type
"application/x-www-form-urlencoded" added by default on {@link org.apache.juneau.rest.RestServletDefault}.
-
New {@link org.apache.juneau.rest.RestServlet#renderError(HttpServletRequest,HttpServletResponse,RestException)} method to allow customized handling of response errors.
5.0.0.10 (Mar 7, 2013)
Juno 5.0.0.10 is a minor update.
Core API changes
- New {@link org.apache.juneau.ObjectMap#findKeyIgnoreCase(String)} method.
- HtmlSerializer will now create 2-dimensional tables for collections of mixed beans/maps if all object have the same set of property names/keys.
REST server API changes
- New
RestServletProperties
class that defines all the class-level properties that can be set on the servlet.
- Properties can be set through {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties} annotation, or new {@link org.apache.juneau.rest.RestServlet#setProperty(String,Object)} method.
- New "?noTrace" URL parameter to prevent stack traces from being logged (for JUnit testing of error conditions).
- New
RestServletProperties.REST_useStackTraceHashes
property to prevent the same stack trace from being logged multiple times.
- New
RestServletProperties.REST_renderResponseStackTraces
property for preventing stack traces in responses for security reasons.
- New overridable
RestServlet.onError(HttpServletRequest,HttpServletResponse,RestException,boolean)
and {@link org.apache.juneau.rest.RestServlet#onSuccess(RestRequest,RestResponse,long)} methods for plugging in your own logging and peformance monitoring.
- Eliminated
RestServlet.getInitParams()
method, since it's now redundant with {@link org.apache.juneau.rest.RestServlet#getProperties()}.
- Header parameters passed as URL parameters are now case-insensitive.
5.0.0.9 (Feb 26, 2013)
Juno 5.0.0.9 is a moderate update.
Core API changes
-
{@link org.apache.juneau.ini INI config file support}:
- A convenient API for reading, writing, and manipulating INI files.
- Ability to convert INI files to batch and shell environment variables.
- Command-line interface for updating INI files.
- Support for encoded INI file values.
- Support for fluent-style bean setters (setters that return the bean itself).
- Ability to use {@link org.apache.juneau.annotation.Bean @Bean} annotation to override bean identification settings.
- New {@link org.apache.juneau.ObjectMap#cast(Class)} method to convert
ObjectMaps
directly to beans.
REST server API changes
- Build-in default
OPTIONS
pages.
- New {@link org.apache.juneau.rest.annotation.RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders} and {@link org.apache.juneau.rest.annotation.RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders} annotations.
- New {@link org.apache.juneau.rest.annotation.RestMethod#serializers() @RestMethod.serializers} and {@link org.apache.juneau.rest.annotation.RestMethod#parsers() @RestMethod.parsers} annotations.
- New {@link org.apache.juneau.rest.annotation.RestMethod#properties() @RestMethod.properties} annotation.
- New {@link org.apache.juneau.rest.annotation.RestMethod#defaultRequestHeaders() @RestMethod.defaultRequestHeaders} annotation.
- New {@link org.apache.juneau.rest.annotation.RestMethod#matchers() @RestMethod.matchers} annotation and {@link org.apache.juneau.rest.RestMatcher} class.
Readers
and InputStreams
can be specified on @Content
annotated parameters.
- New
@HasParam
annotation.
- Full RFC2616 support for matching
Accept
headers to serializers.
Other notes
- Smaller library size (460kB).
5.0.0.8 (Jan 30, 2013)
Juno 5.0.0.8 is a minor update.
-
New {@link org.apache.juneau.ini INI file} support.
- Makes reading, updating, and manipulating INI configuration files a snap.
- Supports automatic conversion of data types in line with the functionality of the rest of the product.
- Comments and layout of INI files are persisted during saves.
5.0.0.7 (Jan 20, 2013)
Juno 5.0.0.7 is a major update.
Core API updates
- Combined previous 3 libraries into a single library.
-
New {@link org.apache.juneau.parser.ParserListener} class.
Adds ability to find and process unknown bean properties during parsing.
-
Enhancements to {@link org.apache.juneau.xml.XmlParser}:
- Coalescing support
- Validations support
- Support for replacing entity references
- Resolver support
- Event allocator support
- Trim-whitespace support
-
Enhanced XML support:
-
New {@link org.apache.juneau.xml.annotation.Xml#format() @Xml.format} annotation.
Controls how POJOs get serialized to XML.
Also allows you to collapse collections and arrays.
-
New
@Xml.namespaces
annotation.
Namespaces can be defined at package, class, method, or field levels.
-
New
@Xml.nsUri
annotation.
Shortcut for specifying namespace URIs.
-
New
@Xml.valAttr
annotation.
Serializes a bean property value as an attribute.
- Ability to override XS and XSI namespaces on XML and RDF/XML serializers.
- Ability to override RDF namespace on RDF/XML serializer.
- New more-efficient namespace resolution.
-
New configurable property classes for everything are now structured better and easier to locate and identify through the following new classes:
- {@link org.apache.juneau.BeanContext}
- {@link org.apache.juneau.serializer.SerializerContext}
- {@link org.apache.juneau.parser.ParserContext}
-
Enhancements to {@link org.apache.juneau.BeanContext}:
-
Ability to mark bean properties as hidden using
@BeanProperty.hidden()
so that they don't get serialized.
-
Simplified
ClassType
{@link org.apache.juneau.ClassMeta} API.
Combined 4 classes into a single class.
-
New
@Bean.filter
and @BeanProperty.filter
annotations.
Used for defining filters on bean classes and bean properties instead of just globally through BeanContext.addTransforms(Class[])
.
-
New {@link org.apache.juneau.PropertyNamer} API / {@link org.apache.juneau.annotation.Bean#propertyNamer() @Bean.propertyNamer} annotation.
Used for customizing bean property names.
-
New
@BeanProperty.beanUri
and @BeanProperty.id
annotations.
Used for associating beans with URLs and IDs.
Used by XML serializer to add a url attribute on a bean element.
Used by RDF/XML serializer to construct rdf:resource
attributes.
-
New {@link org.apache.juneau.annotation.BeanProperty#properties() @BeanProperty.properties} annotation.
Used for limiting properties on child elements.
-
Automatic support for {@link java.net.URL} and {@link java.net.URI} objects.
- Converted to hrefs in HTML.
- Converted to url attributes in XML.
- Converted to resource:about attributes in RDF/XML.
-
Improvements to Javadocs.
-
Improved {@link org.apache.juneau.utils.PojoQuery} support.
REST client updates
- GZIP compression support.
- Bug fixes.
REST server updates
-
Support for overriding bean context and serializer properties in a REST method call through new {@link org.apache.juneau.rest.RestResponse#setProperty(String,Object)} method.
For example, allows you to control whitespace options on a per-request basis.
-
Several new annotations on REST servlets:
@RestResource.filters()
- Associate post-formatting filters on a resource level.
- {@link org.apache.juneau.rest.annotation.RestResource#guards() @RestResource.guards} - Associate resource-level guards.
- {@link org.apache.juneau.rest.annotation.RestResource#messages() @RestResource.messages} - Associate a resource bundle with a REST servlet. Comes with several convenience methods for looking up messages for the client locale.
- {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties} - Override default bean context, serializer, and parser properties though an annotation.
-
Several new annotations on REST methods:
@RestMethod.filters()
- Associate post-formatting filters on a method level.
- {@link org.apache.juneau.rest.annotation.RestMethod#guards() @RestMethod.guards} - Associate method-level guards.
-
New annotations on REST method parameters with automatic conversion:
@Attr
- A parameter or URL variable value as a parsed POJO.
@Param
- A query parameter value as a parsed POJO.
- {@link org.apache.juneau.rest.annotation.PathRemainder @PathRemainder} - The remainder after a URL pattern match as a String.
- {@link org.apache.juneau.rest.annotation.Header @Header} - An HTTP header value as a parsed POJO.
@Content
- The HTTP content as a parsed POJO.
- {@link org.apache.juneau.rest.annotation.Method @Method} - The HTTP method name as a String.
-
HTTP response content POJOs can now simply be returned from methods instead of calling {@link org.apache.juneau.rest.RestResponse#setOutput(Object)}.
5.0.0.6 (Oct 30, 2012)
Juno 5.0.0.6 is a minor update that fixes a small bug in 5.0.0.5.
5.0.0.5 (Oct 29, 2012)
Juno 5.0.0.5 is a major update.
- New
@RestChild
annotation for identifying child resources.
-
New
traversable
and filterable
attributes added to {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod} annotation.
Eliminates the need for PojoResource
and FilteredRestResource
classes.
- Simplified client API. Easier to use when making multiple connections to the same server.
- Support for pluggable authentication in the client API.
- Support for authenticating against Jazz Team Servers.
- Support for rendering package-level Javadocs in REST resources.
- Support for parsing of header values into specific object types.
- Changed default XML representation to not include JSON-type attributes. Produces cleaner XML.
-
New
resourceUri
attributed added to @Bean annotation to associate beans with resource URIs.
- Used for automatically creating hyperlinks in {@link org.apache.juneau.html.HtmlSerializer}.
- Used for automatically creating uri attributes in {@link org.apache.juneau.xml.XmlSerializer}.
- Used for automatically creating rdf:about attributes in
RdfXmlSerializer
.
5.0.0.4 (Oct 7, 2012)
Juno 5.0.0.4 is a minor update.
-
New {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod} annoation on {@link org.apache.juneau.rest.RestServlet} methods.
Allows the usage of URL pattern matching and automatic conversion of URL variables to arguments passed to method handlers.
See {@link org.apache.juneau.rest.RestServlet} for more information.
-
Enhancements to
BeanContext.convertToType(Object,Class)
to be able to convert Strings
to classes with
fromString(String)
/valueOf(String)
static methods or T(String)
constructors.
5.0.0.3 (Oct 3, 2012)
Juno 5.0.0.3 is a minor update.
-
Support for parsing into read-only beans (i.e. beans with only getters, property values set through constructor args).
To support this, the {@link org.apache.juneau.annotation.BeanConstructor @BeanConstructor} annotation has been added.
-
Merged separate settings classes back into their base classes (simplifies the API).
-
{@link org.apache.juneau.serializer.SerializerGroup SerializerGroups} and {@link org.apache.juneau.parser.ParserGroup ParserGroups} now share {@link org.apache.juneau.BeanContext BeanContexts} to reduce memory consumption of class type metadata.
5.0.0.2 (Sept 28, 2012)
Juno 5.0.0.2 is a minor update.
-
Improvements to Javadocs. Most of the information in the Juno Starters Guide wiki has been moved into the overview and package-level javadocs.
Since the information is now written in HTML, you can now copy and paste the code examples directly from the Javadocs.
The code examples are also syntax-highlighted using CSS.
-
Support for defining default XML namespaces on packages and classes for the XML and RDF serializers.
-
Restructured the packages along content type support (e.g. all JSON support moved to
org.apache.juneau.json
).
-
Automatic support for parsing maps with
Enum
keys, and parsing Enum
strings.
This was previously possible using filters, but now it's built-in for all the parsers.
-
Replaced the
ObjectList.toXArray()
methods with a new elements(Class<T> type)
method that's more efficient and avoids creating an unnecessary array.
-
Support for parsing into beans with read-only properties.
New {@link org.apache.juneau.annotation.BeanConstructor @BeanConstructor} annotation allows you to specify bean property values to be passed in through a constructor.
-
Separated the rest library into separate independent client and server libraries.
Use one, use both, it's up to you.
5.0.0.1 (Jun 14, 2012)
Juno 5.0.0.1 is a moderate update.
-
New support for generating XML-Schema documents from POJO models.
-
New support for serializing to RDF/XML.
5.0.0.0 (Jun 11, 2012)
Version 5.0 marks a major release milestone for the Juno/JJSON library.
It is now available for download from iRAM under the name "Juno (previously JJSON)".
The Juno Starters Guide has been updated to reflect new functionality in this release.
-
New name.
Unfortunately, "JJSON" was already trademarked by another similar library.
Therefore, it's been renamed "Juno" (after the Roman goddess and wife of Jupiter) which does not appear to have any similar trademark issues (crosses fingers).
The name is also a play on the word "Uno", indicating that this is a single simple unifying interface of several kinds of technology.
-
Simplified APIs for working with beans.
Significant improvements have been made to the parsers to make it easier to convert serialized POJOs back into their original forms.
-
Serializer/Parser classes now directly subclass from {@link org.apache.juneau.BeanContext}.
In previous releases, if you wanted to change the way beans were handled by the serializers and parsers, you had to construct a separate bean map factory and pass it to the serializer or parser.
Now, you can call the bean map factory methods directly on the serializer or parser class.
-
Simplified Filter API for handling non-standard POJOs.
The API for handling non-standard POJOs has been simplified by introducing the concept of a Transform
class, which is associated with the BeanContext
class (and thus the Serializer and Parser classes too) through the BeanContext.addTransforms(Class[])
method.
Two new subclasses of Transform
:
- {@link org.apache.juneau.transform.BeanFilter} - Filter POJO beans.
- {@link org.apache.juneau.transform.PojoSwap} - Filter POJOs that aren't beans.
This new API replaces the previous separate Cast
and BeanFilter
APIs which were considerably more complicated and puts them under a common API.
-
Elimination of
_class
attributes in parsable output.
One of the complaints about the previous version of JJSON was that if you wanted to have the resulting JSON or XML be parsable back into beans, you had to enable the "addClassAttrs" property on the bean map factory class so that "_class" attributes could be added to the output.
This requirement is virtually eliminated in v5. In many cases, the parsers are able to determine through reflection what the correct target type is based on the top-level class passed in on the parse method.
-
Performance improvements.
Several significant performance improvements have been made in this release.
-
New Reader-based JSON parser.
Previously, the JSON parser required that the entire JSON text be loaded into memory as a String before being parsed.
The new JSON parser is Reader-based which significantly reduces memory consumption.
-
New StAX-based XML parser.
The old XML parser was based on DOM. The new XML parser uses a StAX parser which significantly reduces memory consumption.
-
Caching of reflection data in the
BeanMap
API.
The number of reflection calls have been significantly reduced in the BeanMap
API code.
Reflection is used to determine the class types of property values on beans.
This information is now cached and persisted so that the reflection API calls to determine class types are only performed the first time a bean type is encountered.
-
Automatic support for GZIP compression/decompression in
RestServlets
.
This is completely transparent to the developer.
The output writer is negotiated by the framework to automatically handle compression and charset requests without the developer needing to know anything about it.
-
Cognos/XML support.
-
JSON-schema support.
-
New {@link org.apache.juneau.utils.PojoIntrospector} class.
-
Significant REST servlet API improvements.
-
Defining child resources is considerably simpler now.
In addition to the standard doX() methods for handling the requests for the current resource, you can also define getX() methods for returning child resources which automatically become available under the child URL specified by the getter name.
-
Initialization of the child resources occurs automatically when the parent resource initialization occurs.
-
Other improvments have been made in the area of automatic negotiation of input and output type streams.
For example, automatic support is provided for GZIP (
Accept-Encoding: gzip
) and charsets (e.g Accept-Charset: SJIS
) on both incoming and outgoing data.
It's all transparent from a developers perspective.
The developer simply working with POJOs, and all details about content types, encoding, charsets, and so forth are handled by the framework.
-
Support for generating complex
OPTIONS
pages for resources.
-
Automatic support for SOAP XML output on "text/soap+xml" requests against
RestServlet
.
-
Support for XML namespaces.
-
Support for setting the XML root element name by either passing in a parameter on the serializer, or by specifying it via a @Bean annotation.
-
Support for loading beans directly from Readers and Strings.
-
Parsing support for POJOs of type
Enum
.
-
Significant improved support for various flavors of parameterized types, such as subclasses of parameterized types (e.g.
MyBeanList extends LinkedList<MyBean>
).
-
Improved ordering of bean properties (should now be ordered as they are defined in the class).
-
Various default filters provided:
- byte[]<-->Base64 encoded strings
- Date/Calendar<-->ISO8601/RFC822/Long
-
New {@link org.apache.juneau.html.HtmlParser} and {@link org.apache.juneau.urlencoding.UrlEncodingParser} classes.
-
HtmlSerializer now produces XHTML.