net.named_data.jndn

Class Interest

java.lang.Object

net.named_data.jndn.Interest

All Implemented Interfaces:

ChangeCountable

public class Interest
extends Object
implements ChangeCountable

An Interest holds a Name and other fields for an interest.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHILD_SELECTOR_LEFT
static int	CHILD_SELECTOR_RIGHT

Constructor Summary

Constructors

Constructor and Description
Interest() Create a new Interest with an empty name and "none" for all values.
Interest(Interest interest) Create a new interest as a deep copy of the given interest.
Interest(Name name) Create a new Interest with the given name and "none" for other values.
Interest(Name name, double interestLifetimeMilliseconds) Create a new Interest with the given name and interest lifetime and "none" for other values.

Method Summary

Methods

Modifier and Type	Method and Description
long	getChangeCount() Get the change count, which is incremented each time this object (or a child object) is changed.
int	getChildSelector()
SignedBlob	getDefaultWireEncoding() Return a pointer to the defaultWireEncoding, which was encoded with getDefaultWireEncodingFormat().
Exclude	getExclude()
long	getIncomingFaceId() Get the incoming face ID according to the incoming packet header.
double	getInterestLifetimeMilliseconds()
KeyLocator	getKeyLocator()
Link	getLink() Get the link object.
Blob	getLinkWireEncoding() Get the wire encoding of the link object.
Blob	getLinkWireEncoding(WireFormat wireFormat) Get the wire encoding of the link object.
int	getMaxSuffixComponents()
int	getMinSuffixComponents()
boolean	getMustBeFresh() Get the must be fresh flag.
Name	getName()
Blob	getNonce() Return the nonce value from the incoming interest.
int	getSelectedDelegationIndex() Get the selected delegation index.
boolean	hasLink() Check if this interest has a link object (or a link wire encoding which can be decoded to make the link object).
boolean	matchesData(Data data) Check if the given Data packet can satisfy this Interest.
boolean	matchesData(Data data, WireFormat wireFormat) Check if the given Data packet can satisfy this Interest.
boolean	matchesName(Name name) Check if this Interest's name matches the given name (using Name.match) and the given name also conforms to the interest selectors.
void	refreshNonce() Update the bytes of the nonce with new random values.
Interest	setChildSelector(int childSelector) Set the child selector.
Interest	setExclude(Exclude exclude) Set this interest to use a copy of the given Exclude object.
Interest	setInterestLifetimeMilliseconds(double interestLifetimeMilliseconds) Set the interest lifetime.
Interest	setKeyLocator(KeyLocator keyLocator) Set this interest to use a copy of the given KeyLocator object.
Interest	setLinkWireEncoding(Blob encoding) Set the link wire encoding bytes, without decoding them.
Interest	setLinkWireEncoding(Blob encoding, WireFormat wireFormat) Set the link wire encoding bytes, without decoding them.
Interest	setMaxSuffixComponents(int maxSuffixComponents) Set the max suffix components count.
Interest	setMinSuffixComponents(int minSuffixComponents) Set the min suffix components count.
Interest	setMustBeFresh(boolean mustBeFresh) Set the MustBeFresh flag.
Interest	setName(Name name) Set the interest name.
Interest	setNonce(Blob nonce) Deprecated. You should let the wire encoder generate a random nonce internally before sending the interest.
Interest	setSelectedDelegationIndex(int selectedDelegationIndex) Set the selected delegation index.
String	toUri() Encode the name according to the "NDN URI Scheme".
Interest	unsetLink() Clear the link wire encoding and link object so that getLink() returns null.
void	wireDecode(Blob input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Interest.
void	wireDecode(Blob input, WireFormat wireFormat) Decode the input using a particular wire format and update this Interest.
void	wireDecode(ByteBuffer input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Interest.
void	wireDecode(ByteBuffer input, WireFormat wireFormat) Decode the input using a particular wire format and update this Interest.
SignedBlob	wireEncode() Encode this Interest for the default wire format WireFormat.getDefaultWireFormat().
SignedBlob	wireEncode(WireFormat wireFormat) Encode this Interest for a particular wire format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHILD_SELECTOR_LEFT

public static final int CHILD_SELECTOR_LEFT

See Also:

Constant Field Values

CHILD_SELECTOR_RIGHT

public static final int CHILD_SELECTOR_RIGHT

See Also:

Constant Field Values

Constructor Detail

Interest

public Interest(Name name,
        double interestLifetimeMilliseconds)

Create a new Interest with the given name and interest lifetime and "none" for other values.

Parameters:

name - The name for the interest.

interestLifetimeMilliseconds - The interest lifetime in milliseconds, or -1 for none.

Interest

public Interest(Name name)

Create a new Interest with the given name and "none" for other values.

Parameters:

name - The name for the interest.

Interest

public Interest(Interest interest)

Create a new interest as a deep copy of the given interest.

Parameters:

interest - The interest to copy.

Interest

public Interest()

Create a new Interest with an empty name and "none" for all values.

Method Detail

wireEncode

public final SignedBlob wireEncode(WireFormat wireFormat)

Encode this Interest for a particular wire format. If wireFormat is the default wire format, also set the defaultWireEncoding field to the encoded result.

Parameters:

wireFormat - A WireFormat object used to encode this Interest.

Returns:

The encoded buffer.

wireEncode

public final SignedBlob wireEncode()

Encode this Interest for the default wire format WireFormat.getDefaultWireFormat().

Returns:

The encoded buffer.

wireDecode

public final void wireDecode(ByteBuffer input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this Interest.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(ByteBuffer input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Interest.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this Interest. If wireFormat is the default wire format, also set the defaultWireEncoding field another pointer to the input Blob.

Parameters:

input - The input blob to decode.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Interest.

Parameters:

input - The input blob to decode.

Throws:

EncodingException - For invalid encoding.

toUri

public final String toUri()

Encode the name according to the "NDN URI Scheme". If there are interest selectors, append "?" and added the selectors as a query string. For example "/test/name?ndn.ChildSelector=1".

Returns:

The URI string.

Note:

This is an experimental feature. See the API docs for more detail at http://named-data.net/doc/ndn-ccl-api/interest.html#interest-touri-method .

getName

public final Name getName()

getMinSuffixComponents

public final int getMinSuffixComponents()

getMaxSuffixComponents

public final int getMaxSuffixComponents()

getKeyLocator

public final KeyLocator getKeyLocator()

getExclude

public final Exclude getExclude()

getChildSelector

public final int getChildSelector()

getMustBeFresh

public final boolean getMustBeFresh()

Get the must be fresh flag. If not specified, the default is true.

Returns:

The must be fresh flag.

getInterestLifetimeMilliseconds

public final double getInterestLifetimeMilliseconds()

getNonce

public final Blob getNonce()

Return the nonce value from the incoming interest. If you change any of the fields in this Interest object, then the nonce value is cleared.

Returns:

The nonce.

hasLink

public final boolean hasLink()

Check if this interest has a link object (or a link wire encoding which can be decoded to make the link object).

Returns:

True if this interest has a link object, false if not.

getLink

public final Link getLink()
                   throws EncodingException

Get the link object. If necessary, decode it from the link wire encoding.

Returns:

The link object, or null if not specified.

Throws:

EncodingException - For error decoding the link wire encoding (if necessary).

getLinkWireEncoding

public final Blob getLinkWireEncoding(WireFormat wireFormat)
                               throws EncodingException

Get the wire encoding of the link object. If there is already a wire encoding then return it. Otherwise encode from the link object (if available).

Parameters:

wireFormat - The desired wire format for the encoding.

Returns:

The wire encoding, or an isNull Blob if the link is not specified.

Throws:

EncodingException - for error encoding the link object.

getLinkWireEncoding

public final Blob getLinkWireEncoding()
                               throws EncodingException

Get the wire encoding of the link object. If there is already a wire encoding then return it. Otherwise encode from the link object (if available).

Returns:

The wire encoding, or an isNull Blob if the link is not specified.

Throws:

EncodingException - for error encoding the link object.

getSelectedDelegationIndex

public final int getSelectedDelegationIndex()

Get the selected delegation index.

Returns:

The selected delegation index. If not specified, return -1.

getIncomingFaceId

public final long getIncomingFaceId()

Get the incoming face ID according to the incoming packet header.

Returns:

The incoming face ID. If not specified, return -1.

setName

public final Interest setName(Name name)

Set the interest name.

Parameters:

name - The interest name. This makes a copy of the name.

Returns:

This Interest so that you can chain calls to update values.

Note:

You can also call getName and change the name values directly.

setMinSuffixComponents

public final Interest setMinSuffixComponents(int minSuffixComponents)

Set the min suffix components count.

Parameters:

minSuffixComponents - The min suffix components count. If not specified, set to -1.

Returns:

This Interest so that you can chain calls to update values.

setMaxSuffixComponents

public final Interest setMaxSuffixComponents(int maxSuffixComponents)

Set the max suffix components count.

Parameters:

maxSuffixComponents - The max suffix components count. If not specified, set to -1.

Returns:

This Interest so that you can chain calls to update values.

setChildSelector

public final Interest setChildSelector(int childSelector)

Set the child selector.

Parameters:

childSelector - The child selector. If not specified, set to -1.

Returns:

This Interest so that you can chain calls to update values.

setMustBeFresh

public final Interest setMustBeFresh(boolean mustBeFresh)

Set the MustBeFresh flag.

Parameters:

mustBeFresh - True if the content must be fresh, otherwise false. If you do not set this flag, the default value is true.

Returns:

This Interest so that you can chain calls to update values.

setInterestLifetimeMilliseconds

public final Interest setInterestLifetimeMilliseconds(double interestLifetimeMilliseconds)

Set the interest lifetime.

Parameters:

interestLifetimeMilliseconds - The interest lifetime in milliseconds. If not specified, set to -1.

Returns:

This Interest so that you can chain calls to update values.

setNonce

public final Interest setNonce(Blob nonce)

Deprecated. You should let the wire encoder generate a random nonce internally before sending the interest.

setKeyLocator

public final Interest setKeyLocator(KeyLocator keyLocator)

Set this interest to use a copy of the given KeyLocator object.

Parameters:

keyLocator - The KeyLocator object. This makes a copy of the object. If no key locator is specified, set to a new default KeyLocator(), or to a KeyLocator with an unspecified type.

Returns:

This Interest so that you can chain calls to update values.

Note:

You can also call getKeyLocator and change the key locator directly.

setExclude

public final Interest setExclude(Exclude exclude)

Set this interest to use a copy of the given Exclude object.

Parameters:

exclude - The Exclude object. This makes a copy of the object. If no exclude is specified, set to a new default Exclude(), or to an Exclude with size() 0.

Returns:

This Interest so that you can chain calls to update values.

Note:

You can also call getExclude and change the exclude entries directly.

setLinkWireEncoding

public final Interest setLinkWireEncoding(Blob encoding,
                           WireFormat wireFormat)

Set the link wire encoding bytes, without decoding them. If there is a link object, set it to null. If you later call getLink(), it will decode the wireEncoding to create the link object.

Parameters:

encoding - The buffer with the bytes of the link wire encoding. If no link is specified, set to an empty Blob() or call unsetLink().

wireFormat - The wire format of the encoding, to be used later if necessary to decode.

Returns:

This Interest so that you can chain calls to update values.

setLinkWireEncoding

public final Interest setLinkWireEncoding(Blob encoding)

Set the link wire encoding bytes, without decoding them. If there is a link object, set it to null. IF you later call getLink(), it will decode the wireEncoding to create the link object.

Parameters:

encoding - The buffer with the bytes of the link wire encoding. If no link is specified, set to an empty Blob().

Returns:

This Interest so that you can chain calls to update values.

unsetLink

public final Interest unsetLink()

Clear the link wire encoding and link object so that getLink() returns null.

Returns:

This Interest so that you can chain calls to update values.

setSelectedDelegationIndex

public final Interest setSelectedDelegationIndex(int selectedDelegationIndex)

Set the selected delegation index.

Parameters:

selectedDelegationIndex - The selected delegation index. If not specified, set to -1.

Returns:

This Interest so that you can chain calls to update values.

refreshNonce

public final void refreshNonce()

Update the bytes of the nonce with new random values. This ensures that the new nonce value is different than the current one. If the current nonce is not specified, this does nothing.

matchesName

public final boolean matchesName(Name name)

Check if this Interest's name matches the given name (using Name.match) and the given name also conforms to the interest selectors.

Parameters:

name - The name to check.

Returns:

True if the name and interest selectors match, otherwise false.

matchesData

public final boolean matchesData(Data data,
                  WireFormat wireFormat)
                          throws EncodingException

Check if the given Data packet can satisfy this Interest. This method considers the Name, MinSuffixComponents, MaxSuffixComponents, PublisherPublicKeyLocator, and Exclude. It does not consider the ChildSelector or MustBeFresh. This uses the given wireFormat to get the Data packet encoding for the full Name.

Parameters:

data - The Data packet to check.

wireFormat - A WireFormat object used to encode the Data packet to get its full Name.

Returns:

True if the given Data packet can satisfy this Interest.

Throws:

EncodingException

matchesData

public final boolean matchesData(Data data)
                          throws EncodingException

Check if the given Data packet can satisfy this Interest. This method considers the Name, MinSuffixComponents, MaxSuffixComponents, PublisherPublicKeyLocator, and Exclude. It does not consider the ChildSelector or MustBeFresh. This uses the default WireFormat to get the Data packet encoding for the full Name.

Parameters:

data - The Data packet to check.

Returns:

True if the given Data packet can satisfy this Interest.

Throws:

EncodingException

getDefaultWireEncoding

public final SignedBlob getDefaultWireEncoding()

Return a pointer to the defaultWireEncoding, which was encoded with getDefaultWireEncodingFormat().

Returns:

The default wire encoding. Its pointer may be null.

getChangeCount

public final long getChangeCount()

Get the change count, which is incremented each time this object (or a child object) is changed.

Specified by:

getChangeCount in interface ChangeCountable

Returns:

The change count.