|
Project JXTA | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.jxta.document.Advertisement
net.jxta.document.ExtendableAdvertisement
net.jxta.protocol.ModuleSpecAdvertisement
public abstract class ModuleSpecAdvertisement
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:
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.
ModuleSpecID
,
PipeAdvertisement
,
ModuleImplAdvertisement
,
Advertisement
Constructor Summary | |
---|---|
ModuleSpecAdvertisement()
|
Method Summary | |
---|---|
Object |
clone()
Clone this ModuleSpecAdvertisement |
static String |
getAdvertisementType()
Returns the identifying type of this Advertisement. |
ModuleSpecID |
getAuthSpecID()
returns the specID of an authenticator module. |
String |
getBaseAdvType()
Returns the base type of this advertisement hierarchy. |
String |
getCreator()
Returns the creator of the module spec, in case someone cares. |
String |
getDescription()
returns the keywords/description associated with this class |
ID |
getID()
returns a unique id for that adv for the purpose of indexing. |
ModuleSpecID |
getModuleSpecID()
returns the id of the spec |
String |
getName()
returns the name of the module spec |
StructuredDocument |
getParam()
returns the param element. |
protected StructuredDocument |
getParamPriv()
Privileged version of getParam() that does not clone the elements. |
PipeAdvertisement |
getPipeAdvertisement()
returns the embedded pipe advertisement if any. |
ModuleSpecID |
getProxySpecID()
returns the specID of a proxy module. |
String |
getSpecURI()
returns the uri. |
String |
getVersion()
returns the specification version number |
void |
setAuthSpecID(ModuleSpecID authSpecID)
sets an authenticator module specID |
void |
setCreator(String creator)
Sets the creator of this module spec. |
void |
setDescription(String description)
sets the description associated with this class |
void |
setModuleSpecID(ModuleSpecID id)
sets the id of the spec |
void |
setName(String name)
sets the name of the module spec |
void |
setParam(Element param)
sets the param element. |
void |
setPipeAdvertisement(PipeAdvertisement pipeAdv)
sets an embedded pipe advertisement. |
void |
setProxySpecID(ModuleSpecID proxySpecID)
sets a proxy module specID |
void |
setSpecURI(String uri)
sets the uri |
void |
setVersion(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 |
Constructor Detail |
---|
public ModuleSpecAdvertisement()
Method Detail |
---|
public static String getAdvertisementType()
public final String getBaseAdvType()
final
.
getBaseAdvType
in class ExtendableAdvertisement
public Object clone()
clone
in class Advertisement
public ModuleSpecID getModuleSpecID()
public void setModuleSpecID(ModuleSpecID id)
id
- The id of the specpublic ID getID()
getID
in class Advertisement
public String getName()
public void setName(String name)
name
- name of the module spec to be setpublic String getCreator()
public void setCreator(String creator)
creator
- name of the creator of the modulepublic String getSpecURI()
public void setSpecURI(String uri)
uri
- string uripublic String getVersion()
public void setVersion(String version)
version
- version numberpublic String getDescription()
public void setDescription(String description)
description
- public StructuredDocument getParam()
protected StructuredDocument getParamPriv()
getParam()
that does not clone the elements.
public void setParam(Element param)
param
- Element of an unspecified content.public PipeAdvertisement getPipeAdvertisement()
public void setPipeAdvertisement(PipeAdvertisement pipeAdv)
pipeAdv
- the Pipe Advertisement. null is authorized.public ModuleSpecID getProxySpecID()
public void setProxySpecID(ModuleSpecID proxySpecID)
proxySpecID
- The spec idpublic ModuleSpecID getAuthSpecID()
public void setAuthSpecID(ModuleSpecID authSpecID)
authSpecID
- The spec id
|
JXTA J2SE | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |