    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

##

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

##

BrokerFrame(ServerHandlerManager, AdminServer, AdminWriter)

##

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

##

broker

     protected ResourceBroker broker

writer

     protected AdminWriter writer

  The object that knows how to write the admin protocol.

shm

     protected ServerHandlerManager shm

  The ServerHandlerManager we export.

admin

     protected AdminServer admin

  The controlling ServerHandler.

##

BrokerFrame

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

##

registerResource

     public void registerResource(FramedResource resource)

  Register this frame to the given resource.

  Overrides:
    registerResource in class HTTPFrame

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.

okReply

     protected Reply okReply(Request request,
                             byte bits[])

okReply

     protected Reply okReply(Request request)

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.

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.

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.

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.

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.

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.

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.

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.

remoteRegisterFrame

     public Reply remoteRegisterFrame(Request request) throws ProtocolException

remoteUnregisterFrame

     public Reply remoteUnregisterFrame(Request request) throws ProtocolException

remoteRegisterResource

     public Reply remoteRegisterResource(Request request) throws ProtocolException

remoteReindexResource

     public Reply remoteReindexResource(Request request) throws ProtocolException

remoteDeleteResource

     public Reply remoteDeleteResource(Request request) throws ProtocolException

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