Project JXTA

net.jxta.protocol
Class TransportAdvertisement

java.lang.Object
  extended bynet.jxta.document.Advertisement
      extended bynet.jxta.document.ExtendableAdvertisement
          extended bynet.jxta.protocol.TransportAdvertisement

public abstract class TransportAdvertisement
extends ExtendableAdvertisement

This abstract class defines a Transport advertisement. Each peer endpoint protocol is associated with a transport advertisement that describes the protocol and network interface associated with the endpoint transport. For example for TCP endpoint. the following transport information needs to be maintained for this endpoint:

Transport :

This class is an abstract class that needs to be extended by implementation to support the different types of transport advertisements (TCP, HTTP, etc)

 <?xml version="1.0"?>
  <TransportAdvertisement type="HTTPAdvertisement">
          ..........
  </TransportAdvertisement>

See Also:
AccessPointAdvertisement

Field Summary
protected  String protocol
           
 
Constructor Summary
TransportAdvertisement()
           
 
Method Summary
static String getAdvertisementType()
          Returns the identifying type of this Advertisement.
 String getBaseAdvType()
          Returns the base type of this advertisement hierarchy. Typically, only the most basic advertisement of a type will implement this method and declare it as final.
 ID getID()
          Return ID for indexing.
 String getProtocol()
          returns the protocol supported by this transport
 void setProtocol(String protocol)
          set the protocol to be used for this transport
 
Methods inherited from class net.jxta.document.ExtendableAdvertisement
getDocument, handleElement
 
Methods inherited from class net.jxta.document.Advertisement
clone, getAdvType, getIndexFields, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

protocol

protected String protocol
Constructor Detail

TransportAdvertisement

public TransportAdvertisement()
Method Detail

getAdvertisementType

public static String getAdvertisementType()
Returns the identifying type of this Advertisement.

Returns:
String the type of advertisement

getBaseAdvType

public final String getBaseAdvType()
Returns the base type of this advertisement hierarchy. Typically, only the most basic advertisement of a type will implement this method and declare it as final.

Specified by:
getBaseAdvType in class ExtendableAdvertisement
Returns:
String the base type of advertisements in this hierarchy.

getID

public ID getID()
Return ID for indexing. We don't have one so return the nullID.

Specified by:
getID in class Advertisement
Returns:
jxta id associated with this advertisement.

getProtocol

public String getProtocol()
returns the protocol supported by this transport

Returns:
string protocol

setProtocol

public void setProtocol(String protocol)
set the protocol to be used for this transport

Returns:
string protocol

JXTA J2SE