NETLIB II

UCFR: the URL Connection Factory Registry

Definition

package netscape.net;

import netscape.url.URL;

public abstract class UCFR {
  public UCFR() throws Exception {};

  public abstract void registerFactory(UCF factory) throws Exception;
  public abstract UCF findFactory(String name) throws Exception;
  public abstract void deregisterFactory(String name) throws Exception;
  public abstract String listFactories() throws Exception;

  public abstract UC createUC(URL url, NC nc) throws Exception;
}

Interface Methods

• UCFR

This creation method simply creates a new,empty, registry.

The C signature of this method is:

UCFR *UCFRFactory_Create(JMCException **e);
• registerFactory

This method registers a URL Connection factory. It calls the factory's getProtocolName method to get the protocol name. This method raises an exception if the protocol name is already registered.

The C signature of this method is:

void UCFR_registerFactory(UCFR *self, UCF *factory, JMCException **e);
• findFactory

This method looks up a factory by protocol name, and returns a reference to that factory. If the protocol is not found, this method returns null.

The C signature of this method is:

UCF *UCFR_findFactory(UCFR *self, const char *name, JMCException **e);
• deregisterFactory

This method removes a named protocol from the registry. It is not an error if no protocol by that name is registered.

The C signature of this method is:

void UCFR_deregisterFactory(UCFR *self, const char *name, JMCException **e);
• listFactories

This method returns a comma-separated list of the protocol names with which UC Factories have been registered. E.g., ``http, gopher, ftp, file.'' As this is some analogue of a java String object, which must be released/finalised/GC'd; the caller must remember to XP_FREE the return string.
The C signature of this method is:
const char *UCFR_listFactories(UCFR *self, JMCException **e);
• createUC

This method creates an object that implements the URL Connection interface UC, which object is appropriate to the protocol specified in the provided URL. In short, this method looks at the protocol part of the URL address, looks up that protocol in the registry, and calls that protocol factory's createUC method to do the actual creation.

The C signature of this method is:

UC *UCFR_createUC(UCFR *self, URL *url, NC *nc, JMCException **e);

Inherited Methods

C interface

#include "UCFR.h"

UCFR *UCFRFactory_Create(JMCException **e);

void UCFR_registerFactory(UCFR *self, UCF *factory, JMCException **e);
UCF *UCFR_findFactory(UCFR *self, const char *name, JMCException **e);
void UCFR_deregisterFactory(UCFR *self, const char *name, JMCException **e);
const char *UCFR_listFactories(UCFR *self, JMCException **e);
UC *UCFR_createUC(UCFR *self, URL *url, NC *nc, JMCException **e);

/* methods inherited from base JMC object interface */
void *UCFR_getInterface(UCFR *self, JMCInterfaceID id, JMCException **e);
void UCFR_addRef(UCFR *self, JMCException **e);
void UCFR_release(UCFR *self, JMCException **e);
jint UCFR_hashCode(UCFR *self, JMCException **e);
void *UCFR_clone(UCFR *self, JMCException **e);
const char *UCFR_toString(UCFR *self, JMCException **e);
void UCFR_finalize(UCFR *self, JMCException **e);