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

Variable Index

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

Constructor Index

 o PutListResource()

Method Index

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

Variables

 o debug
 protected static final boolean debug
 o FILE_PB
 public static final int FILE_PB
status: File published

 o FILE_UC
 public static final int FILE_UC
status: File unchanged

 o FILE_MG
 public static final int FILE_MG
status: File merged

 o FILE_CF
 public static final int FILE_CF
status: conflict

 o FILE_DEL
 public static final int FILE_DEL
status: deleted

 o ATTR_FILE
 protected static int ATTR_FILE
Attribute index - The file used to store the modification list.

 o ATTR_SPACE
 protected static int ATTR_SPACE
Attribute index - The user's local space.

 o ATTR_ROOT
 protected static int ATTR_ROOT
Attribute index - The web server public space.

 o ATTR_AUTO_PUBLISH
 protected static int ATTR_AUTO_PUBLISH
Attribute index - The auto publish flag

 o ATTR_AUTO_DELETE
 protected static int ATTR_AUTO_DELETE
Attribute index - The auto delete flag

 o ATTR_MAX_PUBLISHED
 protected static int ATTR_MAX_PUBLISHED
Attribute index - The max number of published entries stored

Constructors

 o PutListResource
 public PutListResource()

Methods

 o getAutoPublishFlag
 public boolean getAutoPublishFlag()
Get our auto publish flag.

Returns:
a boolean.
 o setAutoPublish
 protected void setAutoPublish(boolean onoff)
Enable or disable the auto publish feature.

Parameters:
onoff - if onoff is true auto publish is enable.
 o getAutoDeleteFlag
 public boolean getAutoDeleteFlag()
Get our auto delete flag.

Returns:
a boolean.
 o setAutoDelete
 protected void setAutoDelete(boolean onoff)
Enable or disable the auto delete feature.

Parameters:
onoff - if onoff is true auto publish is enable.
 o getMaxPublishedEntryStored
 public int getMaxPublishedEntryStored()
Get the max number of published entries stored in the putlist.

Returns:
an int.
 o setMaxPublishedEntryStored
 protected void setMaxPublishedEntryStored(int max)
Set the max number of published entries stored in the putlist.

Parameters:
max - This number.
 o getEntries
 protected Enumeration getEntries()
Get the modified entries.

Returns:
an enumeration of PutedEntry
See Also:
PutedEntry
 o getEntriesKeys
 protected Enumeration getEntriesKeys()
Get the modified entries keys

Returns:
an enumeration of String
 o 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
 o addEntry
 protected void addEntry(PutedEntry e)
Add an entry into the putlist

Parameters:
e - the entry to add
 o removeEntry
 protected void removeEntry(String key)
Remove a modified entry from the putlist

Parameters:
key - the key of the entry to remove
 o getDelEntries
 protected Enumeration getDelEntries()
Get the deleted entries.

Returns:
an enumeration of DeletedEntry
See Also:
DeletedEntry
 o getDelEntriesKeys
 protected Enumeration getDelEntriesKeys()
Get the deleted entries keys

Returns:
an enumeration of String
 o 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
 o addDelEntry
 protected void addDelEntry(DeletedEntry e)
Add an entry into the putlist

Parameters:
e - the entry to add
 o removeDelEntry
 protected void removeDelEntry(String key)
Remove a deleted entry from the putlist

Parameters:
key - the key of the entry to remove
 o getPublishedEntries
 protected Enumeration getPublishedEntries()
Get the published entries.

Returns:
an enumeration of PutedEntry
See Also:
PutedEntry
 o removeOldestPublishedEntry
 protected void removeOldestPublishedEntry()
Remove the oldest published entry from the putlist.

 o addPubEntry
 protected synchronized void addPubEntry(PutedEntry e)
Add a published entry into the putlist.

Parameters:
e - The published entry to add.
See Also:
PutedEntry
 o removePubEntry
 protected synchronized void removePubEntry(String key)
Remove a published entry from the putlist

Parameters:
key - the key of the entry to remove
 o 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.
 o getFile
 public File getFile()
Get the file to use to store the edited list of files.

Returns:
The file.
 o getPubFile
 public File getPubFile()
Get the file to use to store the edited list of published files.

Returns:
The file.
 o getDelFile
 public File getDelFile()
Get the file to use to store the edited list of deleted files.

Returns:
The file.
 o 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.
 o 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.
 o writeList
 protected synchronized void writeList()
Dump the current list of edited files back to disk.

 o writePubList
 protected synchronized void writePubList()
Dump the current list of [ublished files back to disk.

 o writeDelList
 protected synchronized void writeDelList()
Dump the current list of [ublished files back to disk.

 o removeUnconfirmedDelEntries
 protected synchronized void removeUnconfirmedDelEntries()
 o readList
 protected synchronized void readList()
Restore the list from the file.

 o readPubList
 protected synchronized void readPubList()
Restore the published list from the file.

 o readDelList
 protected synchronized void readDelList()
Restore the deleted list from the file.

 o lookupEntry
 protected PutedEntry lookupEntry(Request request)
 o lookupDelEntry
 protected DeletedEntry lookupDelEntry(Request request)
 o registerRequest
 public synchronized int registerRequest(Request request)
Register the given request, which must has a PUT method.

Parameters:
file - The modified file.
 o registerDeleteRequest
 public synchronized void registerDeleteRequest(Request request)
 o confirmDelete
 public synchronized int confirmDelete(Request request)
 o delete
 protected int delete(DeletedEntry de)
Delete the file relative to the given entry.

Parameters:
entry - The DeletedEntry.
Returns:
FILE_UC, FILE_DEL
 o 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
 o notifyUnload
 public synchronized void notifyUnload()
This resource is being unloaded.

Overrides:
notifyUnload in class FramedResource
 o 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