Class EPPLoginSecUserAgent
- java.lang.Object
-
- com.verisign.epp.codec.loginsec.v1_0.EPPLoginSecUserAgent
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPLoginSecUserAgent extends java.lang.Object implements EPPCodecComponent
Login Security User Agent identifies the client software and platform used by the server to identify functional or security constraints, current security issues, and potential future functional or security issues for the client.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPLoginSecUserAgent
.static java.lang.String
ELM_NAME
XML root tag forEPPLoginSecUserAgent
.
-
Constructor Summary
Constructors Constructor Description EPPLoginSecUserAgent()
Default constructor forEPPLoginSecUserAgent
.EPPLoginSecUserAgent(java.lang.String aApp, java.lang.String aTech, java.lang.String aOs)
Constructor forEPPLoginSecUserAgent
that sets all attributes.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Clone anEPPCodecComponent
instance.void
decode(org.w3c.dom.Element aElement)
Decode a DOM element tree to initialize the instance attributes.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Encode instance into a DOM element tree.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPLoginSecUserAgent
with this instance.java.lang.String
getApp()
Gets the name of the client application software.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.lang.String
getOs()
Gets the client operating system being used.java.lang.String
getTech()
Gets the technology used for the client software.boolean
hasApp()
Is the name of the client application software set?boolean
hasOs()
Is the client operating system set?boolean
hasTech()
Is the technology used for the client software set?void
setApp(java.lang.String aApp)
Sets the name of the client application software.void
setOs(java.lang.String aOs)
Sets the client operating system being used.void
setTech(java.lang.String aTech)
Sets the technology used for the client software.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPLoginSecUserAgent
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPLoginSecUserAgent
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPLoginSecUserAgent
public EPPLoginSecUserAgent()
Default constructor forEPPLoginSecUserAgent
.
-
EPPLoginSecUserAgent
public EPPLoginSecUserAgent(java.lang.String aApp, java.lang.String aTech, java.lang.String aOs)
Constructor forEPPLoginSecUserAgent
that sets all attributes.- Parameters:
aApp
- OPTIONAL name of the client application software with version if available, such as the name of the client SDK "EPP SDK 1.0.0". An example is "EPP SDK 1.0.0". Set tonull
if undefined.aTech
- OPTIONAL technology used for the client software with version if available, such as "Java 11.0.2". Set tonull
if undefined.aOs
- OPTIONAL operating system used, such as "x86_64 Mac OS X 10.21". Set tonull
if undefined.
-
-
Method Detail
-
hasApp
public boolean hasApp()
Is the name of the client application software set?- Returns:
true
if the name of the client application software is defined;false
otherwise.
-
getApp
public java.lang.String getApp()
Gets the name of the client application software.- Returns:
- Gets the optional name of the client application software;
null
otherwise.
-
setApp
public void setApp(java.lang.String aApp)
Sets the name of the client application software.- Parameters:
aApp
- Name of the client application software with version if available, such as the name of the client SDK being used. An example is "EPP SDK 1.0.0". Set tonull
if undefined.
-
hasTech
public boolean hasTech()
Is the technology used for the client software set?- Returns:
true
if the technology of the client software is defined;false
otherwise.
-
getTech
public java.lang.String getTech()
Gets the technology used for the client software.- Returns:
- Gets the optional technology used for the client software;
null
otherwise.
-
setTech
public void setTech(java.lang.String aTech)
Sets the technology used for the client software.- Parameters:
aTech
- Technology used for the client software, such as "Java 11.0.2". Set tonull
if undefined.
-
hasOs
public boolean hasOs()
Is the client operating system set?- Returns:
true
if the client operating system is defined;false
otherwise.
-
getOs
public java.lang.String getOs()
Gets the client operating system being used.- Returns:
- Gets the operating system used, such as "x86_64 Mac OS X 10.21";
null
otherwise.
-
setOs
public void setOs(java.lang.String aOs)
Sets the client operating system being used.- Parameters:
aOs
- Name of the client operating system, such as "x86_64 Mac OS X 10.21". Set tonull
if undefined.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document, which acts is an Element factory- Returns:
- Element Root element associated with the object
- Throws:
EPPEncodeException
- Error encodingEPPLoginSecUserAgent
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode a DOM element tree to initialize the instance attributes. TheaElement
argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
-Element
to decode- Throws:
EPPDecodeException
- Error decodingElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPLoginSecUserAgent
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Clone anEPPCodecComponent
instance.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of concrete
EPPLoginSecUserAgent
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-