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	ANSWER_CONTENT_STORE
static int	ANSWER_GENERATED
static int	ANSWER_NO_CONTENT_STORE
static int	ANSWER_STALE
static int	CHILD_SELECTOR_LEFT
static int	CHILD_SELECTOR_RIGHT
static int	DEFAULT_ANSWER_ORIGIN_KIND
static int	MARK_STALE

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
int	getAnswerOriginKind() Deprecated. Use getMustBeFresh.
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 of the local control header.
double	getInterestLifetimeMilliseconds()
KeyLocator	getKeyLocator()
int	getMaxSuffixComponents()
int	getMinSuffixComponents()
boolean	getMustBeFresh() Get the must be fresh flag.
Name	getName()
long	getNextHopFaceId() Get the next hop face ID.
Blob	getNonce() Return the nonce value from the incoming interest.
PublisherPublicKeyDigest	getPublisherPublicKeyDigest() Deprecated. The Interest publisherPublicKeyDigest is deprecated. If you need a publisher public key digest, set the keyLocator keyLocatorType to KEY_LOCATOR_DIGEST and set its key data to the digest.
int	getScope()
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.
Interest	setAnswerOriginKind(int answerOriginKind) Deprecated. Use setMustBeFresh.
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	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	setScope(int scope) Set the interest scope.
String	toUri() Encode the name according to the "NDN URI Scheme".
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

ANSWER_NO_CONTENT_STORE

public static final int ANSWER_NO_CONTENT_STORE

See Also:

Constant Field Values

ANSWER_CONTENT_STORE

public static final int ANSWER_CONTENT_STORE

See Also:

Constant Field Values

ANSWER_GENERATED

public static final int ANSWER_GENERATED

See Also:

Constant Field Values

ANSWER_STALE

public static final int ANSWER_STALE

See Also:

Constant Field Values

MARK_STALE

public static final int MARK_STALE

See Also:

Constant Field Values

DEFAULT_ANSWER_ORIGIN_KIND

public static final int DEFAULT_ANSWER_ORIGIN_KIND

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()

getPublisherPublicKeyDigest

public final PublisherPublicKeyDigest getPublisherPublicKeyDigest()

Deprecated. The Interest publisherPublicKeyDigest is deprecated. If you need a publisher public key digest, set the keyLocator keyLocatorType to KEY_LOCATOR_DIGEST and set its key data to the digest.

getKeyLocator

public final KeyLocator getKeyLocator()

getExclude

public final Exclude getExclude()

getChildSelector

public final int getChildSelector()

getAnswerOriginKind

public final int getAnswerOriginKind()

Deprecated. Use getMustBeFresh.

getMustBeFresh

public final boolean getMustBeFresh()

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

Returns:

The must be fresh flag.

getScope

public final int getScope()

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.

getIncomingFaceId

public final long getIncomingFaceId()

Get the incoming face ID of the local control header.

Returns:

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

Note:

This is an experimental feature. This API may change in the future.

getNextHopFaceId

public final long getNextHopFaceId()

Get the next hop face ID.

Returns:

The next hop face ID. If not specified, return -1.

Note:

This is an experimental feature. This API may change in the future.

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.

setAnswerOriginKind

public final Interest setAnswerOriginKind(int answerOriginKind)

Deprecated. Use setMustBeFresh.

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.

setScope

public final Interest setScope(int scope)

Set the interest scope.

Parameters:

scope - The interest scope. If not specified, set to -1.

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:

ou 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.

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.

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.