org.esupportail.portal.channels.CWebdav
Class CWebdav

java.lang.Object
  extended byorg.jasig.portal.channels.BaseChannel
      extended byorg.esupportail.portal.channels.CWebdav.CWebdav
All Implemented Interfaces:
org.jasig.portal.ICacheable, org.jasig.portal.IChannel, org.jasig.portal.IMimeResponse

public class CWebdav
extends org.jasig.portal.channels.BaseChannel
implements org.jasig.portal.IMimeResponse, org.jasig.portal.ICacheable

Id: CWebdav.java,v 1.0 7 avr. 2004
Copyright (c) 2004 Esup Portail (www.esup-portail.org)
Classes: CWebdav
Original Author: Yohan Colmant
Channel used to manage personal files on a webdav server through the portal


Field Summary
private  BufferAction buffer
          Object used to keep the objects used between 2 actions, for example, the clipboard
private  ChannelConfiguration config
          The config object
private  java.lang.String currentMode
          The actual mod in which is the channel
private  Space currentSpace
          The current used space
private  ChannelResource downloadResource
          The resource to download
private  java.lang.String fileId
           
protected static org.apache.commons.logging.Log log
          Logger object
private  org.jasig.portal.PortalControlStructures pcs
           
private  java.lang.String portalLogin
          User login
private  ChannelException setStaticDataException
          Error at the beginning of the channel
private  java.util.ArrayList spaces
          The spaces availables
private  org.jasig.portal.ChannelStaticData staticData
           
private  java.util.Vector userGroups
          The user groups
 
Fields inherited from class org.jasig.portal.channels.BaseChannel
runtimeData
 
Constructor Summary
CWebdav()
          Constructor
 
Method Summary
 void downloadData(java.io.OutputStream arg0)
          Function unused here
 org.jasig.portal.ChannelCacheKey generateKey()
           
 java.lang.String getContentType()
          Return the content type of the seleted file
 java.util.Map getHeaders()
          Send HTTP header
 java.io.InputStream getInputStream()
          Get the strem for the file to dowload
 java.lang.String getName()
          Function unused here
 boolean isCacheValid(java.lang.Object validity)
           
 void renderXML(org.xml.sax.ContentHandler out)
          Output channel content to the portal
 void reportDownloadError(java.lang.Exception arg0)
          Print the error generated by the download
 void setStaticData(org.jasig.portal.ChannelStaticData sd)
          Receive static channel data from the portal.
 
Methods inherited from class org.jasig.portal.channels.BaseChannel
getRuntimeProperties, receiveEvent, setRuntimeData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static final org.apache.commons.logging.Log log
Logger object


staticData

private org.jasig.portal.ChannelStaticData staticData

fileId

private java.lang.String fileId

pcs

private org.jasig.portal.PortalControlStructures pcs

config

private ChannelConfiguration config
The config object


currentMode

private java.lang.String currentMode
The actual mod in which is the channel


spaces

private java.util.ArrayList spaces
The spaces availables


currentSpace

private Space currentSpace
The current used space


setStaticDataException

private ChannelException setStaticDataException
Error at the beginning of the channel


portalLogin

private java.lang.String portalLogin
User login


userGroups

private java.util.Vector userGroups
The user groups


buffer

private BufferAction buffer
Object used to keep the objects used between 2 actions, for example, the clipboard


downloadResource

private ChannelResource downloadResource
The resource to download

Constructor Detail

CWebdav

public CWebdav()
Constructor

Method Detail

setStaticData

public void setStaticData(org.jasig.portal.ChannelStaticData sd)
Receive static channel data from the portal. Satisfies implementation of IChannel Interface.

Specified by:
setStaticData in interface org.jasig.portal.IChannel
Parameters:
sd - ChannelStaticData static channel data

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws org.jasig.portal.PortalException
Output channel content to the portal

Specified by:
renderXML in interface org.jasig.portal.IChannel
Parameters:
out - a sax document handler
Throws:
org.jasig.portal.PortalException

getContentType

public java.lang.String getContentType()
Return the content type of the seleted file

Specified by:
getContentType in interface org.jasig.portal.IMimeResponse
See Also:
IMimeResponse.getContentType()

getHeaders

public java.util.Map getHeaders()
Send HTTP header

Specified by:
getHeaders in interface org.jasig.portal.IMimeResponse
See Also:
IMimeResponse.getHeaders()

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException
Get the strem for the file to dowload

Specified by:
getInputStream in interface org.jasig.portal.IMimeResponse
Throws:
java.io.IOException
See Also:
IMimeResponse.getInputStream()

downloadData

public void downloadData(java.io.OutputStream arg0)
                  throws java.io.IOException
Function unused here

Specified by:
downloadData in interface org.jasig.portal.IMimeResponse
Throws:
java.io.IOException
See Also:
IMimeResponse.downloadData(java.io.OutputStream)

getName

public java.lang.String getName()
Function unused here

Specified by:
getName in interface org.jasig.portal.IMimeResponse
See Also:
IMimeResponse.getName()

reportDownloadError

public void reportDownloadError(java.lang.Exception arg0)
Print the error generated by the download

Specified by:
reportDownloadError in interface org.jasig.portal.IMimeResponse
See Also:
IMimeResponse.reportDownloadError(java.lang.Exception)

generateKey

public org.jasig.portal.ChannelCacheKey generateKey()
Specified by:
generateKey in interface org.jasig.portal.ICacheable

isCacheValid

public boolean isCacheValid(java.lang.Object validity)
Specified by:
isCacheValid in interface org.jasig.portal.ICacheable