View Javadoc
1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec.marshalling;
17  
18  import io.netty.channel.ChannelHandlerContext;
19  
20  import org.jboss.marshalling.MarshallerFactory;
21  import org.jboss.marshalling.MarshallingConfiguration;
22  import org.jboss.marshalling.Unmarshaller;
23  
24  /**
25   * Default implementation of {@link UnmarshallerProvider} which will just create a new {@link Unmarshaller}
26   * on every call to {@link #getUnmarshaller(ChannelHandlerContext)}
27   *
28   * <strong>Security:</strong> serialization can be a security liability,
29   * and should not be used without defining a list of classes that are
30   * allowed to be deserialized. This explicitly needs to be done via {@link MarshallingConfiguration},
31   * missing to do so is a security risk.
32   */
33  public class DefaultUnmarshallerProvider implements UnmarshallerProvider {
34  
35      private final MarshallerFactory factory;
36      private final MarshallingConfiguration config;
37  
38      /**
39       * Create a new instance of {@link DefaultMarshallerProvider}
40       *
41       * @param factory   the {@link MarshallerFactory} to use to create {@link Unmarshaller}
42       * @param config    the {@link MarshallingConfiguration}
43       */
44      public DefaultUnmarshallerProvider(MarshallerFactory factory, MarshallingConfiguration config) {
45          this.factory = factory;
46          this.config = config;
47      }
48  
49      @Override
50      public Unmarshaller getUnmarshaller(ChannelHandlerContext ctx) throws Exception {
51          return factory.createUnmarshaller(config);
52      }
53  
54  }