    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class org.w3c.jigedit.filters.PutListResource

    java.lang.Object
       |
       +----org.w3c.tools.resources.AttributeHolder
               |
               +----org.w3c.tools.resources.Resource
                       |
                       +----org.w3c.tools.resources.FramedResource
                               |
                               +----org.w3c.jigedit.filters.PutListResource

public class PutListResource
extends FramedResource

##

ATTR_AUTO_DELETE
  Attribute index - The auto delete flag
ATTR_AUTO_PUBLISH
  Attribute index - The auto publish flag
ATTR_FILE
  Attribute index - The file used to store the modification list.
ATTR_MAX_PUBLISHED
  Attribute index - The max number of published entries stored
ATTR_ROOT
  Attribute index - The web server public space.
ATTR_SPACE
  Attribute index - The user's local space.
debug
FILE_CF
  status: conflict
FILE_DEL
  status: deleted
FILE_MG
  status: File merged
FILE_PB
  status: File published
FILE_UC
  status: File unchanged

##

PutListResource()

##

addDelEntry(DeletedEntry)
  Add an entry into the putlist
addEntry(PutedEntry)
  Add an entry into the putlist
addPubEntry(PutedEntry)
  Add a published entry into the putlist.
confirmDelete(Request)
delete(DeletedEntry)
  Delete the file relative to the given entry.
getAutoDeleteFlag()
  Get our auto delete flag.
getAutoPublishFlag()
  Get our auto publish flag.
getCvsSpace()
  Get this user's local CVS space root directory.
getDelEntries()
  Get the deleted entries.
getDelEntriesKeys()
  Get the deleted entries keys
getDelEntry(String)
  Get the deleted entry relative to the given key.
getDelFile()
  Get the file to use to store the edited list of deleted files.
getEntries()
  Get the modified entries.
getEntriesKeys()
  Get the modified entries keys
getEntry(String)
  Get the modified entry relative to the given key.
getFile()
  Get the file to use to store the edited list of files.
getMaxPublishedEntryStored()
  Get the max number of published entries stored in the putlist.
getPubFile()
  Get the file to use to store the edited list of published files.
getPublishedEntries()
  Get the published entries.
getRoot()
  Get the root directory of the public server to update.
getServerFile(File)
  Compute the path of the public file for the given local file.
initialize(Object[])
  Initialize the frames of that framed resource.
lookupDelEntry(Request)
lookupEntry(Request)
notifyUnload()
  This resource is being unloaded.
publish(PutedEntry)
  Publish the file relative to the given entry.
readDelList()
  Restore the deleted list from the file.
readList()
  Restore the list from the file.
readPubList()
  Restore the published list from the file.
registerDeleteRequest(Request)
registerRequest(Request)
  Register the given request, which must has a PUT method.
removeDelEntry(String)
  Remove a deleted entry from the putlist
removeEntry(String)
  Remove a modified entry from the putlist
removeOldestPublishedEntry()
  Remove the oldest published entry from the putlist.
removePubEntry(String)
  Remove a published entry from the putlist
removeUnconfirmedDelEntries()
setAutoDelete(boolean)
  Enable or disable the auto delete feature.
setAutoPublish(boolean)
  Enable or disable the auto publish feature.
setMaxPublishedEntryStored(int)
  Set the max number of published entries stored in the putlist.
