Overview  Package   Class  Use  Deprecated  Index
Home >> All >> net >> jxta >> [ protocol overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

net.jxta.protocol
Class ModuleSpecAdvertisement  

java.lang.Object
  net.jxta.document.Advertisement
      net.jxta.document.ExtendableAdvertisement
          net.jxta.protocol.ModuleSpecAdvertisement

All Implemented Interfaces:

java.lang.Cloneable

---

public abstract class ModuleSpecAdvertisement

extends net.jxta.document.ExtendableAdvertisement

implements java.lang.Cloneable

A ModuleSpecAdvertisement describes a module specification. Its main purpose is to provide references to the documentation needed in order to create conforming implementations of that specification. A secondary use is, optionally, to make running instances usable remotely, by publishing any or all of the following:

• PipeAdvertisement
• ModuleSpecID of a proxy module
• ModuleSpecID of an authenticator module

Not all modules are usable remotely, it is up to the specification creator to make that choice. However, if the specification dictates it, all implementations can be expected to support it.

Note that the Standard PeerGroup implementation of the java reference implementation does not support replacing a group service with a pipe to a remote instance. However, nothing prevents a particular implementation of a group from using a proxy module in place of the fully version; provided that the API (and therefore the ClassIDs) of the proxy and local versions are identical.

Note also that in the case of the local+proxy style, it is up to the implementation of both sides to figure-out which pipe to listen to or connect to. The safest method is probably for the full version to seek its own ModuleSpecAdvertisement, and for the proxy version to accept the full version's ModuleSpecAdvertisement as a parameter. Alternatively if the proxy version is completely dedicated to the specification that it proxies, both sides may have the PipeID and type hard-coded.

---

Field Summary
private  net.jxta.platform.ModuleSpecID	authSpecID
private  java.lang.String	creator
private  java.lang.String	description
private  net.jxta.platform.ModuleSpecID	id
private  java.lang.String	name
private  net.jxta.document.StructuredDocument	param
private  PipeAdvertisement	pipeAdv
private  net.jxta.platform.ModuleSpecID	proxySpecID
private  java.lang.String	uri
private  java.lang.String	version

 

Constructor Summary

ModuleSpecAdvertisement()

 

Method Summary
java.lang.Object	clone()           Clone this ModuleSpecAdvertisement
static java.lang.String	getAdvertisementType()           Returns the identifying type of this Advertisement.
net.jxta.platform.ModuleSpecID	getAuthSpecID()           returns the specID of an authenticator module.
java.lang.String	getBaseAdvType()           null
java.lang.String	getCreator()           Returns the creator of the module spec, in case someone cares.
java.lang.String	getDescription()           returns the keywords/description associated with this class
net.jxta.id.ID	getID()           returns a unique id for that adv for the purpose of indexing.
net.jxta.platform.ModuleSpecID	getModuleSpecID()           returns the id of the spec
java.lang.String	getName()           returns the name of the module spec
net.jxta.document.StructuredDocument	getParam()           returns the param element.
protected  net.jxta.document.StructuredDocument	getParamPriv()           Privileged version of getParam() 55 that does not clone the elements.
PipeAdvertisement	getPipeAdvertisement()           returns the embedded pipe advertisement if any.
net.jxta.platform.ModuleSpecID	getProxySpecID()           returns the specID of a proxy module.
java.lang.String	getSpecURI()           returns the uri.
java.lang.String	getVersion()           returns the specification version number
void	setAuthSpecID(net.jxta.platform.ModuleSpecID authSpecID)           sets an authenticator module specID
void	setCreator(java.lang.String creator)           Sets the creator of this module spec.
void	setDescription(java.lang.String description)           sets the description associated with this class
void	setModuleSpecID(net.jxta.platform.ModuleSpecID id)           sets the id of the spec
void	setName(java.lang.String name)           sets the name of the module spec
void	setParam(net.jxta.document.Element param)           sets the param element.
void	setPipeAdvertisement(PipeAdvertisement pipeAdv)           sets an embedded pipe advertisement.
void	setProxySpecID(net.jxta.platform.ModuleSpecID proxySpecID)           sets a proxy module specID
void	setSpecURI(java.lang.String uri)           sets the uri
void	setVersion(java.lang.String version)           sets the version of the module

 

Methods inherited from class net.jxta.document.ExtendableAdvertisement

getDocument, handleElement

 

Methods inherited from class net.jxta.document.Advertisement

getAdvType, getIndexFields, toString

 

Methods inherited from class java.lang.Object

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

 

Field Detail

name

private java.lang.String name

---

id

private net.jxta.platform.ModuleSpecID id

---

creator

private java.lang.String creator

---

uri

private java.lang.String uri

---

version

private java.lang.String version

---

description

private java.lang.String description

---

pipeAdv

private PipeAdvertisement pipeAdv

---

proxySpecID

private net.jxta.platform.ModuleSpecID proxySpecID

---

authSpecID

private net.jxta.platform.ModuleSpecID authSpecID

---

param

private net.jxta.document.StructuredDocument param

Constructor Detail

ModuleSpecAdvertisement

public ModuleSpecAdvertisement()

Method Detail

getAdvertisementType

public static java.lang.String getAdvertisementType()

Returns the identifying type of this Advertisement.

---

getBaseAdvType

public final java.lang.String getBaseAdvType()

null

---

clone

public java.lang.Object clone()

Clone this ModuleSpecAdvertisement

---

getModuleSpecID

public net.jxta.platform.ModuleSpecID getModuleSpecID()

returns the id of the spec

---

setModuleSpecID

public void setModuleSpecID(net.jxta.platform.ModuleSpecID id)

sets the id of the spec

---

getID

public net.jxta.id.ID getID()

returns a unique id for that adv for the purpose of indexing. The spec id uniquely identifies this advertisement.

---

getName

public java.lang.String getName()

returns the name of the module spec

---

setName

public void setName(java.lang.String name)

sets the name of the module spec

---

getCreator

public java.lang.String getCreator()

Returns the creator of the module spec, in case someone cares.

---

setCreator

public void setCreator(java.lang.String creator)

Sets the creator of this module spec. Note: the usefulness of this is unclear.

---

getSpecURI

public java.lang.String getSpecURI()

returns the uri. This uri normally points at the actual specification that this advertises.

---

setSpecURI

public void setSpecURI(java.lang.String uri)

sets the uri

---

getVersion

public java.lang.String getVersion()

returns the specification version number

---

setVersion

public void setVersion(java.lang.String version)

sets the version of the module

---

getDescription

public java.lang.String getDescription()

returns the keywords/description associated with this class

---

setDescription

public void setDescription(java.lang.String description)

sets the description associated with this class

---

getParam

public net.jxta.document.StructuredDocument getParam()

returns the param element.

---

getParamPriv

protected net.jxta.document.StructuredDocument getParamPriv()

Privileged version of getParam() 55 that does not clone the elements.

---

setParam

public void setParam(net.jxta.document.Element param)

sets the param element.

---

getPipeAdvertisement

public PipeAdvertisement getPipeAdvertisement()

returns the embedded pipe advertisement if any.

---

setPipeAdvertisement

public void setPipeAdvertisement(PipeAdvertisement pipeAdv)

sets an embedded pipe advertisement.

---

getProxySpecID

public net.jxta.platform.ModuleSpecID getProxySpecID()

returns the specID of a proxy module.

---

setProxySpecID

public void setProxySpecID(net.jxta.platform.ModuleSpecID proxySpecID)

sets a proxy module specID

---

getAuthSpecID

public net.jxta.platform.ModuleSpecID getAuthSpecID()

returns the specID of an authenticator module.

---

setAuthSpecID

public void setAuthSpecID(net.jxta.platform.ModuleSpecID authSpecID)

sets an authenticator module specID

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> net >> jxta >> [ protocol overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---