KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sslexplorer > agent > client > AgentExtension


1 /*
2  * SSL-Explorer
3  *
4  * Copyright (C) 2003-2006 3SP LTD. All Rights Reserved
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 of
9  * the License, or (at your option) any later version.
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */

19             
20 package com.sslexplorer.agent.client;
21
22 /**
23  * The SSL-Explorer agent may be extended by using <i>Agent Extensions</i>.
24  * Agent extensions may provide a Java class that is instantiated and ivoked
25  * when the agent starts. This is the interface that must be implemeted to
26  * support this.
27  *
28  * @author Lee David Painter <a HREF="mailto: lee@3sp.com">&lt;lee@3sp.com&gt;</a>
29  */

30 public interface AgentExtension {
31
32     /**
33      * Initialise the extension. Invoked when the agent starts
34      * up.
35      *
36      * @param agent agent instance
37      * @throws Exception on any error
38      */

39     public void init(Agent agent) throws Exception JavaDoc;
40
41     /**
42      * Clean up the extension. Invoked when the agent shuts
43      * down.
44      */

45     public void exit();
46
47     /**
48      * Get the name of the extension.
49      *
50      * @return name
51      */

52     public String JavaDoc getName();
53 }
Popular Tags