1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.mina.filter.codec;
21
22 import org.apache.mina.core.session.IoSession;
23
24 /**
25 * Provides {@link ProtocolEncoder} and {@link ProtocolDecoder} which translates
26 * binary or protocol specific data into message object and vice versa.
27 * <p>
28 * Please refer to
29 * <a href="../../../../../xref-examples/org/apache/mina/examples/reverser/ReverseProtocolProvider.html"><code>ReverserProtocolProvider</code></a>
30 * example.
31 *
32 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
33 */
34 public interface ProtocolCodecFactory {
35 /**
36 * Returns a new (or reusable) instance of {@link ProtocolEncoder} which
37 * encodes message objects into binary or protocol-specific data.
38 *
39 * @param session The current session
40 * @return The encoder instance
41 * @throws Exception If an error occurred while retrieving the encoder
42 */
43 ProtocolEncoder getEncoder(IoSession session) throws Exception;
44
45 /**
46 * Returns a new (or reusable) instance of {@link ProtocolDecoder} which
47 * decodes binary or protocol-specific data into message objects.
48 *
49 * @param session The current session
50 * @return The decoder instance
51 * @throws Exception If an error occurred while retrieving the decoder
52 */
53 ProtocolDecoder getDecoder(IoSession session) throws Exception;
54 }