-
Notifications
You must be signed in to change notification settings - Fork 815
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #615 from apache/WW-2815-xstream
[WW-2815] Refactors XStreamHandler to allow to provide a custom configuration
- Loading branch information
Showing
6 changed files
with
213 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
plugins/rest/src/main/java/org/apache/struts2/rest/handler/xstream/XStreamProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.struts2.rest.handler.xstream; | ||
|
|
||
| import com.thoughtworks.xstream.XStream; | ||
|
|
||
| /** | ||
| * An interface to be implemented by an action to create/provide an instance | ||
| * of XStream - it allows customisation per action | ||
| */ | ||
| public interface XStreamProvider { | ||
| XStream createXStream(); | ||
| } |
157 changes: 157 additions & 0 deletions
157
plugins/rest/src/test/java/org/apache/struts2/rest/handler/XStreamHandlerTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.struts2.rest.handler; | ||
|
|
||
| import com.opensymphony.xwork2.ActionContext; | ||
| import com.opensymphony.xwork2.ActionSupport; | ||
| import com.opensymphony.xwork2.XWorkTestCase; | ||
| import com.opensymphony.xwork2.mock.MockActionInvocation; | ||
| import com.thoughtworks.xstream.XStream; | ||
| import com.thoughtworks.xstream.io.xml.StaxDriver; | ||
| import com.thoughtworks.xstream.security.ExplicitTypePermission; | ||
| import com.thoughtworks.xstream.security.TypePermission; | ||
| import org.apache.struts2.rest.handler.xstream.XStreamAllowedClassNames; | ||
| import org.apache.struts2.rest.handler.xstream.XStreamAllowedClasses; | ||
| import org.apache.struts2.rest.handler.xstream.XStreamPermissionProvider; | ||
| import org.apache.struts2.rest.handler.xstream.XStreamProvider; | ||
|
|
||
| import java.io.Reader; | ||
| import java.io.StringReader; | ||
| import java.io.StringWriter; | ||
| import java.io.Writer; | ||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.HashSet; | ||
| import java.util.Locale; | ||
| import java.util.Set; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| public class XStreamHandlerTest extends XWorkTestCase { | ||
|
|
||
| private XStreamHandler handler; | ||
| private MockActionInvocation ai; | ||
|
|
||
| public void setUp() throws Exception { | ||
| super.setUp(); | ||
| handler = new XStreamHandler(); | ||
| ai = new MockActionInvocation(); | ||
| ActionSupport action = new ActionSupport(); | ||
| ActionContext context = ActionContext.of(new HashMap<>()).withLocale(Locale.US); | ||
| ai.setInvocationContext(context); | ||
| ai.setAction(action); | ||
| } | ||
|
|
||
| public void testObjectToXml() throws Exception { | ||
| // given | ||
| SimpleBean obj = new SimpleBean(); | ||
| obj.setName("Jan"); | ||
| obj.setAge(12L); | ||
| obj.setParents(Arrays.asList("Adam", "Ewa")); | ||
|
|
||
| // when | ||
| Writer stream = new StringWriter(); | ||
| handler.fromObject(ai, obj, null, stream); | ||
|
|
||
| // then | ||
| stream.flush(); | ||
| assertThat(stream.toString()) | ||
| .contains("<org.apache.struts2.rest.handler.SimpleBean>") | ||
| .contains("<name>Jan</name>") | ||
| .contains("<age>12</age>") | ||
| .contains("<parents class=\"java.util.Arrays$ArrayList\">") | ||
| .contains("<string>Adam</string>") | ||
| .contains("<string>Ewa</string>") | ||
| .contains("</org.apache.struts2.rest.handler.SimpleBean>"); | ||
| } | ||
|
|
||
| public void testXmlToObject() { | ||
| // given | ||
| String xml = "<?xml version='1.0' encoding='UTF-8'?><org.apache.struts2.rest.handler.SimpleBean><name>Jan</name><age>12</age><parents class=\"java.util.ArrayList\"><string>Adam</string><string>Ewa</string></parents></org.apache.struts2.rest.handler.SimpleBean>"; | ||
|
|
||
| SimpleBean obj = new SimpleBean(); | ||
| ai.setAction(new SimpleAction()); | ||
|
|
||
| // when | ||
| Reader in = new StringReader(xml); | ||
| handler.toObject(ai, in, obj); | ||
|
|
||
| // then | ||
| assertNotNull(obj); | ||
| assertEquals("Jan", obj.getName()); | ||
| assertEquals(12L, obj.getAge().longValue()); | ||
| assertNotNull(obj.getParents()); | ||
| assertThat(obj.getParents()) | ||
| .hasSize(2) | ||
| .containsExactly("Adam", "Ewa"); | ||
| } | ||
|
|
||
| public void testXmlToObjectWithAliases() { | ||
| // given | ||
| String xml = "<?xml version='1.0' encoding='UTF-8'?><data><name>Jan</name><age>12</age><parents><string>Adam</string><string>Ewa</string></parents></data>"; | ||
|
|
||
| SimpleBean obj = new SimpleBean(); | ||
| ai.setAction(new SimpleAliasAction()); | ||
|
|
||
| // when | ||
| Reader in = new StringReader(xml); | ||
| handler.toObject(ai, in, obj); | ||
|
|
||
| // then | ||
| assertNotNull(obj); | ||
| assertEquals("Jan", obj.getName()); | ||
| assertEquals(12L, obj.getAge().longValue()); | ||
| assertNotNull(obj.getParents()); | ||
| assertThat(obj.getParents()) | ||
| .hasSize(2) | ||
| .containsExactly("Adam", "Ewa"); | ||
| } | ||
|
|
||
| private static class SimpleAction implements XStreamAllowedClasses, XStreamAllowedClassNames, XStreamPermissionProvider { | ||
| @Override | ||
| public Set<Class<?>> allowedClasses() { | ||
| Set<Class<?>> classes = new HashSet<>(); | ||
| classes.add(SimpleBean.class); | ||
| return classes; | ||
| } | ||
|
|
||
| @Override | ||
| public Set<String> allowedClassNames() { | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| @Override | ||
| public Collection<TypePermission> getTypePermissions() { | ||
| return Collections.emptyList(); | ||
| } | ||
| } | ||
|
|
||
| private static class SimpleAliasAction extends SimpleAction implements XStreamProvider { | ||
| @Override | ||
| public XStream createXStream() { | ||
| XStream stream = new XStream(new StaxDriver()); | ||
| stream.alias("parents", ArrayList.class); | ||
| stream.alias("data", SimpleBean.class); | ||
| return stream; | ||
| } | ||
| } | ||
| } |