org.w3c.jigsaw.frames
Class RelocateFrame

java.lang.Object
  |
  +--org.w3c.tools.resources.AttributeHolder
        |
        +--org.w3c.tools.resources.Resource
              |
              +--org.w3c.tools.resources.FramedResource
                    |
                    +--org.w3c.tools.resources.ResourceFrame
                          |
                          +--org.w3c.tools.resources.ProtocolFrame
                                |
                                +--org.w3c.jigsaw.frames.HTTPFrame
                                      |
                                      +--org.w3c.jigsaw.frames.RelocateFrame

public class RelocateFrame
extends HTTPFrame

Emit a HTTP redirect.


Field Summary
protected static int ATTR_HANDLE_PATHINFO
          Attribute index - Should we also handle extra path infos ?
protected static int ATTR_LOCATION
          Attribute index - The relocation location.
protected static int ATTR_PERMANENT_REDIRECT
          Attribute index - Is the relocation permanent?
protected static int ATTR_USE_302
          Attribute index - SHould we use the ambiguous 302?
static java.lang.String PATH_INFO
          Name of the state to hold the PATH_INFO in the request.
 
Fields inherited from class org.w3c.jigsaw.frames.HTTPFrame
_allowed, acceptRanges, allowed, ATTR_ALLOW_DEL, ATTR_BROWSABLE, ATTR_CONTENT_ENCODING, ATTR_CONTENT_LANGUAGE, ATTR_CONTENT_LENGTH, ATTR_CONTENT_TYPE, ATTR_ICON, ATTR_ICONDIR, ATTR_INDEX, ATTR_MAXAGE, ATTR_MD5, ATTR_PUTABLE, ATTR_QUALITY, ATTR_RELOCATE, ATTR_STYLE_LINK, ATTR_TITLE, browsetype, COND_FAILED, COND_OK, dresource, fresource, listing, listing_stamp, STATE_CONTENT_LOCATION
 
Fields inherited from class org.w3c.tools.resources.ResourceFrame
filterClass, frameListener, resource
 
Fields inherited from class org.w3c.tools.resources.FramedResource
ATTR_OID, attrListener, debugEvent, event_disabled, framesRef, structListener
 
Fields inherited from class org.w3c.tools.resources.Resource
ATTR_CONTEXT, ATTR_HELP_URL, ATTR_IDENTIFIER, ATTR_LAST_MODIFIED, ATTR_PARENT, ATTR_RESOURCE_FRAMES, ATTR_STORE_ENTRY, ATTR_URL
 
Fields inherited from class org.w3c.tools.resources.AttributeHolder
attributes, slowpickle, values
 
Constructor Summary
RelocateFrame()
           
 
Method Summary
 boolean checkHandlePathInfo()
          Get the path info value
 boolean checkPermanentRedirect()
          Get the permanent redirect flag
 boolean checkUse302()
          Get the "use ambigous 302 response code" flag
 java.lang.String getLocation()
          Get the location for the relocation
protected  org.w3c.jigsaw.http.Reply getOtherResource(org.w3c.jigsaw.http.Request request)
          Emit a redirect.
protected  boolean lookupOther(org.w3c.tools.resources.LookupState ls, org.w3c.tools.resources.LookupResult lr)
          Lookup the target resource when associated with an unknown resource.
 void registerResource(org.w3c.tools.resources.FramedResource resource)
           
 
Methods inherited from class org.w3c.jigsaw.frames.HTTPFrame
addStyleSheet, attributeChanged, browse, checkIfMatch, checkIfModifiedSince, checkIfNoneMatch, checkIfUnmodifiedSince, checkRequest, computeTrashDir, computeTrashFile, createDefaultReply, createFileReply, delete, deleteDirectoryResource, deleteFileResource, deleteOtherResource, extended, get, getAllowDeleteFlag, getBrowsableFlag, getBrowseType, getContentEncoding, getContentLanguage, getContentLength, getContentType, getDirectoryListing, getDirectoryResource, getDirectoryResource, getETag, getFileResource, getFileResource, getHelpURL, getHelpURL, getIcon, getIconDirectory, getIndex, getMaxAge, getMD5Flag, getPutableFlag, getQuality, getRelocateFlag, getStyleSheetURL, getTitle, getURL, handleRangeRequest, head, headDirectoryResource, headFileResource, headOtherResource, link, lookup, lookupDirectory, lookupFile, lookupResource, options, perform, performFrames, post, put, putFileResource, putOtherResource, registerOtherResource, setValue, trace, unlink, updateCachedHeaders
 
