rocks.xmpp.extensions.caps.model

Class EntityCapabilities1

java.lang.Object

rocks.xmpp.core.stream.model.StreamFeature

rocks.xmpp.extensions.caps.model.EntityCapabilities1

All Implemented Interfaces:

java.lang.Comparable<StreamFeature>, EntityCapabilities, Hashed

public final class EntityCapabilities1
extends StreamFeature
implements EntityCapabilities, Hashed

The implementation of the <c/> element in the http://jabber.org/protocol/caps.

This class is immutable.

See Also:

XEP-0115: Entity Capabilities, XML Schema

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE http://jabber.org/protocol/caps

Constructor Summary

Constructors

Constructor and Description
EntityCapabilities1(java.lang.String node, InfoNode infoNode, java.security.MessageDigest messageDigest) Creates an entity caps from an info node and hash function.

Method Summary

Modifier and Type	Method and Description
java.lang.String	createCapabilityHashNode(Hashed hashed) Creates the Capability Hash Node.
byte[]	createVerificationString(InfoNode infoNode) Creates an UTF-8 encoded verification string from a disco#info query.
java.util.Set<Hashed>	getCapabilityHashSet() Gets the capability hash set.
java.lang.String	getHashAlgorithm() Gets the hash algorithm.
byte[]	getHashValue() Gets the hash value.
java.lang.String	getNode() Gets the node.
java.lang.String	getVerificationString() Gets the verification string that is used to verify the identity and supported features of the entity.
java.lang.String	toString()

Methods inherited from class rocks.xmpp.core.stream.model.StreamFeature

compareTo, getPriority, isMandatory, requiresRestart

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

http://jabber.org/protocol/caps

See Also:

Constant Field Values

Constructor Detail

EntityCapabilities1

public EntityCapabilities1(java.lang.String node,
                           InfoNode infoNode,
                           java.security.MessageDigest messageDigest)

Creates an entity caps from an info node and hash function.

Parameters:

node - The node.

infoNode - The info node.

messageDigest - The hash function.

Method Detail

getHashAlgorithm

public final java.lang.String getHashAlgorithm()

Description copied from interface: Hashed

Gets the hash algorithm.

Specified by:

getHashAlgorithm in interface Hashed

Returns:

The hash algorithm.

getHashValue

public final byte[] getHashValue()

Description copied from interface: Hashed

Gets the hash value.

Specified by:

getHashValue in interface Hashed

Returns:

The hash value.

getNode

public final java.lang.String getNode()

Gets the node.

A URI that uniquely identifies a software application, typically a URL at the website of the project or company that produces the software.

It is RECOMMENDED for the value of the ‘node’ attribute to be an HTTP URL at which a user could find further information about the software product, such as “http://psi-im.org” for the Psi client; this enables a processing application to also determine a unique string for the generating application, which it could maintain in a list of known software implementations (e.g., associating the name received via the disco#info reply with the URL found in the caps data).

Returns:

The node.

getVerificationString

public final java.lang.String getVerificationString()

Gets the verification string that is used to verify the identity and supported features of the entity.

Returns:

The verification string.

getCapabilityHashSet

public final java.util.Set<Hashed> getCapabilityHashSet()

Description copied from interface: EntityCapabilities

Gets the capability hash set.

Specified by:

getCapabilityHashSet in interface EntityCapabilities

Returns:

The capability hash set.

createVerificationString

public final byte[] createVerificationString(InfoNode infoNode)

Description copied from interface: EntityCapabilities

Creates an UTF-8 encoded verification string from a disco#info query.

The returned byte array is neither hashed nor base64 encoded. It should be used as input for generating the capability hash set.

Specified by:

createVerificationString in interface EntityCapabilities

Parameters:

infoNode - The query.

Returns:

The caps string, aka. verification string.

createCapabilityHashNode

public final java.lang.String createCapabilityHashNode(Hashed hashed)

Description copied from interface: EntityCapabilities

Creates the Capability Hash Node.

This node is used to query the generating entity via a Service Discovery Info query (disco#info).

Specified by:

createCapabilityHashNode in interface EntityCapabilities

Parameters:

hashed - The pair of hash algorithm and value.

Returns:

The node.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object