Package | org.igniterealtime.xiff.data.auth |
Class | public class AuthExtension |
Inheritance | AuthExtension ![]() ![]() ![]() ![]() |
Implements | IExtension |
OBSOLETE
See also
Property | Defined 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 | ||
![]() | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension |
Method | Defined By | ||
---|---|---|---|
AuthExtension(parent:XML = null) | AuthExtension | ||
![]() |
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 | ||
![]() | getAllExtensions():Array | ExtensionContainer | |
![]() | getAllExtensionsByNS(nameSpace:String):Array | ExtensionContainer | |
![]() | getAttribute(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
![]() | getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML. | XMLStanza | |
![]() | 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 | ||
![]() | getExtension(elementName:String):IExtension
Get the extension having the given element name. | ExtensionContainer | |
![]() | 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 | ||
![]() | remove():void
Removes the extension from its parent. | Extension | |
![]() | removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
![]() | removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
![]() | removeFields(name:String):void
Helper method for removing all child elements that have the given name. | XMLStanza | |
![]() | setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML. | XMLStanza | |
![]() | setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML. | XMLStanza | |
![]() | setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | toString():String
Converts the base stanza XML to a string. | XMLStanza |
Constant | Defined By | ||
---|---|---|---|
![]() | DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
ELEMENT_NAME : String = query [static] | AuthExtension | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
NS : String = jabber:iq:auth [static] | AuthExtension | ||
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
digest | property |
digest:String
The SHA1 digest to use for authentication. While assigned, password is removed.
public function get digest():String
public function set digest(value:String):void
password | property |
password:String
The password to use for authentication. While assigned, digest is removed.
public function get password():String
public function set password(value:String):void
resource | property |
resource:String
The resource to use for authentication.
public function get resource():String
public function set resource(value:String):void
See also
username | property |
username:String
The username to use for authentication.
public function get username():String
public function set username(value:String):void
AuthExtension | () | Constructor |
public function AuthExtension(parent:XML = null)
parent:XML (default = null )
|
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
|
String |
getElementName | () | method |
public function getElementName():String
Gets the element name associated with this extension. The element for this extension is "query".
ReturnsString — 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".
ReturnsString — The namespace
|
isDigest | () | method |
public function isDigest():Boolean
Determines whether this is a digest (SHA1) authentication.
ReturnsBoolean — 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.
ReturnsBoolean — It is plain-text password (true); it is not plain-text
password (false)
|
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = query
NS | Constant |
public static const NS:String = jabber:iq:auth