    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Interface org.w3c.jigsaw.admin.RemoteResource

public interface RemoteResource

The client side view of a server-side resource. The whole servers state are exported through resources, which allows the administration application to discover and query it using a homogeneous interface. All methods will throw a `RemoteAccessException` in case of network failure.

See Also:
  RemoteBroker

##

delete()
  Delete that resource, and detach it from its container.
enumerateResourceIdentifiers()
getAttributes()
  Get the target resource list of attributes.
getClassHierarchy()
  Get the target resource class hierarchy.
getFrames()
  Get the frames attached to that resource.
getValue(String)
getValues(String[])
isContainer()
isDirectoryResource()
isFrame()
isFramed()
  Is this resource a framed resource ?
loadResource(String)
registerFrame(String, String)
  Attach a new frame to that resource.
registerResource(String, String)
  Register a new resource within this container.
reindex()
  Reindex the resource's children if this resource is a DirectoryResource.
setValue(String, Object)
setValues(String[], Object[])
  Set a set of attribute values in one shot.
unregisterFrame(RemoteResource)
  Unregister a given frame from that resource.
updateURL(URL)
  Is this resource a filtered resource ?

##

getClassHierarchy

     public abstract String[] getClassHierarchy() throws RemoteAccessException

  Get the target resource class hierarchy. This method will return the class hierarchy as an array of String. The first string in the array is the name of the resource class itself, the last string will always be java.lang.Object.

  Returns:
    A String array givimg the target resource's class description.
  Throws: RemoteAccessException
    If somenetwork failure occured.

delete

     public abstract void delete() throws RemoteAccessException

  Delete that resource, and detach it from its container.

  Throws: RemoteAccessException
    If somenetwork failure occured.

reindex

     public abstract void reindex() throws RemoteAccessException

  Reindex the resource's children if this resource is a DirectoryResource.

  Throws: RemoteAccessException
    If it's not a DirectoryResource

getAttributes

     public abstract Attribute[] getAttributes() throws RemoteAccessException

  Get the target resource list of attributes. This method returns the target resource attributes description. The resulting array contains instances of the Attribute class, one item per described attributes.

  Even though this returns all the attribute resources, only the ones that are advertized as being editable can be set through this interface.

  Returns:
    An array of Attribute.
  Throws: RemoteAccessException
    If somenetwork failure occured.

getValue

     public abstract Object getValue(String attr) throws RemoteAccessException

  Parameters:
    name - The attribute whose value is to be fetched, encoded as its name.
  Throws: RemoteAccessException
    If somenetwork failure occured.

getValues

     public abstract Object[] getValues(String attrs[]) throws RemoteAccessException

  Parameters:
    attrs - The (ordered) set of attributes whose value is to be fetched.
  Returns:
    An (ordered) set of values, one per queried attribute.
  Throws: RemoteAccessException
    If somenetwork failure occured.

setValue

     public abstract void setValue(String attr,
                                   Object value) throws RemoteAccessException

  Parameters:
    attr - The attribute to set, encoded as it's name.
    value - The new value for that attribute.
  Throws: RemoteAccessException
    If somenetwork failure occured.

setValues

     public abstract void setValues(String attrs[],
                                    Object values[]) throws RemoteAccessException

  Set a set of attribute values in one shot. This method guarantees that either all setting is done, or none of them are.

  Parameters:
    attrs - The (ordered) list of attribute to set, encoded as their names.
    values - The (ordered) list of values, for each of the above attributes.
  Throws: RemoteAccessException
    If somenetwork failure occured.

isContainer

     public abstract boolean isContainer() throws RemoteAccessException

  Throws: RemoteAccessException
    If somenetwork failure occured.

isDirectoryResource

     public abstract boolean isDirectoryResource() throws RemoteAccessException

enumerateResourceIdentifiers

     public abstract String[] enumerateResourceIdentifiers() throws RemoteAccessException

  Throws: RemoteAccessException
    If somenetwork failure occured.

loadResource

     public abstract RemoteResource loadResource(String identifier) throws RemoteAccessException

  Throws: RemoteAccessException
    If somenetwork failure occured.

registerResource

     public abstract RemoteResource registerResource(String id,
                                                     String classname) throws RemoteAccessException

  Register a new resource within this container.

  Parameters:
    id - The identifier of the resource to be created.
    classname - The name of the class of the resource to be added.
  Throws: RemoteAccessException
    if a remote access error occurs.

isFramed

     public abstract boolean isFramed() throws RemoteAccessException

  Is this resource a framed resource ?

  Returns:
    A boolean, true if the resource is framed and it currently has some frames attached, false otherwise.
  Throws: RemoteAccessException
    if a remote access error occurs.

isFrame

     public abstract boolean isFrame()

getFrames

     public abstract RemoteResource[] getFrames() throws RemoteAccessException

  Get the frames attached to that resource. Each frame is itself a resource, so it is returned as an instance of a remote resource.

  Returns:
    A (posssibly null) array of frames attached to that resource.
  Throws: RemoteAccessException
    if a remote access error occurs.

unregisterFrame

     public abstract void unregisterFrame(RemoteResource frame) throws RemoteAccessException

  Unregister a given frame from that resource.

  Parameters:
    filter - The frame to unregister.
  Throws: RemoteAccessException
    if a remote access error occurs.

registerFrame

     public abstract RemoteResource registerFrame(String identifier,
                                                  String classname) throws RemoteAccessException

  Attach a new frame to that resource.

  Parameters:
    identifier - The name for this frame (if any).
    clsname - The name of the frame's class.
  Returns:
    A remote handle to the (remotely) created frame instance.
  Throws: RemoteAccessException
    if a remote access error occurs.

updateURL

     public abstract void updateURL(URL parentURL)

  Is this resource a filtered resource ?

  Returns:
    A boolean, true if the resource is filtered and it currently has some filters attached, false otherwise.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index