p2ps.discovery
Interface Advertisement

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

DefaultAdvertisement, DefaultQuery, EndpointAdvertisement, EndpointQuery, EndpointResolverAdvertisement, EndpointResolverQuery, GroupAdvertisement, GroupQuery, PipeAdvertisement, PipeQuery, Query, RendezvousAdvertisement, RendezvousMessage, RendezvousQuery, ServiceAdvertisement, ServiceQuery

All Known Implementing Classes:

DefaultAdvertisementImp, DefaultQueryImp, EndpointAdvertisementImp, EndpointQueryImp, EndpointResolverAdvertisementImp, EndpointResolverQueryImp, GroupAdvertisementImp, GroupQueryImp, PipeAdvertisementImp, PipeQueryImp, RendezvousAdvertisementImp, RendezvousMessageImp, RendezvousQueryImp, ServiceAdvertisementImp, ServiceQueryImp

public interface Advertisement

extends java.io.Serializable

The base class for all advertisements

Version:

$Revision: 295 $

Author:

Ian Wang

Field Summary

static java.lang.String	ADVERT_ID_TAG
static java.lang.String	EXPIRY_DATE
static java.lang.String	PEER_ID_TAG

Method Summary

java.lang.String	getAdvertID()
long	getExpiryDate()
java.lang.String	getPeerID()
java.lang.String	getType()
Element	getXMLAdvert()
Element	getXMLEnvelope(long expdate)

Field Detail

ADVERT_ID_TAG

public static final java.lang.String ADVERT_ID_TAG

See Also:

Constant Field Values

PEER_ID_TAG

public static final java.lang.String PEER_ID_TAG

See Also:

Constant Field Values

EXPIRY_DATE

public static final java.lang.String EXPIRY_DATE

See Also:

Constant Field Values

Method Detail

getType

public java.lang.String getType()

Returns:

the type for this advertisement

getAdvertID

public java.lang.String getAdvertID()

Returns:

the unique id for this advertisement

getPeerID

public java.lang.String getPeerID()

Returns:

the id of the peer that created this advertisement

getExpiryDate

public long getExpiryDate()

Returns:

the expiry date for this advertisement (-1 if not published)

getXMLAdvert

public Element getXMLAdvert()
                     throws java.io.IOException

Returns:

an XML element for advert

Throws:

java.io.IOException

getXMLEnvelope

public Element getXMLEnvelope(long expdate)
                       throws java.io.IOException

Parameters:

expdate - the expiry date for the advertisement

Returns:

an XML element for the full enveloped advert (returns the same as getXMLAdvert if no envelope)

Throws:

java.io.IOException