cms/util/ACLDatagramSocket.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org.uk
 * Copyright (C) 2000-2002 i-scream
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.util;

//---IMPORTS---
import java.net.DatagramSocket;
import java.net.DatagramPacket;
import java.net.InetAddress;
import java.io.IOException;

/**
 * Access Control List DatagramSocket wrapper. Used
 * to wrap a DatagramSocket with an ACL, whilst extending
 * DatagramSocket to make integration into code easier.
 * Once the ACL has been set, receive() can be used exactly
 * as it would be with a DatagramSocket.
 *
 * @author  $Author: tdb $
 * @version $Id: ACLDatagramSocket.java,v 1.3 2002/05/21 16:47:19 tdb Exp $
 */
public class ACLDatagramSocket extends DatagramSocket {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.3 $";

//---STATIC METHODS---

//---CONSTRUCTORS---

    /**
     * See relevant DatagramSocket constructor.
     */
    public ACLDatagramSocket() throws IOException {
        super();
        setACL(new ACL());
    }

    /**
     * See relevant DatagramSocket constructor.
     */
    public ACLDatagramSocket(int port) throws IOException {
        super(port);
        setACL(new ACL());
    }
    
    /**
     * See relevant DatagramSocket constructor.
     */
    public ACLDatagramSocket(int port, InetAddress laddr) throws IOException {
        super(port, laddr);
        setACL(new ACL());
    }
    
    /**
     * See relevant DatagramSocket constructor, and
     * sets the default acl.
     */
    public ACLDatagramSocket(ACL acl) throws IOException {
        super();
        setACL(acl);
    }
        
    /**
     * See relevant DatagramSocket constructor, and
     * sets the default acl.
     */
    public ACLDatagramSocket(ACL acl, int port) throws IOException {
        super(port);
        setACL(acl);
    }
    
    /**
     * See relevant DatagramSocket constructor, and
     * sets the default acl.
     */
    public ACLDatagramSocket(ACL acl, int port, InetAddress laddr) throws IOException {
        super(port, laddr);
        setACL(acl);
    }

//---PUBLIC METHODS---

    /**
     * Essentially has the same behaviour as the
     * Datagram.receive() method, except won't
     * return  unless it is permitted by the ACL.
     */
    public void receive(DatagramPacket p) throws IOException {
        while(true) {
            super.receive(p);
            if(_acl.check(p.getAddress())) {
                return;
            }
        }
    }
    
    /**
     * Set the ACL at any point in the operation
     * of the DatagramSocket.
     *
     * @param acl the new ACL to apply
     */
    public void setACL(ACL acl) {
        _acl = acl;
    }
    
    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.org.iscream.cms.server.util.FormatName class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),            
            REVISION);
            // super.toString() isn't implemented...
            //REVISION) + ":" + super.toString();
    }

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---

    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = null;
    
    /**
     * The ACL used by this ACLDatagramSocket.
     */
    private ACL _acl;
    
//---STATIC ATTRIBUTES---

