Packageorg.igniterealtime.xiff.data.auth
Classpublic class AuthExtension
InheritanceAuthExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsIExtension

Implements XEP-0078 for non SASL authentication.

See also

http://xmpp.org/extensions/xep-0078.html


Public Properties
 PropertyDefined by
  digest : String
The SHA1 digest to use for authentication.
AuthExtension
 Inherited_exts : Object
ExtensionContainer
  password : String
The password to use for authentication.
AuthExtension
  resource : String
The resource to use for authentication.
AuthExtension
  username : String
The username to use for authentication.
AuthExtension
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
Public Methods
 MethodDefined by
  
AuthExtension(parent:XMLNode = null)
AuthExtension
 Inherited
ExtensionContainer
 Inherited
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
XMLStanza
  
computeDigest(sessionID:String, password:String):String
[static] Computes the SHA1 digest of the password and session ID for use when authenticating with the server.
AuthExtension
  
deserialize(node:XMLNode):Boolean
AuthExtension
  
enable():void
[static] Registers this extension with the extension registry.
AuthExtension
 Inherited
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
XMLStanza
 Inherited
exists(value:*):Boolean
[static] A helper method to determine if a value is both not null and not undefined.
XMLStanza
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(ns:String):Array
ExtensionContainer
  
getElementName():String
Gets the element name associated with this extension.
AuthExtension
 Inherited
getExtension(name:String):Extension
ExtensionContainer
 Inherited
getNode():XMLNode
XMLStanza
  
getNS():String
Gets the namespace associated with this extension.
AuthExtension
  
isDigest():Boolean
Determines whether this is a digest (SHA1) authentication.
AuthExtension
  
isPassword():Boolean
Determines whether this is a plain-text password authentication.
AuthExtension
 Inherited
remove():void
Removes the extension from its parent.
Extension
 Inherited
removeAllExtensions(ns:String):void
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
replaceTextNode(parent:XMLNode, original:XMLNode, elementName:String, value:String):XMLNode
Replaces one node in the stanza with another simple text node.
XMLStanza
  
serialize(parent:XMLNode):Boolean
AuthExtension
 Inherited
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
XMLStanza
 Inherited
toString():String
Converts the extension stanza XML to a string.
Extension
Public Constants
 ConstantDefined by
  ELEMENT_NAME : String = "query"
[static]
AuthExtension
  NS : String = "jabber:iq:auth"
[static]
AuthExtension
Property detail
digestproperty
digest:String  [read-write]

The SHA1 digest to use for authentication.

Implementation
    public function get digest():String
    public function set digest(value:String):void
passwordproperty 
password:String  [read-write]

The password to use for authentication.

Implementation
    public function get password():String
    public function set password(value:String):void
resourceproperty 
resource:String  [read-write]

The resource to use for authentication.

Implementation
    public function get resource():String
    public function set resource(value:String):void

See also

usernameproperty 
username:String  [read-write]

The username to use for authentication.

Implementation
    public function get username():String
    public function set username(value:String):void
Constructor detail
AuthExtension()constructor
public function AuthExtension(parent:XMLNode = null)Parameters
parent:XMLNode (default = null)
Method detail
computeDigest()method
public static function computeDigest(sessionID:String, password:String):String

Computes the SHA1 digest of the password and session ID for use when authenticating with the server.

Parameters
sessionID:String — The session ID provided by the server
 
password:String — The user's password

Returns
String
deserialize()method 
public function deserialize(node:XMLNode):BooleanParameters
node:XMLNode

Returns
Boolean
enable()method 
public static function enable():void

Registers this extension with the extension registry.

getElementName()method 
public function getElementName():String

Gets the element name associated with this extension. The element for this extension is "query".

Returns
String — The element name
getNS()method 
public function getNS():String

Gets the namespace associated with this extension. The namespace for the AuthExtension is "jabber:iq:auth".

Returns
String — The namespace
isDigest()method 
public function isDigest():Boolean

Determines whether this is a digest (SHA1) authentication.

Returns
Boolean — It is a digest (true); it is not a digest (false)
isPassword()method 
public function isPassword():Boolean

Determines whether this is a plain-text password authentication.

Returns
Boolean — It is plain-text password (true); it is not plain-text password (false)
serialize()method 
public function serialize(parent:XMLNode):BooleanParameters
parent:XMLNode

Returns
Boolean
Constant detail
ELEMENT_NAMEconstant
public static const ELEMENT_NAME:String = "query"
NSconstant 
public static const NS:String = "jabber:iq:auth"