p2ps.pipe
Interface PipeAdvertisement

All Superinterfaces:

Advertisement, java.io.Serializable

All Known Implementing Classes:

PipeAdvertisementImp

public interface PipeAdvertisement

extends Advertisement

An interface implemented by advertisements for input pipes.

Version:

$Revision: 295 $

Author:

Ian Wang

Field Summary

static java.lang.String	PIPE_ADVERTISEMENT_TYPE
static java.lang.String	PIPE_ID_TAG
static java.lang.String	PIPE_NAME_TAG
static java.lang.String	PIPE_SCHEME_TAG
static java.lang.String	PIPE_URI_TAG

Fields inherited from interface p2ps.discovery.Advertisement

ADVERT_ID_TAG, EXPIRY_DATE, PEER_ID_TAG

Method Summary

java.lang.String	getPeerID()
java.lang.String	getPipeID()
java.lang.String	getPipeName()
java.lang.String	getPipeScheme()
java.net.URI	getPipeURI()
void	setPeerID(java.lang.String id) Sets the peer id for this pipe
void	setPipeID(java.lang.String id) Sets the UUID of the pipe
void	setPipeName(java.lang.String name) Sets the name of the pipe
void	setPipeScheme(java.lang.String scheme) Sets the scheme of the pipe (e.g.
void	setPipeURI(java.net.URI uri) Sets the URI of the pipe

Methods inherited from interface p2ps.discovery.Advertisement

getAdvertID, getExpiryDate, getType, getXMLAdvert, getXMLEnvelope

Field Detail

PIPE_ADVERTISEMENT_TYPE

public static final java.lang.String PIPE_ADVERTISEMENT_TYPE

See Also:

Constant Field Values

PIPE_ID_TAG

public static final java.lang.String PIPE_ID_TAG

See Also:

Constant Field Values

PIPE_URI_TAG

public static final java.lang.String PIPE_URI_TAG

See Also:

Constant Field Values

PIPE_NAME_TAG

public static final java.lang.String PIPE_NAME_TAG

See Also:

Constant Field Values

PIPE_SCHEME_TAG

public static final java.lang.String PIPE_SCHEME_TAG

See Also:

Constant Field Values

Method Detail

getPeerID

public java.lang.String getPeerID()

Specified by:

getPeerID in interface Advertisement

Returns:

the peer id of the pipe

setPeerID

public void setPeerID(java.lang.String id)

Sets the peer id for this pipe

getPipeID

public java.lang.String getPipeID()

Returns:

the UUID of the pipe

setPipeID

public void setPipeID(java.lang.String id)

Sets the UUID of the pipe

getPipeURI

public java.net.URI getPipeURI()

Returns:

the URI of the pipe

setPipeURI

public void setPipeURI(java.net.URI uri)

Sets the URI of the pipe

getPipeName

public java.lang.String getPipeName()

Returns:

the name of the pipe

setPipeName

public void setPipeName(java.lang.String name)

Sets the name of the pipe

getPipeScheme

public java.lang.String getPipeScheme()

Returns:

the scheme of the pipe (e.g. P2PS_STANDARD, BIDIRECTIONAL, P2PS_DISCOVERY)

setPipeScheme

public void setPipeScheme(java.lang.String scheme)
                   throws java.net.URISyntaxException

Sets the scheme of the pipe (e.g. P2PS_STANDARD, BIDIRECTIONAL, P2PS_DISCOVERY)

Throws:

java.net.URISyntaxException