com.google.gdata.data.appsforyourdomain

Class Login

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.appsforyourdomain.Login

All Implemented Interfaces:

Extension

public class Login
extends ExtensionPoint
implements Extension

A name space element: "apps:login". Used to model a user account in Google Apps for Your Domain. Has attributes "userName", "password", "suspended", "ipWhitelisted" and "hashFunctionName".

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	admin
protected Boolean	agreedToTerms
static String	ATTRIBUTE_ADMIN
static String	ATTRIBUTE_AGREED_TO_TERMS
static String	ATTRIBUTE_CHANGE_PASSWORD_AT_NEXT_LOGIN
static String	ATTRIBUTE_HASH_FUNCTION_NAME
static String	ATTRIBUTE_IPWHITELISTED
static String	ATTRIBUTE_PASSWORD
static String	ATTRIBUTE_SUSPENDED
static String	ATTRIBUTE_USER_NAME
protected Boolean	changePasswordAtNextLogin
static String	EXTENSION_LOCAL_NAME
protected String	hashFunctionName
protected Boolean	ipWhitelisted
protected String	password
protected Boolean	suspended
protected String	userName

Fields inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
Login()

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(XmlWriter w, ExtensionProfile extensionProfile) Generates an XML representation for the extension.
Boolean	getAdmin()
Boolean	getAgreedToTerms()
Boolean	getChangePasswordAtNextLogin()
static ExtensionDescription	getDefaultDescription()
XmlParser.ElementHandler	getHandler(ExtensionProfile extProfile, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.
String	getHashFunctionName()
Boolean	getIpWhitelisted()
String	getPassword()
Boolean	getSuspended()
String	getUserName()
void	setAdmin(Boolean b)
void	setAgreedToTerms(Boolean b)
void	setChangePasswordAtNextLogin(Boolean b)
void	setHashFunctionName(String h)
void	setIpWhitelisted(Boolean b)
void	setPassword(String password)
void	setSuspended(Boolean b)
void	setUserName(String userName)

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren

Methods inherited from class com.google.gdata.data.AbstractExtension

consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTENSION_LOCAL_NAME

public static final String EXTENSION_LOCAL_NAME

See Also:

Constant Field Values

ATTRIBUTE_USER_NAME

public static final String ATTRIBUTE_USER_NAME

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD

public static final String ATTRIBUTE_PASSWORD

See Also:

Constant Field Values

ATTRIBUTE_SUSPENDED

public static final String ATTRIBUTE_SUSPENDED

See Also:

Constant Field Values

ATTRIBUTE_IPWHITELISTED

public static final String ATTRIBUTE_IPWHITELISTED

See Also:

Constant Field Values

ATTRIBUTE_HASH_FUNCTION_NAME

public static final String ATTRIBUTE_HASH_FUNCTION_NAME

See Also:

Constant Field Values

ATTRIBUTE_ADMIN

public static final String ATTRIBUTE_ADMIN

See Also:

Constant Field Values

ATTRIBUTE_AGREED_TO_TERMS

public static final String ATTRIBUTE_AGREED_TO_TERMS

See Also:

Constant Field Values

ATTRIBUTE_CHANGE_PASSWORD_AT_NEXT_LOGIN

public static final String ATTRIBUTE_CHANGE_PASSWORD_AT_NEXT_LOGIN

See Also:

Constant Field Values

userName

protected String userName

password

protected String password

suspended

protected Boolean suspended

ipWhitelisted

protected Boolean ipWhitelisted

hashFunctionName

protected String hashFunctionName

admin

protected Boolean admin

agreedToTerms

protected Boolean agreedToTerms

changePasswordAtNextLogin

protected Boolean changePasswordAtNextLogin

Constructor Detail

Login

public Login()

Method Detail

getUserName

public String getUserName()

setUserName

public void setUserName(String userName)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getSuspended

public Boolean getSuspended()

setSuspended

public void setSuspended(Boolean b)

getIpWhitelisted

public Boolean getIpWhitelisted()

setIpWhitelisted

public void setIpWhitelisted(Boolean b)

getHashFunctionName

public String getHashFunctionName()

setHashFunctionName

public void setHashFunctionName(String h)

getAdmin

public Boolean getAdmin()

setAdmin

public void setAdmin(Boolean b)

getAgreedToTerms

public Boolean getAgreedToTerms()

setAgreedToTerms

public void setAgreedToTerms(Boolean b)

getChangePasswordAtNextLogin

public Boolean getChangePasswordAtNextLogin()

setChangePasswordAtNextLogin

public void setChangePasswordAtNextLogin(Boolean b)

getDefaultDescription

public static ExtensionDescription getDefaultDescription()

Returns:

Description of this extension

generate

public void generate(XmlWriter w,
            ExtensionProfile extensionProfile)
              throws IOException

Description copied from interface: Extension

Generates an XML representation for the extension.

Specified by:

generate in interface Extension

Overrides:

generate in class AbstractExtension

Parameters:

w - XML writer

extensionProfile - extension profile

Throws:

IOException

getHandler

public XmlParser.ElementHandler getHandler(ExtensionProfile extProfile,
                                  String namespace,
                                  String localName,
                                  Attributes attrs)
                                    throws ParseException

Description copied from class: AbstractExtension

The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.

Specified by:

getHandler in interface Extension

Overrides:

getHandler in class ExtensionPoint

Parameters:

extProfile - extension profile

namespace - extension namespace

localName - tag name, without the namespace prefix

attrs - tag attributes

Returns:

an element handler

Throws:

ParseException - when an unexpected tag or badly-formatted XML is detected