|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPLoginCmd
public class EPPLoginCmd
The EPP <login> command is used to establish a session with an EPP
server in response to a greeting issued by the server. A <login>
command MUST be sent to a server before any other EPP command to establish an
ongoing session. A server operator MAY limit the number of failed login
attempts N, 1 <= N <= infinity, after which a login failure results in
the connection to the server (if a connection exists) being closed.
A client identifier and initial password MUST be created on the server before
a client can successfully complete a <login> command. The client
identifier and initial password MUST be delivered to the client using an
out-of-band method that protects the identifier and password from inadvertent
disclosure.
In addition to the standard EPP command elements, the <login> command
contains the following child elements:
EPPFactory
,
Serialized FormField Summary |
---|
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE |
Constructor Summary | |
---|---|
EPPLoginCmd()
Allocates a new EPPLoginCmd with default attribute values. |
|
EPPLoginCmd(java.lang.String aTransId,
java.lang.String aClientId,
java.lang.String aPassword)
Allocates a new EPPLoginCmd with the required attributes. |
|
EPPLoginCmd(java.lang.String aTransId,
java.lang.String aClientId,
java.lang.String aPassword,
java.lang.String aNewPassword)
Allocates a new EPPLoginCmd with the required attributes and
the optional new password attribute. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPLoginCmd . |
protected void |
doGenDecode(org.w3c.dom.Element aElement)
decode EPPLoginCmd from a DOM element tree. |
protected org.w3c.dom.Element |
doGenEncode(org.w3c.dom.Document aDocument)
encode EPPLoginCmd into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPLoginCmd compare. |
java.lang.String |
getClientId()
Gets the client login identifier. |
java.util.Vector |
getExtensionServices()
Gets the list of supported/desired extension services. |
java.lang.String |
getLang()
Gets the desired EPP language. |
java.lang.String |
getNamespace()
Gets the EPP command Namespace associated with EPPLoginCmd . |
java.lang.String |
getNewPassword()
Gets the new client password. |
java.lang.String |
getPassword()
Gets the client password. |
java.util.Vector |
getServices()
Gets the login services. |
java.lang.String |
getType()
Gets the EPP command type associated with EPPLoginCmd . |
java.lang.String |
getVersion()
Gets the desired EPP version. |
boolean |
hasExtensionService(java.lang.String aNamespaceURI)
Does the login extension service include a specified extension service based on the Namespace URI? |
boolean |
hasNewPassword()
Is a new password defined? |
boolean |
hasService(java.lang.String aNamespaceURI)
Does the login service include a specified service based on the Namespace URI? |
boolean |
isValidServices(EPPGreeting aGreeting)
Is the EPPLoginCmd services settings valid as compared with
the services specified in the EPPGreeting ? |
void |
mergeServicesAndExtensionServices(EPPGreeting aGreeting)
Merge the services defined automatically in the EPP SDK configuration with services and extension services defined in the EPP Greeting, so that the login services are sent to only be a subset of the services defined in the EPP Greeting. |
void |
setClientId(java.lang.String aClientId)
Sets the client login identifier. |
void |
setExtensionServices(java.util.Vector someExtServices)
Sets the list of supported/desired extension services. |
void |
setLang(java.lang.String aLang)
Sets the desired EPP language. |
void |
setNewPassword(java.lang.String aNewPassword)
Sets the new client password. |
void |
setPassword(java.lang.String aPassword)
Sets the client password. |
void |
setServices(java.util.Vector someServices)
Sets the login services. |
void |
setVersion(java.lang.String aVersion)
Sets the desired EPP version. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
addExtension, decode, encode, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPLoginCmd()
EPPLoginCmd
with default attribute values.
the defaults include the following: null
.null
null
null
EPPFactory
configuration.encode
.
public EPPLoginCmd(java.lang.String aTransId, java.lang.String aClientId, java.lang.String aPassword)
EPPLoginCmd
with the required attributes.
The other attributes are initialized as follows: null
EPPFactory
configuration.
aTransId
- transaction id of the command.aClientId
- Client login idaPassword
- Client passwordpublic EPPLoginCmd(java.lang.String aTransId, java.lang.String aClientId, java.lang.String aPassword, java.lang.String aNewPassword)
EPPLoginCmd
with the required attributes and
the optional new password attribute. The services is initialized based on
the EPPFactory
configuration.
aTransId
- transaction id of the command.aClientId
- Client login idaPassword
- Client passwordaNewPassword
- New client passwordMethod Detail |
---|
public java.lang.String getNamespace()
EPPLoginCmd
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPCommand
public java.lang.String getType()
EPPLoginCmd
.
getType
in class EPPCommand
EPPCommand.TYPE_LOGIN
public java.lang.String getClientId()
null
otherwise.public void setClientId(java.lang.String aClientId)
aClientId
- Client login identifier.public java.lang.String getPassword()
null
otherwise.public void setPassword(java.lang.String aPassword)
aPassword
- Client password.public java.lang.String getNewPassword()
null
otherwise.public void setNewPassword(java.lang.String aNewPassword)
aNewPassword
- New client password.public boolean hasNewPassword()
true
if the new password is defined;
false
otherwise.public java.lang.String getVersion()
EPPCodec.VERSION
.
null
otherwise.public void setVersion(java.lang.String aVersion)
EPPCodec.VERSION
.
aVersion
- EPP version identifierpublic java.lang.String getLang()
EPPGreeting
. The default language is "en".
null
otherwise.public void setLang(java.lang.String aLang)
EPPGreeting
. The default language is "en".
aLang
- The desired EPP languagepublic java.util.Vector getServices()
Vector
of EPPService
instancespublic void setServices(java.util.Vector someServices)
EPPFactory.getServices
.
someServices
- Vector
of desired EPPService
instancespublic boolean hasService(java.lang.String aNamespaceURI)
aNamespaceURI
- Service Namespace URI to search for
true
if the login services include the
service Namespace URI; false
otherwise.public boolean hasExtensionService(java.lang.String aNamespaceURI)
aNamespaceURI
- Extension service Namespace URI to search for
true
if the login extension services include the
extension service Namespace URI; false
otherwise.public java.util.Vector getExtensionServices()
EPPService
instances.public void setExtensionServices(java.util.Vector someExtServices)
someExtServices
- Vector of EPPService
instances.protected org.w3c.dom.Element doGenEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPLoginCmd
into a DOM element tree. The <login>
element is created and the attribute nodes are appended as children. This
method is part of the Template Design Pattern, where
EPPCommand
provides the public encode
and calls
the abstract doGenEncode
.
doGenEncode
in class EPPCommand
aDocument
- DOCUMENT ME!
EPPEncodeException
- Error encoding the DOM element tree.protected void doGenDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPLoginCmd
from a DOM element tree. The "login"
element needs to be the value of the aElement
argument. This
method is part of the Template Design Pattern, where
EPPCommand
provides the public decode
and calls
the abstract doGenDecode
.
doGenDecode
in class EPPCommand
aElement
- <login> root element tree.
EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
EPPLoginCmd
compare.
equals
in class EPPCommand
aObject
- EPPLoginCmd
instance to compare with
true
if equal; false
otherwisepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPLoginCmd
.
clone
in interface EPPCodecComponent
clone
in class EPPCommand
EPPLoginCmd
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class EPPCommand
String
if successful;
ERROR
otherwise.public boolean isValidServices(EPPGreeting aGreeting)
EPPLoginCmd
services settings valid as compared with
the services specified in the EPPGreeting
? The services
attributes defined in EPPLoginCmd
must be a subset of the
available services specified in the EPPGreeting
.
aGreeting
- Greeting to compare services with
true
if the service settings are valid;
false
otherwise.public void mergeServicesAndExtensionServices(EPPGreeting aGreeting)
aGreeting
- EPP Greeting to merge the services in the EPP Login.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |