com.ausregistry.jtoolkit2.se

Class TransferCommand

java.lang.Object

com.ausregistry.jtoolkit2.se.Command

com.ausregistry.jtoolkit2.se.ObjectCommand

com.ausregistry.jtoolkit2.se.TransferCommand

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ContactTransferCommand, DomainTransferCommand

public abstract class TransferCommand
extends ObjectCommand

Representation of the EPP transfer command, as defined in RFC5730. Subclasses of this must specify the object to which the command is mapped, the type of transfer operation and specify the object-specific identifier of the object to create a transfer command for.

See Also:

TransferResponse, 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.ObjectCommand

objElement

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

cmdElement, command, extension

Constructor Summary

Constructors

Constructor and Description
TransferCommand(ObjectType objType, TransferOp operation, java.lang.String ident) Create a transfer command of the specified operation type mapped to the specified object type for the identified object.
TransferCommand(ObjectType objType, TransferOp operation, java.lang.String ident, Period period, java.lang.String pw) Create a transfer command of the specified operation type mapped to the specified object type for the identified object.
TransferCommand(ObjectType objType, TransferOp operation, java.lang.String ident, Period period, java.lang.String roid, java.lang.String pw) Create a transfer command of the specified operation type mapped to the specified object type for the identified object.
TransferCommand(ObjectType objType, TransferOp operation, java.lang.String ident, java.lang.String pw) Create a transfer command of the specified operation type mapped to the specified object type for the identified object.
TransferCommand(ObjectType objType, TransferOp operation, java.lang.String ident, java.lang.String roid, java.lang.String pw) Create a transfer command of the specified operation type mapped to the specified object type for the identified object.

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

TransferCommand

public TransferCommand(ObjectType objType,
                       TransferOp operation,
                       java.lang.String ident)

Create a transfer command of the specified operation type mapped to the specified object type for the identified object.

Parameters:

objType - The type of object to which the transfer command is to be mapped.

operation - The type of transfer operation to perform. Required.

ident - An object type-specific label identifying the object subject to the transfer command.

Throws:

java.lang.IllegalArgumentException - if operation is null.

TransferCommand

public TransferCommand(ObjectType objType,
                       TransferOp operation,
                       java.lang.String ident,
                       java.lang.String pw)

Create a transfer command of the specified operation type mapped to the specified object type for the identified object.

Parameters:

objType - The type of object to which the transfer command is to be mapped.

operation - The type of transfer operation to perform.

ident - An object type-specific label identifying the object subject to the transfer command.

pw - The password of the object subject to the transfer command - also referred to as authInfo or authorisation information.

TransferCommand

public TransferCommand(ObjectType objType,
                       TransferOp operation,
                       java.lang.String ident,
                       Period period,
                       java.lang.String pw)

Create a transfer command of the specified operation type mapped to the specified object type for the identified object.

Parameters:

objType - The type of object to which the transfer command is to be mapped.

operation - The type of transfer operation to perform.

ident - An object type-specific label identifying the object subject to the transfer command.

period - The validity period of the identified object should be extended by this duration upon successful completion of the transfer related to this command. Required.

pw - The password of the object subject to the transfer command - also referred to as authInfo or authorisation information.

Throws:

java.lang.IllegalArgumentException - if period is null.

TransferCommand

public TransferCommand(ObjectType objType,
                       TransferOp operation,
                       java.lang.String ident,
                       java.lang.String roid,
                       java.lang.String pw)

Create a transfer command of the specified operation type mapped to the specified object type for the identified object.

Parameters:

objType - The type of object to which the transfer command is to be mapped.

operation - The type of transfer operation to perform.

ident - An object type-specific label identifying the object subject to the transfer command.

roid - The Repository Object Identifier of an object related to the identified object subject to transfer which is considered a suitable proxy for authorising transfer commands.

pw - The password of the related object identified by roid.

TransferCommand

public TransferCommand(ObjectType objType,
                       TransferOp operation,
                       java.lang.String ident,
                       Period period,
                       java.lang.String roid,
                       java.lang.String pw)

Create a transfer command of the specified operation type mapped to the specified object type for the identified object.

Parameters:

objType - The type of object to which the transfer command is to be mapped.

operation - The type of transfer operation to perform.

ident - An object type-specific label identifying the object subject to the transfer command.

period - The validity period of the identified object should be extended by this duration upon successful completion of the transfer related to this command.

roid - The Repository Object Identifier of an object related to the identified object subject to transfer which is considered a suitable proxy for authorising transfer commands.

pw - The password of the related object identified by ROID.

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