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 */ 020package org.apache.mina.filter.codec; 021 022import org.apache.mina.core.session.IoSession; 023 024/** 025 * Provides {@link ProtocolEncoder} and {@link ProtocolDecoder} which translates 026 * binary or protocol specific data into message object and vice versa. 027 * <p> 028 * Please refer to 029 * <a href="../../../../../xref-examples/org/apache/mina/examples/reverser/ReverseProtocolProvider.html"><code>ReverserProtocolProvider</code></a> 030 * example. 031 * 032 * @author <a href="http://mina.apache.org">Apache MINA Project</a> 033 */ 034public interface ProtocolCodecFactory { 035 /** 036 * Returns a new (or reusable) instance of {@link ProtocolEncoder} which 037 * encodes message objects into binary or protocol-specific data. 038 * 039 * @param session The current session 040 * @return The encoder instance 041 * @throws Exception If an error occurred while retrieving the encoder 042 */ 043 ProtocolEncoder getEncoder(IoSession session) throws Exception; 044 045 /** 046 * Returns a new (or reusable) instance of {@link ProtocolDecoder} which 047 * decodes binary or protocol-specific data into message objects. 048 * 049 * @param session The current session 050 * @return The decoder instance 051 * @throws Exception If an error occurred while retrieving the decoder 052 */ 053 ProtocolDecoder getDecoder(IoSession session) throws Exception; 054}