You are viewing a plain text version of this content. The canonical link for it is here.
Posted to slide-dev@jakarta.apache.org by re...@apache.org on 2001/04/13 03:33:28 UTC

cvs commit: jakarta-slide/src/webdav/client/src/org/apache/webdav/lib ConnectionInterceptor.java StreamInterceptor.java

remm        01/04/12 18:33:28

  Added:       src/webdav/client/src/org/apache/webdav/lib
                        ConnectionInterceptor.java StreamInterceptor.java
  Log:
  - Add the connection intercepton, which will called when a connection related
    event occurs : connection, disconnection, error, retry.
  - Add the stream interceptor, which is called when bytes are read or written.
  
  Revision  Changes    Path
  1.1                  jakarta-slide/src/webdav/client/src/org/apache/webdav/lib/ConnectionInterceptor.java
  
  Index: ConnectionInterceptor.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-slide/src/webdav/client/src/org/apache/webdav/lib/ConnectionInterceptor.java,v 1.1 2001/04/13 01:33:28 remm Exp $
   * $Revision: 1.1 $
   * $Date: 2001/04/13 01:33:28 $
   *
   * ====================================================================
   *
   * 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 apache@apache.org.
   *
   * 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.lib;
  
  /**
   * The connection interceptor.
   * 
   * @author <a href="mailto:jericho@thinkfree.com">Park, Sung-Gu</a>
   * @author Remy Maucherat
   */
  
  public interface ConnectionInterceptor {
  
  
      // --------------------------------------------------------- Public Methods
  
  
      /**
       * Connect.
       */
      public void connect();
  
  
      /**
       * Disconnect.
       */
      public void disconnect();
  
  
      /**
       * Retry.
       * 
       * @return boolean true if a retry should be attempted
       */
      public boolean retry(int status);
  
  
      /**
       * Unexpected error.
       * 
       * @param status Status code; can be equal to -1 if status code is not 
       * known
       * @param e Underlying exception; can be null
       * @return boolean true if processing of the request should be stopped
       */
      public boolean error(int status, Exception e);
  
  
  }
  
  
  
  1.1                  jakarta-slide/src/webdav/client/src/org/apache/webdav/lib/StreamInterceptor.java
  
  Index: StreamInterceptor.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-slide/src/webdav/client/src/org/apache/webdav/lib/StreamInterceptor.java,v 1.1 2001/04/13 01:33:28 remm Exp $
   * $Revision: 1.1 $
   * $Date: 2001/04/13 01:33:28 $
   *
   * ====================================================================
   *
   * 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 p        bytesRead(count);
  roduct 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 apache@apache.org.
   *
   * 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.lib;
  
  /**
   * The stream interceptor.
   * 
   * @author <a href="mailto:jericho@thinkfree.com">Park, Sung-Gu</a>
   * @author Remy Maucherat
   */
  
  public interface StreamInterceptor {
  
  
      // --------------------------------------------------------- Public Methods
  
  
      /**
       * Notification for bytes sent.
       * 
       * @param b Array containing the bytes which are about to be written; this
       * parameter can be null when writing a single byte
       * @param data If b is not null, contains the offset from which the bytes
       * will be read in the array; otherwise, if a single byte is written, 
       * data will have the byte's value
       * @param count Number of bytes written, or 1 if a single byte is written
       */
      public void bytesWrite(byte[] b, int data, int count);
  
  
      /**
       * Notification for bytes read, which can be used for filtering.
       * 
       * @param b Array containing the bytes which are were read; this
       * parameter can be null when a single byte was read
       * @param data If b is not null, contains the offset from which the bytes
       * will be read in the array; otherwise, if a single byte is read, 
       * data will have the byte's value
       * @param count Number of bytes read, or 1 if a single byte was read
       */
      public void bytesRead(byte[] b, int data, int count);
  
  
  }