p2ps.service
Interface ServiceAdvertisement

All Superinterfaces:
Advertisement, java.io.Serializable
All Known Implementing Classes:
ServiceAdvertisementImp

public interface ServiceAdvertisement
extends Advertisement

An advert for a named p2ps service.

Version:
$Revision: 295 $
Author:
Ian Wang

Field Summary
static java.lang.String CONTROL_PIPES_TAG
           
static java.lang.String SERVICE_ADVERTISEMENT_TYPE
           
static java.lang.String SERVICE_ID_TAG
           
static java.lang.String SERVICE_NAME_TAG
           
 
Fields inherited from interface p2ps.discovery.Advertisement
ADVERT_ID_TAG, EXPIRY_DATE, PEER_ID_TAG
 
Method Summary
 void addControlPipe(PipeAdvertisement advert)
          Sets the advertisement for this services control pipes
 PipeAdvertisement getControlPipe(java.lang.String pipename)
           
 PipeAdvertisement[] getControlPipes()
           
 java.lang.String getServiceID()
           
 java.lang.String getServiceName()
           
 void removeControlPipe(PipeAdvertisement advert)
          Sets the advertisement for this services control pipes
 void setServiceID(java.lang.String id)
          Sets the name for this service
 void setServiceName(java.lang.String name)
          Sets the name for this service
 
Methods inherited from interface p2ps.discovery.Advertisement
getAdvertID, getExpiryDate, getPeerID, getType, getXMLAdvert, getXMLEnvelope
 

Field Detail

SERVICE_ADVERTISEMENT_TYPE

public static final java.lang.String SERVICE_ADVERTISEMENT_TYPE
See Also:
Constant Field Values

SERVICE_NAME_TAG

public static final java.lang.String SERVICE_NAME_TAG
See Also:
Constant Field Values

SERVICE_ID_TAG

public static final java.lang.String SERVICE_ID_TAG
See Also:
Constant Field Values

CONTROL_PIPES_TAG

public static final java.lang.String CONTROL_PIPES_TAG
See Also:
Constant Field Values
Method Detail

getServiceName

public java.lang.String getServiceName()
Returns:
the name of the service

setServiceName

public void setServiceName(java.lang.String name)
Sets the name for this service


getServiceID

public java.lang.String getServiceID()
Returns:
the id of the service

setServiceID

public void setServiceID(java.lang.String id)
Sets the name for this service


getControlPipes

public PipeAdvertisement[] getControlPipes()
Returns:
the advertisements for the services control pipes

getControlPipe

public PipeAdvertisement getControlPipe(java.lang.String pipename)
Returns:
the pipe advertisement for the control pipe with the specified name

addControlPipe

public void addControlPipe(PipeAdvertisement advert)
Sets the advertisement for this services control pipes


removeControlPipe

public void removeControlPipe(PipeAdvertisement advert)
Sets the advertisement for this services control pipes