Package com.verisign.epp.codec.gen

Interface EPPCodecComponent

All Superinterfaces:
Cloneable, Serializable
All Known Subinterfaces:
EPPMessage, EPPNameVerificationCreateResult, EPPNameVerificationInfoResult
All Known Implementing Classes:
EPPAddlEmail, EPPAllocationToken, EPPAllocationTokenInfo, EPPAuthInfo, EPPBalanceInfoCmd, EPPBalanceInfoCmd, EPPBalanceInfoResp, EPPBalanceInfoResp, EPPChangeAction, EPPChangeCaseId, EPPChangeCheckCmd, EPPChangeCheckData, EPPChangeCheckResp, EPPChangeCreateCmd, EPPChangeData, EPPChangeDeleteCmd, EPPChangeExt, EPPChangeInfoCmd, EPPChangeInfoResp, EPPChangeOperation, EPPChangeUpdateAttributes, EPPChangeUpdateCmd, EPPChangeUpdateResp, EPPCheckCmd, EPPCoaExtAttr, EPPCoaExtCreate, EPPCoaExtInfData, EPPCoaExtKey, EPPCoaExtUpdate, EPPCoaExtValue, EPPCommand, EPPContactAddChange, EPPContactAddress, EPPContactCheckCmd, EPPContactCheckResp, EPPContactCheckResult, EPPContactCreateCmd, EPPContactCreateResp, EPPContactDeleteCmd, EPPContactDisclose, EPPContactDiscloseAddress, EPPContactDiscloseName, EPPContactDiscloseOrg, EPPContactInfoCmd, EPPContactInfoResp, EPPContactPendActionMsg, EPPContactPostalDefinition, EPPContactStatus, EPPContactTransferCmd, EPPContactTransferResp, EPPContactUpdateCmd, EPPCourt, EPPCreateCmd, EPPCredentials, EPPCreditThreshold, EPPDcp, EPPDefRegAddRemove, EPPDefRegCheckCmd, EPPDefRegCheckResp, EPPDefRegCheckResult, EPPDefRegCreateCmd, EPPDefRegCreateResp, EPPDefRegDeleteCmd, EPPDefRegInfoCmd, EPPDefRegInfoResp, EPPDefRegName, EPPDefRegPeriod, EPPDefRegRenewCmd, EPPDefRegRenewResp, EPPDefRegStatus, EPPDefRegTransferCmd, EPPDefRegTransferResp, EPPDefRegUpdateCmd, EPPDeleteCmd, EPPDomainAddRemove, EPPDomainCheckCmd, EPPDomainCheckResp, EPPDomainCheckResult, EPPDomainContact, EPPDomainCreateCmd, EPPDomainCreateResp, EPPDomainDeleteCmd, EPPDomainInfoCmd, EPPDomainInfoResp, EPPDomainNameVerification, EPPDomainPendActionMsg, EPPDomainPeriod, EPPDomainRenewCmd, EPPDomainRenewResp, EPPDomainStatus, EPPDomainTransferCmd, EPPDomainTransferResp, EPPDomainUpdateCmd, EPPEmailFwdAddRemove, EPPEmailFwdCheckCmd, EPPEmailFwdCheckResp, EPPEmailFwdCheckResult, EPPEmailFwdContact, EPPEmailFwdCreateCmd, EPPEmailFwdCreateResp, EPPEmailFwdDeleteCmd, EPPEmailFwdInfoCmd, EPPEmailFwdInfoResp, EPPEmailFwdPendActionMsg, EPPEmailFwdPeriod, EPPEmailFwdRenewCmd, EPPEmailFwdRenewResp, EPPEmailFwdStatus, EPPEmailFwdTransferCmd, EPPEmailFwdTransferResp, EPPEmailFwdUpdateCmd, EPPEncodedSignedCode, EPPEncodedSignedCodeValue, EPPEncodedSignedMark, EPPExtValue, EPPFeeCheck, EPPFeeCheckResult, EPPFeeChkData, EPPFeeCommand, EPPFeeCommandData, EPPFeeCreate, EPPFeeCreData, EPPFeeCredit, EPPFeeDelData, EPPFeePeriod, EPPFeeRenData, EPPFeeRenew, EPPFeeTransfer, EPPFeeTransform, EPPFeeTransformResult, EPPFeeTrnData, EPPFeeUpdate, EPPFeeUpdData, EPPFeeValue, EPPGreeting, EPPHello, EPPHostAddRemove, EPPHostAddress, EPPHostAttr, EPPHostCheckCmd, EPPHostCheckResp, EPPHostCheckResult, EPPHostCreateCmd, EPPHostCreateResp, EPPHostDeleteCmd, EPPHostInfoCmd, EPPHostInfoResp, EPPHostPendActionMsg, EPPHostStatus, EPPHostUpdateCmd, EPPIdnLangTag, EPPIdnMap, EPPIdnTableCheckCmd, EPPIdnTableCheckDomain, EPPIdnTableCheckResp, EPPIdnTableCheckTable, EPPIdnTableDomainLabel, EPPIdnTableInfoCmd, EPPIdnTableInfoDomain, EPPIdnTableInfoDomainTable, EPPIdnTableInfoListItem, EPPIdnTableInfoResp, EPPIdnTableInfoTable, EPPInfoCmd, EPPIssuer, EPPLaunchCheck, EPPLaunchCheckResult, EPPLaunchChkData, EPPLaunchClaimKey, EPPLaunchCodeMark, EPPLaunchCreate, EPPLaunchCreData, EPPLaunchDelete, EPPLaunchInfData, EPPLaunchInfo, EPPLaunchNotice, EPPLaunchPhase, EPPLaunchPolicyCreate, EPPLaunchPolicyInfData, EPPLaunchPolicyInfoPhase, EPPLaunchPolicyPhase, EPPLaunchPolicyPhaseStatus, EPPLaunchPolicyPollPolicy, EPPLaunchPolicyUpdate, EPPLaunchPolicyZone, EPPLaunchPolicyZoneContainer, EPPLaunchStatus, EPPLaunchUpdate, EPPLoginCmd, EPPLoginSec, EPPLoginSecData, EPPLoginSecEvent, EPPLoginSecPolicyEvent, EPPLoginSecPolicyInfData, EPPLoginSecPolicyPassword, EPPLoginSecPolicySystem, EPPLoginSecUserAgent, EPPLogoutCmd, EPPLowBalancePollResponse, EPPLowBalancePollThreshold, EPPMaintenanceDescription, EPPMaintenanceId, EPPMaintenanceInfoCmd, EPPMaintenanceInfoResp, EPPMaintenanceIntervention, EPPMaintenanceItem, EPPMaintenanceListItem, EPPMaintenanceSystem, EPPMaintenanceType, EPPMark, EPPMarkAddress, EPPMarkContact, EPPMsgQueue, EPPNamestoreExtNamestoreExt, EPPNamestoreExtNSExtErrData, EPPNameVerificationCheckCmd, EPPNameVerificationCheckResp, EPPNameVerificationCheckResult, EPPNameVerificationCreateCmd, EPPNameVerificationCreateFailed, EPPNameVerificationCreatePending, EPPNameVerificationCreateResp, EPPNameVerificationCreateSuccess, EPPNameVerificationDocument, EPPNameVerificationInfoCmd, EPPNameVerificationInfoInputResult, EPPNameVerificationInfoResp, EPPNameVerificationInfoSignedCodeResult, EPPNameVerificationPendActionMsg, EPPNameVerificationUpdateCmd, EPPNameWatchAddRemove, EPPNameWatchCreateCmd, EPPNameWatchCreateResp, EPPNameWatchDeleteCmd, EPPNameWatchInfoCmd, EPPNameWatchInfoResp, EPPNameWatchPeriod, EPPNameWatchRenewCmd, EPPNameWatchRenewResp, EPPNameWatchRptTo, EPPNameWatchStatus, EPPNameWatchTransferCmd, EPPNameWatchTransferResp, EPPNameWatchUpdateCmd, EPPOrgAddress, EPPOrgCheckCmd, EPPOrgCheckResp, EPPOrgCheckResult, EPPOrgContact, EPPOrgCreateCmd, EPPOrgCreateResp, EPPOrgDeleteCmd, EPPOrgExtAddRemChg, EPPOrgExtCreate, EPPOrgExtId, EPPOrgExtInfData, EPPOrgExtUpdate, EPPOrgInfoCmd, EPPOrgInfoResp, EPPOrgPendActionMsg, EPPOrgPostalDefinition, EPPOrgRole, EPPOrgUpdateCmd, EPPPersRegCreate, EPPPersRegCreateData, EPPPersRegCreateErrData, EPPPersRegGenData, EPPPersRegInfoData, EPPPersRegRenewData, EPPPersRegTransferData, EPPPollCmd, EPPProtection, EPPProtocolExtension, EPPPurpose, EPPRealNameVerification, EPPRecipient, EPPRegistryAbstractMinMax, EPPRegistryBatchJob, EPPRegistryBatchSchedule, EPPRegistryCheckCmd, EPPRegistryCheckCmd, EPPRegistryCheckResp, EPPRegistryCheckResp, EPPRegistryCheckResult, EPPRegistryCheckResult, EPPRegistryContact, EPPRegistryContact, EPPRegistryContactAddress, EPPRegistryContactAddress, EPPRegistryContactCity, EPPRegistryContactCity, EPPRegistryContactName, EPPRegistryContactName, EPPRegistryContactOrg, EPPRegistryContactOrg, EPPRegistryContactPostalCode, EPPRegistryContactPostalCode, EPPRegistryContactStateProvince, EPPRegistryContactStateProvince, EPPRegistryContactStreet, EPPRegistryContactStreet, EPPRegistryCreateCmd, EPPRegistryCreateCmd, EPPRegistryCreateResp, EPPRegistryCreateResp, EPPRegistryCustomData, EPPRegistryDefaultPeriodType, EPPRegistryDefaultPeriodType, EPPRegistryDeleteCmd, EPPRegistryDeleteCmd, EPPRegistryDNSSEC, EPPRegistryDNSSEC, EPPRegistryDomain, EPPRegistryDomain, EPPRegistryDomainContact, EPPRegistryDomainContact, EPPRegistryDomainHostLimit, EPPRegistryDomainHostLimit, EPPRegistryDomainName, EPPRegistryDomainName, EPPRegistryDomainNSLimit, EPPRegistryDomainNSLimit, EPPRegistryDomainPeriod, EPPRegistryDomainPeriod, EPPRegistryDS, EPPRegistryDS, EPPRegistryExceedMaxExDate, EPPRegistryExternalHost, EPPRegistryExternalHost, EPPRegistryFields, EPPRegistryGracePeriod, EPPRegistryGracePeriod, EPPRegistryHost, EPPRegistryHost, EPPRegistryIDN, EPPRegistryIDN, EPPRegistryInfoCmd, EPPRegistryInfoCmd, EPPRegistryInfoResp, EPPRegistryInfoResp, EPPRegistryInternalHost, EPPRegistryInternalHost, EPPRegistryKey, EPPRegistryKey, EPPRegistryKeyValue, EPPRegistryLanguage, EPPRegistryLanguageType, EPPRegistryMaxPeriodType, EPPRegistryMaxPeriodType, EPPRegistryMaxSig, EPPRegistryMaxSig, EPPRegistryMinMax, EPPRegistryMinMaxLength, EPPRegistryMinMaxLength, EPPRegistryMinMaxPeriod, EPPRegistryMinMaxPeriod, EPPRegistryMinPeriodType, EPPRegistryMinPeriodType, EPPRegistryPendingDeletePeriodType, EPPRegistryPendingDeletePeriodType, EPPRegistryPendingRestorePeriodType, EPPRegistryPendingRestorePeriodType, EPPRegistryPeriodType, EPPRegistryPeriodType, EPPRegistryPhase, EPPRegistryPostal, EPPRegistryPostal, EPPRegistryRedemptionPeriodType, EPPRegistryRedemptionPeriodType, EPPRegistryRegex, EPPRegistryRegex, EPPRegistryRelated, EPPRegistryReservedNames, EPPRegistryReservedNames, EPPRegistryRGP, EPPRegistryRGP, EPPRegistryServices, EPPRegistryServices, EPPRegistryServices.EPPRegistryObjURI, EPPRegistryServices.EPPRegistryObjURI, EPPRegistryServices.EPPRegistryURI, EPPRegistryServices.EPPRegistryURI, EPPRegistryServicesExt, EPPRegistryServicesExt, EPPRegistryServicesExt.EPPRegistryExtURI, EPPRegistryServicesExt.EPPRegistryExtURI, EPPRegistrySLA, EPPRegistrySLAInfo, EPPRegistrySupportedStatus, EPPRegistrySupportedStatus, EPPRegistrySystemInfo, EPPRegistryTransferHoldPeriodType, EPPRegistryTransferHoldPeriodType, EPPRegistryUpdateCmd, EPPRegistryUpdateCmd, EPPRegistryUpdateResp, EPPRegistryZone, EPPRegistryZone, EPPRegistryZoneData, EPPRegistryZoneInfo, EPPRegistryZoneList, EPPRegistryZoneList, EPPRegistryZoneMember, EPPRegistryZoneName, EPPRegistryZoneSummary, EPPRelatedDomainExtAuthInfo, EPPRelatedDomainExtAvailable, EPPRelatedDomainExtCreate, EPPRelatedDomainExtCreateResp, EPPRelatedDomainExtDelete, EPPRelatedDomainExtDeleteResp, EPPRelatedDomainExtDomain, EPPRelatedDomainExtDomainData, EPPRelatedDomainExtField, EPPRelatedDomainExtFields, EPPRelatedDomainExtGroup, EPPRelatedDomainExtInfData, EPPRelatedDomainExtInfo, EPPRelatedDomainExtName, EPPRelatedDomainExtPeriod, EPPRelatedDomainExtRegistered, EPPRelatedDomainExtRenew, EPPRelatedDomainExtRenewResp, EPPRelatedDomainExtTransfer, EPPRelatedDomainExtTransferResp, EPPRelatedDomainExtUpdate, EPPRenewCmd, EPPResponse, EPPResult, EPPRgpExtInfData, EPPRgpExtReport, EPPRgpExtReportText, EPPRgpExtRestore, EPPRgpExtStatus, EPPRgpExtUpData, EPPRgpExtUpdate, EPPRgpPollResponse, EPPRgpPollStatus, EPPSecDNSExtCreate, EPPSecDNSExtCreate, EPPSecDNSExtDsData, EPPSecDNSExtDsData, EPPSecDNSExtInfData, EPPSecDNSExtInfData, EPPSecDNSExtKeyData, EPPSecDNSExtKeyData, EPPSecDNSExtUpdate, EPPSecDNSExtUpdate, EPPService, EPPServiceMenu, EPPSignedCode, EPPSignedMark, EPPStatement, EPPSyncExtUpdate, EPPTrademark, EPPTransferCmd, EPPTransId, EPPTreatyOrStatute, EPPTtl, EPPTtlCreate, EPPTtlExtension, EPPTtlInfData, EPPTtlInfo, EPPTtlUpdate, EPPUpdateCmd, EPPValidateAddress, EPPValidateAuthInfo, EPPValidateCheckCmd, EPPValidateCheckResp, EPPValidateCheckResult, EPPValidateContact, EPPValidateKeyValue, EPPValidatePostalDefinition, EPPValue, EPPVerificationCode, EPPVerificationCodeInfData, EPPVerificationCodeInfo, EPPVerificationCodeProfile, EPPWhoisInf, EPPWhoisInfData
public interface EPPCodecComponent extends Serializable, Cloneable
Represents an EPP CODEC Component interface that is implemented by any class that needs to participate in the encoding and decoding of EPP XML documents. All EPPCodecComponent classes are Serializable. All subclasses of EPPMessage and all contained classes of EPPMessage classes must implement the EPPCodecComponent interface.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    clone an EPPCodecComponent.
    void
    decode(Element aElement)
    decode a DOM element tree to initialize the instance attributes.
    Element
    encode(Document aDocument)
    encode instance into a DOM element tree.
    String
    getNamespace()
    Gets the EPP namespace associated with the EPPCodecComponent.

  • Method Details

    • encode

      Element encode(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.

      For example, the <command> element of EPPCommand is created and is used to append the attribute nodes of EPPCommand.
      Parameters:
      aDocument - DOM document used as a factory of DOM objects.
      Returns:
      instance root DOM element along with attribute child nodes.
      Throws:
      EPPEncodeException - Error encoding the DOM element tree.

    • decode

      void decode(Element aElement) throws EPPDecodeException
      decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.

      For example, the <command> element of EPPCommand is passed into decode of EPPCommand to be decoded and used to set the instance attributes.
      Parameters:
      aElement - root DOM element associated with instance
      Throws:
      EPPDecodeException - Error decoding the DOM element tree.

    • clone

      Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Returns:
      clone of concrete EPPCodecComponent
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • getNamespace

      String getNamespace()
      Gets the EPP namespace associated with the EPPCodecComponent.
      Returns:
      Namespace URI associated with the EPPCodecComponent.