1d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 2d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $RCSfile$ 3d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Revision$ 4d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Date$ 5d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 6d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Copyright 2003-2007 Jive Software. 7d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 8d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); 9d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * you may not use this file except in compliance with the License. 10d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * You may obtain a copy of the License at 11d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 12d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * http://www.apache.org/licenses/LICENSE-2.0 13d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 14d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Unless required by applicable law or agreed to in writing, software 15d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * distributed under the License is distributed on an "AS IS" BASIS, 16d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * See the License for the specific language governing permissions and 18d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * limitations under the License. 19d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 20d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 21d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpackage org.jivesoftware.smack.filter; 22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.packet.Packet; 24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Defines a way to filter packets for particular attributes. Packet filters are 27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * used when constructing packet listeners or collectors -- the filter defines 28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * what packets match the criteria of the collector or listener for further 29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * packet processing.<p> 30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Several pre-defined filters are defined. These filters can be logically combined 32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * for more complex packet filtering by using the 33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * {@link org.jivesoftware.smack.filter.AndFilter AndFilter} and 34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * {@link org.jivesoftware.smack.filter.OrFilter OrFilter} filters. It's also possible 35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * to define your own filters by implementing this interface. The code example below 36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * creates a trivial filter for packets with a specific ID. 37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <pre> 39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * // Use an anonymous inner class to define a packet filter that returns 40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * // all packets that have a packet ID of "RS145". 41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * PacketFilter myFilter = new PacketFilter() { 42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * public boolean accept(Packet packet) { 43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * return "RS145".equals(packet.getPacketID()); 44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * } 45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * }; 46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * // Create a new packet collector using the filter we created. 47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * PacketCollector myCollector = packetReader.createPacketCollector(myFilter); 48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * </pre> 49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @see org.jivesoftware.smack.PacketCollector 51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @see org.jivesoftware.smack.PacketListener 52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Matt Tucker 53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic interface PacketFilter { 55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Tests whether or not the specified packet should pass the filter. 58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param packet the packet to test. 60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return true if and only if <tt>packet</tt> passes the filter. 61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public boolean accept(Packet packet); 63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen} 64