net.jxta.document
Class AdvertisementFactory

java.lang.Object
  |
  +--net.jxta.util.ClassFactory
        |
        +--net.jxta.document.AdvertisementFactory

public class AdvertisementFactory

extends ClassFactory

A Factory class for Advertisements. This class abstracts the the implementations used to represent and create advertisements.

Advertisements are core objects that are used to advertise a Peer, a PeerGroup, a Service, or a PipeServiceImpl. The Advertisement class provides a platform independent representation of core objects that can be exchanged between different implementations (Java, C).

The AdvertisementFactory extends the ClassFactory to register the various types of adverstisements into a static hastable. The factory is called with the Advertisement type requested to create the corresponding advertisement type.

The initial set of Advertisement instances is loaded from the java property "net.jxta.impl.config.AdvertisementInstanceTypes"

It would be nice to have "newAdvertisement" methods for "Document" and "TextDocument", but this is not feasible because "TextElement" got there first.

Since:

JXTA 1.0

Version:

$Revision: 1.27 $

See Also:

Advertisement, Document, MimeMediaType, PeerGroup, PeerAdvertisement, PeerGroupAdvertisement, PipeAdvertisement

Inner Class Summary

static interface

AdvertisementFactory.Instantiator Interface for instantiators of StructuredDocuments

Method Summary

protected java.util.Hashtable	getAssocTable() Used by ClassFactory methods to get the mapping of Mime Types to constructors.
java.lang.Class	getClassForKey() Used by ClassFactory methods to ensure that all keys used with the mapping are of the correct type.
java.lang.Class	getClassOfInstantiators() Used by ClassFactory methods to ensure that all of the instance classes which register with this factory have the correct base class
static Advertisement	newAdvertisement(MimeMediaType mimetype, java.io.InputStream stream) Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.
static Advertisement	newAdvertisement(MimeMediaType mimetype, java.io.Reader source) Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.
static Advertisement	newAdvertisement(java.lang.String advertisementType) Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.
static Advertisement	newAdvertisement(TextElement root) Constructs an instance of Advertisement matching the type specified by the root parameter.
static boolean	registerAdvertisementInstance(java.lang.String rootType, AdvertisementFactory.Instantiator instantiator) Register an instantiator for and advertisement type to allow instances of that type to be created.
protected boolean	registerAssoc(java.lang.String className) Register a class with the factory from its class name.

Methods inherited from class net.jxta.util.ClassFactory

getAvailableKeys, getInstantiator, registerAssoc, registerFromResources, registerFromString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAssocTable

protected java.util.Hashtable getAssocTable()

Used by ClassFactory methods to get the mapping of Mime Types to constructors.

Overrides:

getAssocTable in class ClassFactory

Returns:

the hashtable containing the mappings.

Since:

JXTA 1.0

getClassOfInstantiators

public java.lang.Class getClassOfInstantiators()

Used by ClassFactory methods to ensure that all of the instance classes which register with this factory have the correct base class

Overrides:

getClassOfInstantiators in class ClassFactory

Returns:

Class object of the key type.

Since:

JXTA 1.0

getClassForKey

public java.lang.Class getClassForKey()

Used by ClassFactory methods to ensure that all keys used with the mapping are of the correct type.

Overrides:

getClassForKey in class ClassFactory

Returns:

Class object of the key type.

Since:

JXTA 1.0

registerAssoc

protected boolean registerAssoc(java.lang.String className)

Register a class with the factory from its class name. We override the standard implementation to get the advertisement type from the class and use that as the key to register the class with the factory.

Overrides:

registerAssoc in class ClassFactory

Parameters:

className - The class name which will be regiestered.

Returns:

boolean true if the class was registered otherwise false.

Since:

JXTA 1.0

registerAdvertisementInstance

public static boolean registerAdvertisementInstance(java.lang.String rootType,
                                                    AdvertisementFactory.Instantiator instantiator)

Register an instantiator for and advertisement type to allow instances of that type to be created.

Parameters:

rootType - the identifying value for this advertisement instance type

instantiator - the instantiator to use in constructing objects of this rootType.

Returns:

boolean true if the rootType type is registered. If there is already a constructor for this type then false will be returned.

Since:

JXTA 1.0

newAdvertisement

public static Advertisement newAdvertisement(java.lang.String advertisementType)

Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.

Parameters:

advertisementType - Specifies the type of advertisement to create.

Returns:

The instance of Advertisement or null if it could not be created.

Since:

JXTA 1.0

newAdvertisement

public static Advertisement newAdvertisement(MimeMediaType mimetype,
                                             java.io.InputStream stream)
                                      throws java.io.IOException

Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.

Parameters:

mimetype - Specifies the mime media type of the stream being read.

stream - imput stream used to read data to construct the advertisement

Returns:

The instance of Advertisement

Throws:

java.io.IOException - error reading message from input stream

java.util.NoSuchElementException - if there is no matching advertisement type for the type of document read in.

Since:

JXTA 1.0

newAdvertisement

public static Advertisement newAdvertisement(MimeMediaType mimetype,
                                             java.io.Reader source)
                                      throws java.io.IOException

Constructs an instance of Advertisement matching the type specified by the advertisementType parameter.

Parameters:

mimetype - Specifies the mime media type of the stream being read.

source - used to read data to construct the advertisement

Returns:

The instance of Advertisement

Throws:

java.io.IOException - error reading message from input stream

java.util.NoSuchElementException - if there is no matching advertisement type for the type of document read in.

java.lang.UnsupportedOperationException - if the specified mime type is not associated with a text oriented document type.

Since:

JXTA 1.0

newAdvertisement

public static Advertisement newAdvertisement(TextElement root)

Constructs an instance of Advertisement matching the type specified by the root parameter.

Parameters:

root - Specifies a portion of a StructuredDocument which will be converted into an Advertisement.

Returns:

The instance of Advertisement or null if it could not be created.

Throws:

java.util.NoSuchElementException - if there is no matching advertisement type for the type of document read in.

Since:

JXTA 1.0