jericho 01/02/28 05:38:46
Added: src/webdav/client/src/org/apache/webdav/util
WebdavClientSession.java
Log:
- Management for WebdavClient
Revision Changes Path
1.1
jakarta-slide/src/webdav/client/src/org/apache/webdav/util/WebdavClientSession.java
Index: WebdavClientSession.java
===================================================================
/*
* $Header:
/home/cvs/jakarta-slide/src/webdav/client/src/org/apache/webdav/util/WebdavClientSession.java,v
1.1 2001/02/28 13:38:46 jericho Exp $
* $Revision: 1.1 $
* $Date: 2001/02/28 13:38:46 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.webdav.util;
import java.io.IOException;
import java.util.Hashtable;
import java.util.Enumeration;
import java.net.MalformedURLException;
import org.apache.webdav.lib.WebdavClient;
import org.apache.webdav.lib.Credentials;
/**
*
* This WebdavClientSession class is for the multi-session management of
* WebDAV clients. This class saves and restores the requested client.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Park, Sung-Gu</a>
*/
public class WebdavClientSession {
/**
* Infomation hashtable for WebDAV clients for HTTP/1.1 communication.
*/
private static Hashtable clientInfo = new Hashtable();
// ------------------------------------------------------ Public methods
/**
* Get a <code>WebdavClient</code> instance.
* If the same authority is requested, the method returns the same client.
* Otherwise, the method returns a new client instance.
*
* @param httpUrl The HTTP URL to connect. only used the authority part.
* @return An instance of <code>WebdavClient</code>.
* @exception IOException
*/
public WebdavClient getSessionInstance(HttpURL httpUrl)
throws IOException {
String authority = httpUrl.getAuthority();
WebdavClient client = (WebdavClient) clientInfo.get(authority);
// setting for the first time.
if (client == null) {
client = new WebdavClient(httpUrl.toURL());
String userName = httpUrl.getUserName();
if (userName != null && userName.length() > 0) {
String password = httpUrl.getPassword();
client.setCredentials(new Credentials(userName, password));
}
}
return client;
}
/**
* Seek a <code>WebdavClient</code> instance.
* If the return value is null, there is no instance.
*
* @param httpUrl The http URL to connect. only used the authority part.
* @return An instance of <code>WebdavClient</code>.
* @exception MalformedURLException
*/
public WebdavClient seekSession(HttpURL httpUrl)
throws MalformedURLException {
String authority = httpUrl.getAuthority();
WebdavClient client = (WebdavClient) clientInfo.get(authority);
return client;
}
/**
* Save the status of the <code>WebdavClient</code>.
*
* <p>In order to save information of the WebDAV client,
* It is used the authority part of http URL that is useful to save
* each connection having the user, host and port information.
*
* @param httpUrl The http URL to save information of the WebDAV client.
* @param client The <code>WebdavClient</code> instance to save.
* @exception MalformedURLException Required the given arguments matched.
*/
public void setSession(HttpURL httpUrl, WebdavClient client)
throws MalformedURLException {
// Check that the given http URL is going alright.
if (!httpUrl.getHost().equalsIgnoreCase(client.getHost()) ||
httpUrl.getPort() != client.getPort())
throw new MalformedURLException
("Not matched between the given URL and client");
clientInfo.put(httpUrl.getAuthority(), client);
}
/**
* Close connection and unset the <code>WebdavClient</code> instance.
*
* @param httpUrl The http URL to remove a WebDAV client.
* @exception MalformedURLException No protocol.
* @exception IOException Error in closing socket.
*/
public void unsetSession(HttpURL httpUrl)
throws IOException {
WebdavClient webdavClient = seekSession(httpUrl);
if (webdavClient != null) {
webdavClient.endSession();
clientInfo.remove(httpUrl.getAuthority());
}
}
}
