Packageorg.igniterealtime.xiff.data.auth
Classpublic class AuthExtension
InheritanceAuthExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IExtension

XEP-0078: Non-SASL Authentication

OBSOLETE

See also

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

Public Properties
 PropertyDefined By
  digest : String
The SHA1 digest to use for authentication.
AuthExtension
  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
 Inheritedxml : XML
[override] Override in order to take care of setting the Namespace and checking for containing extensions.
Extension
Public Methods
 MethodDefined By
  
AuthExtension(parent:XML = null)
AuthExtension
 Inherited
addExtension(extension:IExtension):IExtension
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
  
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
 Inherited
getAllExtensions():Array
ExtensionContainer
 Inherited
getAllExtensionsByNS(nameSpace:String):Array
ExtensionContainer
 Inherited
getAttribute(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML.
XMLStanza
 Inherited
getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML.
XMLStanza
  
getElementName():String
Gets the element name associated with this extension.
AuthExtension
 Inherited
getExtension(elementName:String):IExtension
Get the extension having the given element name.
ExtensionContainer
 Inherited
getField(name:String):String
Convinience method for getting element value from the XML.
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(nameSpace:String):void
ExtensionContainer
 Inherited
removeExtension(extension:IExtension):Boolean
ExtensionContainer
 Inherited
removeFields(name:String):void
Helper method for removing all child elements that have the given name.
XMLStanza
 Inherited
setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML.
XMLStanza
 Inherited
setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML.
XMLStanza
 Inherited
setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
toString():String
Converts the base stanza XML to a string.
XMLStanza
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NS : Namespace
[static] Default XML namespace.
XMLStanza
  ELEMENT_NAME : String = query
[static]
AuthExtension
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = jabber:iq:auth
[static]
AuthExtension
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
digestproperty
digest:String

The SHA1 digest to use for authentication. While assigned, password is removed.


Implementation
    public function get digest():String
    public function set digest(value:String):void
passwordproperty 
password:String

The password to use for authentication. While assigned, digest is removed.


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

The resource to use for authentication.


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

See also

org.igniterealtime.xiff.core.XMPPConnection.resource
usernameproperty 
username:String

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:XML = null)



Parameters
parent:XML (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
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)
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = query

NSConstant 
public static const NS:String = jabber:iq:auth





Thu Aug 23 2012, 12:09 AM +03:00