Package com.verisign.epp.codec.gen
Class EPPResult
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResult
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPResult extends java.lang.Object implements EPPCodecComponent
Represents an individual result that is contained in anEPPResponse
. A result documents the success or failure of command execution. If the command was processed successfully, only one <result> element MUST be returned. If the command was not processed successfully, multiple <result> elements MAY be returned to document failure conditions. Each <result> element contains the following attribute and child elements:
- A "code" attribute whose value is a four-digit, decimal number that describes the success or failure of the command.
- A <msg> element containing a human-readable description of the response code. The language of the response is identified via an OPTIONAL "lang" attribute. If not specified, the default attribute value MUST be "en" (English).
- Zero or more OPTIONAL <value> elements that identify a client- provided element (including XML tag and value) that caused a server error condition.
- Zero or more OPTIONAL <extValue> elements that can be used to provide additional error diagnostic information.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static int
ASSOC_PROHIBITS_OP
Object association prohibits operation
This response code MUST be returned when a server receives a command to transform an object that can not be completed due to dependencies on other objects that are associated with the target object.static int
AUTHENTICATION_ERROR
Authentication error
This response code MUST be returned when a server notes an error when validating client credentials.static int
AUTHENTICATION_ERROR_END
Authentication error; server closing connection
This response code MUST be returned when a server notes an error when validating client credentials and a server-defined limit on the number of allowable failures has been exceeded.static int
AUTHORIZATION_ERROR
Authorization error
This response code MUST be returned when a server notes a client authorization error when executing a command.static int
BILLING_ERROR
Billing failure
This response code MUST be returned when a server attempts to execute a billable operation and the command can not be completed due to a client billing failure.static int
COMMAND_FAILED
Command failed
This response code MUST be returned when a server is unable to execute a command due to an internal server error that is not related to the protocol.static int
COMMAND_FAILED_END
Command failed; server closing connection
This response code MUST be returned when a server receives a command that can not be completed due to an internal server error that is not related to the protocol.static int
COMMAND_SYNTAX_ERROR
Command syntax error
This response code MUST be returned when a server receives an improperly formed command element.static int
COMMAND_USE_ERROR
Command use error
This response code MUST be returned when a server receives a properly formed command element, but the command can not be executed due to a sequencing or context error.static int
DATA_MGT_POLICY_VIOLATION
Data management policy violation
This response code MUST be returned when a server receives a command whose execution results in a violation of server data management policies.static java.lang.String
DEFAULT_LANG
The default language of the result message "en".static int
INVALID_AUTHORIZATION_INFO
Invalid authorization information
This response code MUST be returned when a server receives invalid command authorization information required to confirm authorization to execute a command.static int
MISSING_PARAMETER
Required parameter missing
This response code MUST be returned when a server receives a command for which a required parameter value has not been provided.static int
NOT_RENEWABLE
Object is not eligible for renewal
This response code MUST be returned when a client attempts to renew an object that is not eligible for renewal in accordance with server policy.static int
NOT_TRANSFERABLE
Object is not eligible for transfer
This response code MUST be returned when a client attempts to transfer an object that is not eligible for transfer in accordance with server policy.static int
OBJECT_DOES_NOT_EXIST
Object does not exist
This response code MUST be returned when a server receives a command to query or transform an object that does not exist in the repository.static int
OBJECT_EXISTS
Object exists
This response code MUST be returned when a server receives a command to create an object that already exists in the repository.static int
OBJECT_NOT_PENDING_TRANSFER
Object not pending transfer
This response code MUST be returned when a server receives a command to confirm, reject, or cancel the transfer an object when no command has been made to transfer the object.static int
OBJECT_PENDING_TRANSFER
Object pending transfer
This response code MUST be returned when a server receives a command to transfer an object that is pending transfer due to an earlier transfer request.static int
PARAM_OUT_OF_RANGE
Parameter value range error
This response code MUST be returned when a server receives a command parameter whose value is outside the range of values specified by the protocol.static int
PARAM_SYNTAX_ERROR
Parameter value syntax error
This response code MUST be returned when a server receives a command containing a parameter whose value is improperly formed.static int
PARAM_VALUE_POLICY_ERROR
Parameter value policy error
This response code MUST be returned when a server receives a command containing a parameter value that is syntactically valid, but semantically invalid due to local policy.static int
SESSION_LIMIT_END
Session limit exceeded; server closing connection
This response code MUST be retunred when a server receives a login command, and the command can not be completed because the client has exceeded a system-defined limit on the number of session that the client can establish.static int
STATUS_PROHIBITS_OP
Object status prohibits operation
This response code MUST be returned when a server receives a command to transform an object that can not be completed due to server policy or business practices.static int
SUCCESS
Command completed successfully
This is the usual response code for a successfully completed command that is not addressed by any other 1xxx-series response code.static int
SUCCESS_END_SESSION
Command completed successfully; ending session
This response code MUST be returned when responding to a successful logout commandstatic int
SUCCESS_PENDING
Command completed successfully; action pending
This response code MUST be returned when responding to a command the requires offline activity before the requested action can be completed.static int
SUCCESS_POLL_MSG
Command completed successfully; ack to dequeue
This response code MUST be returned when responding to a <poll> request command and a message has been retrieved from the server message queue.static int
SUCCESS_POLL_NO_MSGS
Command completed successfully; no messages
This response code MUST be returned when responding to a poll request command and the server message queue is empty.static int
UNIMPLEMENTED_COMMAND
Unimplemented command
This response code MUST be returned when a server receives a valid EPP command element that is not implemented by the server.static int
UNIMPLEMENTED_EXTENSION
Unimplemented extension
This response code MUST be returned when a server receives a valid EPP command element that contains a protocol command extension that is not implemented by the server.static int
UNIMPLEMENTED_OBJECT_SERVICE
Unimplemented object service
This response code MUST be returned when a server receives a command to operate on an object service that is not supported by the server.static int
UNIMPLEMENTED_OPTION
Unimplemented option
This response code MUST be returned when a server receives a valid EPP command element that contains a protocol option that is not implemented by the server.static int
UNIMPLEMENTED_VERSION
Unimplemented protocol version
This response code MUST be returned when a server receives a command element specifying a protocol version that is not implemented by the server.static int
UNKNOWN_COMMAND
Unknown command
This response code MUST be returned when a server receives a command element that is not defined by EPP.
-
Constructor Summary
Constructors Constructor Description EPPResult()
Allocates a newEPPResult
with default attribute values.EPPResult(int aCode)
Allocates a newEPPResult
with a result code.EPPResult(int aCode, java.lang.String aMessage)
Allocates a newEPPResult
with a result code and result message.EPPResult(int aCode, java.lang.String aMessage, java.lang.String aLang)
Allocates a newEPPResult
with a result code, result message, and result message language.EPPResult(int aCode, java.lang.String aMessage, java.lang.String aLang, java.util.Vector aValues)
Allocates a newEPPResult
with all of the attribute set with the arguments.EPPResult(int aCode, java.lang.String aMessage, java.util.Vector aValues)
Allocates a newEPPResult
with a result code, result message, and result values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addExtValue(EPPExtValue aExtValue)
Adds anEPPExtValue
instance to the list of client error elements.void
addExtValueReason(java.lang.String aReason)
Adds anextValue
reason, which will set the value, XML namespace, and XML prefix to default values.void
addValue(EPPValue aValue)
Adds anEPPValue
instance to the list of client error elements.void
addValue(java.lang.String aValue)
Adds an individual XML value to the list of XML values.java.lang.Object
clone()
CloneEPPResult
.void
decode(org.w3c.dom.Element aElement)
decodeEPPResult
from a DOM element tree.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
encodeEPPResult
into a DOM element tree.boolean
equals(java.lang.Object aObject)
implements a deepEPPResult
compare.java.util.Vector
getAllValues()
Gets aVector
of all of theEPPValue
andEPPExtValue
defined in the result.int
getCode()
Gets the result code.java.util.Vector
getExtValues()
Gets theEPPExtValue
instances associated with the result.java.lang.String
getLang()
Gets the message language of the result.java.lang.String
getMessage()
Gets the message of the result.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.util.Vector
getStrValues()
Gets the value strings associated with the result.java.util.Vector
getValues()
Gets theEPPValue
instances associated with the result.boolean
isSuccess()
Was the result a succcess?void
setAllValues(java.util.Vector aValues)
Sets the value and extValue lists based on a singleVector
ofEPPValue
orEPPExtValue
instances.void
setCode(int aCode)
Sets the result code.void
setCode(int aCode, boolean aUseDefaultMessage)
Sets the result code and the default en message associated with the result code ifaUseDefaultMessage
is set totrue
; otherwise only the result code is set.void
setExtValueReasons(java.util.Vector aReasons)
Sets aVector
ofextValue
reasons.void
setExtValues(EPPExtValue[] aExtValues)
Sets the extended values associated with the result using an array.void
setExtValues(java.util.Vector aExtValues)
Sets the extValue's associated with the result.void
setLang(java.lang.String aLang)
Sets the message language of the result.void
setMessage(java.lang.String aMessage)
Sets the message of the result in the default language of "en".void
setMessage(java.lang.String aMessage, java.lang.String aLang)
Sets the message of the result along with the language of the message.void
setValues(EPPValue[] aValues)
Sets the values associated with the result.void
setValues(java.util.Vector aValues)
Sets the values associated with the result.boolean
shouldCloseSession()
Should the EPP session be closed based on the result code?java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
DEFAULT_LANG
public static final java.lang.String DEFAULT_LANG
The default language of the result message "en".- See Also:
- Constant Field Values
-
SUCCESS
public static final int SUCCESS
Command completed successfully
This is the usual response code for a successfully completed command that is not addressed by any other 1xxx-series response code.- See Also:
- Constant Field Values
-
SUCCESS_PENDING
public static final int SUCCESS_PENDING
Command completed successfully; action pending
This response code MUST be returned when responding to a command the requires offline activity before the requested action can be completed.- See Also:
- Constant Field Values
-
SUCCESS_POLL_NO_MSGS
public static final int SUCCESS_POLL_NO_MSGS
Command completed successfully; no messages
This response code MUST be returned when responding to a poll request command and the server message queue is empty.- See Also:
- Constant Field Values
-
SUCCESS_POLL_MSG
public static final int SUCCESS_POLL_MSG
Command completed successfully; ack to dequeue
This response code MUST be returned when responding to a <poll> request command and a message has been retrieved from the server message queue.- See Also:
- Constant Field Values
-
SUCCESS_END_SESSION
public static final int SUCCESS_END_SESSION
Command completed successfully; ending session
This response code MUST be returned when responding to a successful logout command- See Also:
- Constant Field Values
-
UNKNOWN_COMMAND
public static final int UNKNOWN_COMMAND
Unknown command
This response code MUST be returned when a server receives a command element that is not defined by EPP.- See Also:
- Constant Field Values
-
COMMAND_SYNTAX_ERROR
public static final int COMMAND_SYNTAX_ERROR
Command syntax error
This response code MUST be returned when a server receives an improperly formed command element.- See Also:
- Constant Field Values
-
COMMAND_USE_ERROR
public static final int COMMAND_USE_ERROR
Command use error
This response code MUST be returned when a server receives a properly formed command element, but the command can not be executed due to a sequencing or context error. For example, a logout command can not be executed without having first completed a login command.- See Also:
- Constant Field Values
-
MISSING_PARAMETER
public static final int MISSING_PARAMETER
Required parameter missing
This response code MUST be returned when a server receives a command for which a required parameter value has not been provided.- See Also:
- Constant Field Values
-
PARAM_OUT_OF_RANGE
public static final int PARAM_OUT_OF_RANGE
Parameter value range error
This response code MUST be returned when a server receives a command parameter whose value is outside the range of values specified by the protocol. The error value SHOULD be returned via a value element in the EPP response.- See Also:
- Constant Field Values
-
PARAM_SYNTAX_ERROR
public static final int PARAM_SYNTAX_ERROR
Parameter value syntax error
This response code MUST be returned when a server receives a command containing a parameter whose value is improperly formed. The error value SHOULD be returned via a value element in the EPP response.- See Also:
- Constant Field Values
-
UNIMPLEMENTED_VERSION
public static final int UNIMPLEMENTED_VERSION
Unimplemented protocol version
This response code MUST be returned when a server receives a command element specifying a protocol version that is not implemented by the server.- See Also:
- Constant Field Values
-
UNIMPLEMENTED_COMMAND
public static final int UNIMPLEMENTED_COMMAND
Unimplemented command
This response code MUST be returned when a server receives a valid EPP command element that is not implemented by the server. For example, a transfer command MAY be unimplemented for certain object types.- See Also:
- Constant Field Values
-
UNIMPLEMENTED_OPTION
public static final int UNIMPLEMENTED_OPTION
Unimplemented option
This response code MUST be returned when a server receives a valid EPP command element that contains a protocol option that is not implemented by the server. For example, a server MAY not implement the protocol's session-less operating mode.- See Also:
- Constant Field Values
-
UNIMPLEMENTED_EXTENSION
public static final int UNIMPLEMENTED_EXTENSION
Unimplemented extension
This response code MUST be returned when a server receives a valid EPP command element that contains a protocol command extension that is not implemented by the server.- See Also:
- Constant Field Values
-
BILLING_ERROR
public static final int BILLING_ERROR
Billing failure
This response code MUST be returned when a server attempts to execute a billable operation and the command can not be completed due to a client billing failure.- See Also:
- Constant Field Values
-
NOT_RENEWABLE
public static final int NOT_RENEWABLE
Object is not eligible for renewal
This response code MUST be returned when a client attempts to renew an object that is not eligible for renewal in accordance with server policy.- See Also:
- Constant Field Values
-
NOT_TRANSFERABLE
public static final int NOT_TRANSFERABLE
Object is not eligible for transfer
This response code MUST be returned when a client attempts to transfer an object that is not eligible for transfer in accordance with server policy.- See Also:
- Constant Field Values
-
AUTHENTICATION_ERROR
public static final int AUTHENTICATION_ERROR
Authentication error
This response code MUST be returned when a server notes an error when validating client credentials.- See Also:
- Constant Field Values
-
AUTHORIZATION_ERROR
public static final int AUTHORIZATION_ERROR
Authorization error
This response code MUST be returned when a server notes a client authorization error when executing a command. This error is used to note that a client lacks privileges to execute the requested command.- See Also:
- Constant Field Values
-
INVALID_AUTHORIZATION_INFO
public static final int INVALID_AUTHORIZATION_INFO
Invalid authorization information
This response code MUST be returned when a server receives invalid command authorization information required to confirm authorization to execute a command. This error is used to note that a client has the privileges required to execute the requested command, but the authorization information provided by the client does not match the authorization information archived by the server.- See Also:
- Constant Field Values
-
OBJECT_PENDING_TRANSFER
public static final int OBJECT_PENDING_TRANSFER
Object pending transfer
This response code MUST be returned when a server receives a command to transfer an object that is pending transfer due to an earlier transfer request.- See Also:
- Constant Field Values
-
OBJECT_NOT_PENDING_TRANSFER
public static final int OBJECT_NOT_PENDING_TRANSFER
Object not pending transfer
This response code MUST be returned when a server receives a command to confirm, reject, or cancel the transfer an object when no command has been made to transfer the object.- See Also:
- Constant Field Values
-
OBJECT_EXISTS
public static final int OBJECT_EXISTS
Object exists
This response code MUST be returned when a server receives a command to create an object that already exists in the repository.- See Also:
- Constant Field Values
-
OBJECT_DOES_NOT_EXIST
public static final int OBJECT_DOES_NOT_EXIST
Object does not exist
This response code MUST be returned when a server receives a command to query or transform an object that does not exist in the repository.- See Also:
- Constant Field Values
-
STATUS_PROHIBITS_OP
public static final int STATUS_PROHIBITS_OP
Object status prohibits operation
This response code MUST be returned when a server receives a command to transform an object that can not be completed due to server policy or business practices. For example, a server MAY disallow transfer commands under terms and conditions that are matters of local policy, or the server may have received a delete command for an object whose status prohibits deletion.- See Also:
- Constant Field Values
-
ASSOC_PROHIBITS_OP
public static final int ASSOC_PROHIBITS_OP
Object association prohibits operation
This response code MUST be returned when a server receives a command to transform an object that can not be completed due to dependencies on other objects that are associated with the target object. For example, a server MAY disallow delete commands while an object has active associations with other objects.- See Also:
- Constant Field Values
-
PARAM_VALUE_POLICY_ERROR
public static final int PARAM_VALUE_POLICY_ERROR
Parameter value policy error
This response code MUST be returned when a server receives a command containing a parameter value that is syntactically valid, but semantically invalid due to local policy. For example, the server MAY support a subset of a range of valid protocol parameter values. The error value SHOULD be returned via a <value> element in the EPP response.- See Also:
- Constant Field Values
-
UNIMPLEMENTED_OBJECT_SERVICE
public static final int UNIMPLEMENTED_OBJECT_SERVICE
Unimplemented object service
This response code MUST be returned when a server receives a command to operate on an object service that is not supported by the server.- See Also:
- Constant Field Values
-
DATA_MGT_POLICY_VIOLATION
public static final int DATA_MGT_POLICY_VIOLATION
Data management policy violation
This response code MUST be returned when a server receives a command whose execution results in a violation of server data management policies. For example, removing all attribute values or object associations from an object MAY be a violation of a server's data management policies.- See Also:
- Constant Field Values
-
COMMAND_FAILED
public static final int COMMAND_FAILED
Command failed
This response code MUST be returned when a server is unable to execute a command due to an internal server error that is not related to the protocol. The failure MAY be transient. The server MUST keep any ongoing session active.- See Also:
- Constant Field Values
-
COMMAND_FAILED_END
public static final int COMMAND_FAILED_END
Command failed; server closing connection
This response code MUST be returned when a server receives a command that can not be completed due to an internal server error that is not related to the protocol. The failure is not transient, and will cause other commands to fail as well. The server MUST end the active session and close the existing connection.- See Also:
- Constant Field Values
-
AUTHENTICATION_ERROR_END
public static final int AUTHENTICATION_ERROR_END
Authentication error; server closing connection
This response code MUST be returned when a server notes an error when validating client credentials and a server-defined limit on the number of allowable failures has been exceeded. The server MUST close the existing connection.- See Also:
- Constant Field Values
-
SESSION_LIMIT_END
public static final int SESSION_LIMIT_END
Session limit exceeded; server closing connection
This response code MUST be retunred when a server receives a login command, and the command can not be completed because the client has exceeded a system-defined limit on the number of session that the client can establish. It may be possible to establish a session by ending existing unused sessions.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPResult
public EPPResult()
Allocates a newEPPResult
with default attribute values. The defaults are set to:
- code is set to
SUCCESS
- values is set to
null
- message is set to "Command completed successfully"
- lang is set to "en"
- code is set to
-
EPPResult
public EPPResult(int aCode)
Allocates a newEPPResult
with a result code. The other attributes will be set as follows:
- values is set to
null
- message is set to "en" equivalent of
aCode
if code is a pre-defined code; otherwise is set tonull
. - lang is set to
DEFAULT_LANG
.
- Parameters:
aCode
- result code that must be in the range 1000-9999.
- values is set to
-
EPPResult
public EPPResult(int aCode, java.lang.String aMessage)
Allocates a newEPPResult
with a result code and result message. The other attributes will be set as follows:
- values is set to
null
- lang is set to
DEFAULT_LANG
- Parameters:
aCode
- result code that must be in the range 1000-9999.aMessage
- result message in the default "en" language.
- values is set to
-
EPPResult
public EPPResult(int aCode, java.lang.String aMessage, java.lang.String aLang)
Allocates a newEPPResult
with a result code, result message, and result message language. The other attributes will be set as follows:
- values is set to
null
- Parameters:
aCode
- result code that must be in the range 1000-9999.aMessage
- result message in the default "en" language.aLang
- Language of result message.
- values is set to
-
EPPResult
public EPPResult(int aCode, java.lang.String aMessage, java.util.Vector aValues)
Allocates a newEPPResult
with a result code, result message, and result values.
This method should only be called for error results, since successful results don't include values.- Parameters:
aCode
- result code that must be in the range 1000-9999.aMessage
- result message in the default "en" language.aValues
- Vector of eitherEPPValue
orEPPExtValue
instances.
-
EPPResult
public EPPResult(int aCode, java.lang.String aMessage, java.lang.String aLang, java.util.Vector aValues)
Allocates a newEPPResult
with all of the attribute set with the arguments. This method should only be called for error results, since successful results don't include values.- Parameters:
aCode
- result code that must be in the range 1000-9999.aMessage
- result message in the default "en" language.aLang
- Language of result message.aValues
- Vector of eitherEPPValue
orEPPExtValue
instances.
-
-
Method Detail
-
addValue
public void addValue(java.lang.String aValue)
Adds an individual XML value to the list of XML values. The XML prefix and XML prefix will be set to the default values.- Parameters:
aValue
- XMLString
value. For example, "<epp:login/>".
-
addValue
public void addValue(EPPValue aValue)
Adds anEPPValue
instance to the list of client error elements. This method allows for the specification of an XML prefix and XML namespace for the error value.- Parameters:
aValue
-EPPValue
instance that includes the client element XML and its associated XML prefix and namespace.
-
addExtValueReason
public void addExtValueReason(java.lang.String aReason)
Adds anextValue
reason, which will set the value, XML namespace, and XML prefix to default values. The default values will not specify a client element that caused the error. The reason is free form text that can be used to provide more information about the error from the server business logic.- Parameters:
aReason
- Human-readable message that describes the reason for the error.
-
addExtValue
public void addExtValue(EPPExtValue aExtValue)
Adds anEPPExtValue
instance to the list of client error elements. This method allows for the specification of an XML prefix and XML namespace for the error value and a reason.- Parameters:
aExtValue
-EPPExtValue
instance that includes the client element XML and its associated XML prefix and namespace.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPResult
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- Deep copy clone of
EPPResult
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decodeEPPResult
from a DOM element tree. TheaElement
argument needs to be the <result> element.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- The <result> XML element.- Throws:
EPPDecodeException
- Error decoding the DOM element tree.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encodeEPPResult
into a DOM element tree. The result is created and the attribute nodes are appended as children.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- Used as a document factory- Returns:
- <result> root element tree.
- Throws:
EPPEncodeException
- Error encoding the DOM element tree.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPResult
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPResult
instance to compare with- Returns:
true
if equal;false
otherwise
-
getCode
public int getCode()
Gets the result code.- Returns:
- Result code that must be in the range 1000-9999.
-
getLang
public java.lang.String getLang()
Gets the message language of the result. The Language must be structured as documented in [RFC1766].- Returns:
- Language of the message.
-
getMessage
public java.lang.String getMessage()
Gets the message of the result. The language of the message can be retreived bygetLang
.- Returns:
- Message
String
describing the result.
-
getValues
public java.util.Vector getValues()
Gets theEPPValue
instances associated with the result.- Returns:
- Vector error value
EPPValue
instances if defined;null
otherwise.
-
getExtValues
public java.util.Vector getExtValues()
Gets theEPPExtValue
instances associated with the result.- Returns:
- Vector error value
EPPExtValue
instances if defined;null
otherwise.
-
getAllValues
public java.util.Vector getAllValues()
Gets aVector
of all of theEPPValue
andEPPExtValue
defined in the result.- Returns:
- Vector error value
EPPValue
orEPPExtValue
instances if defined;null
otherwise.
-
setAllValues
public void setAllValues(java.util.Vector aValues)
Sets the value and extValue lists based on a singleVector
ofEPPValue
orEPPExtValue
instances.- Parameters:
aValues
-Vector
ofEPPValue
orEPPExtValue
instances.
-
getStrValues
public java.util.Vector getStrValues()
Gets the value strings associated with the result.- Returns:
- Vector error value
String
instances if defined;null
otherwise. - Since:
- EPP 1.0
-
isSuccess
public boolean isSuccess()
Was the result a succcess?- Returns:
true
if success;false
otherwise.
-
shouldCloseSession
public boolean shouldCloseSession()
Should the EPP session be closed based on the result code?- Returns:
true
if the session should be closed;false
otherwise
-
setCode
public void setCode(int aCode)
Sets the result code.- Parameters:
aCode
- Result code that must be in the range 1000-9999.
-
setCode
public void setCode(int aCode, boolean aUseDefaultMessage)
Sets the result code and the default en message associated with the result code ifaUseDefaultMessage
is set totrue
; otherwise only the result code is set.- Parameters:
aCode
- Result code that must be in the range 1000-9999.aUseDefaultMessage
- Use the default en message associated with aCode?
-
setLang
public void setLang(java.lang.String aLang)
Sets the message language of the result. The Language must be structured as documented in [RFC1766].- Parameters:
aLang
- Language of the message.
-
setMessage
public void setMessage(java.lang.String aMessage)
Sets the message of the result in the default language of "en".- Parameters:
aMessage
- MessageString
describing the result.
-
setMessage
public void setMessage(java.lang.String aMessage, java.lang.String aLang)
Sets the message of the result along with the language of the message. The Language must be structured as documented in [RFC1766].- Parameters:
aMessage
- MessageString
describing the result.aLang
- Language of the message
-
setValues
public void setValues(EPPValue[] aValues)
Sets the values associated with the result.- Parameters:
aValues
- Array ofEPPValue
instances.
-
setValues
public void setValues(java.util.Vector aValues)
Sets the values associated with the result.- Parameters:
aValues
- Vector ofEPPValue
instances.
-
setExtValues
public void setExtValues(EPPExtValue[] aExtValues)
Sets the extended values associated with the result using an array. In the specification, an extended value can be used to provide additional error diagnostic information, including a value identifying a client-provided element (including XML tag and value) that caused a server error condition, and a reason containing a human-readable message that describes the reason for the error.- Parameters:
aExtValues
- Array ofEPPExtValue
instances.- Since:
- EPP 1.0
-
setExtValues
public void setExtValues(java.util.Vector aExtValues)
Sets the extValue's associated with the result.- Parameters:
aExtValues
- Vector ofEPPExtValue
instances.
-
setExtValueReasons
public void setExtValueReasons(java.util.Vector aReasons)
Sets aVector
ofextValue
reasons. Each reason will set the value, XML namespace, and XML prefix to default values. The default values will not specify a client element that caused the error. The reason is free form text that can be used to provide more information about the error from the server business logic.- Parameters:
aReasons
-Vector
of human-readableString
messages that describe the reason for the error.
-
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
.
-
-