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.james.socket; 21 22 import java.io.IOException; 23 24 public interface ProtocolHandler { 25 26 /** 27 * This method will be implemented checking for the correct class 28 * type. 29 * 30 * @param theData Configuration Bean. 31 */ 32 public abstract void setConfigurationData(Object theData); 33 34 /** 35 * Handle the protocol 36 * 37 * @throws IOException get thrown if an IO error is detected 38 */ 39 public abstract void handleProtocol() throws IOException; 40 41 /** 42 * Resets the handler data to a basic state. 43 */ 44 public abstract void resetHandler(); 45 46 47 /** 48 * Injects the ProtocolHandlerHelper service 49 * @param phh service 50 */ 51 public void setProtocolHandlerHelper(ProtocolHandlerHelper phh); 52 53 /** 54 * Provides errorHandling 55 * @param e exception 56 */ 57 public abstract void errorHandler(RuntimeException e); 58 59 }