public class EPPService extends java.lang.Object implements EPPCodecComponent
EPPCodec
. A service contains an XML namespace prefix, an
XML namespace URI, and an XML Schema location. Each concrete
EPPMapFactory
is associated with an EPPService
that is used as a descriptor of the service. The list of supported
EPPServices
can be retreived from the
EPPFactory
An EPPService is a member of different EPP
Messages including the EPPGreeting
and the
EPPLoginCmd
. An EPPService
is encoded into an
individual XML element with a tag name of XML namespace
prefix:service and the XML attributes set to the attribute values.EPPFactory
,
EPPMapFactory
,
EPPGreeting
,
EPPLoginCmd
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
EXT_SERVICE
The service is an extension service
|
static int |
OBJ_SERVICE
The service is an object service
|
int |
serviceType
Defines the type of service as either OBJ_SERVICE or EXT_SERVICE.
|
Constructor and Description |
---|
EPPService() |
EPPService(java.lang.String aNamespacePrefix,
java.lang.String aNamespaceURI,
java.lang.String aSchemaLocation)
Allocates a new
EPPService and sets all of the required
attributes to the arguments values. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPService . |
void |
decode(org.w3c.dom.Element aElement)
decode
EPPService from a DOM element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode
EPPService into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPService compare. |
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getNamespacePrefix()
Gets the XML namespace prefix associated with the service.
|
java.lang.String |
getNamespaceURI()
Gets the XML namespace URI associated with the service.
|
java.lang.String |
getSchemaLocation()
Gets the XML Schema location associated with the service.
|
int |
getServiceType()
Gets the service type associcted with this service
|
void |
setNamespacePrefix(java.lang.String aNamespacePrefix)
Set the XML namespace prefix associated with the service.
|
void |
setNamespaceURI(java.lang.String aNamespaceURI)
Set the XML namespace URI associated with the service.
|
void |
setSchemaLocation(java.lang.String aSchemaLocation)
Set the XML Schema location associated with the service.
|
void |
setServiceType(int aServiceType)
Set the service type associated with this service
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final int OBJ_SERVICE
public static final int EXT_SERVICE
public int serviceType
public EPPService()
public EPPService(java.lang.String aNamespacePrefix, java.lang.String aNamespaceURI, java.lang.String aSchemaLocation)
EPPService
and sets all of the required
attributes to the arguments values.aNamespacePrefix
- XML Namespace prefix for the service. For
example, The Domain Mapping prefix is "domain".aNamespaceURI
- XML Namespace URI for the service. For example,
The Domain Mapping URI is "urn:iana:xmlns:domain".aSchemaLocation
- The location of the XML Schema. For example, the
Domain Mapping Schema Location is "urn:iana:xmlns:domain
domain.xsd".public java.lang.String getNamespaceURI()
String
if defined;
null
otherwise.public void setNamespaceURI(java.lang.String aNamespaceURI)
aNamespaceURI
- XML namespace URI String
public java.lang.String getNamespacePrefix()
String
if defined;
null
otherwise.public void setNamespacePrefix(java.lang.String aNamespacePrefix)
aNamespacePrefix
- XML namespace prefix String
public java.lang.String getSchemaLocation()
String
if defined;
null
otherwise.public void setSchemaLocation(java.lang.String aSchemaLocation)
aSchemaLocation
- XML Schema location String
public void setServiceType(int aServiceType)
aServiceType
- .public int getServiceType()
int
; null
otherwise.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPService
into a DOM element tree. The
"prefix:service" element is created and the attribute values
are appended as XML attributes.encode
in interface EPPCodecComponent
aDocument
- DOCUMENT ME!EPPEncodeException
- Error encoding the DOM element tree.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPService
from a DOM element tree. The
aElement
argument needs to be the "prefix:service"
element.decode
in interface EPPCodecComponent
aElement
- The "prefix:service" XML element.EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
EPPService
compare.equals
in class java.lang.Object
aObject
- EPPService
instance to compare withpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPService
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPService
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 java.lang.Object
String
if successful;
ERROR
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.