//---INNER CLASSES---

}
Revision:	1.4
Committed:	Wed Feb 5 14:27:58 2003 UTC (21 years, 2 months ago) by tdb
Branch:	MAIN
Changes since 1.3:	+3 -3 lines
Log Message:	Util package has been pulled out of the server. Next step will be to modify the server and conient (and anything else?) to use this instead. New package name is uk.org.iscream.cms.util. All the java files were moved with a repo copy, so they retain their history.
#	User	Rev	Content
1	tdb	1.2	/*
2			* i-scream central monitoring system
3	tdb	1.3	* http://www.i-scream.org.uk
4	tdb	1.2	* Copyright (C) 2000-2002 i-scream
5			*
6			* This program is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU General Public License
8			* as published by the Free Software Foundation; either version 2
9			* of the License, or (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19			*/
20
21	tdb	1.1	//---PACKAGE DECLARATION---
22	tdb	1.4	package uk.org.iscream.cms.util;
23	tdb	1.1
24			//---IMPORTS---
25			import java.net.DatagramSocket;
26			import java.net.DatagramPacket;
27			import java.net.InetAddress;
28			import java.io.IOException;
29
30			/**
31			* Access Control List DatagramSocket wrapper. Used
32			* to wrap a DatagramSocket with an ACL, whilst extending
33			* DatagramSocket to make integration into code easier.
34			* Once the ACL has been set, receive() can be used exactly
35			* as it would be with a DatagramSocket.
36			*
37			* @author $Author: tdb $
38	tdb	1.4	* @version $Id: ACLDatagramSocket.java,v 1.3 2002/05/21 16:47:19 tdb Exp $
39	tdb	1.1	*/
40			public class ACLDatagramSocket extends DatagramSocket {
41
42			//---FINAL ATTRIBUTES---
43
44			/**
45			* The current CVS revision of this class
46			*/
47	tdb	1.4	public static final String REVISION = "$Revision: 1.3 $";
48	tdb	1.1
49			//---STATIC METHODS---
50
51			//---CONSTRUCTORS---
52
53			/**
54			* See relevant DatagramSocket constructor.
55			*/
56			public ACLDatagramSocket() throws IOException {
57			super();
58			setACL(new ACL());
59			}
60
61			/**
62			* See relevant DatagramSocket constructor.
63			*/
64			public ACLDatagramSocket(int port) throws IOException {
65			super(port);
66			setACL(new ACL());
67			}
68
69			/**
70			* See relevant DatagramSocket constructor.
71			*/
72			public ACLDatagramSocket(int port, InetAddress laddr) throws IOException {
73			super(port, laddr);
74			setACL(new ACL());
75			}
76
77			/**
78			* See relevant DatagramSocket constructor, and
79			* sets the default acl.
80			*/
81			public ACLDatagramSocket(ACL acl) throws IOException {
82			super();
83			setACL(acl);
84			}
85
86			/**
87			* See relevant DatagramSocket constructor, and
88			* sets the default acl.
89			*/
90			public ACLDatagramSocket(ACL acl, int port) throws IOException {
91			super(port);
92			setACL(acl);
93			}
94
95			/**
96			* See relevant DatagramSocket constructor, and
97			* sets the default acl.
98			*/
99			public ACLDatagramSocket(ACL acl, int port, InetAddress laddr) throws IOException {
100			super(port, laddr);
101			setACL(acl);
102			}
103
104			//---PUBLIC METHODS---
105
106			/**
107			* Essentially has the same behaviour as the
108			* Datagram.receive() method, except won't
109			* return unless it is permitted by the ACL.
110			*/
111			public void receive(DatagramPacket p) throws IOException {
112			while(true) {
113			super.receive(p);
114			if(_acl.check(p.getAddress())) {
115			return;
116			}
117			}
118			}
119
120			/**
121			* Set the ACL at any point in the operation
122			* of the DatagramSocket.
123			*
124			* @param acl the new ACL to apply
125			*/
126			public void setACL(ACL acl) {
127			_acl = acl;
128			}
129
130			/**
131			* Overrides the {@link java.lang.Object#toString() Object.toString()}
132			* method to provide clean logging (every class should have this).
133			*
134			* This uses the uk.org.iscream.cms.server.util.FormatName class
135			* to format the toString()
136			*
137			* @return the name of this class and its CVS revision
138			*/
139			public String toString() {
140			return FormatName.getName(
141			_name,
142			getClass().getName(),
143			REVISION);
144			// super.toString() isn't implemented...
145			//REVISION) + ":" + super.toString();
146			}
147
148			//---PRIVATE METHODS---
149
150			//---ACCESSOR/MUTATOR METHODS---
151
152			//---ATTRIBUTES---
153
154			/**
155			* This is the friendly identifier of the
156			* component this class is running in.
157			* eg, a Filter may be called "filter1",
158			* If this class does not have an owning
159			* component, a name from the configuration
160			* can be placed here. This name could also
161			* be changed to null for utility classes.
162			*/
163			private String _name = null;
164
165			/**
166			* The ACL used by this ACLDatagramSocket.
167			*/
168			private ACL _acl;
169
170			//---STATIC ATTRIBUTES---
171
172			//---INNER CLASSES---
173
174			}