Methods inherited from class org.w3c.tools.resources.ResourceFrame
addFrameEventListener, eventDisabled, fireFrameEvent, frameModified, getFilters, getFilters, getFrameReference, getResource, getResourceReference, getSpaceEntry, getURLPath, lookupFilters, lookupFrames, postFrameEvent, processEvent, removeFrameEventListener, unregisterResource, updateDefaultChildAttributes
 
Methods inherited from class org.w3c.tools.resources.FramedResource
addAttributeChangedListener, addStructureChangedListener, collectFramesReference, delete, disableEvent, displayEvent, enableEvent, fireAttributeChangeEvent, fireStructureChangedEvent, fireStructureChangedEvent, frameAdded, frameRemoved, getClone, getFrame, getFrame, getFrameReference, getFrameReference, getFramesReference, getOid, initialize, markModified, notifyUnload, postAttributeChangeEvent, postEvent, postStructureChangedEvent, postStructureChangedEvent, registerFrame, registerFrameIfNone, removeAttributeChangedListener, removeStructureChangedListener, unregisterFrame
 
Methods inherited from class org.w3c.tools.resources.Resource
acceptUnload, checkMultipleLock, collectFrames, getContext, getFrame, getFrames, getIdentifier, getLastModified, getParent, getServer, getSpace, getStoreEntry, getValue, getValue, isInitialized, setContext, setContext, setValue, updateAttributes
 
Methods inherited from class org.w3c.tools.resources.AttributeHolder
definesAttribute, definesAttribute, getAttributes, getBoolean, getChar, getClone, getClone, getDouble, getFloat, getInt, getLong, getString, getValue, initialize, lookupAttribute, pickle, print, setBoolean, setChar, setDouble, setFloat, setInt, setLong, setString, setValue, unpickle, unpickle, unpickle, unpickleInstance, unpickleInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PATH_INFO

public static final java.lang.String PATH_INFO
Name of the state to hold the PATH_INFO in the request.

ATTR_LOCATION

protected static int ATTR_LOCATION
Attribute index - The relocation location.

ATTR_HANDLE_PATHINFO

protected static int ATTR_HANDLE_PATHINFO
Attribute index - Should we also handle extra path infos ?

ATTR_PERMANENT_REDIRECT

protected static int ATTR_PERMANENT_REDIRECT
Attribute index - Is the relocation permanent?

ATTR_USE_302

protected static int ATTR_USE_302
Attribute index - SHould we use the ambiguous 302?
Constructor Detail

RelocateFrame

public RelocateFrame()
Method Detail

getLocation

public java.lang.String getLocation()
Get the location for the relocation
Returns:
a string, containing the relative path.

checkHandlePathInfo

public boolean checkHandlePathInfo()
Get the path info value
Returns:
a boolean

checkPermanentRedirect

public boolean checkPermanentRedirect()
Get the permanent redirect flag
Returns:
a boolean

checkUse302

public boolean checkUse302()
Get the "use ambigous 302 response code" flag
Returns:
a boolean

registerResource

public void registerResource(org.w3c.tools.resources.FramedResource resource)
Overrides:
registerResource in class HTTPFrame

lookupOther

protected boolean lookupOther(org.w3c.tools.resources.LookupState ls,
                              org.w3c.tools.resources.LookupResult lr)
                       throws org.w3c.tools.resources.ProtocolException
Lookup the target resource when associated with an unknown resource.
Parameters:
ls - The current lookup state
lr - The result
Returns:
true if lookup is done.
Throws:
org.w3c.tools.resources.ProtocolException - If an error relative to the protocol occurs
Overrides:
lookupOther in class HTTPFrame

getOtherResource

protected org.w3c.jigsaw.http.Reply getOtherResource(org.w3c.jigsaw.http.Request request)
                                              throws org.w3c.tools.resources.ProtocolException
Emit a redirect. All GET requests are redirected toward the target location.
Parameters:
client - The client issuing the request.
request - The request to handle.
Throws:
org.w3c.tools.resources.ProtocolException - If the request couldn't be handled.
Overrides:
getOtherResource in class HTTPFrame