KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sslexplorer > agent > AgentCallback


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;
21
22
23 import com.sslexplorer.boot.RequestHandlerRequest;
24 import com.sslexplorer.security.User;
25
26 /**
27  * Implementations of this interface are responsible for managing and
28  * authenticating incoming <i>Agent</i> connections.
29  *
30  * @author Lee David Painter <a HREF="mailto: lee@3sp.com">&lt;lee@3sp.com&gt;</a>
31  */
32 public interface AgentCallback extends AgentAuthenticator {
33
34     /**
35      * Create a new agent.
36      *
37      * @param remoteHost remote connecting host
38      * @param user user request
39      * @param type agent type
40      * @param connectionParameters other connection parameters
41      * @return agent instance
42      * @throws AgentException if agent cannot be created
43      */
44     AgentTunnel createAgent(String JavaDoc remoteHost, User user, String JavaDoc type, RequestHandlerRequest connectionParameters) throws AgentException;
45
46     /**
47      * Remove an agent. Called when the agent is shutdown for any
48      * reason (user initiated agent shutdown, logoff, error etc).
49      *
50      * @param tunnel agent tunnel
51      * @throws AgentException on any error removing the agent
52      */
53     void removeAgent(AgentTunnel tunnel) throws AgentException;
54 }
55
Popular Tags