| Package | org.igniterealtime.xiff.data.auth |
| Class | public class AuthExtension |
| Inheritance | AuthExtension Extension XMLStanza ExtensionContainer |
| Implements | IExtension |
See also
| Property | Defined by | ||
|---|---|---|---|
| digest : String
The SHA1 digest to use for authentication.
| AuthExtension | ||
![]() | _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 | ||
![]() | XMLData : XML [static]
| XMLStanza | |
![]() | XMLFactory : XMLDocument [static]
| XMLStanza | |
| Method | Defined by | ||
|---|---|---|---|
|
AuthExtension(parent:XMLNode = null)
| AuthExtension | ||
![]() | ExtensionContainer | ||
![]() |
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 | ||
![]() |
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
| XMLStanza | |
![]() |
exists(value:*):Boolean
[static]
A helper method to determine if a value is both not null
and not undefined.
| XMLStanza | |
![]() |
getAllExtensions():Array
| ExtensionContainer | |
![]() |
getAllExtensionsByNS(ns:String):Array
| ExtensionContainer | |
|
getElementName():String
Gets the element name associated with this extension.
| AuthExtension | ||
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
![]() |
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 | ||
![]() |
remove():void
Removes the extension from its parent.
| Extension | |
![]() |
removeAllExtensions(ns:String):void
| ExtensionContainer | |
![]() |
removeExtension(ext:IExtension):Boolean
| ExtensionContainer | |
![]() |
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 | ||
![]() |
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
| XMLStanza | |
![]() |
toString():String
Converts the extension stanza XML to a string.
| Extension | |
| Constant | Defined by | ||
|---|---|---|---|
| ELEMENT_NAME : String = "query" [static]
| AuthExtension | ||
| NS : String = "jabber:iq:auth" [static]
| AuthExtension | ||
| digest | property |
digest:String [read-write]The SHA1 digest to use for authentication.
Implementation public function get digest():String
public function set digest(value:String):void
| password | property |
password:String [read-write]The password to use for authentication.
Implementation public function get password():String
public function set password(value:String):void
| resource | property |
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
| username | property |
username:String [read-write]The username to use for authentication.
Implementation public function get username():String
public function set username(value:String):void
| AuthExtension | () | constructor |
public function AuthExtension(parent:XMLNode = null)Parameters
parent:XMLNode (default = null) |
| computeDigest | () | method |
public static function computeDigest(sessionID:String, password:String):StringComputes the SHA1 digest of the password and session ID for use when authenticating with the server.
ParameterssessionID:String — The session ID provided by the server
|
|
password:String — The user's password
|
String |
| deserialize | () | method |
public function deserialize(node:XMLNode):BooleanParameters
node:XMLNode |
Boolean |
| enable | () | method |
public static function enable():voidRegisters this extension with the extension registry.
| getElementName | () | method |
public function getElementName():StringGets the element name associated with this extension. The element for this extension is "query".
ReturnsString — The element name
|
| getNS | () | method |
public function getNS():StringGets the namespace associated with this extension. The namespace for the AuthExtension is "jabber:iq:auth".
ReturnsString — The namespace
|
| isDigest | () | method |
public function isDigest():BooleanDetermines whether this is a digest (SHA1) authentication.
ReturnsBoolean — It is a digest (true); it is not a digest (false)
|
| isPassword | () | method |
public function isPassword():BooleanDetermines whether this is a plain-text password authentication.
ReturnsBoolean — It is plain-text password (true); it is not plain-text
password (false)
|
| serialize | () | method |
public function serialize(parent:XMLNode):BooleanParameters
parent:XMLNode |
Boolean |
| ELEMENT_NAME | constant |
public static const ELEMENT_NAME:String = "query"
| NS | constant |
public static const NS:String = "jabber:iq:auth"