writeDelList()
  Dump the current list of [ublished files back to disk.
writeList()
  Dump the current list of edited files back to disk.
writePubList()
  Dump the current list of [ublished files back to disk.

##

debug

     protected static final boolean debug

FILE_PB

     public static final int FILE_PB

  status: File published

FILE_UC

     public static final int FILE_UC

  status: File unchanged

FILE_MG

     public static final int FILE_MG

  status: File merged

FILE_CF

     public static final int FILE_CF

  status: conflict

FILE_DEL

     public static final int FILE_DEL

  status: deleted

ATTR_FILE

     protected static int ATTR_FILE

  Attribute index - The file used to store the modification list.

ATTR_SPACE

     protected static int ATTR_SPACE

  Attribute index - The user's local space.

ATTR_ROOT

     protected static int ATTR_ROOT

  Attribute index - The web server public space.

ATTR_AUTO_PUBLISH

     protected static int ATTR_AUTO_PUBLISH

  Attribute index - The auto publish flag

ATTR_AUTO_DELETE

     protected static int ATTR_AUTO_DELETE

  Attribute index - The auto delete flag

ATTR_MAX_PUBLISHED

     protected static int ATTR_MAX_PUBLISHED

  Attribute index - The max number of published entries stored

##

PutListResource

     public PutListResource()

##

getAutoPublishFlag

     public boolean getAutoPublishFlag()

  Get our auto publish flag.

  Returns:
    a boolean.

setAutoPublish

     protected void setAutoPublish(boolean onoff)

  Enable or disable the auto publish feature.

  Parameters:
    onoff - if onoff is true auto publish is enable.

getAutoDeleteFlag

     public boolean getAutoDeleteFlag()

  Get our auto delete flag.

  Returns:
    a boolean.

setAutoDelete

     protected void setAutoDelete(boolean onoff)

  Enable or disable the auto delete feature.

  Parameters:
    onoff - if onoff is true auto publish is enable.

getMaxPublishedEntryStored

     public int getMaxPublishedEntryStored()

  Get the max number of published entries stored in the putlist.

  Returns:
    an int.

setMaxPublishedEntryStored

     protected void setMaxPublishedEntryStored(int max)

  Set the max number of published entries stored in the putlist.

  Parameters:
    max - This number.

getEntries

     protected Enumeration getEntries()

  Get the modified entries.

  Returns:
    an enumeration of PutedEntry
  See Also:
    PutedEntry

getEntriesKeys

     protected Enumeration getEntriesKeys()

  Get the modified entries keys

  Returns:
    an enumeration of String

getEntry

     protected PutedEntry getEntry(String key)

  Get the modified entry relative to the given key.

  Parameters:
    key - The key relative to the PutedEntry
  Returns:
    a PutedEntry
  See Also:
    PutedEntry

addEntry

     protected void addEntry(PutedEntry e)

  Add an entry into the putlist

  Parameters:
    e - the entry to add

removeEntry

     protected void removeEntry(String key)

  Remove a modified entry from the putlist

  Parameters:
    key - the key of the entry to remove

getDelEntries

     protected Enumeration getDelEntries()

  Get the deleted entries.

  Returns:
    an enumeration of DeletedEntry
  See Also:
    DeletedEntry

getDelEntriesKeys

     protected Enumeration getDelEntriesKeys()

  Get the deleted entries keys

  Returns:
    an enumeration of String

getDelEntry

     protected DeletedEntry getDelEntry(String key)

  Get the deleted entry relative to the given key.

  Parameters:
    key - The key relative to the DeletedEntry
  Returns:
    a DeletedEntry
  See Also:
    DeletedEntry

addDelEntry

     protected void addDelEntry(DeletedEntry e)

  Add an entry into the putlist

  Parameters:
    e - the entry to add

removeDelEntry

     protected void removeDelEntry(String key)

  Remove a deleted entry from the putlist

  Parameters:
    key - the key of the entry to remove

getPublishedEntries

     protected Enumeration getPublishedEntries()

  Get the published entries.

  Returns:
    an enumeration of PutedEntry
  See Also:
    PutedEntry

removeOldestPublishedEntry

     protected void removeOldestPublishedEntry()

  Remove the oldest published entry from the putlist.

addPubEntry

     protected synchronized void addPubEntry(PutedEntry e)

  Add a published entry into the putlist.

  Parameters:
    e - The published entry to add.
  See Also:
    PutedEntry

removePubEntry

     protected synchronized void removePubEntry(String key)

  Remove a published entry from the putlist

  Parameters:
    key - the key of the entry to remove

getServerFile

     protected File getServerFile(File file)

  Compute the path of the public file for the given local file. This method uses the space and root attributes to translate the path of the given file from the user's local space to the public (server) space.

  Returns:
    A File instance, or null.

getFile

     public File getFile()

  Get the file to use to store the edited list of files.

  Returns:
    The file.

getPubFile

     public File getPubFile()

  Get the file to use to store the edited list of published files.

  Returns:
    The file.

getDelFile

     public File getDelFile()

  Get the file to use to store the edited list of deleted files.

  Returns:
    The file.

getRoot

     public File getRoot()

  Get the root directory of the public server to update.

  Returns:
    The root directory of the public server space, supposed to be controled by CVS.

getCvsSpace

     public File getCvsSpace()

  Get this user's local CVS space root directory.

  Returns:
    The usre's root of the CVS local space, assumed to be under CVS control.

writeList

     protected synchronized void writeList()

  Dump the current list of edited files back to disk.

writePubList

     protected synchronized void writePubList()

  Dump the current list of [ublished files back to disk.

writeDelList

     protected synchronized void writeDelList()

  Dump the current list of [ublished files back to disk.

removeUnconfirmedDelEntries

     protected synchronized void removeUnconfirmedDelEntries()

readList

     protected synchronized void readList()

  Restore the list from the file.

readPubList

     protected synchronized void readPubList()

  Restore the published list from the file.

readDelList

     protected synchronized void readDelList()

  Restore the deleted list from the file.

lookupEntry

     protected PutedEntry lookupEntry(Request request)

lookupDelEntry

     protected DeletedEntry lookupDelEntry(Request request)

registerRequest

     public synchronized int registerRequest(Request request)

  Register the given request, which must has a PUT method.

  Parameters:
    file - The modified file.

registerDeleteRequest

     public synchronized void registerDeleteRequest(Request request)

confirmDelete

     public synchronized int confirmDelete(Request request)

delete

     protected int delete(DeletedEntry de)

  Delete the file relative to the given entry.

  Parameters:
    entry - The DeletedEntry.
  Returns:
    FILE_UC, FILE_DEL

publish

     protected int publish(PutedEntry pe)

  Publish the file relative to the given entry.

  Parameters:
    entry - The PutedEntry.
  Returns:
    FILE_UC, FILE_CF, FILE_PB, FILE_MG

notifyUnload

     public synchronized void notifyUnload()

  This resource is being unloaded.

  Overrides:
    notifyUnload in class FramedResource

initialize

     public void initialize(Object values[])

  Initialize the frames of that framed resource.

  Overrides:
    initialize in class FramedResource

    All Packages  Class Hierarchy  This Package  Previous  Next  Index