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.keepalive;
21
22 import org.apache.mina.core.session.IoSession;
23
24 /**
25 * Provides keep-alive messages to {@link KeepAliveFilter}.
26 *
27 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
28 */
29 public interface KeepAliveMessageFactory {
30
31 /**
32 * @return <tt>true</tt> if and only if the specified message is a
33 * keep-alive request message.
34 *
35 * @param session The current session
36 * @param message teh message to check
37 */
38 boolean isRequest(IoSession session, Object message);
39
40 /**
41 * @return <tt>true</tt> if and only if the specified message is a
42 * keep-alive response message;
43 *
44 * @param session The current session
45 * @param message teh message to check
46 */
47 boolean isResponse(IoSession session, Object message);
48
49 /**
50 * @return a (new) keep-alive request message or <tt>null</tt> if no request is required.
51 *
52 * @param session The current session
53 */
54 Object getRequest(IoSession session);
55
56 /**
57 * @return a (new) response message for the specified keep-alive request, or <tt>null</tt> if no response is required.
58 *
59 * @param session The current session
60 * @param request The request we are lookig for
61 */
62 Object getResponse(IoSession session, Object request);
63 }