All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.w3c.jigsaw.admin.BrokerFrame

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.admin.BrokerFrame

public class BrokerFrame
extends HTTPFrame

Variable Index

 o admin
The controlling ServerHandler.
 o broker
 o shm
The ServerHandlerManager we export.
 o writer
The object that knows how to write the admin protocol.

Constructor Index

 o BrokerFrame(ServerHandlerManager, AdminServer, AdminWriter)

Method Index

 o checkContentType(Request)
Check that request incomming content type.
 o error(Request, String)
Trigger an HTTP exception.
 o extended(Request)
Perform an extended request
 o getDataInputStream(Request)
Get a data input stream out of that request input stream
 o lookup(Request)
Lookup the target of the given request.
 o okReply(Request)
 o okReply(Request, byte[])
 o registerResource(FramedResource)
Register this frame to the given resource.
 o remoteDeleteResource(Request)
 o remoteEnumerateIdentifiers(Request)
Enumerate the resource identifiers of that resource.
 o remoteGetAttributes(Request)
Get the set of attributes for the given resource.
 o remoteGetValues(Request)
Get a set of attribute values.
 o remoteLoadResource(Request)
Return a resource back to the client.
 o remoteRegisterFrame(Request)
 o remoteRegisterResource(Request)
 o remoteReindexResource(Request)
 o remoteSetValues(Request)
Set a set of attribute values for the target resource.
 o remoteUnregisterFrame(Request)

Variables

 o broker
 protected ResourceBroker broker
 o writer
 protected AdminWriter writer
The object that knows how to write the admin protocol.

 o shm
 protected ServerHandlerManager shm
The ServerHandlerManager we export.

 o admin
 protected AdminServer admin
The controlling ServerHandler.

Constructors

 o BrokerFrame
 public BrokerFrame(ServerHandlerManager shm,
                    AdminServer admin,
                    AdminWriter writer)

Methods

 o registerResource
 public void registerResource(FramedResource resource)
Register this frame to the given resource.

Overrides:
registerResource in class HTTPFrame
 o error
 protected void error(Request request,
                      String msg) throws ProtocolException
Trigger an HTTP exception.

Parameters:
request - The request we couldn't fulfill.
msg - The error message.
Throws: ProtocolException
Always thrown.
 o okReply
 protected Reply okReply(Request request,
                         byte bits[])
 o okReply
 protected Reply okReply(Request request)
 o checkContentType
 protected void checkContentType(Request request) throws ProtocolException
Check that request incomming content type.

Parameters:
request - The request to check.
Throws: ProtocolException
If the request type doesn't match admin.
 o getDataInputStream
 protected DataInputStream getDataInputStream(Request request) throws ProtocolException
Get a data input stream out of that request input stream

Parameters:
request - The request to get data from.
Returns:
A DataInputStream instance to read the request's content.
Throws: ProtocolException
If we couldn't get the request's content.
 o lookup
 public ResourceReference lookup(Request request) throws ProtocolException
Lookup the target of the given request.

Parameters:
request - The request whose target is to be fetched.
Returns:
A Resource instance.
Throws: ProtocolException
If the resource couldn't be located.
 o remoteSetValues
 public Reply remoteSetValues(Request request) throws ProtocolException
Set a set of attribute values for the target resource.

Parameters:
request - The request to handle.
Returns:
A Reply instance.
Throws: ProtocolException
If some error occurs.
 o remoteGetValues
 public Reply remoteGetValues(Request request) throws ProtocolException
Get a set of attribute values.

Parameters:
request - The request to handle.
Returns:
A Reply instance.
Throws: ProtocolException
If some error occurs.
 o remoteGetAttributes
 public Reply remoteGetAttributes(Request request) throws ProtocolException
Get the set of attributes for the given resource.

Parameters:
request - The request to handle.
Returns:
A Reply instance.
Throws: ProtocolException
If some error occurs.
 o remoteEnumerateIdentifiers
 public Reply remoteEnumerateIdentifiers(Request request) throws ProtocolException
Enumerate the resource identifiers of that resource.

Parameters:
request - The request to handle.
Returns:
A Reply instance.
Throws: ProtocolException
If some error occurs.
 o remoteLoadResource
 public Reply remoteLoadResource(Request request) throws ProtocolException
Return a resource back to the client.

Parameters:
request - The request to handle.
Returns:
A Reply instance.
Throws: ProtocolException
If some error occurs.
 o remoteRegisterFrame
 public Reply remoteRegisterFrame(Request request) throws ProtocolException
 o remoteUnregisterFrame
 public Reply remoteUnregisterFrame(Request request) throws ProtocolException
 o remoteRegisterResource
 public Reply remoteRegisterResource(Request request) throws ProtocolException
 o remoteReindexResource
 public Reply remoteReindexResource(Request request) throws ProtocolException
 o remoteDeleteResource
 public Reply remoteDeleteResource(Request request) throws ProtocolException
 o extended
 public Reply extended(Request request) throws ProtocolException, ResourceException
Perform an extended request

Parameters:
request - the incomming request.
Throws: ProtocolException
if a protocol error occurs
Throws: ResourceException
if a server error occurs
Overrides:
extended in class HTTPFrame

All Packages  Class Hierarchy  This Package  Previous  Next  Index