001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.shiro.io;
020    
021    import java.beans.XMLDecoder;
022    import java.beans.XMLEncoder;
023    import java.io.BufferedInputStream;
024    import java.io.BufferedOutputStream;
025    import java.io.ByteArrayInputStream;
026    import java.io.ByteArrayOutputStream;
027    
028    /**
029     * Serializer implementation that uses the JavaBeans
030     * {@link java.beans.XMLEncoder XMLEncoder} and {@link java.beans.XMLDecoder XMLDecoder} to serialize
031     * and deserialize, respectively.
032     * <p/>
033     * <b>NOTE:</b> The JavaBeans XMLEncoder/XMLDecoder only successfully encode/decode objects when they are
034     * JavaBeans compatible!
035     * 
036     * @since 0.9
037     */
038    public class XmlSerializer implements Serializer {
039    
040        /**
041         * Serializes the specified <code>source</code> into a byte[] array by using the
042         * {@link java.beans.XMLEncoder XMLEncoder} to encode the object out to a
043         * {@link java.io.ByteArrayOutputStream ByteArrayOutputStream}, where the resulting byte[] array is returned.
044         * @param source the Object to convert into a byte[] array.
045         * @return the byte[] array representation of the XML encoded output.
046         */
047        public byte[] serialize(Object source) {
048            if (source == null) {
049                String msg = "argument cannot be null.";
050                throw new IllegalArgumentException(msg);
051            }
052    
053            ByteArrayOutputStream bos = new ByteArrayOutputStream();
054            XMLEncoder encoder = new XMLEncoder(new BufferedOutputStream(bos));
055            encoder.writeObject(source);
056            encoder.close();
057    
058            return bos.toByteArray();
059        }
060    
061        /**
062         * Deserializes the specified <code>serialized</code> source back into an Object by using a
063         * {@link java.io.ByteArrayInputStream ByteArrayInputStream} to wrap the argument and then decode this
064         * stream via an {@link java.beans.XMLDecoder XMLDecoder}, where the
065         * {@link java.beans.XMLDecoder#readObject() readObject} call results in the original Object to return.
066         * @param serialized the byte[] array representation of the XML encoded output.
067         * @return the original source Object in reconstituted form.
068         */
069        public Object deserialize(byte[] serialized) {
070            if (serialized == null) {
071                throw new IllegalArgumentException("Argument cannot be null.");
072            }
073            ByteArrayInputStream bis = new ByteArrayInputStream(serialized);
074            XMLDecoder decoder = new XMLDecoder(new BufferedInputStream(bis));
075            Object o = decoder.readObject();
076            decoder.close();
077            return o;
078        }
079    }