com.ausregistry.jtoolkit2.se

Class LoginCommand

java.lang.Object

com.ausregistry.jtoolkit2.se.Command

com.ausregistry.jtoolkit2.se.LoginCommand

All Implemented Interfaces:

java.io.Serializable

public final class LoginCommand
extends Command

Use this to open an EPP session in order to perform commands only permitted from within the context of a session. Instances of this class generate, via the toXML method, login service elements compliant with the login specification in RFC5730.

See Also:

For services available to be used in the login command on the chosen EPP server., To end a session opened using LoginCommand., Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	userLogger
protected XMLWriter	xmlWriter

Fields inherited from class com.ausregistry.jtoolkit2.se.Command

cmdElement, command, extension

Constructor Summary

Constructors

Constructor and Description
LoginCommand(java.lang.String clID, java.lang.String password)
LoginCommand(java.lang.String clID, java.lang.String password, java.lang.String newPW)
LoginCommand(java.lang.String clID, java.lang.String password, java.lang.String[] objURIs, java.lang.String[] extURIs)
LoginCommand(java.lang.String clID, java.lang.String password, java.lang.String version, java.lang.String lang, java.lang.String[] objURIs, java.lang.String[] extURIs)
LoginCommand(java.lang.String clID, java.lang.String password, java.lang.String newPassword, java.lang.String version, java.lang.String lang, java.lang.String[] objURIs, java.lang.String[] extURIs)

Method Summary

Modifier and Type	Method and Description
java.lang.String	toXML() Serialize the EPP service element to XML.
java.lang.String	toXML(XmlOutputConfig outputConfig) Serialize the EPP service element to XML using the given output config.

Methods inherited from class com.ausregistry.jtoolkit2.se.Command

appendExtension, getCommandType, getExtensionElement, getXmlWriter, initCmdElement, toXMLImpl

Methods inherited from class java.lang.Object

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

Field Detail

xmlWriter

protected final transient XMLWriter xmlWriter

userLogger

protected final transient java.util.logging.Logger userLogger

Constructor Detail

LoginCommand

public LoginCommand(java.lang.String clID,
                    java.lang.String password)

LoginCommand

public LoginCommand(java.lang.String clID,
                    java.lang.String password,
                    java.lang.String newPW)

LoginCommand

public LoginCommand(java.lang.String clID,
                    java.lang.String password,
                    java.lang.String[] objURIs,
                    java.lang.String[] extURIs)

LoginCommand

public LoginCommand(java.lang.String clID,
                    java.lang.String password,
                    java.lang.String version,
                    java.lang.String lang,
                    java.lang.String[] objURIs,
                    java.lang.String[] extURIs)

LoginCommand

public LoginCommand(java.lang.String clID,
                    java.lang.String password,
                    java.lang.String newPassword,
                    java.lang.String version,
                    java.lang.String lang,
                    java.lang.String[] objURIs,
                    java.lang.String[] extURIs)

Parameters:

clID - Required.

password - Required.

newPassword - Optional.

version - Required.

lang -

objURIs - Required.

extURIs - Optional.

Throws:

java.lang.IllegalArgumentException - if clID, password or version are null.

Method Detail

toXML

public final java.lang.String toXML()
                             throws org.xml.sax.SAXException

Serialize the EPP service element to XML. This MUST be called prior to attempting to use Java serialization on this object. Failure to do so will result in NullPointerException when toXML is called after deserializing the object.

Returns:

XML content as string literal

Throws:

org.xml.sax.SAXException - The XML representation of the command failed schema validation. Further attempts to serialize this command will also fail.

See Also:

toXML

toXML

public final java.lang.String toXML(XmlOutputConfig outputConfig)
                             throws org.xml.sax.SAXException

Serialize the EPP service element to XML using the given output config.

Parameters:

outputConfig - a configuration that indicates how to output the XML

Returns:

XML content as string literal

Throws:

org.xml.sax.SAXException

See Also:

XmlOutputConfig