p2ps.endpoint
Interface EndpointAdvertisement

All Superinterfaces:

Advertisement, java.io.Serializable

All Known Implementing Classes:

EndpointAdvertisementImp

public interface EndpointAdvertisement

extends Advertisement

An advertisement for a pipe endpoint. Note that the protocol tag is required for endpoint querying.

 <?xml version="1.0"?>
 <EndpointAdvertisement;>
  <advertId> ID of advertisement </advertId>
  <peerID> ID of resolver peer </peerId>
  <endpointAddress>
   <address> The endpoint address </address>
   <transportProtocol> The endpoint protocol </transportProtocol>
  </endpointAddress>
  <pipeID> Optional pipe id </pipeId>
  <pipeID> The endpoint protocol </pipeId>
 </EndpointAdvertisement;>
 

Version:

$Revision: 295 $

Author:

Ian Wang

Field Summary

static java.lang.String	ENDPOINT_ADVERTISEMENT_TYPE
static java.lang.String	PIPE_ID_TAG
static java.lang.String	SCHEME_TAG
static java.lang.String	URI_TAG

Fields inherited from interface p2ps.discovery.Advertisement

ADVERT_ID_TAG, EXPIRY_DATE, PEER_ID_TAG

Method Summary

java.net.URI	getEndpointURI()
java.lang.String	getPipeID()
java.lang.String	getScheme()
void	setEndpointURI(java.net.URI uri) Sets URI of the endpoint
void	setPipeID(java.lang.String pipeid) Set the pipe id for the endpoint (optional)

Methods inherited from interface p2ps.discovery.Advertisement

getAdvertID, getExpiryDate, getPeerID, getType, getXMLAdvert, getXMLEnvelope

Field Detail

ENDPOINT_ADVERTISEMENT_TYPE

public static final java.lang.String ENDPOINT_ADVERTISEMENT_TYPE

See Also:

Constant Field Values

URI_TAG

public static final java.lang.String URI_TAG

See Also:

Constant Field Values

SCHEME_TAG

public static final java.lang.String SCHEME_TAG

See Also:

Constant Field Values

PIPE_ID_TAG

public static final java.lang.String PIPE_ID_TAG

See Also:

Constant Field Values

Method Detail

getEndpointURI

public java.net.URI getEndpointURI()

Returns:

the URI of the endpoint

setEndpointURI

public void setEndpointURI(java.net.URI uri)

Sets URI of the endpoint

getScheme

public java.lang.String getScheme()

Returns:

the scheme for the endpoint

getPipeID

public java.lang.String getPipeID()

Returns:

the pipe id for the endpoint (optional)

setPipeID

public void setPipeID(java.lang.String pipeid)

Set the pipe id for the endpoint (optional)